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 搜尋資產的根路徑。 若省略,則會使用公司根資料夾。
includeSubfolders xsd:boolean 設為 true以搜尋子資料夾。
publishState xsd:string 發佈狀態選項。
crashState xsd:string 垃圾狀態選擇。 預設值為 NotInTrash
conditionMatchMode xsd:string

選擇組合關鍵字陣列結果的搜索匹配模式,

conditionMatchMode

systemFieldConditionArray和metadataConditionArray 之間。預設值為 MatchAll

keywordArray 類型:StringArray

注意: 已棄用的參數。 建議您不要使用。

要比對的關鍵字字串陣列。

systemFieldMatchMode xsd:string

組合 systemFieldCondition匹配的搜索匹配模式的選擇。 預設值為 MatchAll

.

systemFieldConditionArray

類型:SystemFieldConditionArray

系統欄位條件的陣列。
tagMatchMode xsd:string 搜尋符合模式字串常數。 預設值為 MatchAll
tagConditionArray 類型:TagConditionArray

標籤欄位搜尋述詞的陣列。

謂語根據 tagMatchMode設定組合,然後根據條件MatchMode設定與 keywordArray systemFieldConditionArray metadataConditionArray中的任何詞語組合。

metadataMatchMode xsd:string 搜尋比對模式以結合 metadataCondition比對。 預設值為 MatchAll
metadataConditionArray

類型:MetadataConditionArray

中繼資料欄位搜尋條件的陣列。
assetTypeArray 類型:StringArray 要納入搜尋的資產類型陣列。
excludeAssetTypeArray 類型:StringArray 要從搜尋中排除的資產類型陣列。
assetSubTypeArray 類型:StringArray 要篩選的子類型名稱清單。
strictSubTypeCheck xsd:boolean 如果 true assetSubTypeArray不為空,則只返回子類型位於 assetSubTypeArray中的資產。 如果 false(預設值),則會傳回未定義子類型的資產。
excludeBisspluments xsd:boolean 若為true,擷取主要資產(例如撕下的PDF頁面影像)期間產生的副產品資產,會從搜尋結果中排除。 預設為 false。
excludBybloudArray

types:ExcludeBybloudArray

要從搜尋結果中排除的副產品資產產生條件陣列。 如果存在,此參數將覆蓋excludeBassclups設定。
projectHandle xsd:sting 處理包含要搜尋資產的專案。
recordsPerPage xsd:int 要返回的最大結果數。
resultsPage xsd:int 根據 recordsPerPage頁面大小指定要傳回的結果頁面。
sortBy xsd:string 選擇資產排序欄位。
sortDirection xsd:string 選擇排序方向。
responseFieldArray 類型:StringArray 包含要包含在回應中的欄位和子欄位清單。
excludeFieldArray 類型: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>

本頁內容