指定したIDのShield情報バリアの変更されたステータスを追加

post

https://api.box.com/2.0

/shield_information_barriers/change_status

指定されたIDのShield情報バリアのステータスを変更します。

リクエスト

authorizationbearer [ACCESS_TOKEN]

content-typeapplication/json

リクエスト本文

id string本文内必須

例"1910967"

Shield情報バリアのID。

status string本文内必須

例"pending"

Shield情報バリアの任意のステータス。

次の値のいずれか1つ: pending,disabled

レスポンス

200application/jsonShield情報バリア

更新されたShield情報バリアオブジェクトを返します。

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

Shield情報バリアが見つからなかった場合はnot_foundエラーを返します。

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

既存の情報バリアとの競合が存在する場合はエラーを返します。

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

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

post

指定したIDのShield情報バリアの変更されたステータスを追加

このドキュメント内で一部のAPIを試せるようになりました。

リクエストの例

const barrier = await client.shieldInformationBarriers.changeStatusById({
    id: 12345,
    status: 'pending',
});
console.log(
    `Shield information barrier id ${barrier.id} status is ${barrier.status}`
);

レスポンスの例

{
  "id": "11446498",
  "type": "shield_information_barrier",
  "created_at": "2020-06-26T18:44:45.869Z",
  "created_by": {
    "id": "11446498",
    "type": "user"
  },
  "enabled_at": "2020-07-26T18:44:45.869Z",
  "enabled_by": {
    "id": "11446498",
    "type": "user"
  },
  "enterprise": {
    "id": "1910967",
    "type": "enterprise"
  },
  "status": "draft",
  "updated_at": "2020-07-26T18:44:45.869Z",
  "updated_by": {
    "id": "11446498",
    "type": "user"
  }
}