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": "882ab181c689e8099363ba16",
"lastExecuted": 65151549,
"createdBy": null,
"created": "2011-02-14T02:46:51.311Z",
"lastUpdatedBy": "in Lorem dolor sint",
"lastUpdated": "1995-03-28T22:20:35.683Z",
"formData": {
"deviceName": "ATL-123",
"action": "SYNC"
},
"_id": "bcea2f0404be77e2a13854b7",
"formId": null,
"migrationVersion": -75729780,
"formSchemaHash": "sit"
},
{
"name": "myCoolDocumentName",
"description": "Some helpful information about the document",
"type": "eventSystem",
"enabled": false,
"actionType": "automations",
"actionId": "37b5d68c0ae7db237d258eac",
"lastExecuted": 89590831,
"createdBy": "reprehenderit laboris sint proident aliqua",
"created": "2018-11-06T06:08:05.636Z",
"lastUpdatedBy": "voluptate",
"lastUpdated": "1985-10-14T08:11:02.571Z",
"source": "quis veniam nisi",
"topic": "in consequat",
"_id": "62f7724b53c70a0ea8892993",
"jst": null,
"migrationVersion": 68687617
}
]
}