ListRequestParameters

The set of parameters for returning a list of records.

JSON Example

{
    "site_id": [
        "string"
    ],
    "cursor": "string",
    "offset": 0,
    "page_size": 0,
    "sort_ascending": false,
    "sort_by": "string"
}

array of string

site_id

Optional

Constraints: maxItems: 1

Query list of records based on local manager identifiers.

string

cursor

Optional

A cursor to keep track of pages returned by the backend (a page number). This property is deprecated. Use the type offset instead.

integer

offset

Optional

Constraints: default: 0

Offset pagination parameter used to exclude from a response the first N items of a resource collection. Combine the limit and the page_size options to request a particular set or page of items.

integer As int32 As int32

page_size

Optional

Constraints: default: 1000

Number of records to be returned in the API request from the provided offset

boolean

sort_ascending

Optional

True, if the list of records returned need to be sorted in ascending order, false otherwise.

string

sort_by

Optional

The parameter name on which to sort the list of records. Only top-level parameters in the returned list of records will be supported. If not provided, system will define the parameter by which results are sorted.