getFolderTree

返回分层树结构中的文件夹和子文件夹。 getFolderTree响应最多限制为100,000个文件夹

语法

授权用户类型

  • IpsUser
  • IpsAdmin
  • IpsCompanyAdmin
  • TrialSiteAdmin
  • TrialSiteUser
  • ImagePortalContrib
  • ImagePortalContribUser
注意

用户必须具有对文件夹的读取权限才能返回其上的数据。

参数

输入(getFolderTreeParam)

名称 类型 必需 说明
*companyHandle* xsd:string 公司的把手。
*accessUserHandle* xsd:string 仅供管理员模拟特定用户。
*accessGroupHandle* xsd:string 用于按特定组进行过滤,包括公司所属的任何组。
*folderPath* xsd:string 用于将文件夹及所有子文件夹检索到叶级别的根文件夹。 如果排除,则使用公司根。
*深度* xsd:int 值为零将获取顶级文件夹。 任何其他值指定要向下到树中的深度。
*assetTypeArray* types:StringArray 返回仅包含指定资产类型的文件夹。
*responseFieldArray* types:StringArray 包含要包含在响应中的字段列表。
*excludeFieldArray* types:StringArray 包含要在响应中排除的字段列表。

输出(getFolderTreeReturn)

名称 类型 必需 说明
*文件夹* types:folders 树结构中文件夹的层次结构。 响应最多限制为100,000个文件夹。
*permissionSetArray* types:PermissionSetArray

示例

此代码示例使用公司句柄和深度参数来确定响应应返回的深度级别。 响应包含相关的文件夹和子文件夹数组。 将深度值设置为较小的数字,以便在文件夹树中进行更深入的搜索。

请求

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

响应

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

在此页面上