DocumentaciónAPI del sistema de producción de imágenes Dynamic Media

searchAssets searchassets

Last update: Mon Jul 22 2024 00:00:00 GMT+0000 (Coordinated Universal Time)
  • Temas:

Creado para:

  • Desarrollador
  • Administrador

Busque recursos en función de los criterios especificados.

Sintaxis

searchAssets: Acerca de section-4ad74f12eb754768bf85bd235a7e25f0

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

Tamaño de respuesta

searchAssets devuelve hasta 1000 recursos en una sola llamada. Para devolver hasta 10 000 recursos 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 del archivo de resultados 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 section-9c4bc41bb8b4493982197eb13c7cdc55

  • IpsUser
  • IpsAdmin
  • IpsCompanyAdmin
  • TrialSiteAdmin
  • TrialSiteUser
  • ImagePortalAdmin
  • TrialSiteUser
  • ImagePortalAdmin
  • ImagePortalUser
  • ImagePortalContrib
  • ImagePortalContribUser
NOTE
El usuario debe tener acceso de lectura para devolver los recursos.

Parámetros section-49aabc0600764f55a8b7017d86ded44f

Entrada (searchAssetsParam)

Nombre
Tipo
¿Requerido?
Descripción
companyHandle
xsd:string
Sí
El identificador de la compañía con los recursos que desea buscar.
accessUserHandle
xsd:string
No
Permite que los administradores trabajen como un usuario diferente.
accessGroupHandle
xsd:string
No
Permite que los administradores trabajen como parte de un grupo diferente.
carpeta
xsd:string
No
Ruta de acceso raíz para buscar recursos. Si se omite, se utiliza la carpeta raíz de la compañía.
includeSubfolders
xsd:boolean
No
Se establece en true para buscar subcarpetas.
publishState
xsd:string
No
Opción de estado de Publish.
trashState
xsd:string
No
Opción de estado de 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 aconseja que no lo use.

Matriz de palabras clave de cadena que debe coincidir.

systemFieldMatchMode
xsd:string
No

Elección de modos de coincidencia de búsqueda para combinar 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 Modos de coincidencia de búsqueda. El valor predeterminado es MatchAll.
tagConditionArray
tipos:TagConditionArray
No

Matriz de predicados de búsqueda de campos de etiquetas.

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

metadataMatchMode
xsd:string
No
Buscar modos de coincidencia para combinar 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 incluirán 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 subtipo con los que filtrar.
strictSubTypeCheck
xsd:boolean
No
Si true y assetSubTypeArray no están vacíos, solo se devuelven los recursos cuyos subtipos están en assetSubTypeArray. Si es false (predeterminado), se devuelven recursos sin un subtipo definido.
excludeByproducts
xsd:boolean
No
Si el valor es True, los recursos de subproductos generados durante la ingesta de un recurso principal, como las imágenes de página de PDF copiadas desde CD, 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 subproductos que se excluirán de los resultados de búsqueda. Si está presente, este parámetro anula la configuración excludeByproducts.
projectHandle
xsd:string
No
Controlador 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 va a devolver, en función de recordsPerPage tamaño de página.
sortBy
xsd:string
No
Elección de los campos de ordenación de recursos.
sortDirection
xsd:string
No
Elección de la dirección del orden.
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 la 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
Assets que devuelve la búsqueda.

Ejemplos section-725484cc09b54772a838ad2cc930b94b

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

Solicitud

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