DokumentationDynamic Media Image Production System API

getAssociatedAssets getassociatedassets

Last update: Mon Jul 22 2024 00:00:00 GMT+0000 (Coordinated Universal Time)
  • Ämnen:

Skapat för:

  • Utvecklare
  • Administratör

Hämtar resurser som är associerade med en angiven resurs och information om deras relation.

Syntax

Auktoriserade användartyper section-453cc706400345778713cda249bfac16

  • IpsUser
  • IpsAdmin
  • IpsCompanyAdmin
  • TrialSiteAdmin
  • TrialSiteUser
  • ImagePortalAdmin
  • ImagePortalUser
  • ImagePortalContrib
  • ImagePortalContribUser

Parametrar section-d11d0dab59e94e89b466123a0ebfa82e

Indata (getAssociatedAssetsParam)

Namn
Typ
Obligatoriskt
Beskrivning
companyHandle
xsd:string
Ja
Hantera till företaget som äger tillgången.
assetHandle
xsd:string
Ja
Resurshandtag.
responseFieldArray
typer:StringArray
Nej
Arrayen med önskade svarsfält. Se response- FieldArray/excludeFieldArray i introduktionen.
excludeFieldArray
typer:StringArray
Nej
Arrayen med exkluderade svarsfält. Se response- FieldArray/excludeFieldArray i introduktionen.

Utdata (getAssociatedAssetsReturn)

Namn
Typ
Obligatoriskt
Beskrivning
containerArray
typer:AssetArray
Nej
Array med set- och mallresurser som innehåller den angivna resursen.
memberArray
typer:AssetArray
Nej
Array med resurser som finns i den angivna uppsättningen eller mallresursen.
layerReferenceArray
typer:AssetArray
Nej
Array med resurser som refereras i ett lager eller en mall-URL.
ownerArray
typer:AssetArray
Nej
Array med resurser som äger den angivna resursen.
derivedArray
typer:AssetArray
Nej
Array med resurser som användes för att generera den angivna resursen.
generatorArray
typer:GenerationInfoArray
Nej
generatorArray visar hur resursen skapades. Om assetHandler till exempel är en bildsida för PDF innehåller detta processorverktyget PDF och refererar till PDF-filresursen.
generatedArray
typer:GenerationInfoArray
Nej
generatedArray inverterar sättet som resursen skapades på. generatedArray kan till exempel innehålla en lista med bilder som genererats från denna assetHandler om det här var en PDFFile-resurs.
thumbAsset
typer:resurs
Nej
Information om tumresurs som är associerad med den begärda resursen. Om ingen tumresurs har tilldelats utelämnas fältet i svaret.

Du kan använda parametrarna responseFieldArray eller excludeFieldArray för att begränsa svarsstorleken. I synnerhet är de GenerationInfo objekt som returneras i generatorArray eller generatedArray standard att inkludera både den som är upphovsman och de genererade resursposterna. För en resurstyp i PDF resulterar det här beteendet i oönskade kopior av posten"original" i PDF i svaret. Du kan ta bort det här problemet genom att lägga till generatedArray/items/originator i excludeFieldArray. Du kan också ange en explicit lista med svarsfält som du vill inkludera i responseFieldArray.

Exempel section-8946ea4b9cb94912a8408249c897f192

Följande grundläggande exempel är en begäran om referensen för generatorn för en bild som extraheras från PDF. Den innehåller containerArray längd ett med ett objekt inklusive assetHandle för PDF.

Begäran

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

Svar

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

I exemplet ovan finns följande:

Begäran

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

Svar

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

I nästa exempel läggs en grupp till i ett företag med groupHandleArray. I det här exemplet används endast en grupp.

Begäran

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

Svar

Ingen.

recommendation-more-help
4e9b9d8c-5839-4215-aa35-01b652869681