Search
K
Konnect Service Catalog

CursorPageParameters

object
sizeinteger

The number of items included per page.

Example:10

afterstring

Cursor param specifying the page (i.e. the next page) of data returned.

Example:ewogICJpZCI6ICJoZWxsbyB3b3JsZCIKfQ

beforestring

Cursor param specifying the page (i.e. the previous page) of data returned.

Example:ewogICJpZCI6ICJoZWxsbyB3b3JsZCIKfQ

Example

StringFieldFilterExact

object

Filter using one of the following operators: eq, oeq, neq

* Additional properties are NOT allowed.
eqstring

The field exactly matches the provided value.

Example:?filter[field_name_here][eq]=foo

oeqstring

The field matches any of the provided values.

Example:?filter[field_name_here][oeq]=foo,bar

neqstring

The field does not match the provided value.

Example:?filter[field_name_here][neq]=bar

Example

CursorMetaPage

object
firststring(path)

URI to the first page

laststring(path)

URI to the last page

nextstring(path)required

URI to the next page

previousstring(path)required

URI to the previous page

sizenumberrequired

Requested page size

Example:10

Example

CursorMeta

object

Pagination metadata.

pageobjectrequired
Show Child Parameters
Example

Slug

string

document slug

Match pattern:^[\w\/-]+$

<= 512 characters

Example