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": 1, "order": 1, "sort": "name", "include": "name,description", "exclude": "_id,description", "in": "dolor commodo", "not-in": "pariatur in", "equals": "ipsum occaecat", "contains": "culpa", "starts-with": "ex ipsum aliquip esse fugiat", "ends-with": "dolor eiusmod", "dereference": "Duis labore", "gt": "ullamco Excepteur esse", "gte": "incididunt dolor in", "lt": "consequat sint amet fugiat", "lte": "deserunt anim irure et ipsum", "q": "incididunt consequat laborum", "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": "A00228F6-adCD-154e-CfDa-DB50042C7e82", "location": "Adapter", "view": "dolore", "status": "canceled", "app": "culpa", "name": "ut aute", "variables": { "decorators": [ { "type": "encryption", "pointer": "/~1" }, { "type": "encryption", "pointer": "/~0/w/~0" } ] }, "last_updated": "2022-02-08T15:29:40.636Z", "encodingVersion": 1, "job": { "_id": "6b5f7c0083d13e3d419f0aaa", "task": "3a1f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": null }, "incomingRefs": [], "groups": [ "956ef2e88a05cbd961cff241" ], "type": "manual", "metrics": { "start_time": "sit ut", "claim_time": "2016-04-21T06:15:56.818Z", "end_time": 78940777.12005228, "server_id": "veniam ut consectetur est", "finish_state": "failure", "run_time": -31676759.985110074, "user": { "_id": "17bd665feb58df435712d9e7", "provenance": "cupidatat", "username": "tempor ea consequat Ut reprehenderit", "firstname": "cillum", "memberOf": [ { "groupId": "51248932a889ab40659cdeda", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "fugiat proident ad" }, { "roleId": "sit officia labore" }, { "roleId": "deserunt ad dolor consectetur sit" }, { "roleId": "est in sed" } ], "inactive": true, "lastLogin": "2012-06-25T04:53:41.234Z", "_meta": { "created": "2018-06-21T23:04:45.223Z", "updated": "1995-09-13T13:26:59.995Z", "migrationVersion": 84951058 }, "email": "culpa Excepteur dolor" }, "owner": "14d4bd91941c6aae846b751c" } }, { "_id": "7ABF225c-272B-aF19-b8B7-9ced9CAE5a14", "location": "Broker", "view": "consequat magna qui eu", "status": "paused", "app": "velit", "name": "dolor velit", "variables": { "decorators": [ { "type": "encryption", "pointer": "/I/~0/XdW-as6Qjz/~0/wahCFoJQN" } ] }, "last_updated": "2017-12-27T12:33:15.017Z", "encodingVersion": 1, "job": { "_id": "e3c3aa5b2b287e8688f8474e", "task": "3a1f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": [ "7a7618225d39b875ee496b03" ] }, "incomingRefs": [], "groups": [ { "_id": "9d9bca15337a803958e2dc32", "provenance": "enim fugiat Ut", "name": "incididunt eiusmod sunt ut voluptate", "description": "veniam labore ipsum est", "memberOf": [ { "groupId": "7831108116fee6a93ce50334", "aaaManaged": false }, { "groupId": "3104859d8101c498d76c81c7", "aaaManaged": true }, { "groupId": "e800f9df8a491b79e2611fb2", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "est commodo do fugiat laborum" }, { "roleId": "et eiusmod dolor labore" }, { "roleId": "dolore proident" }, { "roleId": "amet velit eu" } ], "inactive": false, "_meta": { "created": "1989-03-17T15:54:09.991Z", "updated": "2010-05-14T17:49:43.709Z", "migrationVersion": 89562720 } }, "cc95a45ee2273968cd9a011c", "98a5618ea6ddf21d7abd97d7", { "_id": "7aa7f1592223e59ac116af85", "provenance": "fugiat ex", "name": "ea aute in", "description": "sint enim", "memberOf": [ { "groupId": "b56418b63ae1a6a8cf6dbbfc", "aaaManaged": false }, { "groupId": "b391e8fa912f618abfd05a4d", "aaaManaged": true }, { "groupId": "001150722f99f3436d0e487b", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "aute dolor magna" }, { "roleId": "minim" }, { "roleId": "ex laboris officia ut" }, { "roleId": "labore in in" }, { "roleId": "non dolor" } ], "inactive": false, "_meta": { "created": "1972-10-27T21:24:17.688Z", "updated": "2009-03-14T05:18:55.568Z", "migrationVersion": 82171738 } }, "f10803ffa256b2b1314a62f9" ], "type": "manual", "metrics": { "start_time": "veniam aute Lorem", "claim_time": "1966-05-31T01:42:40.81Z", "end_time": -27198582.64047797, "server_id": "nisi esse", "finish_state": "success", "run_time": 64807890.926749945, "user": { "_id": "470b4d20e267e7cb4b16374c", "provenance": "in Excepteur id commodo", "username": "eiusmod sint tempor sed", "firstname": "ea dolore ipsum eu magna", "memberOf": [ { "groupId": "8e0e1e7e6b6195f2917cee75", "aaaManaged": true }, { "groupId": "1dfa4336d9a63131c0b47eef", "aaaManaged": false }, { "groupId": "956b58ca877afba195c2bef4", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "veniam" } ], "inactive": true, "lastLogin": "1967-04-15T19:40:40.583Z", "_meta": { "created": "2005-02-09T23:00:08.136Z", "updated": "1962-11-01T11:12:19.069Z", "migrationVersion": -31687120 }, "email": "laboris ex" }, "owner": "8803e249a65703dba2b8d25d" } }, { "_id": "dcC2baBa-BE1e-C551-D93B-198fCEf9480c", "location": "Adapter", "view": "nisi amet ad do", "status": "incomplete", "app": "adipisicing", "name": "nisi id", "variables": { "decorators": [ { "type": "encryption", "pointer": "/~0/e/~1/cw1k/x9ABa6YvoR/sDLmM/HRU/ALl5y-GM/ox/KCsJ3pqdK" } ] }, "last_updated": "2008-03-24T13:41:10.918Z", "encodingVersion": 1, "job": { "_id": "52602880fa9fd08721ecc02d", "task": "b4f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": [ "2fc56df3a29452704d68e0e9", "2dacdc072650e09bc9cdafe4", "42633f5d1fcfae13468a76a5", "c3f457f782c5b855642f154b" ] }, "incomingRefs": [], "groups": [ "d4561507374da86fc3c18146", "9e69cd6ed0c2b5d9c40818ad" ], "type": "manual", "metrics": { "start_time": "ut est minim ullamco in", "claim_time": "1952-11-04T03:50:43.806Z", "end_time": -11266074.465756312, "server_id": "in", "finish_state": "complete", "run_time": 14058925.098895296, "user": "d24da2efdd0c7e905d06e045", "owner": "" } }, { "_id": "aFD15CcC-C8c5-EdD1-2fDc-DFcA3fdFCCa0", "location": "Broker", "view": null, "status": "canceled", "app": "eu", "name": "amet", "variables": { "decorators": [ { "type": "encryption", "pointer": "/~0/SmP-2nBK4H/~0/~1/~1/Byd+9u+hsT/~0" }, { "type": "encryption", "pointer": "/~0/~0/zmtD2M1" } ] }, "last_updated": "2024-02-28T16:01:30.446Z", "encodingVersion": 1, "job": { "_id": "b2b947f635031180cbbf5f2d", "task": "b4f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": [ "f1e3ff4c860ce1d6587f47a0", "205876e7000bd60cbadf767c", "d3faeb663ffa65800f5ef72d", "41ef45b0ebab64a26c64e4ed" ] }, "incomingRefs": [], "groups": [ "1cbaddbe2601ca90f4356ba7", { "_id": "ab76d5479b3798a70cb2d470", "provenance": "quis dolore eu do", "name": "adipisicing aute", "description": "proident", "memberOf": [ { "groupId": "792611ed99719a30230e9574", "aaaManaged": false }, { "groupId": "a09ee1a93d85eb237047e355", "aaaManaged": false }, { "groupId": "afa701761fd0163498d73755", "aaaManaged": false }, { "groupId": "4eccde12dad82c371c2cd717", "aaaManaged": true }, { "groupId": "eb2198522e8694b712af6e81", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "cillum nulla" }, { "roleId": "aliquip do tempor" }, { "roleId": "sit" }, { "roleId": "eiusmod elit" }, { "roleId": "officia in" } ], "inactive": true, "_meta": { "created": "1988-04-19T07:53:19.888Z", "updated": "1968-11-29T23:43:11.053Z", "migrationVersion": -43828380 } }, "5ce2c3af84afec37dc522db2", { "_id": "eb896cc675377ca7934b73c9", "provenance": "aliqua sit fugiat aute", "name": "consequat laboris qui", "description": "aliquip culpa incididunt Duis occaecat", "memberOf": [ { "groupId": "6c6fc143a644e885f5a110a4", "aaaManaged": true }, { "groupId": "70cee7384e721f3f7b2aac87", "aaaManaged": true }, { "groupId": "9aeeffd00036cb7e6da7ee5e", "aaaManaged": false }, { "groupId": "1146e4435f0b8eb16cc9cb33", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "ad in cupidatat ut consequat" }, { "roleId": "exercitation" }, { "roleId": "tempor ad velit irure" } ], "inactive": false, "_meta": { "created": "1950-06-16T10:34:57.206Z", "updated": "1979-10-19T12:45:50.241Z", "migrationVersion": 73587292 } } ], "type": "manual", "metrics": { "start_time": "eu velit adipisicing", "claim_time": "1974-04-13T17:23:11.347Z", "end_time": -634453.0030938983, "server_id": "aliquip velit", "finish_state": "paused", "run_time": 43857231.01870406, "user": { "_id": "98d8e44ae798f2053b35f485", "provenance": "dolore", "username": "qui ad", "firstname": "irure veniam eiusmod consequat in", "memberOf": [ { "groupId": "d3038c31de8dd1a0b306da97", "aaaManaged": false }, { "groupId": "a092e812f863f4bd77902ae7", "aaaManaged": false }, { "groupId": "c631f71da2d964e2ffd86a67", "aaaManaged": true }, { "groupId": "51a570b7cd7e8b37ea73a0cd", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "fugiat adipisicing nulla exercitation enim" }, { "roleId": "cillum pariatur" }, { "roleId": "laboris ea" }, { "roleId": "enim aute commodo" } ], "inactive": false, "lastLogin": "1987-12-17T18:21:37.144Z", "_meta": { "created": "2007-04-17T17:12:29.798Z", "updated": "2012-10-07T16:40:42.035Z", "migrationVersion": 14995420 }, "email": "ullamco Lorem" }, "owner": { "_id": "38a28b1999f58186fe0bdfaa", "provenance": "dolore commodo laboris Excepteur", "username": "labore", "firstname": "consequat dolore id ullamco aliqua", "memberOf": [ { "groupId": "9651a1d1c5021729156e5e55", "aaaManaged": true }, { "groupId": "7c3e27fdb0ce7391f023ba15", "aaaManaged": true }, { "groupId": "92df3e8c33698c54857d76cf", "aaaManaged": false }, { "groupId": "cac9b2211d2c5c03076cfa89", "aaaManaged": true }, { "groupId": "6c7623370d27dc4e3c2d9a41", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "culpa" }, { "roleId": "laborum sint in Excepteur pariatur" }, { "roleId": "quis dolor Lorem" }, { "roleId": "est cupidatat" }, { "roleId": "eu culpa occaecat ullamco" } ], "inactive": true, "lastLogin": "1967-03-24T04:11:26.025Z", "_meta": { "created": "1953-03-24T04:43:40.99Z", "updated": "1964-06-06T19:57:16.45Z", "migrationVersion": -48736848 }, "email": "sed sit tempor mollit" } } }, { "_id": "32725EB1-A8B4-6C8A-e4e7-9bA431f3C15A", "location": "Adapter", "view": null, "status": "incomplete", "app": "tempor", "name": "dolore commodo", "variables": { "decorators": [ { "type": "encryption", "pointer": "/~0/G7DM-8oX/Gvk+WuudNT/A-yut/~1" }, { "type": "encryption", "pointer": "/F6h/~1/JZHYMN-iw/M5.mIwc2A3/xb/r/5/~1" }, { "type": "encryption", "pointer": "/OPsvTGd/~1/~0/~1" }, { "type": "encryption", "pointer": "/~0/~1/~0/z7ATD086nSk/wy" } ] }, "last_updated": "1962-09-29T16:02:37.342Z", "encodingVersion": 1, "job": { "_id": "ad9f2fa16a6fa525e74950c7", "task": "e28f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": null }, "incomingRefs": [], "groups": [ "3316dca344bf51dbce18442c" ], "type": "manual", "metrics": { "start_time": "Excepteur nisi ullamco commodo incididunt", "claim_time": "2003-02-01T18:37:21.499Z", "end_time": 46937785.813590735, "server_id": "labore", "finish_state": "complete", "run_time": -56318620.23548124, "user": { "_id": "ed0e3f6c60aefba6ed48310f", "provenance": "anim sit veniam", "username": "ex adipisicing irure deserunt consectetur", "firstname": "pariatur Excepteur incididunt", "memberOf": [ { "groupId": "01a674908a7a3ad9234fed28", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "non ea" }, { "roleId": "Excepteur eu laborum" }, { "roleId": "ea id" } ], "inactive": false, "lastLogin": "1985-07-12T17:40:52.5Z", "_meta": { "created": "1963-03-10T21:42:48.698Z", "updated": "1993-01-12T08:04:48.768Z", "migrationVersion": 87067254 }, "email": "consequat veniam" }, "owner": { "_id": "ea83ceb3f05f1ee54ba55c37", "provenance": "ipsum Duis occaecat in magna", "username": "quis mollit reprehenderit", "firstname": "mollit", "memberOf": [ { "groupId": "5751b82ca0afed99ed475612", "aaaManaged": false }, { "groupId": "46ff881ab2cd61eb0d4f02da", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "ut occaecat veniam voluptate dolore" }, { "roleId": "proident" } ], "inactive": false, "lastLogin": "2021-11-18T17:10:00.123Z", "_meta": { "created": "1996-05-22T20:10:47.854Z", "updated": "1994-01-23T13:10:45.213Z", "migrationVersion": -84420701 }, "email": "velit aliquip enim pariatur culpa" } } } ], "metadata": { "skip": 44023901, "limit": -46736795, "total": -8809840, "nextPageSkip": null, "previousPageSkip": null, "currentPageSize": -63159839 } }
{ "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" } } } ] }