DocumentaçãoAPI do sistema de produção de imagens Dynamic Media

searchAssets searchassets

Last update: Sat Jul 20 2024 00:00:00 GMT+0000 (Coordinated Universal Time)
  • Tópicos:

Criado para:

  • Desenvolvedor
  • Administrador

Pesquise por ativos com base nos critérios especificados.

Sintaxe

searchAssets: Sobre section-4ad74f12eb754768bf85bd235a7e25f0

searchAssets é o método principal de recuperação de ativos IPS. Esse método é usado para vários propósitos, como navegar na hierarquia de pastas ou encontrar 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 section-9c4bc41bb8b4493982197eb13c7cdc55

  • IpsUser
  • IpsAdmin
  • IpsCompanyAdmin
  • TrialSiteAdmin
  • TrialSiteUser
  • ImagePortalAdmin
  • TrialSiteUser
  • ImagePortalAdmin
  • ImagePortalUser
  • ImagePortalContrib
  • ImagePortalContribUser
NOTE
O usuário deve ter acesso de leitura para retornar ativos.

Parâmetros section-49aabc0600764f55a8b7017d86ded44f

Entrada (searchAssetsParam)

Nome
Tipo
Obrigatório?
Descrição
companyHandle
xsd:string
Sim
O identificador da empresa com os ativos que você 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 pesquisar por ativos. Se omitida, a pasta raiz da empresa será usada.
includeSubfolders
xsd:booleano
Não
Defina como true para pesquisar subpastas.
publishState
xsd:string
Não
Escolha de estado do Publish.
trashState
xsd:string
Não
Opção de estado da lixeira. O padrão é NotInTrash.
conditionMatchMode
xsd:string
Não

Escolha de 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 você não o use.

Uma matriz de sequência de caracteres de palavras-chave a serem correspondidas.

systemFieldMatchMode
xsd:string
Não

Opção de Modos de Correspondência de Pesquisa para combinar correspondências de 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, em seguida, combinados com quaisquer termos em keywordArray, systemFieldConditionArray e metadataConditionArray de acordo com a configuração conditionMatchMode.

metadataMatchMode
xsd:string
Não
Pesquisar Modos de Correspondência para combinar correspondências de metadataCondition. O padrão é MatchAll.
metadataConditionArray
tipos:MetadataConditionArray
Não
A matriz de condições de pesquisa de 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 a serem excluídos da pesquisa.
assetSubTypeArray
tipos:StringArray
Não
Uma lista de nomes de subtipo para filtrar.
strictSubTypeCheck
xsd:booleano
Não
Se true e assetSubTypeArray não estiver vazio, 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:booleano
Não
Se verdadeiro, os ativos de subprodutos gerados durante a assimilação de um ativo principal, como imagens de página de PDF copiadas, serão excluídos dos resultados da pesquisa. O padrão é falso.
excludByproductArray
tipos:ExcludeByproductArray
Não
Matriz de condições de geração de ativos de subprodutos a ser excluída dos resultados da pesquisa. Se presente, esse parâmetro substitui a configuração excludeByproducts.
projectHandle
xsd:string
Não
Identificador de 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 de página recordsPerPage.
sortBy
xsd:string
Não
Escolha dos campos de classificação de ativos.
sortDirection
xsd:string
Não
Escolha da direção da classificaçã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 a serem excluídos 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
Assets que a pesquisa retorna.

Exemplos section-725484cc09b54772a838ad2cc930b94b

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>
recommendation-more-help
4e9b9d8c-5839-4215-aa35-01b652869681