文档Dynamic Media Image Production System API

searchAssets searchassets

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

创建对象：

  • 开发人员
  • 管理员

根据指定的条件搜索资源。

语法

searchAssets：关于 section-4ad74f12eb754768bf85bd235a7e25f0

searchAssets是检索IPS资源的主要方法。 此方法用于各种目的，例如浏览文件夹层次结构或按名称查找特定资源。

响应大小

searchAssets在一次调用中最多返回1000个资源。 要每次调用返回最多10,000个资源，请将响应数据限制为totalRows、name、handle、type和subType字段的子集。 要返回较大的集，请使用resultPage参数设置分页。

使用responseFieldArray或excludeFieldArray限制结果文件大小

使用responseFieldArray或excludFieldArray参数限制数据集的大小。 这些参数有助于减少内存使用量和带宽，并可以提高服务器响应时间。

授权用户类型 section-9c4bc41bb8b4493982197eb13c7cdc55

  • IpsUser
  • IpsAdmin
  • IpsCompanyAdmin
  • TrialSiteAdmin
  • TrialSiteUser
  • ImagePortalAdmin
  • TrialSiteUser
  • ImagePortalAdmin
  • ImagePortalUser
  • ImagePortalContrib
  • ImagePortalContribUser
NOTE
用户必须具有读取权限才能返回资产。

参数 section-49aabc0600764f55a8b7017d86ded44f

输入(searchAssetsParam)

名称
类型
必需？
说明
companyHandle
xsd：string
是
包含要搜索的资产公司的句柄。
accessUserHandle
xsd：string
否
允许管理员作为其他用户工作。
accessGroupHandle
xsd：string
否
允许管理员作为其他组的一部分工作。
文件夹
xsd：string
否
用于搜索资产的根路径。 如果忽略，则使用公司根文件夹。
includeSubfolders
xsd：boolean
否
设置为 true以搜索子文件夹。
publishState
xsd：string
否
Publish州选择。
trashState
xsd：string
否
将状态选择置入垃圾桶。 默认值为 NotInTrash。
conditionMatchMode
xsd：string
否

选择用于组合 keywordArray的结果的搜索匹配模式

conditionMatchMode

systemFieldConditionArray和 metadataConditionArray。 默认值为 MatchAll。

keywordArray
类型：StringArray
否

注意：已弃用的参数。 建议不要使用它。

要匹配的关键字字符串数组。

systemFieldMatchMode
xsd：string
否

选择用于组合 systemFieldCondition匹配的搜索匹配模式。 默认为 MatchAll

。

systemFieldConditionArray
类型：SystemFieldConditionArray
否
系统字段条件的数组。
tagMatchMode
xsd：string
否
搜索匹配模式字符串常量。 默认值为 MatchAll。
tagConditionArray
类型：TagConditionArray
否

标记字段搜索谓词的数组。

谓词根据 tagMatchMode设置进行组合，然后根据 conditionMatchMode设置与 keywordArray、 systemFieldConditionArray和 metadataConditionArray中的任何术语组合。

metadataMatchMode
xsd：string
否
用于组合 metadataCondition匹配的搜索匹配模式。 默认值为 MatchAll。
metadataConditionArray
类型：MetadataConditionArray
否
元数据字段搜索条件的数组。
assetTypeArray
类型：StringArray
否
要包含在搜索中的资源类型数组。
excludeAssetTypeArray
类型：StringArray
否
要从搜索中排除的资源类型数组。
assetSubTypeArray
类型：StringArray
否
要筛选的子类型名称的列表。
strictSubTypeCheck
xsd：boolean
否
如果 true和 assetSubTypeArray不为空，则只返回子类型位于 assetSubTypeArray中的资产。 如果 false（默认），则返回未定义子类型的资产。
excludeByproducts
xsd：boolean
否
如果为true，则将从搜索结果中排除摄取主资产期间生成的副产品资产，例如翻录的PDF页面图像。 默认值为 false。
excludByproductArray
类型：ExcludeByproductArray
否
要从搜索结果中排除的副产品资产生成条件数组。 如果存在，此参数将覆盖excludeByproducts设置。
项目句柄
xsd：sting
否
包含要搜索的资源的项目的句柄。
条记录PerPage
xsd：int
否
要返回的最大结果数。
结果页面
xsd：int
否
根据条记录PerPage页大小，指定要返回的结果页。
sortBy
xsd：string
否
资源排序字段选择。
sortDirection
xsd：string
否
选择排序方向。
responseFieldArray
类型：StringArray
否
包含要包含在响应中的字段和子字段的列表。
excludeFieldArray
类型：StringArray
否
包含要从响应中排除的字段和子字段的列表。

输出(searchAssetsReturn)

名称
类型
必需
说明
totalRows
xsd:int
否
当每页的记录数不受限制时，搜索返回的行数。
assetArray
types:AssetArray
否
返回搜索的Assets。

示例 section-725484cc09b54772a838ad2cc930b94b

此代码示例搜索属于特定公司的图像资产。 为简短起见，响应将被截断。

请求

<ns1:searchAssetsParam xmlns:ns1="http://www.scene7.com/IpsApi/xsd">
   <ns1:companyHandle>47</ns1:companyHandle>
   <ns1:includeSubfolders>true</ns1:includeSubfolders>
   <ns1:assetTypeArray>
      <ns1:items>Image</ns1:items>
   </ns1:assetTypeArray>
</ns1:searchAssetsParam>

响应

<searchAssetsReturn xmlns="http://www.scene7.com/IpsApi/xsd">
   <totalRows>210</totalRows>
   <assetArray>
      <items>
         <assetHandle>24265|1|17061</assetHandle>
         <type>Image</type>
         <name>Autumn Leaves</name>
         ...
      </items>
    </assetArray>
</searchAssetsReturn>
recommendation-more-help
4e9b9d8c-5839-4215-aa35-01b652869681