v1

latestOpenAPI 3.0.12026-07-1714724311.1 KB

Presets

Create a Preset

Create a new preset.

post/presets

Query parameters

fieldsstring[]

Control what fields are being returned in the object.

metastring

What metadata to return in the response.

Request body

collectionstring required

What collection this collection preset is used for.

titlestring

Name for the bookmark. If this is set, the collection preset will be considered to be a bookmark.

rolestring

The unique identifier of a role in the platform. If user is null, this will be used to apply the collection preset or bookmark for all users in the role.

searchstring

What the user searched for in search/filter in the header bar.

layoutstring

Name of the view type that is used.

layout_querystring

Layout query that's saved per layout type. Controls what data is fetched on load. These follow the same format as the JS SDK parameters.

layout_optionsstring

Options of the views. The properties in here are controlled by the layout.

Example request

{
  "collection": "articles",
  "title": "Highly rated articles",
  "filters": [
    {
      "key": "aHKLAakdVghzD",
      "field": "rating",
      "operator": "gte"
    }
  ]
}

Response

Successful request