get-page

A custom operation to get a specific subset (page) of entries from the list resource.

Input Parameters

Name Cardinality Type Description
count 1..1

integer

The number of entries per page.

offset 1..1

integer

The starting number out of total entries to retrieve.

orderBy 0..1

string

The column name to use for sorting the list. Sort order will be ascending.

Output Parameters

Name Cardinality Type Description
list 1..1

List

The list resource that corresponds to the ‘id’, with a subset of entries based on the ‘count’ and the ‘offset’. Optionally sorted ascending using the ‘orderBy’.


Back to Operations