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": "2020-12-03T19:55:43.189Z", "enabled": false, "actionId": "sed proident voluptate", "limit": 50, "skip": 0, "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": "1941d354a754a62d88412499", "lastExecuted": null, "createdBy": null, "created": "1999-12-30T23:57:40.951Z", "lastUpdatedBy": "reprehenderit in amet deserunt", "lastUpdated": "2025-10-13T00:00:26.979Z", "formData": { "deviceName": "ATL-123", "action": "SYNC" }, "_id": "8fff18d6d70355d51daa2067", "formId": null, "migrationVersion": 19519500, "formSchemaHash": "proident", "legacyWrapper": false }, { "name": "myCoolDocumentName", "description": "Some helpful information about the document", "type": "manual", "enabled": false, "actionType": "automations", "actionId": "c9405cc7afdb8d74eae9df4c", "lastExecuted": 39421994, "createdBy": "mollit eu aute", "created": "1954-07-05T12:15:10.355Z", "lastUpdatedBy": "qui aliquip", "lastUpdated": "1981-01-12T05:55:36.899Z", "formData": { "ip": "1.2.3.4", "name": "myNewDevice" }, "_id": "90b2950d666a5d7760761a29", "formId": null, "migrationVersion": 97627390, "formSchemaHash": null, "legacyWrapper": true }, { "name": "myCoolDocumentName", "description": "Some helpful information about the document", "type": "eventSystem", "enabled": false, "actionType": "automations", "actionId": "103ca8e0f0d53de702145a24", "lastExecuted": null, "createdBy": null, "created": "1968-05-26T23:38:33.813Z", "lastUpdatedBy": null, "lastUpdated": "1971-12-28T17:49:48.004Z", "source": "laborum quis reprehenderit Ut exercitation", "topic": "ad mollit in Lorem", "schema": null, "_id": "6db55e70e8ce37c4ae27a868", "jst": "97e64f11fd539fe86c371dcf", "migrationVersion": 18265096, "legacyWrapper": true }, { "name": "myCoolDocumentName", "description": "Some helpful information about the document", "type": "endpoint", "enabled": true, "actionType": "automations", "actionId": "a9a90c658c2126a19072b429", "lastExecuted": null, "createdBy": null, "created": "1952-05-28T12:32:17.991Z", "lastUpdatedBy": null, "lastUpdated": "2022-05-21T09:45:17.106Z", "verb": "POST", "routeName": "P", "schema": null, "_id": "3dfec51316314a0599d7c89e", "jst": "0fed584c56b99b34bbb65b4e", "migrationVersion": 14666181 } ] }
{ "title": "result", "allOf": [ { "$ref": "common-api#/definitions/success-response" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "trigger-api" } } } } ] }