DocumentazioneAPI di Dynamic Media Image Production System

getFolderTree getfoldertree

Last update: Mon May 22 2023 00:00:00 GMT+0000 (Coordinated Universal Time)

Creato per:

  • Developer
  • Admin

Restituisce cartelle e sottocartelle in una struttura ad albero gerarchica. La risposta getFolderTree è limitata a un massimo di 100.000 cartelle

Sintassi

Tipi di utenti autorizzati section-66ef19149f4d4123a3a99004b5a2743e

  • IpsUser
  • IpsAdmin
  • IpsCompanyAdmin
  • TrialSiteAdmin
  • TrialSiteUser
  • ImagePortalContrib
  • ImagePortalContribUser
NOTE
L'utente deve disporre dell'accesso in lettura alla cartella per restituire i dati in essa contenuti.

Parametri section-0c2b30513f1e439cbd840e8cc6465b3a

Input (getFolderTreeParam)

Nome
Tipo
Obbligatorio
Descrizione
companyHandle
xsd:string
Sì
La maniglia per l'azienda.
accessUserHandle
xsd:string
No
Utilizzato solo dagli amministratori per rappresentare un utente specifico.
accessGroupHandle
xsd:string
No
Utilizzato per filtrare per un gruppo specifico, compresi quelli a cui appartiene l’azienda.
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à.
profondità
xsd:int
Sì
Un valore pari a zero ottiene la cartella di livello superiore. Qualsiasi altro valore specifica la profondità da scendere nell'albero.
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 nella risposta.

Output (getFolderTreeReturn)

Nome
Tipo
Obbligatorio
Descrizione
cartelle
types:folders
No
Gerarchia di cartelle in una struttura ad albero. La risposta è limitata a un massimo di 100.000 cartelle.
permissionSetArray
types:PermissionSetArray

Esempi section-a9fd2edb56574dd9bf8b0f2fd89367e4

Questo esempio di codice utilizza un handle aziendale e un parametro di profondità per determinare il livello di profondità che la risposta deve restituire. La risposta contiene cartelle e array di sottocartelle con i relativi. Impostate il valore di profondità su un numero inferiore per effettuare ricerche più approfondite nella struttura ad albero delle cartelle.

Request Contents (Richiesta contenuto)

<ns1:getFolderTreeParam xmlns:ns1="http://www.scene7.com/IpsApi/xsd">
   <ns1:companyHandle>47</ns1:companyHandle>
   <ns1:depth>-1</ns1:depth>
</ns1:getFolderTreeParam>

Risposta

<getFolderTreeReturn xmlns="http://www.scene7.com/IpsApi/xsd/">
  <folders>
    <items>
      <folderHandle>f|sampleFolder/uploadTestDir/</folderHandle>
      <path>MyCompany/uploadTestDir/</path>
      <lastModified>2011-11-14T11:19:59.031-08:00</lastModified>
      <childLastModified>2011-11-14T11:19:59.031-08:00</childLastModified>
      <permissionSetHandle>pm|2</permissionSetHandle>
      <hasSubfolders>true</hasSubfolders>
      <subfolderArray>
        <items>
          <folderHandle>f|MyCompany/uploadTestDir/SubFolder/</folderHandle>
          <path>DevanCo/uploadTestDir/SubFolder/</path>
          <lastModified>2011-11-14T11:19:59.032-08:00</lastModified>
          <childLastModified>2011-11-14T11:19:59.032-08:00</childLastModified>
          <permissionSetHandle>pm|2</permissionSetHandle>
          <hasSubfolders>true</hasSubfolders>
          <subfolderArray>
            <items>
              <folderHandle>f|MyCompany/uploadTestDir/SubFolder/10/</folderHandle>
              <path>DevanCo/uploadTestDir/SubFolder/10/</path>
              <lastModified>2011-11-14T11:19:59.033-08:00</lastModified>
              <childLastModified>2011-11-14T15:06:58.563-08:00</childLastModified>
              <permissionSetHandle>pm|2</permissionSetHandle>
              <hasSubfolders>false</hasSubfolders>
            </items>
          </subfolderArray>
        </items>
      </subfolderArray>
    </items>
  </folders>
  <permissionSetArray>
    <items>
      <permissionSetHandle>pm|2</permissionSetHandle>
      <permissionArray>
        <items>
          <groupHandle>g|1</groupHandle>
          <groupName>Asset Download Group</groupName>
          <permissionType>Read</permissionType>
          <isAllowed>true</isAllowed>
          <isOverride>false</isOverride>
        </items>
        <items>
          <groupHandle>g|2</groupHandle>
          <groupName>Asset Upload Group</groupName>
          <permissionType>Read</permissionType>
          <isAllowed>true</isAllowed>
          <isOverride>true</isOverride>
        </items>
        <items>
          <groupHandle>g|2</groupHandle>
          <groupName>Asset Upload Group</groupName>
          <permissionType>Write</permissionType>
          <isAllowed>true</isAllowed>
          <isOverride>true</isOverride>
        </items>
      </permissionArray>
    </items>
  <permissionSetArray>
</getFolderTreeReturn>
recommendation-more-help
4e9b9d8c-5839-4215-aa35-01b652869681