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

get

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。

レスポンス

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

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

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

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

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

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

get

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

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

ログイン

リクエストの例

TypeScript Gen

await client.shieldInformationBarrierSegments.getShieldInformationBarrierSegmentById(
  segmentId,
);

Python Gen

client.shield_information_barrier_segments.get_shield_information_barrier_segment_by_id(
    segment_id
)

.NET Gen

await client.ShieldInformationBarrierSegments.GetShieldInformationBarrierSegmentByIdAsync(shieldInformationBarrierSegmentId: segmentId);

Node

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

レスポンスの例

{
  "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"
  }
}