REST APIで直下の子フォルダーを一覧表示する

子フォルダーのエンドポイントはフォルダーだけを返します。ツリーの1階層を遅延読み込みする場合に使用してください。呼び出し元がファイルも必要とする場合は、ファイル一覧エンドポイントを使用してください。

エンドポイントの仕様

GET /api/folders/children?workspace_id=wks_…&parent_id=fld_…を呼び出してください。parent_idを省略するとルートフォルダーをリクエストします。応答は直下の子だけを含む{ok:true,folders:[…]}です。ページ分割はありません。

各行にはid、name、parent_id、file_count、has_childrenが含まれます。内部の非表示状態の列はシリアライズ前に除外されます。

手順

1. RESTを許可し、フォルダーに固定されておらず、access_filesを持つロールに属する読み取り専用またはフルアクセスのキーを使用してください。
2. 信頼できるフォルダーの応答から既知の親IDを選ぶか、ワークスペースのルートを指定するためにパラメーターを省略してください。
3. workspace_idと必要に応じてparent_idを付けて子フォルダーをリクエストし、HTTP 200とok:trueを確認してください。
4. 返されたすべての行のparent_idがリクエストと一致することを確認し、画面で展開を提供するかどうかをhas_childrenで判断してください。
5. file_countはフォルダー行のメタデータとして扱ってください。この応答にはファイルオブジェクトや継続フィールドは含まれません。
6. ファイルが必要な場合はGET /api/files?workspace_id=wks_…&folder_id=fld_…を呼び出し、別のfolders、files、ページ分割データを照合してください。

アクセスとプライバシーの動作

workspace_idが存在しない場合はworkspace_id is requiredが返ります。メンバーでない場合はNot a memberが返ります。このリクエスト元に非表示の親には404 Folder not foundが返り、制限されたメンバーのフォルダー範囲外の親にはThis folder is outside the folder you're confined toが返ります。

フォルダーに範囲を制限されたメンバーがparent_idを省略すると、そのメンバーの固定先が一覧のルートになります。これはAPIキーのフォルダー固定先とは異なります。固定された通常の認証情報はRESTでは拒否されるため、WebDAVまたはS3を使用してください。

このエンドポイントは子孫を再帰的に返しません。返されたIDのhas_childrenの値が真の場合に、再度呼び出してください。

期待される結果

本文には選択した親の直下にある表示可能なフォルダーだけが含まれます。ファイルの取得、ファイルのページ分割、さらに深い階層の展開には、それぞれ明示的なリクエストが必要です。

関連ガイド

• APIでファイルを一覧表示する
• APIエラーに対処する