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": "anim", "limit": 1, "skip": 50, "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": "manual", "enabled": false, "actionType": "automations", "actionId": "eff265cee4f715d5c518db03", "lastExecuted": 87029775, "createdBy": "dolor proident sed", "created": "1948-11-21T23:21:41.76Z", "lastUpdatedBy": "nulla deserunt", "lastUpdated": "2024-01-02T07:50:23.0Z", "formData": { "deviceName": "ATL-123", "action": "SYNC" }, "_id": "0b62ee6b35563a4830bcaf36", "formId": null, "migrationVersion": -60512670, "formSchemaHash": "nostrud do" }, { "name": "ea irure", "description": false, "type": 41289364, "enabled": true, "actionType": -79638693, "actionId": -9740467.800233737, "lastExecuted": 36738691, "createdBy": -26334198.178773075, "created": 20316655, "lastUpdatedBy": -97003863, "lastUpdated": true, "formData": -70224748.49900594, "firstRunAt": true, "nextRunAt": "et nisi occaecat proident", "processMissedRuns": "voluptate velit", "locked": 29354153, "repeatUnit": "est esse in aliquip", "repeatFrequency": "est enim esse", "repeatInterval": 87591019.97193778, "_id": 26119687.96201536, "formId": 75429513.26298198 }, { "name": "myCoolDocumentName", "description": "Some helpful information about the document", "type": "eventSystem", "enabled": true, "actionType": "automations", "actionId": "43cf4aac26298d42acb6fc1c", "lastExecuted": null, "createdBy": "incididunt nostrud sit in ullamco", "created": "1951-08-09T05:54:18.611Z", "lastUpdatedBy": null, "lastUpdated": "1956-04-29T03:20:47.942Z", "source": "laborum in ullamco ut non", "topic": "ut velit sunt tempor", "schema": null, "_id": "13d98bb9f573320cade95f0a", "jst": null, "migrationVersion": -32392239 }, { "name": "myCoolDocumentName", "description": "Some helpful information about the document", "type": "manual", "enabled": true, "actionType": "automations", "actionId": "7bbed3e3ac29dcc654e4a2f9", "lastExecuted": 66105784, "createdBy": "velit voluptate quis sint", "created": "1971-12-18T17:36:04.016Z", "lastUpdatedBy": null, "lastUpdated": "2022-11-14T11:10:19.028Z", "formData": { "ip": "1.2.3.4", "name": "myNewDevice" }, "_id": "19181baf8ff4e4ea5103f8d4", "formId": null, "migrationVersion": 33180935, "formSchemaHash": "officia ullamco Duis ut" } ] }
{ "title": "result", "allOf": [ { "$ref": "common-api#/definitions/success-response" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "trigger-api" } } } } ] }