Box Developerドキュメント

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

put
https://api.box.com/2.0
/shield_information_barrier_segments/:shield_information_barrier_segment_id

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

リクエスト

bearer [ACCESS_TOKEN]
application/json

パスパラメータ

3423

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

リクエスト本文

string本文内省略可能
"'Corporate division that engages in advisory_based financial transactions on behalf of individuals, corporations, and governments.'"

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

string本文内省略可能
\S+
"Investment Banking"

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

レスポンス

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

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

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

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

put
指定したIDのShield情報バリアのセグメントを更新
このドキュメント内で一部のAPIを試せるようになりました。
ログイン

リクエストの例

TypeScript Gen
await client.shieldInformationBarrierSegments.updateShieldInformationBarrierSegmentById(
  segmentId,
  {
    requestBody: {
      description: updatedSegmentDescription,
    } satisfies UpdateShieldInformationBarrierSegmentByIdRequestBody,
  } satisfies UpdateShieldInformationBarrierSegmentByIdOptionalsInput,
);
Python Gen
client.shield_information_barrier_segments.update_shield_information_barrier_segment_by_id(
    segment_id, description=updated_segment_description
)
.NET Gen
await client.ShieldInformationBarrierSegments.UpdateShieldInformationBarrierSegmentByIdAsync(shieldInformationBarrierSegmentId: segmentId, requestBody: new UpdateShieldInformationBarrierSegmentByIdRequestBody() { Description = updatedSegmentDescription });
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"
  }
}