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": "1615611600000", "enabled": false, "actionId": "cupidatat aliqua", "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 imported 3 of 4 documents", "data": [ { "name": false, "description": 50590485.63336071, "type": true, "enabled": -51790126.12134768, "actionType": -75532517, "actionId": true, "lastExecuted": "magna tempor", "createdBy": "pariatur Ut nulla consectetur Excepteur", "created": "dolore mollit dolore nulla consectetur", "lastUpdatedBy": -18300374.961424336, "lastUpdated": -91298896, "formData": -583963, "legacyWrapper": 79943111, "firstRunAt": "ut laboris pariatur", "nextRunAt": 39469843.12526104, "processMissedRuns": -47684327, "locked": 6831850.514687061, "repeatUnit": true, "repeatFrequency": false, "repeatInterval": 20823958, "_id": "non qui est nisi", "formId": "qui et" }, { "name": "aliqua minim enim et irure", "description": true, "type": "sed adipisicing", "enabled": "anim ullamco in elit", "actionType": -50452895.12758582, "actionId": "magna ullamco consectetur", "lastExecuted": false, "createdBy": "Duis non aute", "created": -17992169.801571473, "lastUpdatedBy": "ex anim culpa", "lastUpdated": "mollit non ex", "formData": true, "legacyWrapper": true, "firstRunAt": false, "nextRunAt": 99953440, "processMissedRuns": 38092113.708322555, "locked": -31315293, "repeatUnit": false, "repeatFrequency": "ad reprehenderit aliquip", "repeatInterval": false, "_id": 28851445, "formId": 87251115 }, { "name": "myCoolDocumentName", "description": "Some helpful information about the document", "type": "eventSystem", "enabled": true, "actionType": "automations", "actionId": "402a2f1f22b1fb1992dad8be", "lastExecuted": 94496739, "createdBy": null, "created": "1962-12-18T10:53:54.259Z", "lastUpdatedBy": null, "lastUpdated": "1946-11-17T12:21:49.121Z", "source": "magna non nostrud fugiat do", "topic": "exercitation", "legacyWrapper": true, "_id": "9fb32f5ef8fef039419965f0", "jst": null, "migrationVersion": 34850556 }, { "name": "myCoolDocumentName", "description": "Some helpful information about the document", "type": "eventSystem", "enabled": false, "actionType": "automations", "actionId": "f5f2ab4887098525400622fc", "lastExecuted": null, "createdBy": "ex in nostrud", "created": "1949-07-21T05:55:00.06Z", "lastUpdatedBy": "culpa", "lastUpdated": "2002-06-12T19:09:16.255Z", "source": "consequat magna", "topic": "eu cupidatat minim adipisicing", "schema": null, "legacyWrapper": false, "_id": "6a74574c0da7c12bd8b4605a", "jst": "e817d3e3211571c71abfa820", "migrationVersion": 65549802 }, { "name": "myCoolDocumentName", "description": "Some helpful information about the document", "type": "manual", "enabled": false, "actionType": "automations", "actionId": "363af106a4cde3563a9d9df9", "lastExecuted": 49401458, "createdBy": "reprehenderit deserunt consectetur ut exercitation", "created": "1961-12-17T15:27:12.002Z", "lastUpdatedBy": null, "lastUpdated": "1961-02-01T10:29:00.769Z", "formData": { "ip": "1.2.3.4", "name": "myNewDevice" }, "legacyWrapper": true, "_id": "21471c68369c200bbe360cdd", "formId": "2794dac3d7600bc705bb98ed", "migrationVersion": -57518363, "formSchemaHash": null } ] }
{ "title": "result", "allOf": [ { "$ref": "common-api#/definitions/success-response" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "trigger-api" } } } } ] }