getFolders

Retorna todas as pastas e subpastas, começando no caminho da pasta. A resposta getFolders retorna um máximo de 100.000 pastas.

Propósito das Pastas

Uma pasta permite organizar subpastas e ativos. Todos os nomes de pastas e ativos devem ser exclusivos. Pastas e ativos que compartilham o mesmo nome causarão um conflito de namespaces, mesmo se estiverem em hierarquias de pastas diferentes.
Sintaxe

Tipos de usuário autorizados

  • IpsUser
  • IpsAdmin
  • IpsCompanyAdmin
  • TrialSiteAdmin
  • TrialSiteUser
  • ImagePortalAdmin
  • ImagePortalUser
  • ImagePortalContrib
  • ImagePortalContribUser
OBSERVAÇÃO

O usuário deve ter acesso de leitura à pasta para retornar os dados nela contidos.

Parâmetros

Entrada (getFoldersParam)

Nome Tipo Obrigatório Descrição
*companyHandle* xsd:string Sim A alça da empresa.
*accessUserHandle* xsd:string Não Usado pelos administradores para representar um usuário específico.
*accessGroupHandle* xsd:string Não Filtrar por um grupo específico.
*folderPath* xsd:string Não A pasta raiz para recuperar pastas e todas as subpastas no nível da folha. Se excluído, a raiz da empresa será usada.
*assetTypeArray* types:StringArray Não Retorna pastas que contêm apenas tipos de ativos especificados.
*responseFieldArray* types:StringArray Não Contém uma lista de campos que você deseja incluir na resposta.
*excludeFieldArray* types:StringArray Não Contém uma lista de campos que você deseja excluir da resposta.

Saída (getFoldersReturn)

Nome Tipo Obrigatório Descrição
*folderArray* types:FolderArray Não Uma matriz de pastas que correspondem aos critérios do filtro. A resposta é limitada a no máximo 100.000 pastas.
*permissionsSetArray* types:PermissionSetArray

Exemplos

Essa amostra de código retorna uma matriz que contém todas as pastas de uma empresa, juntamente com informações específicas sobre cada pasta.

Solicitação

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

Resposta

<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>

Nesta página