getFolders

폴더 경로에서 시작하여 모든 폴더 및 하위 폴더를 반환합니다. getFolders 응답은 최대 100,000개의 폴더를 반환합니다.

폴더 목적

폴더를 사용하면 하위 폴더와 자산을 구성할 수 있습니다. 모든 폴더 및 자산 이름은 고유해야 합니다. 동일한 이름을 공유하는 폴더 및 자산은 서로 다른 폴더 계층 유형에도 불구하고 네임스페이스 충돌이 발생합니다.
구문

인증된 사용자 유형

  • IpsUser
  • IpsAdmin
  • IpsCompanyAdmin
  • TrialSiteAdmin
  • TrialSiteUser
  • ImagePortalAdmin
  • ImagePortalUser
  • ImagePortalContrib
  • ImagePortalContribUser
노트

폴더에 대한 데이터를 반환하려면 해당 폴더에 대한 읽기 권한이 있어야 합니다.

매개 변수

입력(getFoldersParam)

이름 유형 필수 설명
*companyHandle* xsd:string 회사의 손잡이입니다.
*accessUserHandle* xsd:string 아니요 관리자가 특정 사용자를 가장하는 데 사용됩니다.
*accessGroupHandle* xsd:string 아니요 특정 그룹별로 필터링합니다.
*folderPath* xsd:string 아니요 폴더 및 모든 하위 폴더를 리프 수준으로 검색하는 루트 폴더. 제외되는 경우 회사 루트가 사용됩니다.
*assetTypeArray* types:StringArray 아니요 지정된 자산 유형만 포함하는 폴더를 반환합니다.
*responseFieldArray* types:StringArray 아니요 응답에 포함할 필드 목록을 포함합니다.
*excludeFieldArray* types:StringArray 아니요 응답에서 제외할 필드 목록을 포함합니다.

출력(getFoldersReturn)

이름 유형 필수 설명
*folderArray* types:FolderArray 아니요 필터 기준과 일치하는 폴더 배열입니다. 응답은 최대 100,000개의 폴더로 제한됩니다.
*permissionsSetArray* types:PermissionSetArray

예제

이 코드 샘플은 각 폴더에 대한 특정 정보와 함께 회사의 모든 폴더를 포함하는 배열을 반환합니다.

요청

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

응답

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

이 페이지에서는