DocumentationAPI du système d’exploitation d’images Dynamic Media

getAssociatedAssets getassociatedassets

Last update: Fri Aug 15 2025 00:00:00 GMT+0000 (Coordinated Universal Time)
  • Rubriques :

Créé pour :

  • Développeur
  • Administration

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

Syntaxe

Types d’utilisateurs autorisés section-453cc706400345778713cda249bfac16

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

Paramètres section-d11d0dab59e94e89b466123a0ebfa82e

Input (getAssociatedAssetsParam)

Nom
Type
Obligatoire
Description
companyHandle
xsd:string
Oui
Gérer vers la société propriétaire de la ressource.
assetHandle
xsd:string
Oui
Identifiant 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 de champs de réponse exclus. Voir response- FieldArray/excludeFieldArray dans l’introduction.

Output (getAssociatedAssetsReturn)

Nom
Type
Obligatoire
Description
containerArray
types :AssetArray
Non
Tableau de ressources d’ensemble et de modèle contenant la ressource spécifiée.
memberArray
types :AssetArray
Non
Tableau des ressources contenues dans l’ensemble ou la ressource de modèle spécifié.
layerReferenceArray
types :AssetArray
Non
Tableau de ressources référencées dans une URL de calque ou de modèle.
ownerArray
types :AssetArray
Non
Tableau des ressources propriétaires de la ressource spécifiée.
derivedArray
types :AssetArray
Non
Tableau des ressources utilisées pour générer la ressource spécifiée.
generatorArray
de sous-réseau:GenerationInfoArray
Non
Le tableau generatorArray répertorie la manière dont cette ressource a été créée. Par exemple, si assetHandler est une page d’image d’un PDF, il contient l’outil de processeur PDF et référence la ressource PdfFile.
generateArray
de sous-réseau:GenerationInfoArray
Non
Le tableau generateArray inverse la manière dont cette ressource a été créée. Par exemple, le generateArray peut contenir la liste des images générées à partir de ce assetHandler s’il s’agit d’une ressource PdfFile.
thumbAsset
de sous-réseau :Asset
Non
Informations sur la ressource de pouce associées à la ressource de requête. Si aucune ressource de pouce 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 de GenerationInfo renvoyés dans generatorArray ou generatedArray par défaut pour inclure à la fois les enregistrements de l’expéditeur et les enregistrements de ressources générés. Pour un type de ressource PDF, ce comportement génère des copies multiples indésirables de l’enregistrement de ressource PDF « d’origine » 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 que vous souhaitez inclure dans responseFieldArray.

Exemples section-8946ea4b9cb94912a8408249c897f192

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

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|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 des groupHandleArray. Cet exemple utilise 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