Summary
Get Triggers
Description
Search the Trigger collection.
Route
GET /operations-manager/triggers
Roles
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| queryParameters | object | yes | 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}' |
{ "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": "incididunt dolor ipsum", "limit": 10, "skip": 1, "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 | The Triggers that matched the search query. |
{ "message": "Successfully created the requested item", "data": [ { "name": "myCoolDocumentName", "description": "Some helpful information about the document", "type": "endpoint", "enabled": false, "actionType": "automations", "actionId": "a9b010dd480a0dd69db8f4a1", "lastExecuted": 54970049, "createdBy": "occaecat", "created": "2008-12-22T23:11:48.802Z", "lastUpdatedBy": "sunt irure in", "lastUpdated": "2006-03-19T16:31:32.288Z", "verb": "POST", "routeName": "JCc", "schema": null, "_id": "184d1d182f9a36194dbc0e57", "jst": "3f989f3d0fdc12d407ac8cef", "migrationVersion": -27561825 }, { "name": "myCoolDocumentName", "description": "Some helpful information about the document", "type": "endpoint", "enabled": false, "actionType": "automations", "actionId": "5d1b1a8c670bef52f1ecf0e6", "lastExecuted": 74656389, "createdBy": null, "created": "1995-06-15T19:06:48.014Z", "lastUpdatedBy": "adipisicing enim", "lastUpdated": "1997-07-25T05:29:33.454Z", "verb": "POST", "routeName": "Xeab-ImYk", "_id": "16f3788b1127c11c8d11b466", "jst": null, "migrationVersion": 54085947 }, { "name": 92175923.28614447, "description": "esse", "type": -5887262, "enabled": true, "actionType": 62364319.91508317, "actionId": 97253838, "lastExecuted": true, "createdBy": true, "created": "in", "lastUpdatedBy": false, "lastUpdated": -27502104.282757685, "formData": -40555823.86205656, "firstRunAt": -35993709.92181838, "nextRunAt": -97077016, "processMissedRuns": 78834094.92996153, "locked": true, "repeatUnit": "dolor voluptate consectetur", "repeatFrequency": 50559095, "repeatInterval": "cupidatat incididunt dolor", "_id": "in dolore ex", "formId": "Ut ea" }, { "name": "myCoolDocumentName", "description": "Some helpful information about the document", "type": "manual", "enabled": false, "actionType": "automations", "actionId": "bb958481ce76755d268488a4", "lastExecuted": 34785597, "createdBy": null, "created": "1946-04-14T09:08:25.668Z", "lastUpdatedBy": "dolor reprehenderit", "lastUpdated": "1991-07-16T16:28:32.66Z", "formData": { "deviceName": "ATL-123", "action": "SYNC" }, "_id": "d6a5efa6eea4e8ac7636f924", "formId": null, "migrationVersion": 51267343, "formSchemaHash": "in ad sint Duis qui" } ] }
{ "title": "result", "allOf": [ { "$ref": "common-api#/definitions/success-response" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "trigger-api" } } } } ] }