根據您指定的條件搜尋資產。
語法
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)
名稱 | 類型 | 必要? | 說明 |
---|---|---|---|
companyHandle | xsd:string | 是 | 擁有您要搜尋之資產的公司的控制代碼。 |
accessUserHandle | xsd:string | 否 | 可讓管理員以不同使用者身分工作。 |
accessGroupHandle | xsd:string | 否 | 可讓管理員作為不同群組的一部分工作。 |
資料夾 | xsd:string | 否 | 用於搜尋資產的根路徑。 如果省略,則使用公司根資料夾。 |
includeSubfolders | xsd:boolean | 否 | 設定為 true 以搜尋子資料夾。 |
publishState | xsd:string | 否 | 發佈狀態選擇。 |
trashState | xsd:string | 否 | 垃圾桶狀態選擇。 預設為 NotInTrash. |
conditionMatchMode | xsd:string | 否 | 組合結果的搜尋比對模式選擇 keywordArray, conditionMatchMode systemFieldConditionArray、和 metadataConditionArray. 預設為 全部符合. |
keywordArray | 型別:StringArray | 否 |
注意:已棄用的引數。 建議您不要使用它。 要比對的關鍵字字字串陣列。 |
Systemfieldmatchmode | xsd:string | 否 | 組合的搜尋比對模式選擇 systemFieldCondition 符合。 預設為 全部符合 . |
systemFieldConditionArray |
型別:SystemFieldConditionArray |
否 | 系統欄位條件的陣列。 |
tagMatchMode | xsd:string | 否 | 搜尋比對模式字串常數。 預設值為 全部符合. |
tagConditionArray | 型別:TagConditionArray | 否 | 標籤欄位搜尋述詞的陣列。 述詞會根據 tagMatchMode 設定,然後與中的任何辭彙結合 keywordArray, systemFieldConditionArray、和 metadataConditionArray 根據 conditionMatchMode 設定。 |
metadataMatchMode | xsd:string | 否 | 搜尋相符模式以進行組合 metadataCondition 符合。 預設為 全部符合. |
metadataConditionArray | 型別:MetadataConditionArray |
否 | 中繼資料欄位搜尋條件的陣列。 |
assetTypeArray | 型別:StringArray | 否 | 要包含在搜尋中的資產型別陣列。 |
excludeAssetTypeArray | 型別:StringArray | 否 | 要從搜尋中排除的資產型別陣列。 |
assetSubTypeArray | 型別:StringArray | 否 | 要篩選的子型別名稱清單。 |
strictSubTypeCheck | xsd:boolean | 否 | 若 true 和 assetSubTypeArray 不是空的,只有子型別位於以下位置的資產: assetSubTypeArray 會傳回。 若 false (預設),則會傳回未定義子型別的資產。 |
excludeByproducts | xsd:boolean | 否 | 如果為true,則擷取主要資產期間產生的副產品資產(例如擷取的PDF頁面影像)會從搜尋結果中排除。 預設為 false。 |
excludeByproductArray | 型別:ExcludeByproductArray |
否 | 要從搜尋結果排除的副產品資產產生條件陣列。 如果存在,此引數會覆寫excludeByproducts設定。 |
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>