Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • JsonApiGetQuery

Indexable

[key: string]: any

Index

Properties

Optional fields

fields: PlainObject<any>

The list of fields that should be requested should be an object representing the resource type and it's fields as arrays

Optional filter

filter: PlainObject<any>

The filter object for this query

Optional include

include: string | string[]

The list of included objects in this request

Optional page

page: { number?: number; size?: number }

The pagination constraints

Type declaration

  • [key: string]: any
  • Optional number?: number
  • Optional size?: number

Optional sort

sort: string | string[]

The array of sort fields. Prefix the field name with a "-" to sort descending

Generated using TypeDoc