getAssociatedAssets

Última actualización: 2023-05-23
  • Creado para:
  • Developer
    Admin

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

Sintaxis

Tipos de usuarios autorizados

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

Parámetros

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.

derivatedArray tipos:AssetArray

No

Matriz de recursos que se utilizaron para generar el recurso especificado.

generatorArray tipos:GenerationInfoArray

No

El generatorArray enumera la forma en que se creó este recurso. Por ejemplo, si assetHandler era una página de imagen de un PDF, que contenía la herramienta de procesador de PDF y hacía referencia al recurso PdfFile.

generateArray tipos:GenerationInfoArray

No

El generateArray invierte la forma en que se creó este recurso. Por ejemplo, la variable generateArray podría contener la lista de imágenes generadas a partir de esta 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 utilizar los parámetros responseFieldArray o excludeFieldArray para limitar el tamaño de la respuesta. En particular, la GenerationInfo elementos devueltos en generatorArray o generatedArray de forma predeterminada, se incluyen 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 añadiendo generatedArray/items/originator hasta excludeFieldArray. O bien, puede especificar una lista explícita de los campos de respuesta que desea incluir en responseFieldArray.

Ejemplos

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

Solicitar

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

Solicitar

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

Solicitar

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

Página anterior
Next page

En esta página