Function getAllPaginatedResults

  • getAllPaginatedResults(token, organizationContext, query, variables?, field?, limit?): Promise<any[]>

  • Get all results from a paginated GraphQL query

    Parameters

    • token: string

      Auth token. This is the token returned by get_auth_token(). Just the token, do not include "Bearer" in this string, that is handled inside the method.

    • organizationContext: string

      Organization context. This is provided by the Finite State API management. It looks like "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx".

    • query: string

      The GraphQL query string

    • Optionalvariables: Record<string, any>

      Variables to be used in the GraphQL query, by default None

    • Optionalfield: string

      The field in the response JSON that contains the results

    • Optionallimit: number

      The maximum number of results to return. By default, None to return all results. Limit cannot be greater than 1000.

    Returns Promise<any[]>

Settings

Member Visibility