latestOpenAPI 3.0.32026-08-109359194.9 KB

112399a67ebb

Search Configs
Query

Execute a Query

Requires "enable-search-service-for-query" feature flag. Must be an administrator or super-user to use this endpoint. Executes a Query to return records.

Authorization Required:

  • Express Super User or Designer Administrator
post/searchConfigs/{queryId}/execute

Path parameters

queryIdstring required

Unique Query ID

Query parameters

countOnlyboolean

Only return the number of records that match the search parameters. These options override the options set in the query itself

limitinteger

Number of records to return. Default and max limit of 50. These options override the options set in the query itself.

offsetinteger

Number of records to skip before selecting records. Offset is zero based. These options override the options set in the query itself.

sortstring

Name of the field(s) to sort on and the sort direction, can be 1 (ascending) or -1 (descending), separated by a semi-colon. Multiple fields are separated by a comma. Ex. '?firstName:-1,lastName:1'. These options override the options set in the query itself

Request body

object required

Example request

{
  "variable1": "variableValue1",
  "variable2": "variableValue2"
}

Response

Array of records matching the query

idstring

Id of Model Record

dataobject

Data Model data stored in Model Record

ownerstring

Owner of Data Model Record

createdstring

Timestamp of Model Record creation

archivedboolean

Whether or not the Model Record has been archived