DocumentazioneAPI di Dynamic Media Image Production System

getAssociatedAssets getassociatedassets

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

Creato per:

  • Developer
  • Admin

Ottiene le risorse associate a una risorsa specificata e i dettagli sulla relativa relazione.

Sintassi

Tipi di utenti autorizzati section-453cc706400345778713cda249bfac16

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

Parametri section-d11d0dab59e94e89b466123a0ebfa82e

Input (getAssociatedAssetsParam)

Nome
Tipo
Obbligatorio
Descrizione
companyHandle
xsd:stringa
Sì
Gestisci per l'azienda proprietaria della risorsa.
assetHandle
xsd:stringa
Sì
Handle risorsa.
responseFieldArray
tipi:StringArray
No
L’array di campi di risposta desiderato. Vedi risposta- FieldArray/excludeFieldArray nell’Introduzione.
excludeFieldArray
tipi:StringArray
No
L’array dei campi di risposta esclusi. Vedi risposta- FieldArray/excludeFieldArray nell’Introduzione.

Output (getAssociatedAssetsReturn)

Nome
Tipo
Obbligatorio
Descrizione
containerArray
tipi:AssetArray
No
Array di risorse set e template contenenti la risorsa specificata.
memberArray
tipi:AssetArray
No
Array di risorse contenute nel set o nella risorsa modello specificato.
layerReferenceArray
tipi:AssetArray
No
Array di risorse a cui si fa riferimento in un livello o in un URL modello.
ownerArray
tipi:AssetArray
No
Array di risorse proprietarie della risorsa specificata.
derivatoArray
tipi:AssetArray
No
Array di risorse utilizzate per generare la risorsa specificata.
generatorArray
tipi:GenerationInfoArray
No
Il generatorArray elenca la modalità di creazione di questa risorsa. Ad esempio, se assetHandler era una pagina di immagine di un PDF, che conteneva lo strumento processore PDF e faceva riferimento alla risorsa PdfFile.
generatedArray
tipi:GenerationInfoArray
No
Il generatedArray inverte la modalità di creazione di questa risorsa. Ad esempio, il generatedArray potrebbe contenere l’elenco delle immagini generate da questo assetHandler se si trattava di una risorsa PdfFile.
thumbAsset
tipi:Risorsa
No
Informazioni sulla risorsa miniatura associate alla risorsa richiesta. Se non viene assegnata alcuna risorsa miniatura, il campo viene omesso nella risposta.

Puoi utilizzare i parametri responseFieldArray o excludeFieldArray per limitare la dimensione della risposta. In particolare, GenerationInfo elementi restituiti in generatorArray o generatedArray impostazione predefinita per includere sia il record originatore che il record risorsa generato. Per un tipo di risorsa PDF, questo comportamento genera più copie indesiderate del record di risorsa PDF "originator" nella risposta. Puoi eliminare questo problema aggiungendo generatedArray/items/originator a excludeFieldArray. In alternativa, puoi specificare un elenco esplicito di campi di risposta da includere in responseFieldArray.

Esempi section-8946ea4b9cb94912a8408249c897f192

L'esempio di base seguente è una richiesta per l'handle del generatore di un'immagine estratta da un PDF. Include un containerArray di lunghezza uno con un elemento che include assetHandle del PDF.

Request Contents (Richiesta contenuto)

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

Risposta

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

L’inverso dell’esempio precedente è il seguente:

Request Contents (Richiesta contenuto)

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

Risposta

<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 questo esempio successivo, viene aggiunto un gruppo a un’azienda con groupHandleArray. Questo esempio utilizza un solo gruppo.

Request Contents (Richiesta contenuto)

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

Risposta

Nessuno.

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