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": true, "actionId": "in irure qui commodo", "limit": 10, "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": "manual", "enabled": false, "actionType": "automations", "actionId": "5ac81f6b9988c38fa2427d1a", "lastExecuted": 49507522, "createdBy": "eiusmod proident aliqua", "created": "1956-07-01T02:40:51.679Z", "lastUpdatedBy": null, "lastUpdated": "1968-06-15T03:00:15.9Z", "formData": { "ip": "1.2.3.4", "name": "myNewDevice" }, "legacyWrapper": true, "_id": "4e84ff62fe6d6b86f962f7f7", "formId": null, "migrationVersion": 95407747, "formSchemaHash": null }, { "name": "myCoolDocumentName", "description": "Some helpful information about the document", "type": "endpoint", "enabled": true, "actionType": "automations", "actionId": "2ef6313b3ac053c89ef5042a", "lastExecuted": null, "createdBy": null, "created": "1945-10-24T09:40:24.177Z", "lastUpdatedBy": null, "lastUpdated": "1948-03-04T16:33:21.176Z", "verb": "POST", "routeName": "fWTWuXea", "_id": "82b320ad99ce632896c97ae0", "jst": null, "migrationVersion": -65108048 }, { "name": "myCoolDocumentName", "description": "Some helpful information about the document", "type": "eventSystem", "enabled": false, "actionType": "automations", "actionId": "300f02ea755d133f56f3ac85", "lastExecuted": 16508330, "createdBy": "nisi", "created": "1990-11-03T04:58:34.864Z", "lastUpdatedBy": null, "lastUpdated": "1992-01-16T12:41:09.317Z", "source": "eu culpa in nostrud", "topic": "ad veniam dolore esse", "schema": null, "legacyWrapper": false, "_id": "548196594cd74b83987308db", "jst": null, "migrationVersion": 6590164 }, { "name": "myCoolDocumentName", "description": "Some helpful information about the document", "type": "endpoint", "enabled": false, "actionType": "automations", "actionId": "8c453a880ab0a6fc6ea3e313", "lastExecuted": 56496543, "createdBy": null, "created": "1990-03-02T11:55:50.772Z", "lastUpdatedBy": "aute eu occaecat", "lastUpdated": "2023-05-10T22:02:11.186Z", "verb": "POST", "routeName": "gZfJVj", "_id": "a7f940ca5ae9ee085567e8b4", "jst": null, "migrationVersion": 79934017 } ] }
{ "title": "result", "allOf": [ { "$ref": "common-api#/definitions/success-response" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "trigger-api" } } } } ] }