getAssociatedAssets

Obtiene 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í	Gestionar en la empresa propietaria del recurso.
assetHandle	xsd:string	Sí	Identificador de recurso.
responseFieldArray	tipos:StringArray	No	Matriz de campos de respuesta deseados. Consulte response- FieldArray/excludeFieldArray en la Introducción.
excludeFieldArray	tipos:StringArray	No	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 conjuntos y recursos de plantilla que contiene el recurso que se va a poner en práctica.
memberArray	tipos:AssetArray	No	Matriz de recursos contenida en el conjunto o recurso de plantilla especificado.
layerReferenceArray	tipos:AssetArray	No	Matriz de recursos a los que se hace referencia en una capa o en una URL de plantilla.
ownerArray	tipos:AssetArray	No	Matriz de recursos que son propietarios del recurso especificado.
derivadaArray	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, contendría la herramienta de procesador PDF y haría referencia al recurso PdfFile.
generatedArray	tipos:GenerationInfoArray	No	El 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 de recurso de la miniatura asociada al 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 respuesta. En concreto, los GenerationInfo elementos devueltos en generatorArray o generatedArray tienen el valor predeterminado de incluir tanto el iniciador como los registros de recursos generados. Para un tipo de recurso PDF, este comportamiento da como resultado varias copias no deseadas del registro de recursos PDF "originador" en la respuesta. Puede eliminar este problema añadiendo generatedArray/items/originator a excludeFieldArray. O bien, puede especificar una lista explícita de 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 este ejemplo siguiente, se agrega un grupo a una empresa con groupHandleArray. Este ejemplo utiliza un solo 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.