Interface GetConnectionsRequest

Hierarchy

  • GetConnectionsRequest

Properties

fields? from? include_fields? include_totals? name? page? per_page? strategy? take?

Properties

Optional fields

fields?: string

A comma separated list of fields to include or exclude (depending on include_fields) from the result, empty to retrieve all fields

Optional from

from?: string

Optional Id from which to start selection.

Optional include_fields

include_fields?: boolean

true if the fields specified are to be included in the result, false otherwise (defaults to true)

Optional include_totals

include_totals?: boolean

true if a query summary must be included in the result, false otherwise. Not returned when using checkpoint pagination. Default false.

Optional name

name?: string

Provide the name of the connection to retrieve

Optional page

page?: number

The page number. Zero based

Optional per_page

per_page?: number

The amount of entries per page. Default: no paging is used, all connections are returned

Optional strategy

strategy?: GetConnectionsStrategyEnum[]

Provide strategies to only retrieve connections with such strategies

Optional take

take?: number

Number of results per page. Defaults to 50.

Settings

Member Visibility

Theme

On This Page