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

searchAssetsByMetadata searchassetsbymetadata

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

Creado para:

  • Desarrollador
  • Administrador

Busca los términos de búsqueda dados en el repositorio de índices de metadatos. Devuelve datos de recurso como el método searchAssets.

Aunque searchAssetsByMetadata le permite buscar campos de metadatos definidos por el usuario, esos campos no se devuelven si se especifican en responseMetadataArray. Para ilustrar este punto, vea el siguiente ejemplo de código:

<ns:responseMetadataArray>
 <ns:items>custom_attributes.x</ns:items>
</ns:responseMetadataArray>

devuelve un valor nulo:

<items>
 <name>custom_attributes.x</name>
 <value>null</value>
</items>

Para solucionar este problema, puede usar fieldHandles de los recursos que se devuelven de la búsqueda para ejecutar getAssets (consulte también getAssets). Este método obtiene los valores de Campos definidos por el usuario para los recursos en cuestión. Utilice el siguiente ejemplo de sintaxis para buscar campos de metadatos definidos por el usuario:

<ns:metadataConditionArray>
 <ns:items>
  <ns:fieldHandle>custom_attributes.[UDF Field Name]</ns:fieldHandle>
  <ns:op>[Conditional]</ns:op>
  <ns:value>[Value]</ns:value>
 </ns:items>
</ns:metadataConditionArray>

Tipos de usuarios autorizados section-9f85dd55ab574104b5fdc0f95aa0a0e2

  • IpsUser
  • IpsAdmin
  • IpsCompanyAdmin
  • ImagePortalAdmin
  • ImagePortalUser
  • ImagePortalContrib
  • ImagePortalContribUser

Parámetros section-5f1edb9c5b914160ab361f4364b8aa8d

Entrada (searchAssetsByMetadataParam)

Nombre
Tipo
Obligatorio
Descripción
companyHandle
xsd:string
Sí
El identificador de la compañía.
Filtro
type:SearchFilter
No

Filtros que ayudan a definir los criterios de búsqueda.

Ver SearchFilter.

metadataConditionArray
tipo:MetadataConditionArray
No
Condiciones que definen los criterios de búsqueda. Consulte a continuación para obtener más información.
responseMetadataArray
tipo:StringArray
No
Campos adicionales que desee rellenar en la respuesta del resumen del recurso. Los campos deben especificarse en el formato normalizado.
recordsPerPage
xsd:int
No
El número de recursos que devuelve la respuesta. El valor predeterminado es 1000.
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
Ordenar por el campo de recurso seleccionado.
sortDirection
xsd:string
No
Elección de la dirección del orden. Ascendente es el valor predeterminado.

Salida (searchAssetsByMetadataReturn)

Nombre
Tipo
Obligatorio
Descripción
totalRows
xsd:int
No
Número de coincidencias.
assetArray
types:AssetArray
No
Matriz de recursos devueltos por la búsqueda.

Detalles de metadataConditionArray section-1af4a4a22f82451eabdf6dfe13d9f27d

Estructura del elemento

La estructura de metadataConditionArray es la siguiente:

<ns1:items>
   <ns:fieldHandle>field_handle</ns:fieldHandle>
   <ns:op>operator</ns:op>
   <ns:value>comparison_value</ns:value>
</ms1:items>

Valores

field_handle es la clave de búsqueda de metadatos. Puede contener notación de puntos. Los valores posibles incluyen:

  • asset_id (sin prefijo)

  • name

  • folder_path

  • type

  • file_name

  • description

  • comment

  • user_data

  • sku

  • modified_at

  • modified_by

  • created_at (igual que modified_at (fecha con el formato: viernes, 25 de julio de 2014 22:13:45 GMT-0500 (CDT))

  • created_by

Operadores permitidos

operator define cómo comparar el valor e incluir:

  • Equals
  • NotEquals
  • Contains
  • NotContains
  • StartsWith
  • EndsWith

comparison_value es el término que se debe buscar.

Ejemplos section-53a12b9c023e4e629eddf5719c955ad4

Este ejemplo de código realiza una búsqueda con los siguientes criterios de metadatos:

  • El campo name contiene 1000801.

  • dc.rights campo es igual a Per Jessen Schmidt.

Solicitud

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.scene7.com/IpsApi/xsd"
xmlns:ns="http://www.scene7.com/IpsApi/xsd/2010-01-31">
   <soapenv:Header>
      <xsd:authHeader>
          <xsd:user>user@adobe.com</xsd:user>
          <xsd:password>topSecret</xsd:password>
      </xsd:authHeader>
   </soapenv:Header>
   <soapenv:Body>
      <ns:searchAssetsByMetadataParam>
         <ns:companyHandle>c|656</ns:companyHandle>
         <ns:metadataConditionArray>
            <ns:items>
               <ns:fieldHandle>name</ns:fieldHandle>
               <ns:op>Contains</ns:op>
               <ns:value>1000801</ns:value>
            </ns:items>
            <ns:items>
               <ns:fieldHandle>dc.rights</ns:fieldHandle>
               <ns:op>Equals</ns:op>
               <ns:value>Per Jessen Schmidt</ns:value>
            </ns:items>
         </ns:metadataConditionArray>
         <ns:responseMetadataArray>
            <ns:items>dc.subject</ns:items>
            <ns:items>xmp.CreatorTool</ns:items>
         </ns:responseMetadataArray>
      </ns:searchAssetsByMetadataParam>
   </soapenv:Body>
</soapenv:Envelope>

Respuesta

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
   <soapenv:Body>
      <searchAssetsByMetadataReturn xmlns="http://www.scene7.com/IpsApi/xsd/2010-01-31">
         <totalRows>1</totalRows>
         <assetSummaryArray>
            <items>
               <assetHandle>a|885289</assetHandle>
               <type>Image</type>
               <name>test9-1000801</name>
               <folder>Extroscope/Test subfolders/</folder>
               <filename>test9-1000801.jpg</filename>
               <created>2009-11-19T07:21:24.252-08:00</created>
               <createUser>pschmidt@adobe.com</createUser>
               <lastModified>2009-11-19T07:21:25.487-08:00</lastModified>
               <lastModifyUser>pschmidt@adobe.com</lastModifyUser>
               <metadataArray>
                  <items>
                     <name>dc.subject</name>
                     <value>[San Fransico, USA</value>
                  </items>
                  <items>
                     <name>xmp.CreatorTool</name>
                     <value>Ver.1.0</value>
                  </items>
               </metadataArray>
            </items>
         </assetSummaryArray>
      </searchAssetsByMetadataReturn>
   </soapenv:Body>
</soapenv:Envelope>
recommendation-more-help
4e9b9d8c-5839-4215-aa35-01b652869681