DokumentationDynamic Media Image Production System-API

getFolders getfolders

Last update: Sat Nov 04 2023 00:00:00 GMT+0000 (Coordinated Universal Time)

Erstellt für:

  • Developer
  • Admin

Gibt alle Ordner und Unterordner zurück, beginnend mit dem Ordnerpfad. Die Antwort getFolders gibt maximal 100.000 Ordner zurück.

Zweck der Ordner section-66e344d5333f42f1b060a0cba25935c3

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 section-0dc7e17cb60f4cf7bcdb76648e5d2f8e

  • IpsUser
  • IpsAdmin
  • IpsCompanyAdmin
  • TrialSiteAdmin
  • TrialSiteUser
  • ImagePortalAdmin
  • ImagePortalUser
  • ImagePortalContrib
  • ImagePortalContribUser
NOTE
Der Benutzer muss Lesezugriff auf den Ordner haben, um Daten darauf zurückzugeben.

Parameter section-0c1976503eaa418a9226b51667901176

Eingabe (getFoldersParam)

Name
Typ
Erforderlich
Beschreibung
companyHandle
xsd:string
Ja
Der Handle für das Unternehmen.
accessUserHandle
xsd:string
Nein
Wird von Administratoren verwendet, um die Identität eines bestimmten Benutzers zu übernehmen.
accessGroupHandle
xsd:string
Nein
Filtern nach einer bestimmten Gruppe.
folderPath
xsd:string
Nein
Der Stammordner zum Abrufen von Ordnern und allen Unterordnern auf Blattebene. Wenn diese Option ausgeschlossen ist, wird der Stammordner des Unternehmens verwendet.
assetTypeArray
types:StringArray
Nein
Gibt Ordner zurück, die nur bestimmte 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 von Feldern, 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 section-b5cb06e9fb9945ad898dbdc3692b754e

Dieses Codebeispiel gibt ein Array zurück, das alle Ordner für ein Unternehmen sowie spezifische Informationen zu den einzelnen Ordnern enthält.

Anforderung

<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