搜索資產

根據您指定的條件搜索資產。

語法

searchAssets:關於

searchAssets 是檢索IPS資產的主要方法。 此方法用於各種目的，例如瀏覽資料夾層次結構或按名稱查找特定資產。

響應大小

searchAssets 在一次呼叫中返回多達1000個資產。 要每次呼叫返回最多10,000個資產，請將響應資料限制為 totalRows。 name。 handle。 type, subType 的子菜單。 要返回較大集，請使用 resultPage 的下界。

使用responseFieldArray或excludeFieldArray限制結果檔案大小

使用 responseFieldArray 或 excludFieldArray 參數。 這些參數有助於減少記憶體使用和頻寬，並可以縮短伺服器響應時間。

授權用戶類型

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

用戶必須具有讀取權限才能返回資產。

參數

輸入(searchAssetsParam)

名稱 類型 必要? 說明
公司句柄 xsd:string 是 包含要搜索的資產的公司的句柄。
accessUserHandle xsd：字串 否 允許管理員以其他用戶的身份工作。
accessGroupHandle xsd：字串 否 允許管理員作為不同組的一部分工作。
資料夾 xsd：字串 否 用於搜索資產的根路徑。 如果省略，則使用公司根資料夾。
包括子資料夾 xsd:boolean 否 設定為 真 搜索子資料夾。
發佈狀態 xsd：字串 否 發佈狀態選擇。
垃圾州 xsd：字串 否 垃圾狀態選擇。 預設值為 不在垃圾。
條件匹配模式 xsd：字串 否

搜索匹配模式的選擇 關鍵字陣列。

條件匹配模式

systemFieldConditionArray, 元資料條件陣列。 預設值為 全部匹配。

關鍵字陣列 類型：StringArray 否

注：已棄用的參數。 建議你別用它。

要匹配的關鍵字字串陣列。

系統欄位匹配模式 xsd：字串 否

組合搜索匹配模式的選擇 系統欄位條件 匹配。 預設值為 全部匹配

。

systemFieldConditionArray

類型：SystemFieldConditionArray

否 系統欄位條件的陣列。
標籤匹配模式 xsd：字串 否 搜索匹配模式字串常數。 預設值為 全部匹配。
tagConditionArray 類型：TagConditionArray 否

標籤欄位搜索謂詞的陣列。

謂語根據 標籤匹配模式 設定，然後與任何術語組合 關鍵字陣列。 systemFieldConditionArray, 元資料條件陣列 根據 條件匹配模式 的子菜單。

元資料匹配模式 xsd：字串 否 搜索匹配模式以組合 元資料條件 匹配。 預設值為 全部匹配。
元資料條件陣列

類型：MetadataConditionArray

否 元資料欄位搜索條件的陣列。
assetTypeArray 類型：StringArray 否 要包括在搜索中的資產類型陣列。
排除AssetTypeArray 類型：StringArray 否 要從搜索中排除的資產類型陣列。
assetSubTypeArray 類型：StringArray 否 要篩選的子類型名稱清單。
strictSubTypeCheck xsd：布爾 否 如果 真 和 assetSubTypeArray 不為空，只有子類型在的資產 assetSubTypeArray 的子菜單。 如果 假 （預設），則返回沒有定義子類型的資產。
排除副產品 xsd：布爾 否 如果為true，則在接收主資產(如撕開的PDF頁影像)期間生成的副產品資產將從搜索結果中排除。 預設為 false。
排除副產品陣列

類型：排除副產品陣列

否 要從搜索結果中排除的副產品資產生成條件陣列。 如果存在，則此參數將覆蓋excludeDisplusses設定。
項目句柄 xsd:sting 否 包含要搜索的資產的項目的處理。
記錄每頁 xsd:int 否 要返回的最大結果數。
結果頁 xsd:int 否 根據 記錄每頁 頁面大小。
排序依據 xsd：字串 否 資產排序欄位的選擇。
排序方向 xsd：字串 否 排序方向的選擇。
響應欄位陣列 類型：StringArray 否 包含要包含在響應中的欄位和子欄位的清單。
排除欄位陣列 類型：StringArray 否 包含要從響應中排除的欄位和子欄位的清單。

輸出(searchAssetsReturn)

名稱 類型 必要 說明
總行數 xsd:int 否 當每頁記錄不受限制時搜索返回的行數。
資產陣列 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>

本頁內容