Summary
Gets Tasks
Description
Search the Task collection.
Route
GET /operations-manager/tasks
Roles
Parameters
Name | Type | Required | Description |
---|---|---|---|
queryParameters | object | yes | The query parameters available for this method. |
{ "queryParameters": { "limit": 25, "skip": 1, "order": 1, "sort": "name", "include": "name,description", "exclude": "description", "in": "ipsum amet ex ut sed", "not-in": "quis ut deserunt aute fugiat", "equals": "in", "contains": "sint Duis exercitation", "starts-with": "irure Lorem", "ends-with": "non commodo sint", "dereference": "laboris nulla dolore irure enim", "gt": "exercitation eiusmod ut laboris Excepteur", "gte": "aliquip eu", "lt": "laboris minim", "lte": "sit dolor elit aute do", "q": "mollit proident qui ea cillum", "actionableTasks": false } }
{ "type": "object", "properties": { "queryParameters": { "title": "queryParameters", "type": "object", "properties": { "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": "Sort direction, 1 for ascending and -1 for descending.", "default": 1, "enum": [ -1, 1 ] }, "sort": { "type": "string", "description": "Field to sort by", "default": "name", "enum": [ "name" ] }, "include": { "type": "string", "description": "Inclusive projection operator formatted as a comma-delineated list. '_id' will be included implicitly unless excluded with 'exclude=_id'. May only be used in conjunction with 'exclude' when 'exclude=_id'.", "examples": [ "name", "description", "name,description" ] }, "exclude": { "type": "string", "description": "Exclusive projection operator formatted as a comma-delineated list. May only be used in conjunction with 'include' when 'exclude=_id'.", "examples": [ "_id", "description", "_id,description" ] }, "in": { "description": "Search for fields exactly matching one of the given list options", "type": "string" }, "not-in": { "description": "Search for fields not exactly matching one of the given list options", "type": "string" }, "equals": { "description": "Returns results where the specified fields exactly match the given match string(s).", "type": "string" }, "contains": { "description": "Returns results where the specified fields contain the given match string(s).", "type": "string" }, "starts-with": { "description": "Returns results where the specified fields start with the given match string(s).", "type": "string" }, "ends-with": { "description": "Returns results where the specified fields end in the given match string(s).", "type": "string" }, "dereference": { "description": "Designates foreign key fields to dereference in the API output.", "type": "string" }, "gt": { "description": "Returns results where the specified fields have values greater than the specified values.", "type": "string" }, "gte": { "description": "Returns results where the specified fields have values greater than or equal to the specified values.", "type": "string" }, "lt": { "description": "Returns results where the specified fields have values less than the specified values.", "type": "string" }, "lte": { "description": "Returns results where the specified fields have values less than or equal to the specified values.", "type": "string" }, "q": { "description": "Accepts a full query expression as a URL-encoded JSON object. Supports all other query operators, in addition to logical conjunction with 'and', disjunction with 'or', and negation with 'not'. May be combined with other top-level operators.", "type": "string" }, "actionableTasks": { "type": "boolean", "description": "If true, only returns actionable tasks that the current user has write access to.", "default": false } } } }, "required": [ "queryParameters" ], "additionalProperties": false }
Return
Name | Type | Description |
---|---|---|
result | object | The Tasks that matched the search query. |
{ "message": "Successfully retrieved search results", "data": [ { "_id": "93521032-b65D-503b-72Cc-9Ec85cdF7C41", "location": "Broker", "view": null, "status": "paused", "app": "consectetur", "name": "ut in sint elit", "variables": { "decorators": [ { "type": "encryption", "pointer": "/uH/B47/D74vl/~0/UwJvgr10o/FrvEqFPx/~1/~1/Kowkyc--/MdLqCrai3C/~0/~0" }, { "type": "encryption", "pointer": "/c/~0/~0/PGdTgSq/PHlEj/u+QvBQmsI/~0/Hu2-X4/" }, { "type": "encryption", "pointer": "/UwSkMCECg//PZwn1NSnab/D/U/~0" }, { "type": "encryption", "pointer": "/~0/~0/~1/Akni3tf/~0/sltkQ9" }, { "type": "encryption", "pointer": "/o/m6g/~0/Uqydz4vi1tl/~1/~1/~0/~0/sQkfdLwHpm4" } ] }, "last_updated": "1956-04-27T11:33:50.662Z", "encodingVersion": 1, "job": { "_id": "fc403cf769cffab8840db49c", "task": "b4f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": null }, "incomingRefs": [], "groups": [ { "_id": "97429b603aabe0ca3437401f", "provenance": "sunt cillum ut id", "name": "dolor qui tempor", "description": "sed irure laborum", "memberOf": [ { "groupId": "9376de87308b3fb3a72da63c", "aaaManaged": true }, { "groupId": "b7b6f9f64c92ea865e0aac3b", "aaaManaged": true }, { "groupId": "9a268e351abcbcc93f9c715a", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "pariatur sed" }, { "roleId": "nisi" } ], "inactive": true, "_meta": { "created": "1989-10-14T18:46:07.657Z", "updated": "1984-01-08T06:45:52.916Z", "migrationVersion": 5104648 } }, "db3689e517003734e8eec36a", { "_id": "c408d1c9f6fc1459cf4cdfab", "provenance": "Excepteur incididunt nisi officia", "name": "Lorem anim", "description": "voluptate est officia", "memberOf": [ { "groupId": "671b627de72b22d2f3b0ef9f", "aaaManaged": true }, { "groupId": "d95f237dbd79852b37a58227", "aaaManaged": true }, { "groupId": "60895d4e171b933bde077f6b", "aaaManaged": true }, { "groupId": "1b3d0a90141b8c609b185464", "aaaManaged": false }, { "groupId": "51a65165448b2e8537eb6e2b", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "incididunt voluptate minim nisi" } ], "inactive": false, "_meta": { "created": "1994-01-28T05:28:38.909Z", "updated": "2008-11-05T11:09:41.566Z", "migrationVersion": 71959700 } } ], "type": "manual", "metrics": { "start_time": "laborum voluptate consectetur", "claim_time": "1958-07-30T04:45:51.899Z", "end_time": 47407219.50169936, "server_id": "quis mollit", "finish_state": "failure", "run_time": -71966021.4440656, "user": "Pronghorn", "owner": "Pronghorn" } }, { "_id": "f79BBe2C-1aCF-7B44-7C3D-EeacdafdDF95", "location": "Broker", "view": "Excepteur eiusmod", "status": "complete", "app": "commodo elit tempor exercitation consequat", "name": "incididunt", "variables": { "decorators": [ { "type": "encryption", "pointer": "/VQkK5DW5ine/LzEcig/+-/DF-BIJGjmlu/i/~1" }, { "type": "encryption", "pointer": "/~0" }, { "type": "encryption", "pointer": "/ljhY/~0/yL.4cd/~1/~1/CQ-vDR/OjK1vxobS" }, { "type": "encryption", "pointer": "/q/~0/~0/h/ahxurM/qSwtWA/~1/RS/~1/i79Ug/~1" }, { "type": "encryption", "pointer": "/~1/~0/gY/~1/~0/~0/Ri69CAzuQ7T" } ] }, "last_updated": "1966-05-07T17:24:00.217Z", "encodingVersion": 1, "job": { "_id": "fecca6f41a2ceed30d8904ab", "task": "e28f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": null }, "incomingRefs": [], "groups": [ "599c5ea5faf57be7225288b0", { "_id": "36a30d9d5e578bff4f85b8e1", "provenance": "voluptate esse occaecat in minim", "name": "minim amet", "description": "sed reprehenderit", "memberOf": [ { "groupId": "07f7a91922778cfd563d1b3e", "aaaManaged": false }, { "groupId": "e65fb29e9cadb63dcfcf3dd7", "aaaManaged": true }, { "groupId": "a1b41fa64e86c7de7fed5494", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "ad" }, { "roleId": "esse" }, { "roleId": "occaecat do" } ], "inactive": false, "_meta": { "created": "1987-01-31T16:17:47.09Z", "updated": "1963-06-18T15:54:32.343Z", "migrationVersion": -74826846 } }, "d7419512f9071fb6c2bb30ab", "4e0ca0ec8fd9bd94398f5ae4" ], "type": "manual", "metrics": { "start_time": "nulla in sed labore exercitation", "claim_time": "2016-09-14T02:16:14.03Z", "end_time": 16945649.59908788, "server_id": "veniam nostrud elit", "finish_state": "paused", "run_time": 42272255.718830496, "user": { "_id": "455ee2b87bb0cc296179863f", "provenance": "adipisicing dolor", "username": "fugiat", "firstname": "nisi", "memberOf": [ { "groupId": "9006073a17985b2aab5ea2d3", "aaaManaged": true }, { "groupId": "5f11906d852d38e07de99ca8", "aaaManaged": true }, { "groupId": "67693529f7bbe012b8287184", "aaaManaged": true }, { "groupId": "bf5e108e5d435657e9e4f03f", "aaaManaged": false }, { "groupId": "e2fae125c079013f01a44180", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "enim" }, { "roleId": "exercitation amet sunt enim" }, { "roleId": "in" }, { "roleId": "Lorem" } ], "inactive": true, "lastLogin": "1955-12-25T00:27:25.009Z", "_meta": { "created": "1968-11-30T18:29:45.549Z", "updated": "1956-04-07T08:44:23.289Z", "migrationVersion": -51823179 }, "email": "sed" }, "owner": { "_id": "fa96cddff9351fd899a3657c", "provenance": "id aute est sed", "username": "sed", "firstname": "cillum culpa Ut sint sed", "memberOf": [ { "groupId": "437e629a0111522395b1f64c", "aaaManaged": false }, { "groupId": "df5115a930578c4cec3cdf7c", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "sint" }, { "roleId": "Lorem et eu mollit" }, { "roleId": "amet sunt adipisicing" } ], "inactive": true, "lastLogin": "1979-06-29T13:18:32.038Z", "_meta": { "created": "1970-09-08T10:13:39.265Z", "updated": "1960-10-24T11:29:01.199Z", "migrationVersion": 39803286 }, "email": "culpa do" } } }, { "_id": "39aC7AFf-C871-2Bf9-4a73-79A203Ce3ec5", "location": "Application", "view": "Lorem aliqua aliquip quis elit", "status": "complete", "app": "enim in eiusmod incididunt", "name": "sint eiusmod consectetur aliqua", "variables": { "decorators": [ { "type": "encryption", "pointer": "/~0/~1/~0" }, { "type": "encryption", "pointer": "/EMJLpt6DtIa" }, { "type": "encryption", "pointer": "/~0/~0/~1/T14ms/~0/JoAvh/VpI/~1/XhMVRn/~0" }, { "type": "encryption", "pointer": "/~0/gXA/Kvci4o/nTfdM./~0/~1/V/~0/jp6a3U/~0" } ] }, "last_updated": "2020-08-27T21:37:50.752Z", "encodingVersion": 1, "job": { "_id": "a2d3a4a92e623d0645bfbe91", "task": "b4f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": null }, "incomingRefs": [], "groups": [ { "_id": "f642ab697e4f121d47a1d673", "provenance": "aliqua non deserunt", "name": "est", "description": "laboris", "memberOf": [ { "groupId": "1e6eeb1d116410dce5a4efa8", "aaaManaged": false }, { "groupId": "7d6ec21356a0651cec384341", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "Duis" } ], "inactive": true, "_meta": { "created": "1959-10-02T08:21:52.775Z", "updated": "1976-06-06T02:12:35.983Z", "migrationVersion": 49107217 } }, "edd116011f396f18e395b066" ], "type": "manual", "metrics": { "start_time": "occaecat", "claim_time": "1973-12-17T07:06:26.817Z", "end_time": 12635551.042875022, "server_id": "aute eu", "finish_state": "running", "run_time": 15400459.73243767, "user": "e4f064ac2eeb5182f5371ec6", "owner": "01bad50d29fc9cef15a0a31c" } }, { "_id": "Db0cc64C-Fea9-dBfA-cfdF-B8C3C16D75fd", "location": "Application", "view": null, "status": "complete", "app": "eu", "name": "minim nisi dolor", "variables": { "decorators": [ { "type": "encryption", "pointer": "/~0" }, { "type": "encryption", "pointer": "/RgMEOa" }, { "type": "encryption", "pointer": "/N" } ] }, "last_updated": "1990-12-15T15:53:44.497Z", "encodingVersion": 1, "job": { "_id": "9a7cb84f701af6266fee949d", "task": "e28f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": [ "a3799ece97da8c8a82376c8c", "1b096d3781a57cc2b542524e" ] }, "incomingRefs": [], "groups": [ { "_id": "2ba4c048b45d51258b14e965", "provenance": "fugiat Ut minim", "name": "mollit id laborum", "description": "magna occaecat", "memberOf": [ { "groupId": "3f2fa8753df55294828a26ad", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "aliquip nisi labore pariatur" } ], "inactive": false, "_meta": { "created": "1956-10-14T23:14:41.737Z", "updated": "1992-07-24T22:13:23.772Z", "migrationVersion": 86374196 } }, "d9b795335fe20a3b9bc9d71e", "803e12815d7f0c280f157f8c", "941a7e3541554b79fda8493d" ], "type": "manual", "metrics": { "start_time": "occaecat irure in id Ut", "claim_time": "2015-01-01T14:43:37.082Z", "end_time": 98303768.54380634, "server_id": "reprehenderit pariatur laborum culpa", "finish_state": "canceled", "run_time": -24189889.674830317, "user": "", "owner": "1c77671c66c617231d95fe97" } }, { "_id": "BB5a4E26-Fa4B-eb9d-5AF2-9cfa3CE11A45", "location": "Adapter", "view": "irure minim aute qui in", "status": "complete", "app": "consequat dolor minim tempor do", "name": "ut tempor non", "variables": { "decorators": [ { "type": "encryption", "pointer": "/S9fB9RB-5tW/HE/IX88lZIIN,5/~0/cRZa0M.Gm/~0/fnUMmjb4/IdgZXJInrJ./~0/UK" }, { "type": "encryption", "pointer": "/QvaNPmDYO/likCk48i0Kx/~1/Hm+0.M1p/oKBgXW0fzJ/u220D2Rx/SVGb" }, { "type": "encryption", "pointer": "/~1/~1/~0/WGPYorfT/eRzAptv+5sH/~1/~0/S6Ih+C" }, { "type": "encryption", "pointer": "/PC/tVm/tmrk-CXDL/~1/q0rY/UutQKY/~1" } ] }, "last_updated": "1973-02-25T00:40:49.942Z", "encodingVersion": 1, "job": { "_id": "6403e8d6bb16bff3c7e383c3", "task": "e28f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": null }, "incomingRefs": [], "groups": [ "bf4a0e68db1c9fa5077162c0", { "_id": "626cab593d23bb551c9ed44e", "provenance": "in esse adipisicing ut cupidatat", "name": "ut in ipsum", "description": "aute tempor in", "memberOf": [ { "groupId": "b0b134079fd9b8c572c14871", "aaaManaged": true }, { "groupId": "00575ae43f0d6a4e643bc4e3", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "id exercitation pariatur Excepteur" } ], "inactive": true, "_meta": { "created": "1952-09-21T21:41:35.628Z", "updated": "1982-06-14T19:55:09.905Z", "migrationVersion": 56413619 } }, "ba9fc3c42874809ee0215431", { "_id": "5da9281a353889e4a05da25d", "provenance": "minim", "name": "proident et", "description": "elit", "memberOf": [ { "groupId": "eadb29ee5c36402025fb2a2d", "aaaManaged": true }, { "groupId": "045437eb60e32d78f743e0ab", "aaaManaged": true }, { "groupId": "838ccb060249217a89afb5b4", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "consequat ad occaecat do" }, { "roleId": "eiusmod" } ], "inactive": false, "_meta": { "created": "2023-11-04T02:03:20.953Z", "updated": "1981-12-05T13:08:11.075Z", "migrationVersion": -33244661 } } ], "type": "manual", "metrics": { "start_time": "est voluptate tempor commodo dolor", "claim_time": "1949-10-18T15:01:13.856Z", "end_time": 95260656.83210695, "server_id": "fugiat labore non consequat esse", "finish_state": "paused", "run_time": 234905.9678056836, "user": "Pronghorn", "owner": "Pronghorn" } } ], "metadata": { "skip": -9741223, "limit": 83812212, "total": -77621090, "nextPageSkip": null, "previousPageSkip": null, "currentPageSize": -27184342 } }
{ "title": "result", "allOf": [ { "$ref": "common-api#/definitions/success-response" }, { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "task-api" } }, "metadata": { "$ref": "common-api#/definitions/pagination-metadata" } } } ] }