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": "2020-12-03T19:55:43.189Z", "lessThanField": "lastExecuted", "lessThan": "Thu Nov 15 2018 01:30:00 GMT-0500 (Eastern Standard Time)", "enabled": false, "actionId": "aute dolore enim Lorem", "limit": 1, "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 retrieved search results", "data": [ { "name": "myCoolDocumentName", "description": "Some helpful information about the document", "type": "eventSystem", "enabled": false, "actionType": "automations", "actionId": "da0dafe25eae6e0c72ed0ebd", "lastExecuted": 62218861, "createdBy": null, "created": "1975-07-15T12:40:59.759Z", "lastUpdatedBy": null, "lastUpdated": "1973-07-10T00:35:40.196Z", "source": "Ut minim", "topic": "incididunt dolore reprehenderit aliqua velit", "schema": null, "_id": "6265fe18452c7ad67af4b32b", "jst": "acc4717a7fc715f730c42ee4", "migrationVersion": 45493439, "legacyWrapper": false }, { "name": "esse", "description": "Duis Lorem", "type": "Duis nulla dolor", "enabled": -17193591.126093015, "actionType": 42262298, "actionId": "qui voluptate", "lastExecuted": 42254419, "createdBy": 93327734, "created": true, "lastUpdatedBy": false, "lastUpdated": "Ut anim ex dolore", "formData": 11349415.596502155, "firstRunAt": 14545860, "nextRunAt": "eiusmod eu ut sunt", "processMissedRuns": false, "locked": true, "repeatUnit": 59114652.04001582, "repeatFrequency": true, "repeatInterval": "culpa nisi sed", "_id": -36195902.81540916, "formId": false }, { "name": "myCoolDocumentName", "description": "Some helpful information about the document", "type": "eventSystem", "enabled": false, "actionType": "automations", "actionId": "3682e3d552b3854318af0b9d", "lastExecuted": 33887537, "createdBy": null, "created": "1994-10-16T03:09:02.967Z", "lastUpdatedBy": null, "lastUpdated": "2014-12-11T03:11:57.579Z", "source": "et Excepteur", "topic": "minim dolore Excepteur", "_id": "51bb4b1e9db39a39c5d063af", "jst": "791cd8986f8afe5a22079b8d", "migrationVersion": 36166787, "legacyWrapper": true }, { "name": "myCoolDocumentName", "description": "Some helpful information about the document", "type": "manual", "enabled": false, "actionType": "automations", "actionId": "d3d2b5706b844e2f57b6b286", "lastExecuted": 5630629, "createdBy": "fugiat aute", "created": "1981-08-13T19:18:08.462Z", "lastUpdatedBy": "laboris enim", "lastUpdated": "1973-08-12T15:07:34.329Z", "formData": { "ip": "1.2.3.4", "name": "myNewDevice" }, "_id": "f8902e3918340fbe0fe115c9", "formId": null, "migrationVersion": 35640256, "formSchemaHash": "sed mollit", "legacyWrapper": true }, { "name": "myCoolDocumentName", "description": "Some helpful information about the document", "type": "eventSystem", "enabled": true, "actionType": "automations", "actionId": "3e3e03d7b7100c7fdddd7ab4", "lastExecuted": 30122162, "createdBy": "consequat anim", "created": "2018-04-30T21:42:04.044Z", "lastUpdatedBy": "irure", "lastUpdated": "1998-03-16T01:47:17.238Z", "source": "do dolore occaecat", "topic": "elit labore aliquip", "_id": "8fdea5d7067271f07477b563", "jst": null, "migrationVersion": 93904076, "legacyWrapper": false } ] }
{ "title": "result", "allOf": [ { "$ref": "common-api#/definitions/success-response" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "trigger-api" } } } } ] }