getFolders
最後更新: 2024年7月22日
建立對象:
- 開發人員
- 管理員
從資料夾路徑開始,傳回所有資料夾和子資料夾。 getFolders回應最多會傳回100,000個資料夾。
資料夾用途
資料夾可讓您組織子資料夾和資產。 所有資料夾和資產名稱都必須是唯一的。 共用相同名稱的資料夾和資產會造成名稱空間衝突,即使它們位在不同資料夾階層中亦然。
語法
授權的使用者型別
IpsUser
IpsAdmin
IpsCompanyAdmin
TrialSiteAdmin
TrialSiteUser
ImagePortalAdmin
ImagePortalUser
ImagePortalContrib
ImagePortalContribUser
NOTE
使用者必須擁有資料夾的讀取存取權,才能傳回其上的資料。
參數
輸入(getFoldersParam)
名稱 | 類型 | 必要 | 說明 |
---|---|---|---|
companyHandle | xsd:string | 是 | 公司的控制代碼。 |
accessUserHandle | xsd:string | 否 | 管理員用來模擬特定使用者。 |
accessGroupHandle | xsd:string | 否 | 依特定群組篩選。 |
資料夾路徑 | xsd:string | 否 | 根資料夾以擷取資料夾及葉層級的所有子資料夾。 如果排除,則會使用公司根目錄。 |
assetTypeArray | types:StringArray | 否 | 傳回僅包含指定資產型別的資料夾。 |
responseFieldArray | types:StringArray | 否 | 包含您要納入回應的欄位清單。 |
excludeFieldArray | types:StringArray | 否 | 包含您要從回應中排除的欄位清單。 |
輸出(getFoldersReturn)
名稱 | 類型 | 必要 | 說明 |
---|---|---|---|
folderArray | types:FolderArray | 否 | 符合篩選條件的資料夾陣列。 回應上限為100,000個資料夾。 |
permissionsSetArray | types:PermissionSetArray |
範例
此程式碼範例傳回陣列,其中包含公司的所有資料夾以及有關每個資料夾的特定資訊。
要求
<ns1:getFoldersParam xmlns:ns1="http://www.scene7.com/IpsApi/xsd">
<ns1:companyHandle>47</ns1:companyHandle>
</ns1:getFoldersParam>
回應
<getFoldersReturn xmlns="http://www.scene7.com/IpsApi/xsd">
<folderArray>
<items>
<folderHandle>MyCompany/</folderHandle>
<path>MyCompany/</path>
<hasSubfolders>false</hasSubfolders>
</items>
<items>
<folderHandle>MyCompany/eCatalogs/</folderHandle>
<path>MyCompany/eCatalogs/</path>
<hasSubfolders>false</hasSubfolders>
</items>
<items>
<folderHandle>MyCompany/PDF/</folderHandle>
<path>MyCompany/PDF/</path>
<hasSubfolders>false</hasSubfolders>
</items>
</folderArray>
</getFoldersReturn>
recommendation-more-help
4e9b9d8c-5839-4215-aa35-01b652869681