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": "04/06/2021", "lessThanField": "lastExecuted", "lessThan": "Thu Nov 15 2018 01:30:00 GMT-0500 (Eastern Standard Time)", "enabled": false, "actionId": "Ut ea dolor sunt incididunt", "limit": 50, "skip": 10, "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": "eventSystem", "enabled": true, "actionType": "automations", "actionId": "a70b2ac28c66bd4550796537", "lastExecuted": null, "createdBy": null, "created": "2001-03-12T06:19:24.0Z", "lastUpdatedBy": "dolor pariatur minim", "lastUpdated": "1959-04-06T03:40:27.028Z", "source": "sit dolor qui voluptate nulla", "topic": "ipsum in proident in", "legacyWrapper": true, "_id": "cdd13e3e2e21277d5afa422e", "jst": "f2fd8284651d1da998a3b48b", "migrationVersion": -84094974 }, { "name": "myCoolDocumentName", "description": "Some helpful information about the document", "type": "eventSystem", "enabled": false, "actionType": "automations", "actionId": "185250d31fb481ef5bb5e726", "lastExecuted": null, "createdBy": null, "created": "1959-01-30T16:50:53.871Z", "lastUpdatedBy": "Ut dolore", "lastUpdated": "1995-05-19T18:32:23.025Z", "source": "tempor Ut Duis sit", "topic": "sit eu nostrud officia", "legacyWrapper": true, "_id": "40120a8e67b5eba55dcc7f99", "jst": "9894353a8451d01dc2499647", "migrationVersion": -92938777 }, { "name": true, "description": "laboris eiusmod aute", "type": false, "enabled": false, "actionType": false, "actionId": false, "lastExecuted": "qui ut", "createdBy": "ad labore Ut", "created": -8000377.862177461, "lastUpdatedBy": true, "lastUpdated": 34247755, "formData": 26716954.40367095, "legacyWrapper": false, "firstRunAt": 31294108, "nextRunAt": "proident ea Duis", "processMissedRuns": 76265106, "locked": "laborum exercitation", "repeatUnit": -46335514.54895848, "repeatFrequency": 96356322, "repeatInterval": -51348773, "_id": "minim dolore veniam", "formId": 59992696.25083637 }, { "name": "myCoolDocumentName", "description": "Some helpful information about the document", "type": "endpoint", "enabled": true, "actionType": "automations", "actionId": "352d4894bec250dc4b395c28", "lastExecuted": null, "createdBy": "exercitation amet labore reprehenderit ut", "created": "1949-10-06T23:53:10.0Z", "lastUpdatedBy": null, "lastUpdated": "2015-08-04T00:43:30.654Z", "verb": "POST", "routeName": "bzGcA60", "schema": null, "_id": "c7cb2592102f738fe11fe558", "jst": "b5b1b032340013ae25325058", "migrationVersion": -10867676 }, { "name": "myCoolDocumentName", "description": "Some helpful information about the document", "type": "endpoint", "enabled": false, "actionType": "automations", "actionId": "b363365af67da13816518000", "lastExecuted": 79069513, "createdBy": "tempor", "created": "1946-08-27T14:52:54.197Z", "lastUpdatedBy": null, "lastUpdated": "1991-01-09T21:16:47.657Z", "verb": "POST", "routeName": "er", "schema": null, "_id": "cec6b124f59fd2de8398bebb", "jst": "f096eb26071adbc4ef893302", "migrationVersion": 72840737 } ] }
{ "title": "result", "allOf": [ { "$ref": "common-api#/definitions/success-response" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "trigger-api" } } } } ] }