getAssociatedAssets

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

Sintassi

Tipi di utenti autorizzati

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

Parametri

Input (getAssociatedAssetsParam)

Nome

Tipo

Obbligatorio

Descrizione

companyHandle

xsd:string

Gestisci l’azienda proprietaria della risorsa.

assetHandle

xsd:string

Gestione risorse.

responseFieldArray

tipi:StringArray

No

Matrice di campi di risposta desiderata. Vedi response- FieldArray/excludeFieldArray nell'introduzione.

excludeFieldArray

tipi:StringArray

No

Matrice dei campi di risposta esclusi. Vedi response- FieldArray/excludeFieldArray nell'introduzione.

Output (getAssociatedAssetsReturn)

Nome

Tipo

Obbligatorio

Descrizione

containerArray tipi:AssetArray

No

Array di risorse set e template contenenti la risorsa specifica.

MemberArray tipi:AssetArray

No

Array di risorse contenute nel set o nella risorsa modello specificato.

layerReferenceArray tipi:AssetArray

No

Array di risorse a cui viene fatto riferimento in un URL di livello o di 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 il modo in cui è stata creata la risorsa. Ad esempio, se assetHandler è una pagina di immagine di un PDF, questo conterrà lo strumento di elaborazione PDF e farà riferimento alla risorsa PdfFile.

generateArray tipi:GenerationInfoArray

No

La generateArray inverte il modo in cui è stata creata la risorsa. Ad esempio, il generateArray potrebbe contenere l’elenco di immagini generate da questo assetHandler se si tratta di una risorsa PdfFile.

thumbAsset tipi:Risorsa

No

Informazioni sulla risorsa principale associata 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, gli elementi GenerationInfo restituiti in generatorArray o generatedArray sono predefiniti per includere sia i record di origine che quelli di risorsa generati. Per un tipo di risorsa PDF, questo comportamento genera indesiderate copie multiple del record di risorse 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

L’esempio di base seguente è una richiesta per l’handle del generatore per un’immagine estratta da un PDF. Include un elemento containerArray di lunghezza uno con 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 una società con groupHandleArray. In questo esempio viene utilizzato 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.

In questa pagina