Box Developerドキュメント
ログイン
最新バージョン

フォルダロックのリストを取得

get
https://api.box.com/2.0
/folder_locks

このエンドポイントはバージョン2024.0です。引き続き使用するために 変更は必要ありません。詳細については、 **Box APIのバージョン管理**を参照してください。

指定したフォルダのフォルダロックの詳細を取得します。

このエンドポイントを使用するには、フォルダの所有者または共同所有者として認証されている必要があります。

関連するガイド

リクエスト

bearer [ACCESS_TOKEN]
application/json

クエリパラメータ

stringクエリ内必須
12345

フォルダを表す一意の識別子。

フォルダIDを確認するには、ウェブアプリケーションでこのフォルダにアクセスして、URLからIDをコピーします。たとえば、URLがhttps://*.app.box.com/folder/123の場合、folder_idは123です。

Boxアカウントのルートフォルダは常にID 0で表されます。

レスポンス

application/jsonフォルダロック

フォルダに適用されたすべてのフォルダロックの詳細 (ロックの種類やロックを適用したユーザーを含む) を返します。

application/jsonクライアントエラー

Authorizationヘッダーで指定されているアクセストークンが認識されないか、指定されていない場合に返されます。

application/jsonクライアントエラー

フォルダが見つからない場合、またはユーザーにフォルダへのアクセス権限が与えられていない場合に返されます。

application/jsonクライアントエラー

folder_idが認識されていない形式で指定されている場合に返されます。

application/jsonクライアントエラー

予期しないクライアントエラー。

get
フォルダロックのリストを取得
このドキュメント内で一部のAPIを試せるようになりました。
ログイン

リクエストの例

cURL
curl -i -X GET "https://api.box.com/2.0/folder_locks?folder_id=33552487093" \
     -H "authorization: Bearer <ACCESS_TOKEN>"
TypeScript Gen
await client.folderLocks.getFolderLocks({
  folderId: folder.id,
} satisfies GetFolderLocksQueryParams);
Python Gen
client.folder_locks.get_folder_locks(folder.id)
.NET Gen
await client.FolderLocks.GetFolderLocksAsync(queryParams: new GetFolderLocksQueryParams(folderId: folder.Id));

レスポンスの例

{
  "entries": [
    {
      "created_at": "2020-09-14T23:12:53Z",
      "created_by": {
        "id": "11446498",
        "type": "user"
      },
      "folder": {
        "etag": "1",
        "id": "12345",
        "type": "folder",
        "name": "Contracts",
        "sequence_id": "3"
      },
      "id": "12345678",
      "lock_type": "freeze",
      "locked_operations": {
        "delete": true,
        "move": true
      },
      "type": "folder_lock"
    }
  ],
  "limit": "1000",
  "next_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii"
}