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": "04/06/2021", "lessThanField": "lastExecuted", "lessThan": "Thu Nov 15 2018 01:30:00 GMT-0500 (Eastern Standard Time)", "enabled": true, "actionId": "aute consectetur irure", "limit": 25, "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 created the requested item", "data": [ { "name": "myCoolDocumentName", "description": "Some helpful information about the document", "type": "endpoint", "enabled": false, "actionType": "automations", "actionId": "eebb21a35133967c58c43d6a", "lastExecuted": null, "createdBy": "amet exercitation", "created": "1965-08-10T12:46:23.461Z", "lastUpdatedBy": null, "lastUpdated": "1995-06-13T11:14:05.854Z", "verb": "POST", "routeName": "ylRI6f", "schema": null, "_id": "e852f2f2779b83475d15c699", "jst": null, "migrationVersion": -95372014 }, { "name": "myCoolDocumentName", "description": "Some helpful information about the document", "type": "endpoint", "enabled": false, "actionType": "automations", "actionId": "791b4ebcfdfc62548f4da8e6", "lastExecuted": 25802283, "createdBy": "nulla", "created": "1946-09-25T15:22:40.416Z", "lastUpdatedBy": null, "lastUpdated": "1973-05-13T18:35:33.87Z", "verb": "POST", "routeName": "b9b7hBEJ", "_id": "03421e3c08aca7537367eccb", "jst": "ebae0a2132b3e708f95f26a3", "migrationVersion": -70736792 }, { "name": "myCoolDocumentName", "description": "Some helpful information about the document", "type": "endpoint", "enabled": false, "actionType": "automations", "actionId": "92a9f2e1d421b0cb4f10db9b", "lastExecuted": null, "createdBy": null, "created": "1972-01-28T22:09:27.345Z", "lastUpdatedBy": "irure officia dolore ipsum", "lastUpdated": "2022-06-12T03:48:27.472Z", "verb": "POST", "routeName": "fEc-kgPps", "_id": "1b0a1212a97f200172823c33", "jst": null, "migrationVersion": 25445511 }, { "name": "myCoolDocumentName", "description": "Some helpful information about the document", "type": "manual", "enabled": true, "actionType": "automations", "actionId": "af15cbc5da4a96a19fed93e3", "lastExecuted": 32405682, "createdBy": "dolore", "created": "2012-09-03T08:21:38.051Z", "lastUpdatedBy": null, "lastUpdated": "1982-07-27T13:05:00.111Z", "formData": { "ip": "1.2.3.4", "name": "myNewDevice" }, "_id": "e5c88f7867fc82b2acd801e8", "formId": "d311568f4ef114c351099399", "migrationVersion": 91197157, "formSchemaHash": "dolor" } ] }
{ "title": "result", "allOf": [ { "$ref": "common-api#/definitions/success-response" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "trigger-api" } } } } ] }