文档Dynamic Media Image Production System API

searchAssetsByMetadata searchassetsbymetadata

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

创建对象：

  • 开发人员
  • 管理员

在元数据索引资料档案库中搜索给定的搜索词。 返回资产数据，如searchAssets方法。

虽然searchAssetsByMetadata允许您根据用户定义的元数据字段进行搜索，但是如果在responseMetadataArray中指定了这些字段，则不会返回这些字段。 为了说明这一点，以下代码示例介绍了：

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

返回null值：

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

授权用户类型 section-9f85dd55ab574104b5fdc0f95aa0a0e2

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

参数 section-5f1edb9c5b914160ab361f4364b8aa8d

输入(searchAssetsByMetadataParam)

名称
类型
必需
说明
companyHandle
xsd：string
是
公司的把手。
筛选器
类型：SearchFilter
否

帮助您定义搜索条件的过滤器。

请参阅 SearchFilter。

metadataConditionArray
类型：MetadataConditionArray
否
定义搜索条件的条件。 有关其他信息，请参阅下文。
responseMetadataArray
类型：StringArray
否
要在资源摘要的响应中填充的其他字段。 字段必须以规范化格式指定。
条记录PerPage
xsd：int
否
响应返回的资源的数量。 預設值為 1000。
结果页面
xsd：int
否
根据条记录PerPage页大小，指定要返回的结果页。
sortBy
xsd：string
否
按所选资源字段排序。
sortDirection
xsd：string
否
选择排序方向。 默认使用升序。

输出(searchAssetsByMetadataReturn)

名称
类型
必需
说明
totalRows
xsd:int
否
匹配数。
assetArray
types:AssetArray
否
搜索返回的资源的数组。

metadataConditionArray详细信息 section-1af4a4a22f82451eabdf6dfe13d9f27d

项结构

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相同(日期格式为：2014年7月25日星期五22:13:45 GMT-0500 (CDT))

  • created_by

允许的运算符

operator定义如何比较该值并包括：

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

comparison_value是要搜索的术语。

示例 section-53a12b9c023e4e629eddf5719c955ad4

此代码示例使用以下元数据条件执行搜索：

  • 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>
recommendation-more-help
4e9b9d8c-5839-4215-aa35-01b652869681