getAssociatedAssets getassociatedassets

Obtém ativos associados a um ativo especificado e detalhes sobre sua relação.

Sintaxe

Tipos de usuário autorizados section-453cc706400345778713cda249bfac16

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

Parâmetros section-d11d0dab59e94e89b466123a0ebfa82e

Entrada (getAssociatedAssetsParam)

Nome
Tipo
Obrigatório
Descrição
companyHandle
xsd:string
Sim
Processe a empresa proprietária do ativo.
assetHandle
xsd:string
Sim
Identificador de ativo.
responseFieldArray
tipos:MatrizDeCadeiaDeCaracteres
Não
A matriz de campos de resposta desejada. Consulte response- FieldArray/excludeFieldArray na Introdução.
excludeFieldArray
tipos:MatrizDeCadeiaDeCaracteres
Não
A matriz de campos de resposta excluídos. Consulte response- FieldArray/excludeFieldArray na Introdução.

Saída (getAssociatedAssetsReturn)

Nome
Tipo
Obrigatório
Descrição
containerArray
tipos:AssetArray
Não
Matriz de ativos de conjunto e modelo contendo o ativo especificado.
memberArray
tipos:AssetArray
Não
Matriz de ativos contidos pelo conjunto ou ativo de modelo especificado.
layerReferenceArray
tipos:AssetArray
Não
Matriz de ativos referenciados em uma camada ou URL de modelo.
ownerArray
tipos:AssetArray
Não
Matriz de ativos que possuem o ativo especificado.
arrayDerivada
tipos:AssetArray
Não
Matriz de ativos que foram usados para gerar o ativo especificado.
generatorArray
tipos:GenerationInfoArray
Não
A variável generatorArray lista a forma como esse ativo foi criado. Por exemplo, se assetHandler era uma página de imagem de um PDF, então ela conteria a ferramenta PDF e referenciaria o ativo PdfFile.
generatedArray
tipos:GenerationInfoArray
Não
A variável generatedArray inverte a forma como esse ativo foi criado. Por exemplo, a variável generatedArray pode conter a lista de imagens geradas a partir deste assetHandler se era um ativo PdfFile.
thumbAsset
tipos:Ativo
Não
As informações do ativo de miniatura associadas ao ativo de solicitação. Se nenhum ativo de miniatura for atribuído, o campo será omitido na resposta.

Você pode usar os parâmetros responseFieldArray ou excludeFieldArray para limitar o tamanho da resposta. Em especial, a GenerationInfo itens retornados em generatorArray ou generatedArray padrão para incluir tanto o originador quanto os registros de ativo gerados. Para um tipo de ativo PDF, esse comportamento resulta em várias cópias indesejadas do registro de ativo PDF "originador" na resposta. Você pode eliminar esse problema adicionando generatedArray/items/originator para excludeFieldArray. Ou você pode especificar uma lista explícita de campos de resposta que deseja incluir no responseFieldArray.

Exemplos section-8946ea4b9cb94912a8408249c897f192

O exemplo básico a seguir é uma solicitação para o identificador do gerador de uma imagem que é extraída de um PDF. Inclui uma containerArray de comprimento um com um item incluindo o assetHandle do PDF.

Solicitação

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

Resposta

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

O inverso do exemplo acima é o seguinte:

Solicitação

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

Resposta

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

Neste próximo exemplo, um grupo é adicionado a uma empresa com groupHandleArray. Este exemplo usa apenas um grupo.

Solicitação

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

Resposta

Nenhum.

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