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": "Thu Nov 15 2018 01:30:00 GMT-0500 (Eastern Standard Time)", "enabled": false, "actionId": "laboris 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 imported 3 of 4 documents", "data": [ { "name": "myCoolDocumentName", "description": "Some helpful information about the document", "type": "endpoint", "enabled": false, "actionType": "automations", "actionId": "6723fb7cc1c135d373a67de3", "lastExecuted": null, "createdBy": null, "created": "1993-04-17T03:56:53.006Z", "lastUpdatedBy": null, "lastUpdated": "1993-02-22T07:23:15.944Z", "verb": "POST", "routeName": "-YtdCKWM", "schema": null, "_id": "d8b3b6f150f06fe48d46896f", "jst": null, "migrationVersion": 53430912 }, { "name": "myCoolDocumentName", "description": "Some helpful information about the document", "type": "eventSystem", "enabled": false, "actionType": "automations", "actionId": "9cb9e0a0b7f9b7e2850e33a1", "lastExecuted": null, "createdBy": "sint consectetur aliqua do", "created": "1990-09-10T19:09:24.867Z", "lastUpdatedBy": null, "lastUpdated": "1952-09-29T10:04:18.588Z", "source": "dolor eu voluptate ut mollit", "topic": "in laborum officia sunt", "legacyWrapper": true, "_id": "c80dce963b81ebfdf762bf67", "jst": "d62dab0e6416b1bdb7d8573e", "migrationVersion": -91447531 }, { "name": "myCoolDocumentName", "description": "Some helpful information about the document", "type": "manual", "enabled": true, "actionType": "automations", "actionId": "4685c977510b1bd7b9f7031f", "lastExecuted": null, "createdBy": null, "created": "1949-07-25T20:16:51.992Z", "lastUpdatedBy": null, "lastUpdated": "2001-12-14T18:58:55.532Z", "formData": { "deviceName": "ATL-123", "action": "SYNC" }, "legacyWrapper": true, "_id": "68203b5fe77c4b9730d70f13", "formId": null, "migrationVersion": -90897481, "formSchemaHash": "ex consectetur" }, { "name": "myCoolDocumentName", "description": "Some helpful information about the document", "type": "endpoint", "enabled": true, "actionType": "automations", "actionId": "fd3a718257e1ac4ca5d0d544", "lastExecuted": null, "createdBy": "incididunt magna aliquip cupidatat", "created": "1996-02-01T04:30:12.664Z", "lastUpdatedBy": "et nostrud ut mollit", "lastUpdated": "1969-06-20T08:17:54.957Z", "verb": "POST", "routeName": "cJ", "_id": "5535d0eb53fc075f5c64449a", "jst": null, "migrationVersion": 65674368 } ] }
{ "title": "result", "allOf": [ { "$ref": "common-api#/definitions/success-response" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "trigger-api" } } } } ] }