ドキュメントDynamic Media Image Production System API

getFolderTree

最終更新日： 2024年7月22日
  • トピック：

作成対象：

  • 開発者
  • 管理者

フォルダーとサブフォルダーを階層ツリー構造で返します。 getFolderTree 応答は最大 100,000 フォルダーに制限されています

構文

許可されているユーザータイプ

  • IpsUser
  • IpsAdmin
  • IpsCompanyAdmin
  • TrialSiteAdmin
  • TrialSiteUser
  • ImagePortalContrib
  • ImagePortalContribUser
メモ
データを返すには、ユーザーにフォルダーへの読み取りアクセス権が必要です。

パラメーター

入力（getFolderTreeParam）

名前種類必須説明
companyHandlexsd:stringはい会社へのハンドル。
accessUserHandlexsd:stringいいえ管理者が特定のユーザーとして実行する場合にのみ使用します。
accessGroupHandlexsd:stringいいえ会社が属するもののいずれかを含む、特定のグループでフィルタリングするために使用されます。
folderPathxsd:stringいいえフォルダーとリーフレベルまでのすべてのサブフォルダーを取得するルートフォルダー。 除外する場合は、会社ルートが使用されます。
深さxsd:intはい値が 0 の場合は、最上位フォルダーを取得します。 その他の値は、ツリーに降りる深度を指定します。
assetTypeArraytypes:StringArrayいいえ指定したアセットタイプのみを含むフォルダーを返します。
responseFieldArraytypes:StringArrayいいえ応答に含めるフィールドのリストが含まれます。
excludeFieldArraytypes:StringArrayいいえ応答で除外するフィールドのリストが含まれます。

出力（getFolderTreeReturn）

名前種類必須説明
フォルダtypes:foldersいいえツリー構造におけるフォルダーの階層。 応答は最大 100,000 個のフォルダーに制限されます。
permissionSetArraytypes:PermissionSetArray

例

このコードサンプルでは、会社ハンドルと depth パラメーターを使用して、応答が返す深度レベルを決定します。 応答には、関連するを持つフォルダーとサブフォルダー配列が含まれます。 深さの値を小さい数に設定すると、フォルダーツリーをさらに深く検索できます。

リクエスト

<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>
recommendation-more-help
4e9b9d8c-5839-4215-aa35-01b652869681