mirror of
https://github.com/directus/directus.git
synced 2026-02-18 17:14:32 -05:00
34 lines
987 B
YAML
34 lines
987 B
YAML
type: object
|
|
properties:
|
|
fields:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: Control what fields are being returned in the object.
|
|
example: ['*', '*.*']
|
|
filter:
|
|
type: object
|
|
example: { <field>: { <operator>: <value> } }
|
|
search:
|
|
description: Filter by items that contain the given search query in one of their fields.
|
|
type: string
|
|
sort:
|
|
type: array
|
|
items:
|
|
type: string
|
|
description: How to sort the returned items.
|
|
example: ['-date_created']
|
|
limit:
|
|
type: number
|
|
description: Set the maximum number of items that will be returned
|
|
offset:
|
|
type: number
|
|
description: How many items to skip when fetching data.
|
|
page:
|
|
type: number
|
|
description: Cursor for use in pagination. Often used in combination with limit.
|
|
deep:
|
|
type: object
|
|
description: Deep allows you to set any of the other query parameters on a nested relational dataset.
|
|
example: { 'related_articles': { '_limit': 3 } }
|