getAssetsByName

Última atualização em 2023-05-20
  • Criado para:
  • Developer
    Admin

Retorna ativos com base em uma matriz de nomes de ativos.

Sintaxe

Tipos de usuário autorizados

  • IpsUser
  • IpsAdmin
  • IpsCompanyAdmin
  • TrialSiteAdmin
  • TrialSiteUser
  • ImagePortalAdmin
  • ImagePortalContrib
  • ImagePortalContribUser
OBSERVAÇÃO

Retorna somente ativos aos quais o usuário tem acesso de leitura.

Parâmetros

Entrada (getAssetsByNameParam)

Nome Tipo Obrigatório Descrição
companyHandle xsd:string Sim O identificador da empresa.
accessUserHandle xsd:string Não Fornece acesso como outro usuário. Disponível somente para administradores do.
accessGroupHandle xsd:string Não Usado para filtrar por um grupo específico.
nameArray tipos:MatrizDeCadeiaDeCaracteres Sim Matriz de nomes de ativos a serem recuperados.
assetTypeArray tipos:MatrizDeCadeiaDeCaracteres Não Matriz de tipos de ativos permitidos para ativos recuperados.
excludeAssetTypeArray tipos:MatrizDeCadeiaDeCaracteres Não Matriz de Tipos de ativos excluídos para ativos recuperados.
assetSubTypeArray tipos:MatrizDeCadeiaDeCaracteres Não Matriz de subtipos de ativos permitidos para ativos recuperados.
strictSubTypeCheck xsd:booleano Não

Se true e assetSubTypeArray não estiver vazio, somente os ativos cujos subtipos estiverem em assetSubTypeArray são retornados.

Se false, os ativos sem subtipo definido serão incluídos.

O valor padrão é false.

responseFieldArray tipos:MatrizDeCadeiaDeCaracteres Não Contém uma lista de campos e subcampos incluídos na resposta.
excludeFieldArray tipos:MatrizDeCadeiaDeCaracteres Não Contém uma lista de campos e subcampos excluídos da resposta.

Saída (getAssetsByNameReturn)

Nome Tipo Obrigatório Descrição
assetArray types:AssetArray Não Matriz de ativos que correspondem aos critérios do filtro.

Exemplos

Essa amostra de código retorna dois ativos do tipo imagem.

Solicitação

<getAssetsByNameParam xmlns="http://www.scene7.com/IpsApi/xsd/2010-01-31">
   <companyHandle>c|3</companyHandle>
   <nameArray>
      <items>B010</items>
      <items>IMG_0103</items>
   </nameArray>
   <assetTypeArray>
      <items>Image</items>
   </assetTypeArray>
</getAssetsByNameParam>

Resposta

<getAssetsByNameReturn xmlns="http://www.scene7.com/IpsApi/xsd/2010-01-31">
   <assetArray>
      <items>
         <assetHandle>a|210</assetHandle>
         <type>Image</type>
         <name>B010</name>
         ...</items>
      <items>
         <assetHandle>a|189</assetHandle>
         <type>Image</type>
         <name>IMG_0103</name>
         ...
      </items>
   </assetArray>
</getAssetsByNameReturn>

Nesta página