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": "1617681600000", "lessThanField": "lastExecuted", "lessThan": "1615611600000", "enabled": true, "actionId": "laboris", "limit": 1, "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 imported 3 of 4 documents", "data": [ { "name": "myCoolDocumentName", "description": "Some helpful information about the document", "type": "eventSystem", "enabled": true, "actionType": "automations", "actionId": "8ce2c6de000a23171a9036c0", "lastExecuted": null, "createdBy": "mollit sint est commodo", "created": "1997-11-01T02:34:09.092Z", "lastUpdatedBy": null, "lastUpdated": "1967-02-12T16:43:30.231Z", "source": "nisi cupidatat incididunt", "topic": "pariatur", "_id": "4ec908c3c95efe02530bc069", "jst": null, "migrationVersion": 95486678 }, { "name": "myCoolDocumentName", "description": "Some helpful information about the document", "type": "manual", "enabled": false, "actionType": "automations", "actionId": "f41f635aedabadbcff637a33", "lastExecuted": 93579049, "createdBy": null, "created": "2018-01-23T11:08:22.359Z", "lastUpdatedBy": null, "lastUpdated": "1993-04-26T09:22:22.586Z", "formData": { "ip": "1.2.3.4", "name": "myNewDevice" }, "_id": "ba5d58aaca82be8fc5681ef9", "formId": "91d921dd637017109c2a481f", "migrationVersion": 63824849, "formSchemaHash": null }, { "name": "myCoolDocumentName", "description": "Some helpful information about the document", "type": "endpoint", "enabled": false, "actionType": "automations", "actionId": "78be7d6d60b95b740756c9ac", "lastExecuted": null, "createdBy": "ad dolore pariatur officia", "created": "1967-03-12T19:08:16.125Z", "lastUpdatedBy": "adipisicing id minim", "lastUpdated": "1987-05-10T03:06:25.924Z", "verb": "POST", "routeName": "z", "schema": null, "_id": "b0b545aed4743cf32c561133", "jst": "1a65f2a13c1352f603fa9945", "migrationVersion": 96540115 }, { "name": "myCoolDocumentName", "description": "Some helpful information about the document", "type": "manual", "enabled": true, "actionType": "automations", "actionId": "0fb60036b54124f889743268", "lastExecuted": 93929939, "createdBy": null, "created": "1980-08-03T10:51:39.898Z", "lastUpdatedBy": null, "lastUpdated": "1949-01-10T19:35:47.612Z", "formData": { "deviceName": "ATL-123", "action": "SYNC" }, "_id": "312db10d5998186a4010c9b0", "formId": "57fd399adf5f345925b89054", "migrationVersion": -87160420, "formSchemaHash": null }, { "name": "myCoolDocumentName", "description": "Some helpful information about the document", "type": "manual", "enabled": false, "actionType": "automations", "actionId": "824e8a47ddcc6730f64f66ac", "lastExecuted": 51708083, "createdBy": "occaecat consequat", "created": "1949-12-12T10:32:24.873Z", "lastUpdatedBy": null, "lastUpdated": "1950-12-05T02:19:48.505Z", "formData": { "ip": "1.2.3.4", "name": "myNewDevice" }, "_id": "7e8b4ab6282bbebc6f9cd0f7", "formId": "da7b48196231c426e9347d32", "migrationVersion": 59556147, "formSchemaHash": "nulla reprehenderit anim amet ullamco" } ] }
{ "title": "result", "allOf": [ { "$ref": "common-api#/definitions/success-response" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "trigger-api" } } } } ] }