Shield情報バリアのセグメントのリストを取得

get

https://api.box.com/2.0

/shield_information_barrier_segments

指定した情報バリアIDのShield情報バリアのセグメントオブジェクトのリストを取得します。

リクエスト

authorizationbearer [ACCESS_TOKEN]

content-typeapplication/json

クエリパラメータ

limit integer / int64クエリ内省略可能

例1000最大値1000

返す項目の1ページあたりの最大数。

marker stringクエリ内省略可能

例"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii"

結果が返される開始位置のマーカー。マーカーベースのページ割りを使用している場合に使用されます。

これを使用するには、usemarkerをtrueに設定する必要があります。

shield_information_barrier_id stringクエリ内必須

例"1910967"

Shield情報バリアのID。

レスポンス

200application/json

Shield情報バリアのセグメントオブジェクトのページ割りされたリストを返します。

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

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

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

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

get

Shield情報バリアのセグメントのリストを取得

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

リクエストの例

const result = await client.shieldInformationBarrierSegments.getAll({
	shield_information_barrier_id: '123'
});
console.log(`There are ${result.entries.length} shield information barrier segments`);