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": "Thu Dec 03 2020 14:55:00 GMT-0500 (Eastern Standard Time)", "lessThanField": "lastExecuted", "lessThan": "04/06/2021", "enabled": true, "actionId": "adipisicing fugiat incididunt", "limit": 1, "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 retrieved search results", "data": [ { "name": "myCoolDocumentName", "description": "Some helpful information about the document", "type": "eventSystem", "enabled": true, "actionType": "automations", "actionId": "de384a19305f92ff00e95b02", "lastExecuted": 73712788, "createdBy": "veniam consequat dolor nulla sit", "created": "2007-02-06T11:08:28.635Z", "lastUpdatedBy": "nulla Excepteur ipsum cillum", "lastUpdated": "1988-12-13T15:02:47.695Z", "source": "sit consectetur enim", "topic": "id in exercitation est", "schema": null, "_id": "1262aca64819a1e5190285d2", "jst": "e02cdd92761d6ddbdb5e82e1", "migrationVersion": -81724783, "legacyWrapper": true }, { "name": "myCoolDocumentName", "description": "Some helpful information about the document", "type": "eventSystem", "enabled": true, "actionType": "automations", "actionId": "4534a8abc9ae18f81d1144a8", "lastExecuted": null, "createdBy": null, "created": "1981-05-11T09:20:38.697Z", "lastUpdatedBy": null, "lastUpdated": "1962-10-08T10:09:54.562Z", "source": "non cillum cupidatat ut do", "topic": "ea culpa", "_id": "bedc37dd7a17294a071319eb", "jst": "61e24c4400d487f5ec80d337", "migrationVersion": 14573162, "legacyWrapper": true }, { "name": "occaecat", "description": 30767410, "type": 27523269, "enabled": -94139444.12897441, "actionType": 30824637.31474006, "actionId": 70855380, "lastExecuted": 62653325, "createdBy": 41592759, "created": "Ut", "lastUpdatedBy": true, "lastUpdated": 45135016, "formData": false, "firstRunAt": -28212855, "nextRunAt": "eu magna veniam", "processMissedRuns": "proident ullamco", "locked": 64401430, "repeatUnit": -99145815, "repeatFrequency": true, "repeatInterval": -25215033.27600251, "_id": true, "formId": 92980252.00394595 }, { "name": "myCoolDocumentName", "description": "Some helpful information about the document", "type": "manual", "enabled": true, "actionType": "automations", "actionId": "373da8c374f76ab23dd6d8ef", "lastExecuted": 885188, "createdBy": null, "created": "2008-10-06T19:38:38.422Z", "lastUpdatedBy": null, "lastUpdated": "1984-04-06T02:47:56.785Z", "formData": { "ip": "1.2.3.4", "name": "myNewDevice" }, "_id": "60e7eb2ac14f77596f948b3a", "formId": null, "migrationVersion": 7374757, "formSchemaHash": "exercitation quis dolore nostrud", "legacyWrapper": true }, { "name": "myCoolDocumentName", "description": "Some helpful information about the document", "type": "eventSystem", "enabled": true, "actionType": "automations", "actionId": "ae6709f7322ea511944305b2", "lastExecuted": null, "createdBy": "minim consequat nulla sint sunt", "created": "1999-06-29T14:31:43.847Z", "lastUpdatedBy": null, "lastUpdated": "1978-10-17T15:14:53.005Z", "source": "Ut nulla in elit", "topic": "aute esse", "_id": "5a186bb9993c68c1b33adc05", "jst": "e6fe31d26de1ccd6c1e665a6", "migrationVersion": 37641927, "legacyWrapper": true } ] }
{ "title": "result", "allOf": [ { "$ref": "common-api#/definitions/success-response" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "trigger-api" } } } } ] }