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": "2020-12-03T19:55:43.189Z", "enabled": true, "actionId": "ad ex nostrud pariatur velit", "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": "myCoolDocumentName", "description": "Some helpful information about the document", "type": "manual", "enabled": false, "actionType": "automations", "actionId": "9465e839f9aa827b09de8422", "lastExecuted": 45805929, "createdBy": null, "created": "2017-08-08T22:13:44.768Z", "lastUpdatedBy": "sed", "lastUpdated": "1982-02-19T06:26:10.77Z", "formData": { "ip": "1.2.3.4", "name": "myNewDevice" }, "_id": "13449c753859b8b06f2fbce9", "formId": "18e0a7d98b0b752e7199c24a", "migrationVersion": 79244888, "formSchemaHash": "fugiat" }, { "name": "myCoolDocumentName", "description": "Some helpful information about the document", "type": "eventSystem", "enabled": true, "actionType": "automations", "actionId": "163d001179f755fb7544826a", "lastExecuted": null, "createdBy": null, "created": "1963-12-17T11:22:26.734Z", "lastUpdatedBy": "Lorem enim amet sint ullamco", "lastUpdated": "2007-07-01T00:30:45.629Z", "source": "ad est eiusmod", "topic": "nisi non", "schema": null, "_id": "38b4499a4daea5abdda6d627", "jst": "293deafd7ef766f0a5dee587", "migrationVersion": -97485428 }, { "name": "myCoolDocumentName", "description": "Some helpful information about the document", "type": "manual", "enabled": true, "actionType": "automations", "actionId": "ca2ae809e9495b1f93652d57", "lastExecuted": null, "createdBy": null, "created": "2017-12-10T14:00:26.792Z", "lastUpdatedBy": "laboris", "lastUpdated": "2011-09-06T18:29:24.939Z", "formData": { "deviceName": "ATL-123", "action": "SYNC" }, "_id": "4576f9018fae1c3c79bfe998", "formId": "08a42f0ffa25ad94fe57cba2", "migrationVersion": 46081419, "formSchemaHash": null }, { "name": "myCoolDocumentName", "description": "Some helpful information about the document", "type": "eventSystem", "enabled": false, "actionType": "automations", "actionId": "01053be11fee03b296a51409", "lastExecuted": 17879334, "createdBy": "proident nulla veniam ullamco", "created": "1959-09-02T23:40:26.928Z", "lastUpdatedBy": null, "lastUpdated": "1982-01-05T08:46:08.28Z", "source": "ex", "topic": "Duis ea sed ex officia", "schema": null, "_id": "b07000a290e59a41cb616148", "jst": null, "migrationVersion": 9739758 } ] }
{ "title": "result", "allOf": [ { "$ref": "common-api#/definitions/success-response" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "trigger-api" } } } } ] }