Udostępnij za pośrednictwem


GetPersonGroups interface

Metody

get(GetPersonGroupsParameters)

Grupy osób są przechowywane w kolejności alfabetycznej personGroupId.

    • Parametr "start" (ciąg, opcjonalny) określa wartość identyfikatora, z której zwrócone wpisy będą miały większe identyfikatory na podstawie porównania ciągów. Ustawienie wartości "start" na wartość pustą wskazuje, że wpisy powinny być zwracane od pierwszego elementu.
    • Parametr "top" (int, optional) określa maksymalną liczbę wpisów do zwrócenia, z limitem do 1000 wpisów na wywołanie. Aby pobrać dodatkowe wpisy wykraczające poza ten limit, określ wartość "start" z identyfikatorem personId ostatniego wpisu zwróconego w bieżącym wywołaniu.

Napiwek

  • Na przykład istnieje łącznie 5 elementów z ich identyfikatorami: "itemId1", ..., "itemId5".
    • Wyrażenie "start=&top=" zwróci wszystkie 5 elementów.
    • Wyrażenie "start=&top=2" zwróci wartość "itemId1", "itemId2".
    • Wyrażenie "start=itemId2&top=3" zwróci wartość "itemId3", "itemId4", "itemId5".

Szczegóły metody

get(GetPersonGroupsParameters)

Grupy osób są przechowywane w kolejności alfabetycznej personGroupId.

    • Parametr "start" (ciąg, opcjonalny) określa wartość identyfikatora, z której zwrócone wpisy będą miały większe identyfikatory na podstawie porównania ciągów. Ustawienie wartości "start" na wartość pustą wskazuje, że wpisy powinny być zwracane od pierwszego elementu.
    • Parametr "top" (int, optional) określa maksymalną liczbę wpisów do zwrócenia, z limitem do 1000 wpisów na wywołanie. Aby pobrać dodatkowe wpisy wykraczające poza ten limit, określ wartość "start" z identyfikatorem personId ostatniego wpisu zwróconego w bieżącym wywołaniu.

Napiwek

  • Na przykład istnieje łącznie 5 elementów z ich identyfikatorami: "itemId1", ..., "itemId5".
    • Wyrażenie "start=&top=" zwróci wszystkie 5 elementów.
    • Wyrażenie "start=&top=2" zwróci wartość "itemId1", "itemId2".
    • Wyrażenie "start=itemId2&top=3" zwróci wartość "itemId3", "itemId4", "itemId5".
function get(options?: GetPersonGroupsParameters): StreamableMethod<GetPersonGroups200Response | GetPersonGroupsDefaultResponse>

Parametry

Zwraca