Documentatie Dynamic Media Image Production System API

getAssociatedAssets getassociatedassets

Last update: Mon May 22 2023 00:00:00 GMT+0000 (Coordinated Universal Time)

Onderwerpen:

Gemaakt voor:

Ontwikkelaar
Beheerder

Hiermee worden elementen opgehaald die zijn gekoppeld aan een opgegeven element en worden details over de relatie ervan weergegeven.

Syntaxis

Geautoriseerde gebruikerstypen section-453cc706400345778713cda249bfac16

IpsUser
IpsAdmin
IpsCompanyAdmin
TrialSiteAdmin
TrialSiteUser
ImagePortalAdmin
ImagePortalUser
ImagePortalContrib
ImagePortalContribUser

Parameters section-d11d0dab59e94e89b466123a0ebfa82e

Input (getAssociatedAssetsParam)

Naam

Type

Vereist

Beschrijving

companyHandle

xsd:tekenreeks

Verwerking naar het bedrijf dat eigenaar is van het actief.

assetHandle

xsd:tekenreeks

Asset handle.

responseFieldArray

types:StringArray

Nee

De array met responsvelden die u wilt. Zie response- FieldArray/excludeFieldArray in de Inleiding.

excludeFieldArray

types:StringArray

Nee

De array van uitgesloten responsvelden. Zie response- FieldArray/excludeFieldArray in de Inleiding.

Output (getAssociatedAssetsReturn)

Naam

Type

Vereist

Beschrijving

containerArray

types:AssetArray

Nee

Array van set- en sjabloonelementen die het opgegeven element bevatten.

memberArray

types:AssetArray

Nee

Array met elementen die deel uitmaken van de opgegeven set of het sjabloonelement.

layerReferenceArray

types:AssetArray

Nee

Array met elementen waarnaar wordt verwezen in een laag of sjabloon-URL.

ownerArray

types:AssetArray

Nee

Array met elementen die eigenaar zijn van het opgegeven element.

derivedArray

types:AssetArray

Nee

Array met elementen die zijn gebruikt om het opgegeven element te genereren.

generatorArray

types:GenerationInfoArray

Nee

De generatorArray geeft aan hoe dit element is gemaakt. Als assetHandler was een afbeeldingspagina van een PDF, dan bevat dit het gereedschap PDF-processor en verwijst het naar het PDFFile-element.

generateArray

types:GenerationInfoArray

Nee

De generateArray Hiermee keert u de manier om waarop dit element is gemaakt. De generateArray kan de lijst met afbeeldingen bevatten die op basis van deze assetHandler als dit een PDFFile-element was.

thumbAsset

typen:element

Nee

De informatie over het blokelement dat aan het aanvraagelement is gekoppeld. Als er geen blokelement is toegewezen, wordt het veld weggelaten in het antwoord.

U kunt de parameters gebruiken responseFieldArray of excludeFieldArray om de responsgrootte te beperken. Met name de GenerationInfo objecten geretourneerd in generatorArray of generatedArray standaard worden zowel de initiator als de gegenereerde elementenrecords opgenomen. Voor een PDF-elementtype resulteert dit in ongewenste meervoudige kopieën van de "originator"-PDF-elementrecord in de reactie. U kunt dit probleem verhelpen door het toevoegen generatedArray/items/originator tot excludeFieldArray. U kunt ook een expliciete lijst opgeven met responsvelden die u wilt opnemen in responseFieldArray.

Voorbeelden section-8946ea4b9cb94912a8408249c897f192

Het volgende eenvoudige voorbeeld is een verzoek om de handgreep van de generator voor een afbeelding die uit een PDF is geëxtraheerd. Het omvat een containerArray van lengte één met een punt met inbegrip van assetHandle van de PDF.

Verzoek

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

Antwoord

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

Het omgekeerde van het bovenstaande voorbeeld is als volgt:

Verzoek

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

Antwoord

<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 dit volgende voorbeeld wordt een groep toegevoegd aan een bedrijf met groupHandleArray. In dit voorbeeld wordt slechts één groep gebruikt.

Verzoek

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

Antwoord

Geen.

recommendation-more-help

4e9b9d8c-5839-4215-aa35-01b652869681