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": "04/06/2021", "enabled": true, "actionId": "ea nisi", "limit": 1, "skip": 50, "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 retrieved search results", "data": [ { "name": "myCoolDocumentName", "description": "Some helpful information about the document", "type": "endpoint", "enabled": false, "actionType": "automations", "actionId": "b2171c8bb834472e018b783a", "lastExecuted": null, "createdBy": "Ut cupidatat eiusmod", "created": "2024-02-19T23:10:00.134Z", "lastUpdatedBy": "sint", "lastUpdated": "1972-01-03T17:07:30.775Z", "verb": "POST", "routeName": "bb2TYZ", "schema": null, "_id": "1b15124100a10b53774a8a5f", "jst": null, "migrationVersion": 57934852 }, { "name": "myCoolDocumentName", "description": "Some helpful information about the document", "type": "manual", "enabled": true, "actionType": "automations", "actionId": "7dfd24c1fd733e997f17f28f", "lastExecuted": null, "createdBy": "ex dolore", "created": "1955-07-06T21:28:16.095Z", "lastUpdatedBy": null, "lastUpdated": "2012-06-20T07:41:17.277Z", "formData": { "ip": "1.2.3.4", "name": "myNewDevice" }, "legacyWrapper": false, "_id": "477c923ff099306e0b43c2e6", "formId": "d37a8530c5cb93a732128db8", "migrationVersion": -66233203, "formSchemaHash": null }, { "name": "irure ex elit", "description": 10838695, "type": false, "enabled": true, "actionType": -84141884.61978318, "actionId": -65095218, "lastExecuted": true, "createdBy": 4505591.860240579, "created": -98248119, "lastUpdatedBy": true, "lastUpdated": 23730857.778306186, "formData": 29854856.2603222, "legacyWrapper": -33901203, "firstRunAt": 93217778.03116152, "nextRunAt": "dolor", "processMissedRuns": 18174808, "locked": "dolore eu nisi qui non", "repeatUnit": -9652618.379977047, "repeatFrequency": true, "repeatInterval": false, "_id": 58349462.346474856, "formId": false }, { "name": "myCoolDocumentName", "description": "Some helpful information about the document", "type": "endpoint", "enabled": false, "actionType": "automations", "actionId": "f15e9bef707e980daa64e146", "lastExecuted": null, "createdBy": null, "created": "1967-05-15T09:35:26.806Z", "lastUpdatedBy": null, "lastUpdated": "1978-03-31T15:14:12.929Z", "verb": "POST", "routeName": "gudbKgXQ", "_id": "71fde61d4c6ddd4170531542", "jst": "f158ff1b5e45de754693553e", "migrationVersion": 36875641 } ] }
{ "title": "result", "allOf": [ { "$ref": "common-api#/definitions/success-response" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "trigger-api" } } } } ] }