searchAssetsByMetadata

在元資料索引儲存庫中搜索給定的搜索項。 返回資產資料,如searchAssets方法。

同時 searchAssetsByMetadata 用於搜索用戶定義的元資料欄位,如果在 responseMetadataArray。 為說明這一點,以下代碼示例:

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

返回空值:

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

要解決此問題,可使用 fieldHandles 從要運行的搜索返回的資產 getAssets (另請參見) getAssets)。 此方法獲取有關資產的「用戶定義欄位」值。 使用以下語法示例搜索用戶定義的元資料欄位:

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

授權用戶類型

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

參數

輸入(searchAssetsByMetadataParam)

名稱 類型 必要 說明

公司句柄

xsd:string

公司的把手。

篩選

類型:搜索篩選器

幫助您定義搜索條件的篩選器。

請參閱 搜索篩選器

元資料條件陣列

類型:MetadataConditionArray

定義搜索條件的條件。 有關其他資訊,請參閱下文。

響應元資料陣列

類型:StringArray

要在資產匯總中的響應中填充的附加欄位。 必須以規範化格式指定欄位。

記錄每頁

xsd:int

響應返回的資產數。 預設值為 1000。

結果頁

xsd:int

根據 記錄每頁 頁面大小。

排序依據

xsd:字串

按所選資產欄位排序。

排序方向

xsd:字串

排序方向的選擇。 升序為預設值。

輸出(searchAssetsByMetadataReturn)

名稱 類型 必要 說明
總行數 xsd:int 匹配項數。
資產陣列 types:AssetArray 搜索返回的資產陣列。

元資料ConditionArray詳細資訊

物料結構

metadataConditionArray 結構如下:

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

field_handle 是元資料搜索鍵。 它可以包含點符號。 可能的值包括:

  • asset_id (無前置詞)

  • name

  • folder_path

  • type

  • file_name

  • description

  • comment

  • user_data

  • sku

  • modified_at

  • modified_by

  • created_at (與 modified_at (格式日期:星期五7月25 2014 22:13:45 GMT-0500(CDT)

  • created_by

允許的運算子

的 operator 定義如何比較值並包括:

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

comparison_value 是搜索的詞。

範例

此代碼示例使用以下元資料標準執行搜索:

  • name 欄位包含 1000801

  • dc.rights 欄位等於 Per Jessen Schmidt

請求

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

回答

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

本頁內容