Box Developerドキュメント
最新バージョン

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

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

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

リクエスト

bearer [ACCESS_TOKEN]
application/json

クエリパラメータ

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

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

stringクエリ内省略可能
JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii

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

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

stringクエリ内必須
3423

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

レスポンス

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

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

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

リクエストの例

TypeScript Gen
await client.shieldInformationBarrierSegmentMembers.getShieldInformationBarrierSegmentMembers(
  {
    shieldInformationBarrierSegmentId: segment.id!,
  } satisfies GetShieldInformationBarrierSegmentMembersQueryParams,
);
Python Gen
client.shield_information_barrier_segment_members.get_shield_information_barrier_segment_members(
    segment.id
)
.NET Gen
await client.ShieldInformationBarrierSegmentMembers.GetShieldInformationBarrierSegmentMembersAsync(queryParams: new GetShieldInformationBarrierSegmentMembersQueryParams(shieldInformationBarrierSegmentId: NullableUtils.Unwrap(segment.Id)));
Node
const result = await client.shieldInformationBarrierSegmentMembers.getAll({
	shield_information_barrier_segment_id: '123'
});
console.log(`There are ${result.entries.length} shield information barrier segment members`);

レスポンスの例

{
  "entries": [
    {
      "id": "11446498",
      "type": "shield_information_barrier_segment_member",
      "user": {
        "id": "11446498",
        "type": "user"
      },
      "created_at": "2020-06-26T18:44:45.869Z",
      "created_by": {
        "id": "11446498",
        "type": "user"
      },
      "shield_information_barrier": {
        "id": "11446498",
        "type": "shield_information_barrier"
      },
      "shield_information_barrier_segment": {
        "id": "432554",
        "type": "shield_information_barrier_segment"
      },
      "updated_at": "2020-07-26T18:44:45.869Z",
      "updated_by": {
        "id": "11446498",
        "type": "user"
      }
    }
  ],
  "limit": 1000,
  "next_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii"
}