searchAssets

Pesquise ativos com base nos critérios especificados.

Sintaxe

searchAssets: Sobre

searchAssets é o principal método de recuperação de ativos IPS. Esse método é usado para vários propósitos, como navegar na hierarquia de pastas ou localizar um ativo específico por nome.

Tamanho da resposta

searchAssets retorna até 1000 ativos em uma única chamada. Para retornar até 10.000 ativos por chamada, limite os dados de resposta a um subconjunto dos campos totalRows, name, handle, type e subType. Para retornar conjuntos maiores, configure a paginação com o parâmetro resultPage.

Limitar tamanho do arquivo de resultado com responseFieldArray ou excludeFieldArray

Limite o tamanho do seu conjunto de dados com os parâmetros responseFieldArray ou excludFieldArray. Esses parâmetros ajudam a reduzir o uso de memória e a largura de banda e podem melhorar os tempos de resposta do servidor.

Tipos de usuário autorizados

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

O usuário deve ter acesso de leitura para retornar ativos.

Parâmetros

Entrada (searchAssetsParam)

Nome Tipo Obrigatório? Descrição
companyHandle xsd:string Sim O controle da empresa com os ativos que deseja pesquisar.
accessUserHandle xsd:string Não Permite que os administradores trabalhem como um usuário diferente.
accessGroupHandle xsd:string Não Permite que os administradores trabalhem como parte de um grupo diferente.
pasta xsd:string Não O caminho raiz para procurar ativos. Se omitida, a pasta raiz da empresa será usada.
includeSubfolders xsd:boolean Não Defina como true para pesquisar subpastas.
publishState xsd:string Não Publicar opção de estado.
trashState xsd:string Não Escolha do estado da lixeira. O padrão é NotInTrash.
conditionMatchMode xsd:string Não

Escolha dos modos de correspondência de pesquisa para combinar resultados de keywordArray,

conditionMatchMode

systemFieldConditionArray e metadataConditionArray. O padrão é MatchAll.

keywordArray tipos:StringArray Não

Observação: Parâmetro obsoleto. Recomenda-se que não o utilize.

Uma matriz de sequências de palavras-chave para corresponder.

systemFieldMatchMode xsd:string Não

Escolha dos Modos de Correspondência de Pesquisa para combinar as correspondências systemFieldCondition. O padrão é MatchAll

.

systemFieldConditionArray

tipos:SystemFieldConditionArray

Não A matriz de condições de campo do sistema.
tagMatchMode xsd:string Não Constantes de string dos Modos de Correspondência de Pesquisa. O padrão é MatchAll.
tagConditionArray tipos:TagConditionArray Não

Uma matriz de predicados de pesquisa de campo de tag.

Os predicados são combinados de acordo com a configuração tagMatchMode e depois combinados com qualquer termo em keywordArray, systemFieldConditionArray e metadataConditionArray de acordo com conditionMatch Configuração de modo.

metadataMatchMode xsd:string Não Modos de correspondência de pesquisa para combinar metadataCondition correspondências. O padrão é MatchAll.
metadataConditionArray

tipos:MetadataConditionArray

Não A matriz de condições de pesquisa do campo de metadados.
assetTypeArray tipos:StringArray Não Matriz de tipos de ativos para incluir na pesquisa.
excludeAssetTypeArray tipos:StringArray Não Matriz de tipos de ativos para excluir da pesquisa.
assetSubTypeArray tipos:StringArray Não Uma lista de nomes de subtipo para filtrar.
hardSubTypeCheck xsd:boolean Não Se true e assetSubTypeArray não estiverem vazias, somente os ativos cujos subtipos estão em assetSubTypeArray serão retornados. Se false (padrão), os ativos sem subtipo definido serão retornados.
excludeByproducts xsd:boolean Não Se for verdadeiro, os ativos de subproduto gerados durante a assimilação de um ativo principal, como imagens de página em PDF rasgadas, serão excluídos dos resultados da pesquisa. O padrão é false.
excludByproductArray

tipos:ExcludeByproductArray

Não Matriz de condições de geração de ativos de subproduto para excluir dos resultados de pesquisa. Se estiver presente, esse parâmetro substituirá a configuração excludeByproducts .
projectHandle xsd:string Não Gerenciar um projeto que contém os ativos a serem pesquisados.
recordsPerPage xsd:int Não Número máximo de resultados a serem retornados.
resultsPage xsd:int Não Especifica a página de resultados a ser retornada, com base no tamanho da página recordsPerPage.
sortBy xsd:string Não Escolha dos campos de classificação de ativos.
sortDirection xsd:string Não Escolha de uma espécie de direção.
responseFieldArray tipos:StringArray Não Contém uma lista de campos e subcampos para inclusão na resposta.
excludeFieldArray tipos:StringArray Não Contém uma lista de campos e subcampos para exclusão da resposta.

Saída (searchAssetsReturn)

Nome Tipo Obrigatório Descrição
*totalRows* xsd:int Não Número de linhas que uma pesquisa retorna quando os registros por página não são limitados.
*assetArray* types:AssetArray Não Ativos que a pesquisa retorna.

Exemplos

Este exemplo de código pesquisa ativos de imagem que pertencem a uma empresa específica. A resposta é truncada por brevidade.

Solicitação

<ns1:searchAssetsParam xmlns:ns1="http://www.scene7.com/IpsApi/xsd">
   <ns1:companyHandle>47</ns1:companyHandle>
   <ns1:includeSubfolders>true</ns1:includeSubfolders>
   <ns1:assetTypeArray>
      <ns1:items>Image</ns1:items>
   </ns1:assetTypeArray>
</ns1:searchAssetsParam>

Resposta

<searchAssetsReturn xmlns="http://www.scene7.com/IpsApi/xsd">
   <totalRows>210</totalRows>
   <assetArray>
      <items>
         <assetHandle>24265|1|17061</assetHandle>
         <type>Image</type>
         <name>Autumn Leaves</name>
         ...
      </items>
    </assetArray>
</searchAssetsReturn>

Nesta página