DocumentatieDynamic Media Image Production System API

searchAssetsByMetadata searchassetsbymetadata

Last update: Tue Mar 08 2022 00:00:00 GMT+0000 (Coordinated Universal Time)

Gemaakt voor:

  • Developer
  • Admin

Zoekt de gegevensopslagplaats van de meta-gegevensindex naar de bepaalde onderzoekstermijnen. Retourneert elementgegevens zoals de methode searchAssets.

while searchAssetsByMetadata Hiermee kunt u zoeken op door de gebruiker gedefinieerde metagegevensvelden. Deze velden worden niet geretourneerd als ze zijn opgegeven in het dialoogvenster responseMetadataArray. Ter illustratie dit punt, het volgende codevoorbeeld:

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

retourneert een null-waarde:

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

Als u dit probleem wilt verhelpen, kunt u de opdracht fieldHandles van de elementen die worden geretourneerd uit de te voeren zoekopdracht getAssets (zie ook getAssets). Deze methode krijgt de Gebruiker - bepaalde waarden van Gebieden voor de activa in kwestie. Gebruik het volgende syntaxisvoorbeeld om tegen user-defined Gebieden van Meta-gegevens te zoeken:

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

Geautoriseerde gebruikerstypen section-9f85dd55ab574104b5fdc0f95aa0a0e2

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

Parameters section-5f1edb9c5b914160ab361f4364b8aa8d

Input (searchAssetsByMetadataParam)

Naam
Type
Vereist
Beschrijving
companyHandle
xsd:tekenreeks
Ja
De handgreep aan het bedrijf.
Filter
tekst:SearchFilter
Nee

Filters die u helpen zoekcriteria te definiëren.

Zie SearchFilter.

metadataConditionArray
type:MetadataConditionArray
Nee
Voorwaarden die zoekcriteria definiëren. Zie hieronder voor meer informatie.
responseMetadataArray
type:StringArray
Nee
De extra gebieden u op de reactie in het activaoverzicht wilt bevolken. De velden moeten in de genormaliseerde indeling worden opgegeven.
recordsPerPage
xsd:int
Nee
Het aantal elementen dat door de reactie wordt geretourneerd. De standaardwaarde is 1000.
resultsPage
xsd:int
Nee
Hiermee geeft u de resultatenpagina op die u wilt retourneren, op basis van recordsPerPage paginaformaat.
sortBy
xsd:tekenreeks
Nee
Sorteren op geselecteerd elementveld.
sortDirection
xsd:tekenreeks
Nee
Keuze van sorteerrichting. Oplopend is standaard.

Output (searchAssetsByMetadataReturn)

Naam
Type
Vereist
Beschrijving
totalRows
xsd:int
Nee
Aantal overeenkomsten.
assetArray
types:AssetArray
Nee
Array met elementen die door de zoekopdracht worden geretourneerd.

details metadataConditionArray section-1af4a4a22f82451eabdf6dfe13d9f27d

Itemstructuur

metadataConditionArray de structuur is als volgt:

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

Waarden

field_handle is de zoeksleutel voor metagegevens. Het kan puntnotatie bevatten. Mogelijke waarden zijn:

  • asset_id (zonder voorvoegsel)

  • name

  • folder_path

  • type

  • file_name

  • description

  • comment

  • user_data

  • sku

  • modified_at

  • modified_by

  • created_at (gelijk aan modified_at (Datum in de vorm: 25 jul. 2014 22:13:45 GMT-0500 (CDT))

  • created_by

Toegestane operatoren

De operator definieert hoe u de waarde kunt vergelijken en opnemen:

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

De comparison_value is de term waarnaar moet worden gezocht.

Voorbeelden section-53a12b9c023e4e629eddf5719c955ad4

In dit codevoorbeeld wordt gezocht met de volgende metagegevenscriteria:

  • name field contains 1000801.

  • dc.rights gelijk aan veld Per Jessen Schmidt.

Verzoek

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

Antwoord

<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