searchAssets

Busque recursos en función de los criterios especificados.

Sintaxis

searchAssets: Acerca de

searchAssets es el método principal para recuperar recursos IPS. Este método se utiliza para varios fines, como explorar la jerarquía de carpetas o encontrar un recurso específico por su nombre.

Tamaño de respuesta

searchAssets devuelve hasta 1000 activos en una sola llamada. Para devolver hasta 10 000 activos por llamada, limite los datos de respuesta a un subconjunto de los campos totalRows, name, handle, type y subType. Para devolver conjuntos más grandes, configure la paginación con el parámetro resultPage.

Limitar tamaño de archivo de resultado con responseFieldArray o excludeFieldArray

Limite el tamaño del conjunto de datos con los parámetros responseFieldArray o excludFieldArray . Estos parámetros ayudan a reducir el uso de memoria y el ancho de banda y pueden mejorar los tiempos de respuesta del servidor.

Tipos de usuarios autorizados

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

El usuario debe tener acceso de lectura para devolver recursos.

Parámetros

Entrada (searchAssetsParam)

Nombre Tipo Obligatorio? Descripción
companyHandle xsd:string El identificador de la empresa con los recursos que desea buscar.
accessUserHandle xsd:string No Permite que los administradores trabajen como usuarios diferentes.
accessGroupHandle xsd:string No Permite que los administradores trabajen como parte de un grupo diferente.
carpeta xsd:string No Ruta raíz para buscar recursos. Si se omite, se utiliza la carpeta raíz de la empresa.
includeSubfolders xsd:boolean No Configúrelo en true para buscar subcarpetas.
publishState xsd:string No Opción de estado de publicación.
trashState xsd:string No Selección del estado de la papelera. El valor predeterminado es NotInTrash.
conditionMatchMode xsd:string No

Elección de modos de coincidencia de búsqueda para combinar los resultados de keywordArray,

conditionMatchMode

systemFieldConditionArray y metadataConditionArray. El valor predeterminado es MatchAll.

keywordArray tipos:StringArray No

Nota: Parámetro obsoleto. Se recomienda que no lo use.

Una matriz de cadenas de palabras clave que se deben coincidir.

systemFieldMatchMode xsd:string No

Elección de modos de coincidencia de búsqueda para combinar las coincidencias de systemFieldCondition. El valor predeterminado es MatchAll

.

systemFieldConditionArray

tipos:SystemFieldConditionArray

No Matriz de condiciones de campo del sistema.
tagMatchMode xsd:string No Constantes de cadena de los modos de coincidencia de búsqueda. El valor predeterminado es MatchAll.
tagConditionArray tipos:TagConditionArray No

Una matriz de predicados de búsqueda de campos de etiqueta.

Los predicados se combinan según la configuración tagMatchMode y luego se combinan con cualquier término de keywordArray, systemFieldConditionArray y metadataConditionArray según la configuración conditionMatchMode.

metadataMatchMode xsd:string No Buscar modos de coincidencia para combinar las coincidencias metadataCondition. El valor predeterminado es MatchAll.
metadataConditionArray

tipos:MetadataConditionArray

No Matriz de condiciones de búsqueda de campos de metadatos.
assetTypeArray tipos:StringArray No Matriz de tipos de recursos que se incluyen en la búsqueda.
excludeAssetTypeArray tipos:StringArray No Matriz de tipos de recursos que se excluirán de la búsqueda.
assetSubTypeArray tipos:StringArray No Una lista de nombres de subtipos con los que filtrar.
strictoSubTypeCheck xsd:boolean No Si true y assetSubTypeArray no están vacíos, solo se devuelven los activos cuyos subtipos se encuentran en assetSubTypeArray. Si es false (valor predeterminado), se devuelven los recursos sin ningún subtipo definido.
excludeByproducts xsd:boolean No Si el valor es true, los recursos de subproducto generados durante la ingesta de un recurso principal, como las imágenes de página PDF dañadas, se excluyen de los resultados de búsqueda. El valor predeterminado es false.
excludByproductArray

tipos:ExcludeByproductArray

No Matriz de condiciones de generación de recursos de subproducto para excluir de los resultados de búsqueda. Si está presente, este parámetro anula la configuración excludeByproducts .
projectHandle xsd:sting No Gestión de un proyecto que contiene los recursos que se van a buscar.
recordsPerPage xsd:int No Número máximo de resultados que se van a devolver.
resultsPage xsd:int No Especifica la página de resultados que se van a devolver, en función del tamaño de página recordsPerPage.
sortBy xsd:string No Selección de los campos de ordenación de recursos.
sortDirection xsd:string No Elección de la dirección.
responseFieldArray tipos:StringArray No Contiene una lista de campos y subcampos para su inclusión en la respuesta.
excludeFieldArray tipos:StringArray No Contiene una lista de campos y subcampos para su exclusión de la respuesta.

Salida (searchAssetsReturn)

Nombre Tipo Obligatorio Descripción
*totalRows* xsd:int No Número de filas que devuelve una búsqueda cuando los registros por página no están limitados.
*assetArray* types:AssetArray No Recursos que devuelve la búsqueda.

Ejemplos

Este ejemplo de código busca recursos de imagen que pertenecen a una empresa específica. La respuesta se trunca para su brevedad.

Solicitar

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

Respuesta

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

En esta página