Generic paged response returned by list endpoints.

interface PagedResponse<T> {
    isLast?: boolean;
    maxResults: number;
    startAt: number;
    total: number;
    values: T[];
}

Type Parameters

  • T

    The type of items in the page

Properties

isLast?: boolean

Whether this is the last page (used by Agile endpoints)

maxResults: number

Maximum number of items requested

startAt: number

Index of the first item in this page

total: number

Total number of items matching the query

values: T[]

The items in this page