Interface PaginatedQuery

A standard query for a paginated endpoint

interface PaginatedQuery {
    expand?: string[];
    filter?: string;
    order?: {
        asc: "ASC" | "DESC";
        field: string;
    }[];
    pagination: TokenPagination | OffsetPagination;
}

Properties

expand? filter? order? pagination

Properties

Optional expand

expand?: string[]

Fields to expand on the response

Optional filter

filter?: string

A filter string. This is passed directly to $filter

Optional order

order?: {
    asc: "ASC" | "DESC";
    field: string;
}[]

A list of fields to order by.

Type declaration

  • asc: "ASC" | "DESC"
  • field: string

pagination

pagination: TokenPagination | OffsetPagination

Pagination configuration. Token and offset pagination are both supported

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc