PageResponse

Table of contents

  1. Description
  2. Constructor properties
  3. @Example

Description

Paged response is a common object for the Configuration API returned when searching for all entities of a given type.

Constructor properties

Field Type Description
results Action | Condition | Subscription[] (object[]) An array of entities
metadata PageMetadata (object) Describes the metadata of a paginated response

@Example

const pagedResponse = {
    results: [],
    page: 0,
    pageSize: 100,
    totalPages: 1,
    totalResultsCount: 0
}