DocumentazioneAPI di Dynamic Medie Image Production System

searchAssetsByMetadata searchassetsbymetadata

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

Creato per:

  • Sviluppatore
  • Amministratore

Cerca i termini di ricerca specificati nell'archivio dell'indice dei metadati. Restituisce i dati delle risorse come il metodo searchAssets.

Mentre searchAssetsByMetadata consente di eseguire ricerche nei campi metadati definiti dall'utente, tali campi non vengono restituiti se sono specificati in responseMetadataArray. Per illustrare questo punto, il seguente esempio di codice:

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

restituisce un valore null:

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

Per risolvere il problema, è possibile utilizzare fieldHandles delle risorse restituite dalla ricerca per eseguire getAssets (vedere anche getAssets). Questo metodo ottiene i valori dei campi definiti dall'utente per le risorse in questione. Utilizza l’esempio di sintassi seguente per eseguire ricerche nei campi di metadati definiti dall’utente:

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

Tipi di utenti autorizzati section-9f85dd55ab574104b5fdc0f95aa0a0e2

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

Parametri section-5f1edb9c5b914160ab361f4364b8aa8d

Input (searchAssetsByMetadataParam)

Nome
Tipo
Obbligatorio
Descrizione
companyHandle
xsd:string
Sì
La maniglia per l'azienda.
Filtro
Tipo :SearchFilter
No

Filtri che consentono di definire i criteri di ricerca.

Vedere SearchFilter.

metadataConditionArray
Tipo :MetadataConditionArray
No
Condizioni che definiscono i criteri di ricerca. Per ulteriori informazioni, vedere di seguito.
responseMetadataArray
tipo:StringArray
No
Campi aggiuntivi da compilare nella risposta nel riepilogo delle risorse. I campi devono essere specificati nel formato normalizzato.
recordPerPage
xsd:int
No
Numero di risorse restituite dalla risposta. Il valore predefinito è 1000.
risultatiPagina
xsd:int
No
Specifica la pagina dei risultati da restituire, in base alle dimensioni di pagina recordsPerPage.
sortBy
xsd:string
No
Ordina per campo risorsa selezionato.
sortDirection
xsd:string
No
Scelta della direzione di ordinamento. L'impostazione predefinita è Crescente.

Output (searchAssetsByMetadataReturn)

Nome
Tipo
Obbligatorio
Descrizione
totalRows
xsd:int
No
Numero di corrispondenze.
assetArray
types:AssetArray
No
Array di risorse restituite dalla ricerca.

Dettagli metadataConditionArray section-1af4a4a22f82451eabdf6dfe13d9f27d

Struttura elemento

metadataConditionArray struttura:

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

Valori

field_handle è la chiave di ricerca metadati. Può contenere la notazione del punto. I valori possibili includono:

  • asset_id (senza prefisso)

  • name

  • folder_path

  • type

  • file_name

  • description

  • comment

  • user_data

  • sku

  • modified_at

  • modified_by

  • created_at (uguale a modified_at (Data nella forma: Ven 25 lug 2014 22:13:45 GMT-0500 (CDT))

  • created_by

Operatori consentiti

operator definisce come confrontare il valore e include:

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

comparison_value è il termine da cercare.

Esempi section-53a12b9c023e4e629eddf5719c955ad4

In questo esempio di codice viene eseguita una ricerca con i seguenti criteri di metadati:

  • Il campo name contiene 1000801.

  • Il campo dc.rights è uguale a Per Jessen Schmidt.

Richiesta

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

Risposta

<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