BoxWorks 2024でコンテンツとAIの可能性について紹介します。

詳細を表示

Shield情報バリアレポートのリストを取得

get
https://api.box.com/2.0
/shield_information_barrier_reports

Shield情報バリアレポートのリストを取得します。

リクエスト

bearer [ACCESS_TOKEN]
application/json

クエリパラメータ

integer (int64)クエリ内省略可能
10001000

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

stringクエリ内省略可能
JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii

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

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

stringクエリ内必須
1910967

Shield情報バリアのID。

レスポンス

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

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

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

get
Shield情報バリアレポートのリストを取得
このドキュメント内で一部のAPIを試せるようになりました。
ログイン

リクエストの例

TypeScript Gen
await client.shieldInformationBarrierReports.getShieldInformationBarrierReports(
  {
    shieldInformationBarrierId: barrierId,
  } satisfies GetShieldInformationBarrierReportsQueryParams
);
Python Gen
client.shield_information_barrier_reports.get_shield_information_barrier_reports(
    barrier_id
)
.NET Gen
await client.ShieldInformationBarrierReports.GetShieldInformationBarrierReportsAsync(queryParams: new GetShieldInformationBarrierReportsQueryParams(shieldInformationBarrierId: barrierId));
Node
const result = await client.shieldInformationBarrierReports.getAll({
	shield_information_barrier_id: '123'
});
console.log(`There are ${result.entries.length} shield information barrier reports`);

レスポンスの例

{
  "entries": [
    {
      "id": "11446498",
      "type": "shield_information_barrier_report",
      "shield_information_barrier": {
        "shield_information_barrier": {
          "id": "11446498",
          "type": "shield_information_barrier"
        }
      },
      "status": "pending",
      "details": {
        "details": {
          "folder_id": "124235"
        }
      },
      "created_at": "2020-06-26T18:44:45.869Z",
      "created_by": {
        "id": "11446498",
        "type": "user"
      },
      "updated_at": "2020-07-26T18:44:45.869Z"
    }
  ],
  "limit": 1000,
  "next_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii"
}