DokumentationDynamic Media Image Production System-API

searchAssetsByMetadata searchassetsbymetadata

Last update: Tue Dec 31 2024 00:00:00 GMT+0000 (Coordinated Universal Time)
  • Themen:

Erstellt für:

  • Entwickler
  • Admin

Durchsucht das Metadaten-Index-Repository nach den angegebenen Suchbegriffen. Gibt Asset-Daten wie die searchAssets-Methode zurück.

searchAssetsByMetadata können Sie zwar nach benutzerdefinierten Metadatenfeldern suchen, diese Felder werden jedoch nicht zurückgegeben, wenn sie im responseMetadataArray angegeben sind. Um diesen Punkt zu veranschaulichen, führen Sie folgendes Codebeispiel aus:

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

Gibt einen Nullwert zurück:

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

Um dieses Problem zu umgehen, können Sie die fieldHandles der Assets verwenden, die von der Suche zurückgegeben werden, um getAssets auszuführen (siehe auch getAssets). Diese Methode ruft die Werte der benutzerdefinierten Felder für die betreffenden Assets ab. Verwenden Sie das folgende Syntaxbeispiel, um nach benutzerdefinierten Metadatenfeldern zu suchen:

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

Autorisierte Benutzertypen section-9f85dd55ab574104b5fdc0f95aa0a0e2

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

Parameter section-5f1edb9c5b914160ab361f4364b8aa8d

Eingabe (searchAssetsByMetadataParam)

Name
Typ
Erforderlich
Beschreibung
companyHandle
xsd:string
Ja
Der Griff zum Unternehmen.
Filter
:SearchFilter
Nein

Filter, mit denen Sie Suchkriterien definieren können.

Siehe SearchFilter.

metadataConditionArray
:MetadataConditionArray
Nein
Bedingungen, die Suchkriterien definieren. Weitere Informationen finden Sie unten.
ResponseMetadataArray
:StringArray
Nein
Zusätzliche Felder, die mit der Antwort in der Asset-Zusammenfassung ausgefüllt werden sollen. Die Felder müssen im normalisierten Format angegeben werden.
recordsPerPage
xsd:int
Nein
Die Anzahl der von der Antwort zurückgegebenen Assets. Der Standardwert ist 1000.
resultsPage
xsd:int
Nein
Gibt die zurückzugebende Ergebnisseite basierend auf der Seitengröße recordsPerPage .
sortBy
xsd:string
Nein
Sortieren nach ausgewähltem Asset-Feld.
sortDirection
xsd:string
Nein
Auswahl der Sortierrichtung. Aufsteigend ist Standard.

Ausgabe (searchAssetsByMetadataReturn)

Name
Typ
Erforderlich
Beschreibung
totalRows
xsd:int
Nein
Anzahl Übereinstimmungen.
assetArray
types:AssetArray
Nein
Array von Assets, die von der Suche zurückgegeben werden.

metadataConditionArray-Details section-1af4a4a22f82451eabdf6dfe13d9f27d

Artikelstruktur

metadataConditionArray Struktur sieht wie folgt aus:

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

Werte

field_handle ist der Metadaten-Suchschlüssel. Sie kann Punktnotation enthalten. Mögliche Werte sind:

  • asset_id (ohne Präfix)

  • name

  • folder_path

  • type

  • file_name

  • description

  • comment

  • user_data

  • sku

  • modified_at

  • modified_by

  • created_at (wie modified_at (Datum im Formular: Fr. Jul 25 2014 22:13:45 GMT-0500 (CDT)))

  • created_by

Zulässige Benutzer

Die operator definiert, wie der Wert verglichen und einbezogen wird:

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

Der comparison_value ist der Begriff, nach dem gesucht werden soll.

Beispiele section-53a12b9c023e4e629eddf5719c955ad4

Dieses Codebeispiel führt eine Suche mit den folgenden Metadatenkriterien durch:

  • name Feld enthält 1000801.

  • dc.rights Feld ist gleich Per Jessen Schmidt.

Anfrage

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

Antwort

<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