searchAssets

根据您指定的条件搜索资产。

语法

searchAssets:关于

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

响应大小

searchAssets 在一次调用中最多返回1000个资产。要在每次调用中返回最多10,000个资产,请将响应数据限制为totalRowsnamehandletypesubType字段的子集。 要返回较大的集,请使用resultPage参数设置分页。

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

使用responseFieldArrayexcludFieldArray参数限制数据集的大小。 这些参数有助于减少内存使用和带宽,并可缩短服务器响应时间。

授权用户类型

  • IpsUser
  • IpsAdmin
  • IpsCompanyAdmin
  • TrialSiteAdmin
  • TrialSiteUser
  • ImagePortalAdmin
  • TrialSiteUser
  • ImagePortalAdmin
  • ImagePortalUser
  • ImagePortalContrib
  • ImagePortalContribUser
注意

用户必须具有返回资产的读取权限。

参数

输入(searchAssetsParam)

名称 类型 必需? 说明
companyHandle xsd:string 包含您要搜索的资产的公司的句柄。
accessUserHandle xsd:string 允许管理员以其他用户的身份工作。
accessGroupHandle xsd:string 允许管理员作为其他组的一部分工作。
文件夹 xsd:string 用于搜索资产的根路径。 如果忽略,则使用公司根文件夹。
includeSubfalders xsd:boolean 设置为 true可搜索子文件夹。
publishState xsd:string 发布状态选项。
trashState xsd:string 垃圾状态选择。 默认值为 NotInTrashe
conditionMatchMode xsd:string

组合关键字数组结果的搜索匹配模式选择,

conditionMatchMode

systemFieldConditionArray和metadataConditionArray 。默认值为 MatchAll

keywordArray types:StringArray

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

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

systemFieldMatchMode xsd:string

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

systemFieldConditionArray

types:SystemFieldConditionArray

系统字段条件的数组。
tagMatchMode xsd:string 搜索匹配模式字符串常量。 默认值为 MatchAll
tagConditionArray types:TagConditionArray

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

根据 tagMatchMode设置组合谓词,然后根据条件MatchMode设置与 keywordArray systemFieldConditionArray metadataConditionArray中的任何术语组合。

metadataMatchMode xsd:string 搜索匹配模式以组合 metadataCondition匹配。 默认值为 MatchAll
metadataConditionArray

types:MetadataConditionArray

元数据字段搜索条件的数组。
assetTypeArray types:StringArray 要包含在搜索中的资产类型数组。
excludeAssetTypeArray types:StringArray 要从搜索中排除的资产类型数组。
assetSubTypeArray types:StringArray 要筛选的子类型名称列表。
strictSubTypeCheck xsd:boolean 如果 true assetSubTypeArray不为空,则只返回子类型位于 assetSubTypeArray中的资产。 如果 false(默认),则返回未定义子类型的资产。
excludeDispluments xsd:boolean 如果为true,则在摄取主资产期间生成的副产品资产(如撕开的PDF页面图像)将从搜索结果中排除。 默认值为 false。
excludBybludArray

类型:ExcludeBybludArray

要从搜索结果中排除的副产品资产生成条件的数组。 如果存在,此参数将覆盖excludeBisclupes设置。
projectHandle xsd:sting 包含要搜索的资产的项目的处理。
recordsPerPage xsd:int 要返回的最大结果数。
resultsPage xsd:int 根据 recordsPerPage页面大小指定要返回的结果页。
sortBy xsd:string 资产排序字段的选项。
sortDirection xsd:string 排序方向的选择。
responseFieldArray types:StringArray 包含要包含在响应中的字段和子字段列表。
excludeFieldArray types:StringArray 包含要从响应中排除的字段和子字段列表。

输出(searchAssetsReturn)

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

示例

此代码示例用于搜索属于特定公司的图像资产。 响应因简短而被截断。

请求

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

在此页面上