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": 10, "skip": 10, "order": 1, "sort": "name", "include": "description", "exclude": "_id,description", "in": "amet incididunt in proident ad", "not-in": "elit sunt veniam", "equals": "voluptate laboris ut adipisicing", "contains": "ipsum eiusmod amet incididunt labore", "starts-with": "nostrud", "ends-with": "ex exercitation", "dereference": "id Lorem", "gt": "non voluptate amet ut", "gte": "non aliquip Lorem", "lt": "dolor cupidatat ullamco dolore", "lte": "Duis in veniam in", "q": "aute esse tempor ut anim", "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 created the requested item", "data": [ { "_id": "fBCa9bD2-75a8-fb41-ae2c-22C23979b248", "location": "Adapter", "view": "do amet ipsum", "status": "failure", "app": "proident velit do sit", "name": "id irure ut laboris reprehenderit", "variables": { "decorators": [ { "type": "encryption", "pointer": "/~1/MU.q1eEF" }, { "type": "encryption", "pointer": "/C/iiODsM/~1/~1" }, { "type": "encryption", "pointer": "/~0/~0/D7P-/3FP/~0/b79-j" }, { "type": "encryption", "pointer": "/~1/pyjZfa9+IQx/Ju0FiO0/pvR/~0/~0/Cb33n6n7xS/uH" }, { "type": "encryption", "pointer": "/qFpEM/~1/hnd5XO0VLg/~1/~0/B4R2jh,ksf/~0" } ] }, "last_updated": "1996-01-22T19:19:09.896Z", "encodingVersion": 1, "job": { "_id": "b53216ed5f180f681d84c202", "task": "b4f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": [ "4b36cd6d95a78947aae88547" ] }, "groups": [ "885807a03c0597653d40f7d9", { "_id": "051280496fb25cc31713f65d", "provenance": "nostrud qui exercitation", "name": "proident", "description": "pariatur consectetur dolore est proident", "memberOf": [ { "groupId": "786e89f7fe79d20087704f17", "aaaManaged": false }, { "groupId": "6e1d010060c7ce77f2ba8097", "aaaManaged": true }, { "groupId": "3ac89d4923f69f97a6d8570c", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "dolore laboris qui magna" }, { "roleId": "enim aliqua dolore eu" }, { "roleId": "ipsum officia sunt quis" }, { "roleId": "minim ea culpa cillum" }, { "roleId": "deserunt dolore nostrud" } ], "inactive": true, "_meta": { "created": "1954-02-09T08:54:03.492Z", "updated": "1978-04-28T07:34:11.458Z", "migrationVersion": 97637429 } }, { "_id": "b71e1ef907e59f4c9e35f190", "provenance": "ipsum non dolore sint eiusmod", "name": "commodo et dolor ea culpa", "description": "esse dolore consequat labore ea", "memberOf": [ { "groupId": "19bf566a929b3d902399a118", "aaaManaged": false }, { "groupId": "6d7db1be9fce88c81e11183b", "aaaManaged": true }, { "groupId": "b7e6a0c096ebdf9eac1da56a", "aaaManaged": true }, { "groupId": "b31daf6d63c1a168c66311e8", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "Excepteur minim Lorem" }, { "roleId": "aute eiusmod proident" }, { "roleId": "Lorem aliqua aliquip veniam" }, { "roleId": "voluptate cupidatat dolor exercitation culpa" } ], "inactive": false, "_meta": { "created": "2004-01-31T05:19:14.263Z", "updated": "2005-07-26T02:12:55.996Z", "migrationVersion": -65190073 } }, "caf8383be7680e33fafd607c", "a538708448a7ce7014bc1b88" ], "type": "operation", "metrics": { "start_time": "in pariatur officia", "end_time": 66195700.28268686, "server_id": "laboris", "finish_state": "success", "run_time": -15460842.122818217, "retrying": null, "user": "a1d93d27bb29151295b79e7e", "owner": "5fda6056bdaed0bd7a94660e" } }, { "_id": "C09eA51E-EaBe-d8Aa-F3ea-3324Ff7b3899", "location": "Application", "view": null, "status": "incomplete", "app": "ullamco Excepteur", "name": "velit sit deserunt", "variables": { "decorators": [ { "type": "encryption", "pointer": "/f8byO/KCmp2XJvL/~1/H31Q/~1/z5/8Z" }, { "type": "encryption", "pointer": "/OhTPn/Uxa/k-0/~1/~0/sfP+.xqd/n6MzY,o2SOh/~1/fx9QD/S/~1" }, { "type": "encryption", "pointer": "/FbQQ/KzuK+.LEBMp" }, { "type": "encryption", "pointer": "/l/rSU5Gu/~0/ZAXXk/Xc2k" } ] }, "last_updated": "1994-06-20T15:54:22.816Z", "encodingVersion": 1, "job": { "_id": "6b0d7662a3feed50bcb0b6ad", "task": "e28f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": [ "25677f6fd9ee59319de8a837", "a5373894bef1817d7efa080e", "bca3153f142614c2110b4bd6", "e7eada96b404b46d609737f2" ] }, "groups": [ "8fdd80824fe4c81cb54d8986", { "_id": "855aaf3b4f6a00d74267da4b", "provenance": "id sunt eu aliquip do", "name": "aliqua nostrud irure officia laboris", "description": "cupidatat ut", "memberOf": [ { "groupId": "d4eed872bedf59396136d4dd", "aaaManaged": true }, { "groupId": "7c113a0007742f8da8233251", "aaaManaged": false }, { "groupId": "0f38a7f51d3d4d3349d7bfd9", "aaaManaged": true }, { "groupId": "7c189ad02c4af26968b823c2", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "dolore exercitation irure" } ], "inactive": true, "_meta": { "created": "2017-08-21T21:47:29.975Z", "updated": "1997-02-23T00:44:16.168Z", "migrationVersion": -45623684 } }, { "_id": "444142488311ef58d0d029ba", "provenance": "deserunt", "name": "id", "description": "ut", "memberOf": [ { "groupId": "f85b9908e68873a6f82542f1", "aaaManaged": false }, { "groupId": "b86b40df31ac6ae76ad46c42", "aaaManaged": false }, { "groupId": "0107f33cc508c4e17edb068a", "aaaManaged": true }, { "groupId": "c0aaab6832d5dc40e3fb8c9d", "aaaManaged": true }, { "groupId": "cfcd85c526fe355a8c7dfae1", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "in" }, { "roleId": "eu in pariatur" } ], "inactive": false, "_meta": { "created": "1979-11-27T15:58:38.21Z", "updated": "1999-10-08T00:56:43.562Z", "migrationVersion": 37444793 } }, { "_id": "0e891ebed15a906f021d65b6", "provenance": "laboris nulla", "name": "Duis in ut non sint", "description": "ut ut", "memberOf": [ { "groupId": "49e2ded12a4d906d4343080b", "aaaManaged": false }, { "groupId": "7fee24c9accda78974208a49", "aaaManaged": true }, { "groupId": "ade2d299b7e74a37e07eadbc", "aaaManaged": false }, { "groupId": "eceb5f705beb52fd10de7d59", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "sed" }, { "roleId": "commodo aliqua qui sunt" } ], "inactive": true, "_meta": { "created": "2025-05-28T00:28:40.09Z", "updated": "1947-04-09T11:29:43.069Z", "migrationVersion": -54216367 } } ], "type": "operation", "metrics": { "start_time": "in sint velit", "end_time": -64249743.63874032, "server_id": "ut", "finish_state": "success", "run_time": -16699828.649466172, "retrying": null, "user": { "_id": "cfe8f23d5bface71ed7d7ae5", "provenance": "ut ipsum", "username": "enim proident ut tempor id", "firstname": "aliquip fugiat sed", "memberOf": [ { "groupId": "36104a75b0843d9458e67780", "aaaManaged": false }, { "groupId": "587b3a519be5dfd6cac06839", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "incididunt adipisicing velit sunt" }, { "roleId": "id tempor" } ], "inactive": false, "lastLogin": "1992-05-12T10:17:42.095Z", "_meta": { "created": "1987-09-15T22:33:09.782Z", "updated": "1956-04-20T11:30:39.741Z", "migrationVersion": -84274729 }, "email": "Lorem ut nostrud" }, "owner": { "_id": "a3016df31c6846eef8d090d8", "provenance": "ad", "username": "aliqua dolor labore cupidatat reprehenderit", "firstname": "culpa Ut sed", "memberOf": [ { "groupId": "f9923bd746dde0fc290d91ab", "aaaManaged": true }, { "groupId": "97135d344920295ac38d9fc2", "aaaManaged": true }, { "groupId": "700b71810a5d8c8ae7e6ae16", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "aliqua" }, { "roleId": "incididunt" } ], "inactive": true, "lastLogin": "2006-05-23T09:30:10.343Z", "_meta": { "created": "2015-02-23T06:12:24.763Z", "updated": "1997-11-14T07:08:12.558Z", "migrationVersion": -22666500 }, "email": "id elit dolor fugiat" } } } ], "metadata": { "skip": 43229392, "limit": 53554406, "total": 2134083, "nextPageSkip": 82153773, "previousPageSkip": null, "currentPageSize": 79954657 } }
{ "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" } } } ] }