Restituisce tutte le cartelle e le sottocartelle, a partire dal percorso della cartella. La risposta getFolders restituisce un massimo di 100.000 cartelle.
Una cartella consente di organizzare sottocartelle e risorse. Tutti i nomi delle cartelle e delle risorse devono essere univoci. Le cartelle e le risorse che condividono lo stesso nome causeranno un conflitto nello spazio dei nomi, anche se si trovano in gerarchie di cartelle diverse.
Sintassi
IpsUser
IpsAdmin
IpsCompanyAdmin
TrialSiteAdmin
TrialSiteUser
ImagePortalAdmin
ImagePortalUser
ImagePortalContrib
ImagePortalContribUser
L'utente deve disporre dell'accesso in lettura alla cartella per restituire i dati in essa contenuti.
Input (getFoldersParam)
Nome | Tipo | Obbligatorio | Descrizione |
---|---|---|---|
companyHandle | xsd:string |
Sì | La maniglia per l'azienda. |
accessUserHandle | xsd:string |
No | Utilizzato dagli amministratori per rappresentare un utente specifico. |
accessGroupHandle | xsd:string |
No | Filtra per un gruppo specifico. |
folderPath | xsd:string |
No | La cartella principale per recuperare le cartelle e tutte le sottocartelle al livello foglia. Se non specificato, viene utilizzata la directory principale della società. |
assetTypeArray | types:StringArray |
No | Restituisce cartelle che contengono solo i tipi di risorse specificati. |
responseFieldArray | types:StringArray |
No | Contiene un elenco di campi che si desidera includere nella risposta. |
excludeFieldArray | types:StringArray |
No | Contiene un elenco di campi che desideri escludere dalla risposta. |
Output (getFoldersReturn)
Nome | Tipo | Obbligatorio | Descrizione |
---|---|---|---|
folderArray | types:FolderArray |
No | Matrice di cartelle che corrispondono ai criteri di filtro. La risposta è limitata a massimo 100.000 cartelle. |
permissionsSetArray | types:PermissionSetArray |
Questo esempio di codice restituisce un array che contiene tutte le cartelle di un’azienda insieme a informazioni specifiche su ciascuna cartella.
Request Contents (Richiesta contenuto)
<ns1:getFoldersParam xmlns:ns1="http://www.scene7.com/IpsApi/xsd">
<ns1:companyHandle>47</ns1:companyHandle>
</ns1:getFoldersParam>
Risposta
<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>