指定したIDのShield情報バリアのセグメントを更新

put

https://api.box.com/2.0

/shield_information_barrier_segments/:shield_information_barrier_segment_id

指定されたIDに基づいてShield情報バリアのセグメントを更新します。

リクエスト

authorizationbearer [ACCESS_TOKEN]

content-typeapplication/json

パスパラメータ

shield_information_barrier_segment_id stringパス内必須

例"3423"

Shield情報バリアのセグメントのID。

リクエスト本文

description string本文内省略可能

例

"'Corporate division that engages in advisory_based\nfinancial transactions on behalf of individuals,\ncorporations, and governments.'"

Shield情報バリアのセグメントの更新した説明。

name string本文内省略可能

例"Investment Banking"

Shield情報バリアのセグメントの更新した名前。

レスポンス

200application/jsonShield情報バリアのセグメント

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

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

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

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

同じ名前のShield情報バリアのセグメントが存在する場合はエラーを返します。

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

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

put

指定したIDのShield情報バリアのセグメントを更新

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

ログイン

リクエストの例

Node

const barrierSegment = await client.shieldInformationBarrierSegments.update({
	name: 'updated name',
	description: 'updated description',
}, {
	shield_information_barrier_segment_id: '12345'
});
console.log(`Shield information barrier segment id ${barrierSegment.id} updated`);

レスポンスの例

{
  "id": "11446498",
  "type": "shield_information_barrier_segment",
  "created_at": "2020-06-26T18:44:45.869Z",
  "created_by": {
    "id": "11446498",
    "type": "user"
  },
  "description": "'Corporate division that engages in advisory_based financial\n transactions on behalf of individuals, corporations, and governments.'",
  "name": "Investment Banking",
  "shield_information_barrier": {
    "id": "11446498",
    "type": "shield_information_barrier"
  },
  "updated_at": "2020-07-26T18:44:45.869Z",
  "updated_by": {
    "id": "11446498",
    "type": "user"
  }
}