Dokumentation Dynamic Media Image Production System-API

getAssociatedAssets getassociatedassets

Last update: Fri Aug 15 2025 00:00:00 GMT+0000 (Coordinated Universal Time)

Themen:

Erstellt für:

Entwickler
Admin

Ruft Assets ab, die mit einem bestimmten Asset verknüpft sind, sowie Details zu ihrer Beziehung.

Syntax

Autorisierte Benutzertypen section-453cc706400345778713cda249bfac16

IpsUser
IpsAdmin
IpsCompanyAdmin
TrialSiteAdmin
TrialSiteUser
ImagePortalAdmin
ImagePortalUser
ImagePortalContrib
ImagePortalContribUser

Parameter section-d11d0dab59e94e89b466123a0ebfa82e

Eingabe (getAssociatedAssetsParam)

Name

Typ

Erforderlich

Beschreibung

companyHandle

xsd:string

Handle an das Unternehmen, dem das Asset gehört.

AssetHandle

xsd:string

Asset-Handle.

responseFieldArray

:StringArray

Nein

Das Array der gewünschten Antwortfelder. Siehe Antwort - FieldArray/excludeFieldArray in der Einführung.

excludeFieldArray

:StringArray

Nein

Das Array der ausgeschlossenen Antwortfelder. Siehe Antwort - FieldArray/excludeFieldArray in der Einführung.

Ausgabe (getAssociatedAssetsReturn)

Name

Typ

Erforderlich

Beschreibung

containerArray

:AssetArray

Nein

Array von Satz- und Vorlagen-Assets, das das angegebene Asset enthält.

memberArray

:AssetArray

Nein

Array von Assets, die im angegebenen Satz oder Vorlagen-Asset enthalten sind.

layerReferenceArray

:AssetArray

Nein

Array von Assets, auf die in einer Ebenen- oder Vorlagen-URL verwiesen wird.

OwnerArray

:AssetArray

Nein

Array von Assets, denen das angegebene Asset gehört.

DerivedArray

:AssetArray

Nein

Array von Assets, die zum Generieren des angegebenen Assets verwendet wurden.

generatorArray

:GenerationInfoArray

Nein

Das generatorArray listet die Art und Weise auf, wie dieses Asset erstellt wurde. Wenn AssetHandler beispielsweise eine Bildseite einer PDF wäre, würde diese das PDF-Prozessor-Tool enthalten und auf das PDF-Datei-Asset verweisen.

generateArray

:GenerationInfoArray

Nein

Das generateArray invertiert die Art und Weise, wie dieses Asset erstellt wurde. Beispielsweise könnte generateArray die Liste der Bilder enthalten, die aus diesem assetHandler generiert wurden wenn dies ein PDF-Datei-Asset war.

ThumbAsset

:Asset

Nein

Die Miniatur-Asset-Informationen, die mit der Asset-Anfrage verknüpft sind. 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 in GenerationInfo oder generatorArray zurückgegebenen generatedArray standardmäßig sowohl die ursprünglichen 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.

Beispiele section-8946ea4b9cb94912a8408249c897f192

Das folgende grundlegende Beispiel ist eine Anfrage für das Handle des Generators für ein Bild, das aus einer PDF extrahiert wird. Sie enthält eine containerArray der Länge 1 mit einem Element, das die assetHandle der PDF enthält.

Anfrage

<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>

Im obigen Beispiel sieht es umgekehrt wie folgt aus:

Anfrage

<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 einer Firma mit groupHandleArray hinzugefügt. In diesem Beispiel wird nur eine Gruppe verwendet.

Anfrage

<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.

recommendation-more-help

4e9b9d8c-5839-4215-aa35-01b652869681