メインコンテンツへスキップ
POST
/
folder_locks
cURL
curl -i -X POST "https://api.box.com/2.0/folder_locks" \
     -H "authorization: Bearer <ACCESS_TOKEN>" \
     -H "content-type: application/json" \
     -d '{
       "folder": {
         "type": "folder",
         "id": "33552487093"
       },
       "locked_operations": {
         "move": true,
         "delete": true
       }
     }'
{
  "folder": {
    "id": "12345",
    "type": "folder",
    "etag": "1",
    "sequence_id": "3",
    "name": "Contracts"
  },
  "id": "12345678",
  "type": "folder_lock",
  "created_by": {
    "id": "11446498",
    "type": "user"
  },
  "created_at": "2020-09-14T23:12:53Z",
  "locked_operations": {
    "move": true,
    "delete": true
  },
  "lock_type": "freeze"
}
このリソースは、バージョン2024.0のエンドポイントで使用されています。 詳細については、 Box APIのバージョン管理を参照してください。Box SDKのバージョニング戦略について詳しく学ぶ。」

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Body

application/json
folder
object
required

ロックの適用先となるフォルダ。

locked_operations
object

フォルダをロックする操作。locked_operationsがリクエストに含まれている場合は、movedeleteの両方も含めたうえで、どちらもtrueに設定する必要があります。

Response

ロックを適用したユーザーや設定された操作など、フォルダに適用されたフォルダロックのインスタンスを返します。

フォルダロックでは、特定のフォルダが移動または削除されないように、フォルダ所有者によって設定されるアクセス制限を定義します。

folder
フォルダ (Mini) · object

ロックが適用されるフォルダ。

id
string

このフォルダロックの一意の識別子。

Example:

"12345678"

type
string

オブジェクトタイプ (常にfolder_lock)。

Example:

"folder_lock"

created_by
ユーザー (Base) · object

ロックを作成したユーザーまたはグループ。

created_at
string<date-time>

フォルダロックオブジェクトが作成された日時。

Example:

"2020-09-14T23:12:53Z"

locked_operations
object

ロックされている操作。現在、move操作とdelete操作を別々にロックすることはできません。両方ともtrueに設定する必要があります。

lock_type
string

ロックの種類 (常にfreeze)。

Example:

"freeze"