The query parameters available for this method. HTTP queries take the form of '?contains=myTitle&containsField=name&sort=name&order=1. An equivalent task configuration would be '{`contains`: `myTitle`, `containsField`: `name`, `sort`: `name`, `order`: 1}'
{
"type": "object",
"properties": {
"queryParameters": {
"title": "queryParameters",
"type": "object",
"properties": {
"contains": {
"type": "string",
"examples": [
"event"
],
"description": "the value for a contains query. if the property with the key of containsField does not have a value that contains this string, then filter out the document"
},
"containsField": {
"type": "string",
"examples": [
"name"
],
"description": "the field to run a contains query on"
},
"equals": {
"type": "string",
"examples": [
"my event trigger"
],
"description": "the value for an equals query. if the property with the key of equalsField does not have a value that equals this string, then filter out the document"
},
"equalsField": {
"type": "string",
"examples": [
"name"
],
"description": "the field to run an equals query on"
},
"startsWith": {
"type": "string",
"examples": [
"my"
],
"description": "the value for a startsWith query. if the property with the key of startsWithField does not have a value that starts with this string, then filter out the document"
},
"startsWithField": {
"type": "string",
"examples": [
"name"
],
"description": "the field to run a startsWith query on"
},
"greaterThanField": {
"type": "string",
"examples": [
"lastExecuted"
],
"description": "the field to run a greater than query on"
},
"greaterThan": {
"type": "string",
"examples": [
"04/06/2021",
"Thu Dec 03 2020 14:55:00 GMT-0500 (Eastern Standard Time)",
"2020-12-03T19:55:43.189Z",
"1617681600000"
],
"description": "the value to use for the greater than query. If the value is a valid date string, then it will be converted to a unix timestamp in milliseconds"
},
"lessThanField": {
"type": "string",
"examples": [
"lastExecuted"
],
"description": "the field to run a less than query on"
},
"lessThan": {
"type": "string",
"examples": [
"04/06/2021",
"Thu Nov 15 2018 01:30:00 GMT-0500 (Eastern Standard Time)",
"2020-12-03T19:55:43.189Z",
"1615611600000"
],
"description": "the value to use for the less than query. If the value is a valid date string, then it will be converted to a unix timestamp in milliseconds"
},
"enabled": {
"type": "boolean",
"description": "if true, then only return trigger documents that are enabled"
},
"actionId": {
"type": "string",
"description": "if provided, only return trigger documents with this action id"
},
"limit": {
"type": "integer",
"description": "Number of results to return. Used for pagination.",
"default": 25,
"minimum": 0,
"examples": [
1,
10,
50
]
},
"skip": {
"type": "integer",
"description": "Number of results to skip. Used for pagination.",
"default": 0,
"minimum": 0,
"examples": [
1,
10,
50
]
},
"order": {
"type": "integer",
"description": "The sort direction: 1 for ascending or -1 for descending.",
"default": 1,
"enum": [
-1,
1
]
},
"sort": {
"type": "string",
"description": "Field to sort by. Default is name.",
"default": "name",
"enum": [
"name"
]
}
}
}
},
"required": [
"queryParameters"
],
"additionalProperties": false
}
Return
DetailsExampleSchema
Name
Type
Description
result
object
The Triggers that matched the search query.
Copied to Clipboard
{
"message": "Successfully created the requested item",
"data": [
{
"name": "myCoolDocumentName",
"description": "Some helpful information about the document",
"type": "endpoint",
"enabled": false,
"actionType": "automations",
"actionId": "3e1666d06462e0b8b3f91c2a",
"lastExecuted": null,
"createdBy": "laborum pariatur quis",
"created": "2007-09-18T22:08:36.976Z",
"lastUpdatedBy": "ullamco aliqua nostrud",
"lastUpdated": "1995-03-10T17:28:45.66Z",
"verb": "POST",
"routeName": "X-pK",
"schema": null,
"_id": "c8fb70fb889e97e91881d6de",
"jst": null,
"migrationVersion": 19556363
},
{
"name": "myCoolDocumentName",
"description": "Some helpful information about the document",
"type": "eventSystem",
"enabled": false,
"actionType": "automations",
"actionId": "685435bd33512604bc1917e4",
"lastExecuted": null,
"createdBy": "fugiat mollit Ut",
"created": "1948-07-21T01:13:00.297Z",
"lastUpdatedBy": "magna in do adipisicing",
"lastUpdated": "1999-06-21T15:46:44.751Z",
"source": "in do officia",
"topic": "culpa ut",
"legacyWrapper": true,
"_id": "ca3e66441ee340019362a42e",
"jst": null,
"migrationVersion": 8340796
}
]
}