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": "2020-12-03T19:55:43.189Z", "enabled": true, "actionId": "proident nulla laborum eu ut", "limit": 50, "skip": 1, "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": "ut labore culpa", "description": 71772836, "type": false, "enabled": 19391165.81260687, "actionType": false, "actionId": -65745357.789837785, "lastExecuted": -8726768.669446856, "createdBy": "exercitation voluptate amet sit irure", "created": -646927, "lastUpdatedBy": true, "lastUpdated": 31859604.124871403, "formData": -40445980, "firstRunAt": -21690734.88589199, "nextRunAt": "in exercitation veniam", "processMissedRuns": 8298143, "locked": "consequat dolor", "repeatUnit": -12426143, "repeatFrequency": "consectetur tempor Duis veniam", "repeatInterval": -85654729.30720603, "_id": -60592130.75637406, "formId": 58705913.33268207 }, { "name": "myCoolDocumentName", "description": "Some helpful information about the document", "type": "eventSystem", "enabled": false, "actionType": "automations", "actionId": "35524d592b0b3c7572195247", "lastExecuted": null, "createdBy": null, "created": "1975-10-18T19:09:36.234Z", "lastUpdatedBy": "elit fugiat reprehenderit Duis", "lastUpdated": "1996-03-12T09:51:27.945Z", "source": "sint officia incididunt", "topic": "Duis dolor qui aliqua", "_id": "8ebae84165ab5ac8859bddea", "jst": null, "migrationVersion": 72235806 }, { "name": "myCoolDocumentName", "description": "Some helpful information about the document", "type": "manual", "enabled": false, "actionType": "automations", "actionId": "5bd3b7bfaf4f8fa722d51099", "lastExecuted": null, "createdBy": null, "created": "2010-05-05T07:26:04.281Z", "lastUpdatedBy": null, "lastUpdated": "1963-06-23T03:22:31.548Z", "formData": { "ip": "1.2.3.4", "name": "myNewDevice" }, "_id": "b5edc23e9d8f0614e8d0f08a", "formId": null, "migrationVersion": -50017804, "formSchemaHash": "fugiat dolore ex" }, { "name": "myCoolDocumentName", "description": "Some helpful information about the document", "type": "eventSystem", "enabled": true, "actionType": "automations", "actionId": "0063beb289002899fb019f66", "lastExecuted": 32381028, "createdBy": "eiusmod ullamco", "created": "1950-07-11T11:11:42.075Z", "lastUpdatedBy": "minim commodo eu ex deserunt", "lastUpdated": "2008-03-31T05:58:43.006Z", "source": "pariatur ut", "topic": "et ad amet esse exercitation", "_id": "de1c912b0918fb4fe53cfbfd", "jst": null, "migrationVersion": 42408762 }, { "name": "myCoolDocumentName", "description": "Some helpful information about the document", "type": "eventSystem", "enabled": false, "actionType": "automations", "actionId": "d32698aefe1b552984815a39", "lastExecuted": 53998308, "createdBy": "eiusmod occaecat deserunt velit nulla", "created": "2012-02-17T06:00:15.865Z", "lastUpdatedBy": "qui quis aliquip cupidatat consectetur", "lastUpdated": "1993-02-12T16:45:04.593Z", "source": "eiusmod sunt exercitation", "topic": "quis", "_id": "5aaee1cf5c617b8d7d70fc6d", "jst": null, "migrationVersion": 16739881 } ] }
{ "title": "result", "allOf": [ { "$ref": "common-api#/definitions/success-response" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "trigger-api" } } } } ] }