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": "04/06/2021", "enabled": false, "actionId": "cupidatat esse id", "limit": 10, "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 imported 3 of 4 documents", "data": [ { "name": 57561385, "description": -33047359.319114514, "type": -19452655.81177011, "enabled": false, "actionType": 74567353, "actionId": false, "lastExecuted": false, "createdBy": "eiusmod dolore Excepteur", "created": false, "lastUpdatedBy": -53794652.44253514, "lastUpdated": -56902026.894100375, "formData": -22963144, "legacyWrapper": true, "firstRunAt": "ut magna", "nextRunAt": true, "processMissedRuns": "enim cillum", "locked": -36037384, "repeatUnit": "reprehenderit fugiat et", "repeatFrequency": "consectetur dolor nulla", "repeatInterval": true, "_id": 72436359, "formId": 98802986.08955806 }, { "name": "myCoolDocumentName", "description": "Some helpful information about the document", "type": "eventSystem", "enabled": true, "actionType": "automations", "actionId": "e2f3a17e5d1034bcc46c9457", "lastExecuted": null, "createdBy": null, "created": "1966-09-29T20:59:49.807Z", "lastUpdatedBy": null, "lastUpdated": "1955-11-21T02:58:08.957Z", "source": "mollit", "topic": "ipsum occaecat", "legacyWrapper": false, "_id": "944400eb30d7e2469282970e", "jst": null, "migrationVersion": 66874199 }, { "name": "myCoolDocumentName", "description": "Some helpful information about the document", "type": "eventSystem", "enabled": true, "actionType": "automations", "actionId": "87e5126c5d9670c6f090b0dd", "lastExecuted": 61838092, "createdBy": "dolore sit cupidatat", "created": "1977-06-14T05:58:14.351Z", "lastUpdatedBy": null, "lastUpdated": "1981-10-15T10:56:31.087Z", "source": "nostrud", "topic": "non fugiat ipsum consectetur dolor", "schema": null, "legacyWrapper": false, "_id": "64d207adb5184d19f2ec5036", "jst": "a19805266dfd2fbea71f8166", "migrationVersion": -83166706 }, { "name": "myCoolDocumentName", "description": "Some helpful information about the document", "type": "manual", "enabled": true, "actionType": "automations", "actionId": "99c59d3c5a6741059b720210", "lastExecuted": null, "createdBy": "Lorem aute", "created": "2001-01-29T16:26:21.758Z", "lastUpdatedBy": "laborum quis reprehenderit irure dolore", "lastUpdated": "1953-09-09T19:13:02.1Z", "formData": { "deviceName": "ATL-123", "action": "SYNC" }, "legacyWrapper": true, "_id": "256c2eb29e8396ea93a78fd5", "formId": null, "migrationVersion": 42157341, "formSchemaHash": null } ] }
{ "title": "result", "allOf": [ { "$ref": "common-api#/definitions/success-response" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "trigger-api" } } } } ] }