DocumentationAPI Système de production dʼimages Dynamic Media

getAssociatedAssets getassociatedassets

Last update: Wed Jul 21 2021 00:00:00 GMT+0000 (Coordinated Universal Time)

Créé pour :

  • Developer
  • Admin

Obtient les ressources associées à une ressource spécifiée et des détails sur leur relation.

Syntaxe

Types d’utilisateurs autorisés section-453cc706400345778713cda249bfac16

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

Paramètres section-d11d0dab59e94e89b466123a0ebfa82e

Entrée (getAssociatedAssetsParam)

Nom
Type
Obligatoire
Description
companyHandle
xsd:string
Oui
Gérer l’entreprise propriétaire de l’actif.
assetHandle
xsd:string
Oui
Poignée de ressource.
responseFieldArray
types:StringArray
Non
Tableau des champs de réponse souhaités. Voir response-FieldArray/excludeFieldArray dans l’introduction.
excludeFieldArray
types:StringArray
Non
Tableau des champs de réponse exclus. Voir response-FieldArray/excludeFieldArray dans l’introduction.

Sortie (getAssociatedAssetsReturn)

Nom
Type
Obligatoire
Description
containerArray
types:AssetArray
Non
Tableau des ressources définies et de modèles contenant la ressource de champ spécifique.
memberArray
types:AssetArray
Non
Tableau des ressources contenues par le jeu ou le modèle de ressource spécifié.
layerReferenceArray
types:AssetArray
Non
Tableau des ressources référencées dans une URL de calque ou de modèle.
ownerArray
types:AssetArray
Non
Tableau des ressources qui possèdent la ressource spécifiée.
extractArray
types:AssetArray
Non
Tableau des ressources utilisées pour générer la ressource spécifiée.
generatorArray
types:GenerationInfoArray
Non
generatorArray répertorie la manière dont cette ressource a été créée. Par exemple, si assetHandler était une page d’image d’un PDF, il contiendrait l’outil de processeur PDF et référencerait la ressource PdfFile.
generateArray
types:GenerationInfoArray
Non
generatedArray inverse la manière dont cette ressource a été créée. Par exemple, le generatedArray peut contenir la liste des images générées à partir de ce assetHandler s’il s’agissait d’une ressource PdfFile.
thumbAsset
types:Asset
Non
Informations de la ressource de miniature associée à la ressource de requête. Si aucune ressource de miniature n’est affectée, le champ est omis dans la réponse.

Vous pouvez utiliser les paramètres responseFieldArray ou excludeFieldArray pour limiter la taille de la réponse. En particulier, les éléments GenerationInfo renvoyés dans generatorArray ou generatedArray par défaut pour inclure à la fois l’expéditeur et les enregistrements de ressource générés. Pour un type de ressource PDF, ce comportement entraîne plusieurs copies indésirables de l’enregistrement de ressource PDF "originator" dans la réponse. Vous pouvez éliminer ce problème en ajoutant generatedArray/items/originator à excludeFieldArray. Vous pouvez également spécifier une liste explicite de champs de réponse à inclure dans responseFieldArray.

Exemples section-8946ea4b9cb94912a8408249c897f192

L’exemple de base suivant est une requête pour la gestion du générateur pour une image extraite d’un PDF. Il comprend une balise containerArray de longueur 1 avec un élément comprenant la balise assetHandle du PDF.

Request

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

Réponse

<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’inverse de l’exemple ci-dessus est le suivant :

Requête

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

Réponse

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

Dans cet exemple suivant, un groupe est ajouté à une société avec groupHandleArray. Cet exemple n’utilise qu’un seul groupe.

Requête

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

Réponse

Aucune

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