DocumentaciónAPI del sistema de producción de imágenes Dynamic Media

getAssociatedAssets getassociatedassets

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

Creado para:

  • Desarrollador
  • Administrador

Obtiene los recursos asociados a un recurso especificado y detalles sobre su relación.

Sintaxis

Tipos de usuarios autorizados section-453cc706400345778713cda249bfac16

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

Parámetros section-d11d0dab59e94e89b466123a0ebfa82e

Entrada (getAssociatedAssetsParam)

Nombre
Tipo
Obligatorio
Descripción
companyHandle
xsd:string
Sí
Gestión a la compañía propietaria del recurso.
assetHandle
xsd:string
Sí
Controlador de recurso.
responseFieldArray
tipos:StringArray
No
La matriz de campos de respuesta que desee. Consulte response- FieldArray/excludeFieldArray en la Introducción.
excludeFieldArray
tipos:StringArray
No
La matriz de campos de respuesta excluidos. Consulte response- FieldArray/excludeFieldArray en la Introducción.

Salida (getAssociatedAssetsReturn)

Nombre
Tipo
Obligatorio
Descripción
containerArray
tipos:AssetArray
No
Matriz de recursos de conjunto y plantilla que contiene el recurso específico.
memberArray
tipos:AssetArray
No
Matriz de recursos que contiene el conjunto o recurso de plantilla especificado.
layerReferenceArray
tipos:AssetArray
No
Matriz de recursos a los que se hace referencia en una URL de capa o plantilla.
ownerArray
tipos:AssetArray
No
Matriz de recursos que poseen el recurso especificado.
derivaciónArray
tipos:AssetArray
No
Matriz de recursos que se utilizaron para generar el recurso especificado.
generatorArray
tipos:GenerationInfoArray
No
La matriz generatorArray de enumera la forma en que se creó este recurso. Por ejemplo, si assetHandler era una página de imagen de un PDF, entonces contendría la herramienta de procesador de PDF y haría referencia al recurso PdfFile.
generatedArray
tipos:GenerationInfoArray
No
generatedArray invierte la forma en que se creó este recurso. Por ejemplo, generatedArray podría contener la lista de imágenes generadas a partir de este assetHandler si se trata de un recurso PdfFile.
thumbAsset
tipos:Recurso
No
La información del recurso de miniatura asociado con el recurso de solicitud. Si no se asigna ningún recurso de miniatura, el campo se omite en la respuesta.

Puede usar los parámetros responseFieldArray o excludeFieldArray para limitar el tamaño de la respuesta. En particular, los GenerationInfo elementos devueltos en generatorArray o generatedArray tienen de forma predeterminada la inclusión de los registros de recursos generados y del creador. Para un tipo de recurso de PDF, este comportamiento da como resultado varias copias no deseadas del registro de recurso de PDF "originador" en la respuesta. Puede eliminar este problema agregando generatedArray/items/originator a excludeFieldArray. O bien, puede especificar una lista explícita de los campos de respuesta que desea incluir en responseFieldArray.

Ejemplos section-8946ea4b9cb94912a8408249c897f192

El siguiente ejemplo básico es una solicitud del identificador del generador de una imagen extraída de un PDF. Incluye un(a) containerArray de longitud uno con un elemento que incluye el(la) assetHandle del PDF.

Solicitud

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

Respuesta

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

Lo contrario del ejemplo anterior es lo siguiente:

Solicitud

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

Respuesta

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

En el siguiente ejemplo, se agrega un grupo a una compañía con groupHandleArray. Este ejemplo utiliza solo un grupo.

Solicitud

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

Respuesta

Ninguno.

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