Summary
Get Triggers
Description
Query the Trigger document collection
Route
GET /operations-manager/triggers
Roles
Parameters
Name | Type | Required | Description |
---|---|---|---|
queryParameters | object | yes | query params for searching |
{ "queryParameters": { "contains": "event", "containsField": "name", "equals": "my event trigger", "equalsField": "name", "startsWith": "my", "startsWithField": "name", "greaterThanField": "lastExecuted", "greaterThan": "Thu Dec 03 2020 14:55:00 GMT-0500 (Eastern Standard Time)", "lessThanField": "lastExecuted", "lessThan": "2020-12-03T19:55:43.189Z", "enabled": false, "actionId": "labore aliquip in irure proident", "limit": 1, "skip": 0, "order": 1, "sort": "name" } }
{ "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
Name | Type | Description |
---|---|---|
result | object | total number and a list of trigger documents that matched the search query |
{ "results": [ { "name": "My document", "actionType": "automations", "actionId": "4321abcdef694aa79dae47ad", "enabled": false, "type": "manual", "_id": "4321abcdef694aa79dae47ad", "created": "2019-04-16T00:43:22.038Z", "createdBy": "Pronghorn", "lastUpdated": "2019-04-16T00:43:22.038Z", "lastUpdatedBy": "5cb7b531d06cceb89fd21b1c", "formId": "5cb7b531d06cceb89fd21b1c", "formData": null }, { "name": "My document", "actionType": "automations", "actionId": "4321abcdef694aa79dae47ad", "enabled": true, "type": "manual", "_id": "4321abcdef694aa79dae47ad", "created": "2019-04-16T00:43:22.038Z", "createdBy": "5cb7b531d06cceb89fd21b1c", "lastUpdated": "2019-04-16T00:43:22.038Z", "lastUpdatedBy": "5cb7b531d06cceb89fd21b1c", "formId": null }, { "name": "My document", "actionType": "automations", "actionId": "5cb7b531d06cceb89fd21b1c", "enabled": false, "type": "manual", "_id": "4321abcdef694aa79dae47ad", "created": "2019-04-16T00:43:22.038Z", "createdBy": "5cb7b531d06cceb89fd21b1c", "lastUpdated": "2019-04-16T00:43:22.038Z", "lastUpdatedBy": "4321abcdef694aa79dae47ad", "formId": null }, { "name": "My document", "actionType": "automations", "actionId": "5cb7b531d06cceb89fd21b1c", "enabled": true, "type": "manual", "_id": "4321abcdef694aa79dae47ad", "created": "2019-04-16T00:43:22.038Z", "createdBy": "Pronghorn", "lastUpdated": "2019-04-16T00:43:22.038Z", "lastUpdatedBy": "Pronghorn", "formId": null, "formData": null }, { "name": "My document", "type": "schedule", "enabled": false, "actionType": "automations", "actionId": "4321abcdef694aa79dae47ad", "firstRunAt": 6500173, "processMissedRuns": "none", "repeatUnit": "day", "_id": "4321abcdef694aa79dae47ad", "created": "2019-04-16T00:43:22.038Z", "createdBy": "Pronghorn", "lastUpdated": "2019-04-16T00:43:22.038Z", "lastUpdatedBy": "5cb7b531d06cceb89fd21b1c", "formId": null, "lastExecuted": 86169868, "nextRunAt": null, "repeatInterval": null, "waitFlag": true } ], "total": 68630874 }
{ "title": "result", "properties": { "results": { "type": "array", "items": { "anyOf": [ { "$ref": "endpoint-schema" }, { "$ref": "eventSystem-schema" }, { "$ref": "manual-schema" }, { "$ref": "schedule-schema" } ] } }, "total": { "description": "total number of event docs that matched the query", "type": "integer" } } }