DocumentaciónAPI del sistema de producción de imágenes Dynamic Media

getFolders getfolders

Last update: Mon Jul 22 2024 00:00:00 GMT+0000 (Coordinated Universal Time)
  • Temas:

Creado para:

  • Desarrollador
  • Administrador

Devuelve todas las carpetas y subcarpetas, empezando por la ruta de carpeta. La respuesta getFolders devuelve un máximo de 100 000 carpetas.

Finalidad de las carpetas section-66e344d5333f42f1b060a0cba25935c3

Una carpeta permite organizar subcarpetas y recursos. Todos los nombres de carpetas y recursos deben ser únicos. Las carpetas y recursos que comparten el mismo nombre causan un conflicto de área de nombres, incluso si están en jerarquías de carpetas diferentes.
Sintaxis

Tipos de usuarios autorizados section-0dc7e17cb60f4cf7bcdb76648e5d2f8e

  • IpsUser
  • IpsAdmin
  • IpsCompanyAdmin
  • TrialSiteAdmin
  • TrialSiteUser
  • ImagePortalAdmin
  • ImagePortalUser
  • ImagePortalContrib
  • ImagePortalContribUser
NOTE
El usuario debe tener acceso de lectura a la carpeta para devolver datos sobre ella.

Parámetros section-0c1976503eaa418a9226b51667901176

Entrada (getFoldersParam)

Nombre
Tipo
Obligatorio
Descripción
companyHandle
xsd:string
Sí
El identificador de la compañía.
accessUserHandle
xsd:string
No
Los administradores los utilizan para suplantar a un usuario específico.
accessGroupHandle
xsd:string
No
Filtre por un grupo específico.
folderPath
xsd:string
No
La carpeta raíz para recuperar carpetas y todas las subcarpetas al nivel de hoja. Si se excluye, se utiliza la raíz de la empresa.
assetTypeArray
types:StringArray
No
Devuelve carpetas que solo contienen tipos de recursos especificados.
responseFieldArray
types:StringArray
No
Contiene una lista de los campos que desea incluir en la respuesta.
excludeFieldArray
types:StringArray
No
Contiene una lista de los campos que desea excluir de la respuesta.

Salida (getFoldersReturn)

Nombre
Tipo
Obligatorio
Descripción
folderArray
types:FolderArray
No
Matriz de carpetas que coinciden con los criterios de filtro. La respuesta está limitada a un máximo de 100 000 carpetas.
permissionsSetArray
types:PermissionSetArray

Ejemplos section-b5cb06e9fb9945ad898dbdc3692b754e

Este ejemplo de código devuelve una matriz que contiene todas las carpetas de una compañía junto con información específica sobre cada carpeta.

Solicitud

<ns1:getFoldersParam xmlns:ns1="http://www.scene7.com/IpsApi/xsd">
   <ns1:companyHandle>47</ns1:companyHandle>
</ns1:getFoldersParam>

Respuesta

<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