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": true, "actionId": "magna elit sed aute", "limit": 10, "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 created the requested item", "data": [ { "name": 30022196.344636276, "description": -62917452, "type": 36389483.95157993, "enabled": -27087961, "actionType": true, "actionId": -7345487.139914036, "lastExecuted": -80251979, "createdBy": "cillum ipsum non", "created": -21472444.596707836, "lastUpdatedBy": -75881438, "lastUpdated": "ut occaecat mollit non ullamco", "formData": 13434272, "firstRunAt": 13841478, "nextRunAt": 26698135.195060775, "processMissedRuns": -37010709, "locked": 72445504, "repeatUnit": false, "repeatFrequency": -8430323.440934107, "repeatInterval": -15395960, "_id": false, "formId": 47006484 }, { "name": "myCoolDocumentName", "description": "Some helpful information about the document", "type": "endpoint", "enabled": false, "actionType": "automations", "actionId": "89a49aa11691d78b27893c7d", "lastExecuted": null, "createdBy": "cupidatat ad", "created": "2023-09-30T00:40:55.459Z", "lastUpdatedBy": null, "lastUpdated": "1980-08-13T05:59:43.481Z", "verb": "POST", "routeName": "9", "_id": "f9f8b13ec6ff131f10361f45", "jst": null, "migrationVersion": 92793743 }, { "name": "myCoolDocumentName", "description": "Some helpful information about the document", "type": "manual", "enabled": true, "actionType": "automations", "actionId": "f8ced96d1ad14a26979eb91b", "lastExecuted": null, "createdBy": null, "created": "1952-12-28T18:59:24.615Z", "lastUpdatedBy": "ad qui commodo aute ipsum", "lastUpdated": "1981-03-05T07:51:13.11Z", "formData": { "deviceName": "ATL-123", "action": "SYNC" }, "_id": "0786d2cbb699f34873eb8075", "formId": "4c1a69db641e723815105037", "migrationVersion": -19984414, "formSchemaHash": null }, { "name": "myCoolDocumentName", "description": "Some helpful information about the document", "type": "endpoint", "enabled": true, "actionType": "automations", "actionId": "61cf38b8c18871f20f930b79", "lastExecuted": 20532632, "createdBy": null, "created": "2010-05-10T00:49:11.034Z", "lastUpdatedBy": null, "lastUpdated": "1955-06-11T00:53:40.818Z", "verb": "POST", "routeName": "jGcs", "schema": null, "_id": "833de5657c4843421d4b3fcb", "jst": "a657e3ef7073139eb4866735", "migrationVersion": -10970798 }, { "name": "myCoolDocumentName", "description": "Some helpful information about the document", "type": "endpoint", "enabled": true, "actionType": "automations", "actionId": "5bda73a8547626123d17e408", "lastExecuted": null, "createdBy": null, "created": "1992-04-22T08:11:06.922Z", "lastUpdatedBy": "Excepteur adipisicing culpa commodo", "lastUpdated": "2023-10-08T03:26:57.259Z", "verb": "POST", "routeName": "zDG", "schema": null, "_id": "15dff9345d6c118b668b4bf6", "jst": "e4f25a3a49831e90a9fcb57f", "migrationVersion": -54866310 } ] }
{ "title": "result", "allOf": [ { "$ref": "common-api#/definitions/success-response" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "trigger-api" } } } } ] }