最新バージョン
Shield情報バリアのセグメントのリストを取得
APIバージョン 2024.0
指定した情報バリアIDのShield情報バリアのセグメントオブジェクトのリストを取得します。
リクエスト
bearer [ACCESS_TOKEN]
application/json
クエリパラメータ
integer (int64)クエリ内省略可能
10001000返す項目の1ページあたりの最大数。
stringクエリ内省略可能
JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii結果が返される開始位置のマーカー。マーカーベースのページ割りを使用している場合に使用されます。
これを使用するには、usemarkerをtrueに設定する必要があります。
stringクエリ内必須
1910967Shield情報バリアのID。
レスポ ンス
application/jsonShield情報バリアのセグメントのリスト
Shield情報バリアのセグメントオブジェクトのページ割りされたリストを返します。
application/json クライアントエラー
指定されたIDのShield情報バリアが見つからなかった場合はnot_foundエラーを返します。
application/jsonクライアントエラー
予期しないクライアントエラー。
リクエストの例
TypeScript Gen
await client.shieldInformationBarrierSegments.getShieldInformationBarrierSegments(
{
shieldInformationBarrierId: barrierId,
} satisfies GetShieldInformationBarrierSegmentsQueryParams,
);Python Gen
client.shield_information_barrier_segments.get_shield_information_barrier_segments(
barrier_id
).NET Gen
await client.ShieldInformationBarrierSegments.GetShieldInformationBarrierSegmentsAsync(queryParams: new GetShieldInformationBarrierSegmentsQueryParams(shieldInformationBarrierId: barrierId));Node
const result = await client.shieldInformationBarrierSegments.getAll({
shield_information_barrier_id: '123'
});
console.log(`There are ${result.entries.length} shield information barrier segments`);レスポンスの例
{
"entries": [
{
"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.'",
"id": "11446498",
"name": "Investment Banking",
"shield_information_barrier": {
"id": "11446498",
"type": "shield_information_barrier"
},
"type": "shield_information_barrier_segment",
"updated_at": "2020-07-26T18:44:45.869Z",
"updated_by": {
"id": "11446498",
"type": "user"
}
}
],
"limit": 1000,
"next_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii"
}