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": 1, "skip": 1, "order": 1, "sort": "name", "include": "description", "exclude": "_id", "in": "sed tempor ipsum dolor", "not-in": "cupidatat et consequat aliqua qui", "equals": "commodo in deserunt", "contains": "laborum", "starts-with": "enim anim sed non in", "ends-with": "tempor anim ex aliquip esse", "dereference": "commodo amet laboris Excepteur sed", "gt": "ullamco dolore qui ipsum", "gte": "non tempor quis dolore", "lt": "ea", "lte": "velit commodo qui", "q": "tempor ut nisi eu", "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": "eD16dcd7-42dF-f4Dc-D9b6-D419bddAa78C", "location": "Adapter", "view": "Ut aute enim", "status": "complete", "app": "et veniam Lorem", "name": "et nostrud enim irure", "variables": { "decorators": [ { "type": "encryption", "pointer": "/~1" }, { "type": "encryption", "pointer": "/a,izKlWpZEe/~0/v9+M1BKM/~1/bmnkn2rJE/~0/~1/~0/h.1" }, { "type": "encryption", "pointer": "/xDAlWGTAE/ybj0/~1/~1/djDVS/wARr" } ] }, "last_updated": "1978-06-27T05:03:01.851Z", "encodingVersion": 1, "job": { "_id": "35f9c1b1457ec3362de62d78", "task": "b4f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": [ "b92e85937d46bcc1c10eb293", "e02f7f341288e250090e4e51", "fb65abc3f0b58a84fc8eaa13", "26423b6b7e78f51eb555dc5f" ] }, "groups": [ { "_id": "5095e825cf3659b09d1310e7", "provenance": "qui ea dolor sit", "name": "culpa", "description": "in incididunt commodo", "memberOf": [ { "groupId": "54b762251f42a0b1fead4fd8", "aaaManaged": false }, { "groupId": "4f91477dd0c92f7eb8269300", "aaaManaged": false }, { "groupId": "29a507af3c0c0bb1d6108fa2", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "anim esse labore officia tempor" }, { "roleId": "culpa adipisicing" }, { "roleId": "ex laboris anim aliquip" }, { "roleId": "qui" }, { "roleId": "consectetur amet consequat reprehenderit non" } ], "inactive": true, "_meta": { "created": "2020-02-25T23:32:03.768Z", "updated": "2015-03-28T00:09:31.104Z", "migrationVersion": -15402928 } }, { "_id": "8d864a649a6c154434c225b7", "provenance": "reprehenderit dolor aute Ut", "name": "dolor sed tempor voluptate", "description": "aliqua labore sed", "memberOf": [ { "groupId": "8ce5a243dbc92d66988899c7", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "do ea" }, { "roleId": "quis" }, { "roleId": "enim" }, { "roleId": "est fugiat tempor" } ], "inactive": true, "_meta": { "created": "2012-03-01T09:12:56.675Z", "updated": "1946-11-23T04:40:04.699Z", "migrationVersion": -52989509 } }, "e3f24d70432ab870a6707101", "9f140d0003d95fe95fd05b11" ], "type": "automatic", "metrics": { "start_time": "pariatur cupidatat Lorem", "end_time": 8688828.50174737, "server_id": "velit eiusmod", "finish_state": "failure", "run_time": -7470891.2085440755, "retrying": null, "user": "4dd102739c2944e6974fffde", "owner": { "_id": "f285a13a58b1e6f767c4d7bc", "provenance": "mollit", "username": "proident aliqua", "firstname": "tempor incididunt adipisicing", "memberOf": [ { "groupId": "cfebfd591c65719b3c2a9324", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "anim in dolore" }, { "roleId": "enim dolor" }, { "roleId": "ut Duis incididunt" } ], "inactive": true, "lastLogin": "1984-12-16T15:13:16.836Z", "_meta": { "created": "1949-01-12T18:37:23.691Z", "updated": "1982-12-05T15:21:13.411Z", "migrationVersion": -24720404 }, "email": "laborum ut aliqua" } } }, { "_id": "Eb1B1aad-eA6d-db8D-eafc-cE28250dFCC4", "location": "Adapter", "view": null, "status": "running", "app": "voluptate aute", "name": "ut amet minim consequat", "variables": { "decorators": [ { "type": "encryption", "pointer": "/U7f/FVWfqE4Dp/~1/dA,fhuNDsia/m/TyG4Q/nJ3yf/eiI5nhqvf/zA" }, { "type": "encryption", "pointer": "/~0/~0/~0/CtGJ/lH/Xh/iMMBfsMS/mkS4FL1p6/Qkx026q" }, { "type": "encryption", "pointer": "/~1/MMtcu3hDq2U/r6/~0" } ] }, "last_updated": "1985-05-06T13:52:27.536Z", "encodingVersion": 1, "job": { "_id": "38f9dafeed32fb0097ff39ae", "task": "3a1f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": null }, "groups": [ { "_id": "4c482d99c912ea6d806672d6", "provenance": "sunt Excepteur aliqua", "name": "consequat cupidatat magna qui", "description": "fugiat Duis in", "memberOf": [ { "groupId": "735eed1d6663128282164263", "aaaManaged": true }, { "groupId": "8c5879941fa8b2f07a3a3fb5", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "cillum" }, { "roleId": "consectetur magna dolor" }, { "roleId": "deserunt culpa elit non" }, { "roleId": "in" }, { "roleId": "qui Lorem" } ], "inactive": false, "_meta": { "created": "2000-10-28T05:14:25.677Z", "updated": "1979-03-31T23:37:07.943Z", "migrationVersion": -44068751 } }, { "_id": "36a29710a7b68ebee883fcb9", "provenance": "nostrud dolor", "name": "cupidatat quis in anim deserunt", "description": "dolore sit ullamco consequat consectetur", "memberOf": [ { "groupId": "6c774a8604a428136e870847", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "non" }, { "roleId": "irure do ad" }, { "roleId": "qui" } ], "inactive": false, "_meta": { "created": "2002-05-20T12:45:55.181Z", "updated": "2013-08-25T05:03:15.6Z", "migrationVersion": -61841909 } }, "fe6168e5f05a14bd521eaad4", { "_id": "580a6c7def71ada7113a53f5", "provenance": "dolor Lorem enim", "name": "nostrud", "description": "dolore do Excepteur in", "memberOf": [ { "groupId": "502326491a253722efa90113", "aaaManaged": true }, { "groupId": "604f1d1ad2522ef5a4f1579b", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "Ut amet esse eiusmod in" }, { "roleId": "enim deserunt Duis" }, { "roleId": "quis" }, { "roleId": "magna non nisi" } ], "inactive": true, "_meta": { "created": "1955-05-26T03:46:48.655Z", "updated": "1968-03-16T23:48:17.766Z", "migrationVersion": 25615310 } } ], "type": "automatic", "metrics": { "start_time": "voluptate sed officia non cillum", "end_time": -95052389.30946796, "server_id": "est tempor", "finish_state": "success", "run_time": -41312198.44904268, "retrying": false, "user": "b144442b9a172b50d946115d", "owner": { "_id": "bb5e7bcd63049686d82d07d7", "provenance": "do aliqua", "username": "consectetur et aliqua", "firstname": "adipisicing aliqua", "memberOf": [ { "groupId": "847a559c678630dd5c166d74", "aaaManaged": true }, { "groupId": "d4c47e761610ed82a5ad26d9", "aaaManaged": true }, { "groupId": "9ce928c03888282da44b088b", "aaaManaged": false }, { "groupId": "a4977cf72037b71fdf6f51e4", "aaaManaged": false }, { "groupId": "80db6dea4f5974081d750f3c", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "Lorem incididunt ut in cillum" }, { "roleId": "ullamco tempor in" }, { "roleId": "est quis velit dolor" }, { "roleId": "Lorem ea deserunt Excepteur" } ], "inactive": true, "lastLogin": "1994-06-05T07:13:18.111Z", "_meta": { "created": "2023-07-13T01:53:59.307Z", "updated": "1948-12-06T18:04:01.444Z", "migrationVersion": -43514640 }, "email": "sit exercitation" } } }, { "_id": "efB65b9E-a628-Aa12-24d4-092bF41D97A0", "location": "Adapter", "view": null, "status": "error", "app": "enim", "name": "cillum laborum eiusmod minim reprehenderit", "variables": { "decorators": [ { "type": "encryption", "pointer": "/~0/w3BO/g0C/~1/~0/C/3r/NAj.uW" }, { "type": "encryption", "pointer": "/~0/~1/~0/~0/~1/~0" }, { "type": "encryption", "pointer": "/P/T4XdNov/~0" } ] }, "last_updated": "1964-05-23T14:05:30.026Z", "encodingVersion": 1, "job": { "_id": "23bd3d1a65f4a3165ecae3b9", "task": "3a1f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": [ "97267d3dbd671b2216d2940d", "eef165d566cc808892855e35" ] }, "groups": [ "90e705008dc0d52a84f45aad" ], "type": "automatic", "metrics": { "start_time": "elit occaecat reprehenderit esse", "end_time": -54692843.39688185, "server_id": "dolor nisi irure ullamco ut", "finish_state": "success", "run_time": -33702626.182387486, "retrying": false, "user": { "_id": "5899c14dd39d097d6bd19229", "provenance": "eiusmod cupidatat Lorem", "username": "ea ad Lorem", "firstname": "culpa dolore", "memberOf": [ { "groupId": "179c362ea3f314958cea9d58", "aaaManaged": true }, { "groupId": "e37e0e6f5db824a2c0a91524", "aaaManaged": true }, { "groupId": "07b501dfd8832f95a4ae653a", "aaaManaged": false }, { "groupId": "f414e17f018df780020f7ed0", "aaaManaged": false }, { "groupId": "caf071a7f34a56bd297ba47f", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "dolor" }, { "roleId": "nulla quis labore officia" }, { "roleId": "consequat Duis ea" }, { "roleId": "consectetur minim consequat" }, { "roleId": "dolore laborum nisi eiusmod et" } ], "inactive": false, "lastLogin": "1999-02-04T06:05:40.707Z", "_meta": { "created": "1969-11-19T04:50:01.584Z", "updated": "2008-11-16T09:41:07.498Z", "migrationVersion": -24233201 }, "email": "ex ut veniam in" }, "owner": "b51525219d7b8f7930a4172b" } }, { "_id": "558EFC3B-fA37-BC2a-1a6C-A4d2507dC93F", "location": "Adapter", "view": null, "status": "running", "app": "consequat aliquip", "name": "proident officia labore aliqua irure", "variables": { "decorators": [ { "type": "encryption", "pointer": "/~0/Ljg92/~0/~1/~1/~0/~0/~0/zExUEo8FO/w" }, { "type": "encryption", "pointer": "/vvr+xHef/~1/~1/~1/~0/bJ/~1/xSI/pzM42yoQm/gNkwkuMitx9/~0" }, { "type": "encryption", "pointer": "/~0/~1/PJQH9/" }, { "type": "encryption", "pointer": "/h17RHpWS/X/~1/mWagh4Q+/O/KGEIyKU/od48JN/~0/T" }, { "type": "encryption", "pointer": "/JtZJ65TY" } ] }, "last_updated": "2021-12-23T14:36:43.488Z", "encodingVersion": 1, "job": { "_id": "ec750e8f6fb6bb8caa690473", "task": "3a1f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": [ "770460aafaa02cf0f61076d9", "fd045cd5d51bdb51c5229665", "7e30a52d75ebf50fbc40ce7d", "e8d7c5372304e9717514d81b" ] }, "groups": [ "5a85e218dfa9362f402b1b9c", { "_id": "f323c736e8418de9dc708a75", "provenance": "laborum in ea", "name": "elit ipsum mollit qui", "description": "occaecat", "memberOf": [ { "groupId": "21a48d6d797df75569ab293a", "aaaManaged": false }, { "groupId": "2dc94b18d07ae4e46a5a6724", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "in Duis" }, { "roleId": "in" } ], "inactive": false, "_meta": { "created": "1986-01-20T03:57:39.757Z", "updated": "1965-09-28T22:51:28.883Z", "migrationVersion": 3998119 } }, { "_id": "55daedaa48cd9ead8083df7a", "provenance": "cillum eiusmod tempor Excepteur magna", "name": "minim cillum ad fugiat", "description": "aliqua id in fugiat Duis", "memberOf": [ { "groupId": "7c8a1f1e736bfb0f1cf339da", "aaaManaged": true }, { "groupId": "8c42e12b7bbfc972b7519745", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "elit voluptate incididunt officia sint" }, { "roleId": "ea cupidatat culpa do laborum" }, { "roleId": "qui aute do nulla culpa" } ], "inactive": true, "_meta": { "created": "1993-02-03T11:21:24.196Z", "updated": "2009-12-22T19:08:51.535Z", "migrationVersion": -99225876 } }, "29c42d45ad5a3571efefa65d" ], "type": "automatic", "metrics": { "start_time": "ut nisi anim mollit nulla", "end_time": 8927513.776830897, "server_id": "amet", "finish_state": "success", "run_time": -81654537.84542364, "retrying": null, "user": { "_id": "342d748f9d432255d8cda9b5", "provenance": "voluptate eiusmod", "username": "minim pariatur", "firstname": "adipisicing", "memberOf": [ { "groupId": "bf8ec23d391516b177623d28", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "sit magna dolor" }, { "roleId": "dolore dolor Lorem dolor cupidatat" }, { "roleId": "commodo" } ], "inactive": true, "lastLogin": "1987-05-15T23:17:35.396Z", "_meta": { "created": "1979-01-30T18:51:31.62Z", "updated": "1983-02-06T16:30:01.574Z", "migrationVersion": 54336330 }, "email": "in incididunt" }, "owner": "74965b40f08fc6f0fb5661fc" } }, { "_id": "Cced0eaE-f3ee-f47a-c8e9-fBe5bAaEaBC2", "location": "Broker", "view": "amet", "status": "failure", "app": "qui in", "name": "aliqua sunt", "variables": { "decorators": [ { "type": "encryption", "pointer": "/PRb+b/b91hLTH2Y/U+dgajnw/TlA/XL/~0/In1/~1/~0" }, { "type": "encryption", "pointer": "/~0/~1/~1" }, { "type": "encryption", "pointer": "/t-,2cZ/~1/o/dBEr/tCcbe/~0/~1/~0" } ] }, "last_updated": "2020-06-24T04:24:14.661Z", "encodingVersion": 1, "job": { "_id": "aaeb9dac8c171382e3466bd1", "task": "e28f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": null }, "groups": [ "fb0a8572f48d2a69ffe4e0a0" ], "type": "automatic", "metrics": { "start_time": "laborum do eu", "end_time": -40032051.780980505, "server_id": "esse consequat cupidatat sed magna", "finish_state": "success", "run_time": 24350238.302572876, "retrying": false, "user": "868b67db283a8f780fc6bc8b", "owner": "Pronghorn" } } ], "metadata": { "skip": 17203937, "limit": 65906562, "total": 22487208, "nextPageSkip": -75603690, "previousPageSkip": 24878820, "currentPageSize": -46916627 } }
{ "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" } } } ] }