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": "04/06/2021", "enabled": false, "actionId": "adipisicing cupidatat ex Excepteur", "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": true, "actionType": "automations", "actionId": "5998267fbc1f8bc222bf0963", "lastExecuted": null, "createdBy": null, "created": "2009-09-16T04:23:51.42Z", "lastUpdatedBy": "in", "lastUpdated": "2000-04-06T13:48:51.727Z", "verb": "POST", "routeName": "b7ydNFO", "_id": "8a8c624454c4eaa77d49c479", "jst": "ed8be49c718ffee16286eb54", "migrationVersion": 68167896 }, { "name": "myCoolDocumentName", "description": "Some helpful information about the document", "type": "manual", "enabled": false, "actionType": "automations", "actionId": "a1e42384b02da26cf24771fa", "lastExecuted": null, "createdBy": "cupidatat officia", "created": "2007-03-14T06:37:39.914Z", "lastUpdatedBy": "sit elit", "lastUpdated": "1967-05-19T09:31:34.371Z", "formData": { "ip": "1.2.3.4", "name": "myNewDevice" }, "legacyWrapper": false, "_id": "a0f83296ead10c7c61b2f2f9", "formId": null, "migrationVersion": -51977863, "formSchemaHash": null }, { "name": "myCoolDocumentName", "description": "Some helpful information about the document", "type": "endpoint", "enabled": false, "actionType": "automations", "actionId": "34b4bd3c7aec3fa107a5164d", "lastExecuted": null, "createdBy": null, "created": "1978-12-17T01:07:52.282Z", "lastUpdatedBy": "non eu ut cupidatat", "lastUpdated": "2012-08-11T19:49:52.937Z", "verb": "POST", "routeName": "1BBsh", "_id": "5dc200e097e609aca548a6d8", "jst": "cca10eb56a13e2e76a6283d1", "migrationVersion": 21553644 }, { "name": "myCoolDocumentName", "description": "Some helpful information about the document", "type": "eventSystem", "enabled": false, "actionType": "automations", "actionId": "4206efc7cfd4e1df1a071e42", "lastExecuted": null, "createdBy": null, "created": "1997-12-15T13:06:52.93Z", "lastUpdatedBy": "occaecat in fugiat nulla proident", "lastUpdated": "1972-09-21T19:06:32.987Z", "source": "pariatur ex aliqua sed", "topic": "ea labore", "schema": null, "legacyWrapper": false, "_id": "be61b26c2771c105e43ca276", "jst": null, "migrationVersion": 91363799 }, { "name": "myCoolDocumentName", "description": "Some helpful information about the document", "type": "eventSystem", "enabled": false, "actionType": "automations", "actionId": "61c43b7ca876527977801571", "lastExecuted": null, "createdBy": "est aliquip", "created": "2009-11-16T23:08:28.914Z", "lastUpdatedBy": "nulla", "lastUpdated": "1989-01-29T15:49:48.965Z", "source": "cupidatat aute culpa velit", "topic": "aute do Excepteur", "legacyWrapper": false, "_id": "84d97cf44edba7068a2ecb5d", "jst": null, "migrationVersion": -3496496 } ] }
{ "title": "result", "allOf": [ { "$ref": "common-api#/definitions/success-response" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "trigger-api" } } } } ] }