Ruft Assets ab, die mit einem angegebenen Asset verknüpft sind, sowie Details zu dessen Beziehung.
Syntax
IpsUser
IpsAdmin
IpsCompanyAdmin
TrialSiteAdmin
TrialSiteUser
ImagePortalAdmin
ImagePortalUser
ImagePortalContrib
ImagePortalContribUser
Eingabe (getAssociatedAssetsParam)
Name |
Typ |
Erforderlich |
Beschreibung |
---|---|---|---|
companyHandle |
xsd:string |
Ja |
Handle an das Unternehmen, dem das Asset gehört. |
assetHandle |
xsd:string |
Ja |
Asset-Handle. |
responseFieldArray |
Typen:StringArray |
Nein |
Das Array der gewünschten Antwortfelder. Siehe response- FieldArray/excludeFieldArray in der Einführung. |
excludeFieldArray |
Typen:StringArray |
Nein |
Das Array der ausgeschlossenen Antwortfelder. Siehe response- FieldArray/excludeFieldArray in der Einführung. |
Ausgabe (getAssociatedAssetsReturn)
Name |
Typ |
Erforderlich |
Beschreibung |
---|---|---|---|
containerArray | Typen:AssetArray | Nein |
Array von Set- und Vorlagen-Assets, die das angegebene Asset enthalten. |
memberArray | Typen:AssetArray | Nein |
Array von Assets, die vom angegebenen Satz oder Vorlagen-Asset enthalten sind. |
layerReferenceArray | Typen:AssetArray | Nein |
Array von Assets, die in einer Ebene oder Vorlagen-URL referenziert werden. |
ownerArray | Typen:AssetArray | Nein |
Array von Assets, die Eigentümer des angegebenen Assets sind. |
abgeleitetesArray | Typen:AssetArray | Nein |
Array von Assets, die zum Generieren des angegebenen Assets verwendet wurden. |
generatorArray | Typen:GenerationInfoArray | Nein |
Das generatorArray listet auf, wie dieses Asset erstellt wurde. Wenn assetHandler beispielsweise eine Bildseite eines PDF-Dokuments war, würde dies das PDF-Prozessor-Tool enthalten und auf das PDF-Datei-Asset verweisen. |
generateArray | Typen:GenerationInfoArray | Nein |
generatedArray kehrt die Art und Weise um, wie dieses Asset erstellt wurde. Beispielsweise könnte das generatedArray die Liste der Bilder enthalten, die aus diesem assetHandler generiert wurden, wenn es ein PdfFile-Asset war. |
thumbAsset | Typen:Asset | Nein |
Die mit dem Anfrage-Asset verknüpften Asset-Informationen. Wenn kein Miniatur-Asset zugewiesen ist, wird das Feld in der Antwort weggelassen. |
Sie können die Parameter responseFieldArray
oder excludeFieldArray
verwenden, um die Antwortgröße zu begrenzen. Insbesondere enthalten die GenerationInfo
-Elemente, die in generatorArray
oder generatedArray
zurückgegeben werden, standardmäßig sowohl den Originator als auch die generierten Asset-Datensätze. Bei einem PDF-Asset-Typ führt dieses Verhalten zu unerwünschten mehreren Kopien des PDF-Asset-Datensatzes "originator"in der Antwort. Sie können dieses Problem beheben, indem Sie generatedArray/items/originator
zu excludeFieldArray
hinzufügen. Sie können auch eine explizite Liste von Antwortfeldern angeben, die Sie in responseFieldArray
einbeziehen möchten.
Das folgende grundlegende Beispiel ist eine Anfrage an den Handle des Generators für ein Bild, das aus einer PDF-Datei extrahiert wird. Sie enthält ein containerArray
der Länge 1 mit einem Element, das die assetHandle
der PDF-Datei enthält.
Anforderung
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:beta="http://www.scene7.com/IpsApi/xsd/2013-08-29-beta">
<soap:Body>
<beta:getAssociatedAssetsParam>
<beta:companyHandle>c|11</beta:companyHandle>
<beta:assetHandle>a|197</beta:assetHandle>
<beta:responseFieldArray>
<beta:items>containerArray/items/assetHandle</beta:items>
</beta:responseFieldArray>
</beta:getAssociatedAssetsParam>
</soap:Body>
</soap:Envelope>
Antwort
<soapenv:Envelope xmlns:soapenv="http://www.w3.org/2003/05/soap-envelope">
<soapenv:Body>
<getAssociatedAssetsReturn xmlns="http://www.scene7.com/IpsApi/xsd/2013-08-29-beta">
<containerArray>
<items>
<assetHandle>a|207</assetHandle>
</items>
</containerArray>
</getAssociatedAssetsReturn>
</soapenv:Body>
</soapenv:Envelope>
Das Gegenteil des obigen Beispiels ist:
Anforderung
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:beta="http://www.scene7.com/IpsApi/xsd/2013-08-29-beta">
<soap:Body>
<beta:getAssociatedAssetsParam>
<beta:companyHandle>c|11</beta:companyHandle>
<beta:assetHandle>a|177</beta:assetHandle>
<beta:responseFieldArray>
<beta:items>generatedArray/items/originator/assetHandle</beta:items>
</beta:responseFieldArray>
</beta:getAssociatedAssetsParam>
</soap:Body>
</soap:Envelope>
Antwort
<soapenv:Envelope xmlns:soapenv="http://www.w3.org/2003/05/soap-envelope">
<soapenv:Body>
<getAssociatedAssetsReturn xmlns="http://www.scene7.com/IpsApi/xsd/2013-08-29-beta">
<generatedArray>
<items>
<originator>
<assetHandle>a|177</assetHandle>
</originator>
</items>
<items>
<originator>
<assetHandle>a|177</assetHandle>
</originator>
</items>
<items>
<originator>
<assetHandle>a|177</assetHandle>
</originator>
</items>
<items>
<originator>
<assetHandle>a|177</assetHandle>
</originator>
</items>
<items>
<originator>
<assetHandle>a|177</assetHandle>
</originator>
</items>
<items>
<originator>
<assetHandle>a|177</assetHandle>
</originator>
</items>
<items>
<originator>
<assetHandle>a|177</assetHandle>
</originator>
</items>
<items>
<originator>
<assetHandle>a|177</assetHandle>
</originator>
</items>
<items>
<originator>
<assetHandle>a|177</assetHandle>
</originator>
</items>
<items>
<originator>
<assetHandle>a|177</assetHandle>
</originator>
</items>
</generatedArray>
</getAssociatedAssetsReturn>
</soapenv:Body>
</soapenv:Envelope>
In diesem nächsten Beispiel wird eine Gruppe zu einem Unternehmen mit groupHandleArray
hinzugefügt. In diesem Beispiel wird nur eine Gruppe verwendet.
Anforderung
<ns1:addGroupMembershipParam xmlns:ns1="http://www.scene7.com/IpsApi/xsd">
<ns1:companyHandle>47</ns1:companyHandle>
<ns1:groupHandleArray><ns1:items>225</ns1:items></ns1:groupHandleArray>
</ns1:addGroupMembershipParam>
Antwort
Keine.