Documentazione API di Dynamic Medie Image Production System

getFolderTree

Ultimo aggiornamento: 20 luglio 2024

Argomenti:

Creato per:

Sviluppatore
Amministratore

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

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

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

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.

Richiesta

<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