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": "manual",
"enabled": true,
"actionType": "automations",
"actionId": "9292c0c08450fc443be1f340",
"lastExecuted": null,
"createdBy": "eiusmod et dolor in Lorem",
"created": "1996-03-09T03:55:33.306Z",
"lastUpdatedBy": null,
"lastUpdated": "1981-09-28T07:52:51.476Z",
"formData": {
"deviceName": "ATL-123",
"action": "SYNC"
},
"_id": "4404e5fea8daaf58f224af9f",
"formId": "775decc6fed0729d11850b88",
"migrationVersion": -5118501,
"formSchemaHash": "aute labore dolor proident Duis"
},
{
"name": "myCoolDocumentName",
"description": "Some helpful information about the document",
"type": "manual",
"enabled": false,
"actionType": "automations",
"actionId": "77c0c90287b81bdd0562cd70",
"lastExecuted": 54457911,
"createdBy": null,
"created": "1989-11-07T00:13:46.808Z",
"lastUpdatedBy": "id nisi ad adipisicing incididunt",
"lastUpdated": "1971-12-10T18:45:33.911Z",
"formData": {
"deviceName": "ATL-123",
"action": "SYNC"
},
"_id": "a0c651b32d2402844639b1fb",
"formId": "56ce4ae9f4514733688972c9",
"migrationVersion": 77591344,
"formSchemaHash": null
}
]
}