GetLargePersonGroups interface
メソッド
| get(Get |
大規模人物グループは、largePersonGroupId のアルファベット順に格納されます。
先端
|
メソッドの詳細
get(GetLargePersonGroupsParameters)
大規模人物グループは、largePersonGroupId のアルファベット順に格納されます。
-
- "start" パラメーター (文字列、省略可能) は、返されるエントリの ID 値が文字列比較に基づいて大きい ID を持つ値を指定します。 "start" を空の値に設定すると、最初の項目からエントリを返す必要があることを示します。
- "top" パラメーター (int, optional) は、返されるエントリの最大数を決定します。1 回の呼び出しあたり最大 1000 エントリの制限があります。 この制限を超える追加のエントリを取得するには、現在の呼び出しで返された最後のエントリの personId で "start" を指定します。
先端
- たとえば、"itemId1"、...、"itemId5" という ID を持つ項目が合計 5 個あります。
- "start=&top=" は、5 つの項目をすべて返します。
- "start=&top=2" は "itemId1", "itemId2" を返します。
- "start=itemId2&top=3" は 、"itemId3"、"itemId4"、"itemId5" を返します。
function get(options?: GetLargePersonGroupsParameters): StreamableMethod<GetLargePersonGroups200Response | GetLargePersonGroupsDefaultResponse>パラメーター
- options
- GetLargePersonGroupsParameters
