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": "cupidatat", "limit": 25, "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 imported 3 of 4 documents", "data": [ { "name": "myCoolDocumentName", "description": "Some helpful information about the document", "type": "endpoint", "enabled": true, "actionType": "automations", "actionId": "0cd69302df511f9834b129ae", "lastExecuted": 38522471, "createdBy": null, "created": "2024-02-21T21:44:05.066Z", "lastUpdatedBy": "qui commodo tempor", "lastUpdated": "1981-02-06T12:44:40.273Z", "verb": "POST", "routeName": "LG6F1RXn", "schema": null, "_id": "b74c169b725782eb3753a983", "jst": "de0b277e0074df9ba09fd9a3", "migrationVersion": 26165964 }, { "name": "myCoolDocumentName", "description": "Some helpful information about the document", "type": "manual", "enabled": false, "actionType": "automations", "actionId": "af64178e9f3f559ffac490b9", "lastExecuted": 77808143, "createdBy": null, "created": "1979-05-24T12:46:00.128Z", "lastUpdatedBy": "commodo eu qui", "lastUpdated": "1964-01-20T03:28:18.627Z", "formData": { "ip": "1.2.3.4", "name": "myNewDevice" }, "legacyWrapper": true, "_id": "3c32b9fcd4b4dfed75c54711", "formId": null, "migrationVersion": 26412247, "formSchemaHash": null }, { "name": -42568922, "description": -49197152.223394535, "type": -14278629, "enabled": true, "actionType": "ullamco dolore mollit Duis", "actionId": "reprehenderit dolore tempor et esse", "lastExecuted": 95076089.88365316, "createdBy": "ut", "created": 80181842, "lastUpdatedBy": false, "lastUpdated": -47467209, "formData": true, "legacyWrapper": -21712354.169583663, "firstRunAt": -21915003, "nextRunAt": true, "processMissedRuns": 78065672.89297065, "locked": 25489905, "repeatUnit": "id", "repeatFrequency": false, "repeatInterval": 964059.9905114174, "_id": "esse sint", "formId": "exercitation dolore ipsum in consequat" }, { "name": -36777064, "description": 3872931.332138747, "type": true, "enabled": "enim nostrud labore", "actionType": -42472140, "actionId": 65316998, "lastExecuted": -48393382, "createdBy": -58475263, "created": 32104406.48792319, "lastUpdatedBy": -86201022, "lastUpdated": "deserunt velit", "formData": "commodo deserunt", "legacyWrapper": "sunt voluptate aliqua", "firstRunAt": 23903027, "nextRunAt": 62698750.422192514, "processMissedRuns": false, "locked": -42169354, "repeatUnit": true, "repeatFrequency": -49095841, "repeatInterval": 64809694.374295235, "_id": true, "formId": false } ] }
{ "title": "result", "allOf": [ { "$ref": "common-api#/definitions/success-response" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "trigger-api" } } } } ] }