getFolders
Letzte Aktualisierung: 30. Dezember 2024
Erstellt für:
- Entwickler
- Admin
Gibt alle Ordner und Unterordner ausgehend vom Ordnerpfad aus zurück. Die getFolders-Antwort gibt maximal 100.000 Ordner zurück.
Zweck der Ordner
Mit einem Ordner können Sie Unterordner und Assets organisieren. Alle Ordner- und Asset-Namen müssen eindeutig sein. Ordner und Assets mit demselben Namen verursachen einen Namespace-Konflikt, auch wenn sie sich in unterschiedlichen Ordnerhierarchien befinden.
Syntax
Autorisierte Benutzertypen
IpsUser
IpsAdmin
IpsCompanyAdmin
TrialSiteAdmin
TrialSiteUser
ImagePortalAdmin
ImagePortalUser
ImagePortalContrib
ImagePortalContribUser
Der Benutzer muss über Lesezugriff auf den Ordner verfügen, um Daten darüber zurückzugeben.
Parameter
Eingabe (getFoldersParam)
Name | Typ | Erforderlich | Beschreibung |
---|---|---|---|
companyHandle | xsd:string | Ja | Der Griff zum Unternehmen. |
accessUserHandle | xsd:string | Nein | Wird von Administratoren verwendet, um die Identität eines bestimmten Benutzers auszudrücken. |
accessGroupHandle | xsd:string | Nein | Nach einer bestimmten Gruppe filtern. |
folderPath | xsd:string | Nein | Der Stammordner zum Abrufen von Ordnern und allen Unterordnern auf Blattebene. Wenn dies ausgeschlossen ist, wird der Stammordner des Unternehmens verwendet. |
assetTypeArray | types:StringArray | Nein | Gibt Ordner zurück, die nur angegebene Asset-Typen enthalten. |
responseFieldArray | types:StringArray | Nein | Enthält eine Liste von Feldern, die Sie in die Antwort aufnehmen möchten. |
excludeFieldArray | types:StringArray | Nein | Enthält eine Liste der Felder, die Sie aus der Antwort ausschließen möchten. |
Ausgabe (getFoldersReturn)
Name | Typ | Erforderlich | Beschreibung |
---|---|---|---|
folderArray | types:FolderArray | Nein | Ein Array von Ordnern, die den Filterkriterien entsprechen. Die Antwort ist auf maximal 100.000 Ordner beschränkt. |
permissionsSetArray | types:PermissionSetArray |
Beispiele
Dieses Codebeispiel gibt ein -Array zurück, das alle Ordner für ein Unternehmen zusammen mit spezifischen Informationen zu den einzelnen Ordnern enthält.
Anfrage
<ns1:getFoldersParam xmlns:ns1="http://www.scene7.com/IpsApi/xsd">
<ns1:companyHandle>47</ns1:companyHandle>
</ns1:getFoldersParam>
Antwort
<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