Dokumentation Dynamic Media Image Production System-API

getAssociatedAssets getassociatedassets

Last update: Sat Jul 20 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

Themen:

Erstellt für:

Entwickler
Admin

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

Syntax

Autorisierte Benutzertypen section-453cc706400345778713cda249bfac16

IpsUser
IpsAdmin
IpsCompanyAdmin
TrialSiteAdmin
TrialSiteUser
ImagePortalAdmin
ImagePortalUser
ImagePortalContrib
ImagePortalContribUser

Parameter section-d11d0dab59e94e89b466123a0ebfa82e

Input (getAssociatedAssetsParam)

Name

Typ

Erforderlich

Beschreibung

companyHandle

xsd:string

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

assetHandle

xsd:string

Asset-Handle.

responseFieldArray

types:StringArray

Nein

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

excludeFieldArray

types:StringArray

Nein

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

Output (getAssociatedAssetsReturn)

Name

Typ

Erforderlich

Beschreibung

containerArray

types:AssetArray

Nein

Array von Set- und Vorlagen-Assets, die das angegebene Asset enthalten.

memberArray

types:AssetArray

Nein

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

layerReferenceArray

types:AssetArray

Nein

Array von Assets, die in einer Ebene oder Vorlagen-URL referenziert werden.

ownerArray

types:AssetArray

Nein

Array von Assets, die Eigentümer des angegebenen Assets sind.

derivedArray

types:AssetArray

Nein

Array von Assets, mit denen das angegebene Asset generiert wurde.

generatorArray

types:GenerationInfoArray

Nein

Das generatorArray listet auf, wie dieses Asset erstellt wurde. Wenn beispielsweise assetHandler eine Bildseite einer PDF war, würde dies das PDF-Prozessor-Tool enthalten und auf das PdfFile-Asset verweisen.

generatedArray

types:GenerationInfoArray

Nein

Das generatedArray kehrt die Art und Weise um, wie dieses Asset erstellt wurde. Beispielsweise könnte der generatedArray die Liste der Bilder enthalten, die aus diesem assetHandler generiert wurden, wenn es ein PdfFile-Asset war.

thumbAsset

types: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 in generatorArray oder generatedArray zurückgegebenen GenerationInfo-Elemente 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.

Beispiele section-8946ea4b9cb94912a8408249c897f192

Im folgenden Beispiel wird der Handle des Generators für ein Bild angefordert, das aus einer PDF extrahiert wird. Er enthält eine containerArray 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>

Das Gegenteil des obigen Beispiels ist:

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