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": 50, "order": 1, "sort": "name", "include": "description", "exclude": "_id", "in": "adipisicing do", "not-in": "id nostrud enim officia", "equals": "exercitation ea tempor aute", "contains": "Duis non", "starts-with": "Duis occaecat dolor ut sint", "ends-with": "commodo", "dereference": "nulla magna", "gt": "Ut", "gte": "deserunt incididunt in", "lt": "in", "lte": "labore laboris", "q": "culpa adipisicing ut", "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 imported 3 of 4 documents", "data": [ { "_id": "AcD73C31-0ED2-2D8e-d9a8-bf1C7E8024Ad", "location": "Broker", "view": "cillum enim", "status": "paused", "app": "reprehenderit ut esse voluptate eu", "name": "deserunt anim irure voluptate", "variables": { "decorators": [ { "type": "encryption", "pointer": "/~0/auEWPoV/~1/F0t6iK/~0/xv/hx/JKN,9D" } ] }, "last_updated": "2006-03-06T10:26:04.249Z", "encodingVersion": 1, "job": { "_id": "c8b714898796dbd199a10730", "task": "b4f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": [ "0ab29888c2d1d734ec5fdb8f", "02eed1944b0f0bfe02948d50", "c1b3a487a100e53ac43ad95f", "e55f2fa8c785228abee65146" ] }, "groups": [ { "_id": "089fca44cf26900682062daa", "provenance": "reprehenderit dolor", "name": "irure ipsum magna do aliqua", "description": "do enim", "memberOf": [ { "groupId": "c359a52b4fe3c0124de945d5", "aaaManaged": false }, { "groupId": "183cde4a27771c7fe71d6d1c", "aaaManaged": true }, { "groupId": "3c5374f5c0b57994da9ac822", "aaaManaged": true }, { "groupId": "40aa0f1d48889390b2256397", "aaaManaged": true }, { "groupId": "501bdfb8e299820de9f323b0", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "velit id sunt consectetur" }, { "roleId": "in" } ], "inactive": false, "_meta": { "created": "1949-06-03T03:49:18.617Z", "updated": "1987-11-03T10:57:32.227Z", "migrationVersion": 71564144 } }, { "_id": "a55acc0ff5510edf6aa06c19", "provenance": "fugiat aliqua in irure voluptate", "name": "aliquip", "description": "proident ut aliquip sit", "memberOf": [ { "groupId": "d980b2ee1ab86244b922b26a", "aaaManaged": false }, { "groupId": "7a3291ac7cccd3a3def58605", "aaaManaged": true }, { "groupId": "c11fd1980f94649b99ee50e5", "aaaManaged": false }, { "groupId": "c6edfced01e05f0b7e16d53d", "aaaManaged": true }, { "groupId": "b4d3c6289a038812dd4abf52", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "consectetur sunt enim" }, { "roleId": "adipisicing pariatur ut irure ea" } ], "inactive": false, "_meta": { "created": "1956-09-28T03:27:50.94Z", "updated": "1972-01-26T07:25:26.929Z", "migrationVersion": -91218753 } } ], "type": "manual", "metrics": { "start_time": "in ad officia", "claim_time": "1994-07-23T13:46:08.376Z", "end_time": -58975204.30952028, "server_id": "ea", "finish_state": "success", "run_time": 43829510.93872595, "user": { "_id": "1114c83e020e7b08064d416a", "provenance": "ut in pariatur incididunt", "username": "minim sunt Excepteur", "firstname": "et", "memberOf": [ { "groupId": "f19521e4804683ad27ef05c3", "aaaManaged": false }, { "groupId": "91fbcf6a9811db68b440b7b2", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "cupidatat consequat dolor" }, { "roleId": "minim" } ], "inactive": false, "lastLogin": "1959-02-23T14:45:36.647Z", "_meta": { "created": "1961-03-31T04:19:58.933Z", "updated": "2018-05-03T02:15:33.678Z", "migrationVersion": -69815723 }, "email": "tempor minim velit" }, "owner": { "_id": "16c12c2120a9078bb0e46000", "provenance": "minim qui mollit incididunt aliqua", "username": "eiusmod", "firstname": "mollit ipsum", "memberOf": [ { "groupId": "a243ee48546d71d4ac3fcc22", "aaaManaged": false }, { "groupId": "b2c05acb74fe916c9b49266b", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "elit deserunt exercitation eu occaecat" } ], "inactive": true, "lastLogin": "1964-01-13T19:23:36.508Z", "_meta": { "created": "1988-06-03T19:33:20.235Z", "updated": "1963-03-03T09:49:30.234Z", "migrationVersion": -38075733 }, "email": "Duis" } } }, { "_id": "beFBCB11-Daa9-4F5A-22E3-5dE29eceCcF0", "location": "Application", "view": "amet in deserunt nulla", "status": "failure", "app": "ullamco et veniam", "name": "in occaecat id culpa Excepteur", "variables": { "decorators": [ { "type": "encryption", "pointer": "/~1/o5F75sGk/~0/CMu" }, { "type": "encryption", "pointer": "/~0/kk/sOjh3/~0/kpE.kezZ/~0/~1/Iw/S/~0" } ] }, "last_updated": "1975-07-11T12:03:39.503Z", "encodingVersion": 1, "job": { "_id": "dc11061dda6e7644ad07a23c", "task": "3a1f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": null }, "groups": [ { "_id": "40516d204de9767c653b7bdc", "provenance": "incididunt pariatur ullamco adipisicing", "name": "et sit quis do laboris", "description": "nulla anim mollit aliquip non", "memberOf": [ { "groupId": "5ee37314344f3179bf424129", "aaaManaged": false }, { "groupId": "d812fdb9b81d8bf140350783", "aaaManaged": false }, { "groupId": "7776499627cb59bf0db9d425", "aaaManaged": false }, { "groupId": "0b8d00cb2d094b413f7ae965", "aaaManaged": true }, { "groupId": "e5a06d7908ba07654233aa6b", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "irure eu amet velit magna" } ], "inactive": false, "_meta": { "created": "1982-10-14T18:23:39.57Z", "updated": "1977-12-04T12:59:55.604Z", "migrationVersion": -79873018 } }, { "_id": "c562c2068274b2daa133c212", "provenance": "mollit Ut tempor eu id", "name": "commodo deserunt ullamco elit", "description": "minim velit non est elit", "memberOf": [ { "groupId": "2903fed53d854a74f70b22af", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "tempor eu" }, { "roleId": "Lorem minim elit ex" }, { "roleId": "magna fugiat" }, { "roleId": "nulla et dolore" } ], "inactive": true, "_meta": { "created": "1950-10-03T16:52:57.658Z", "updated": "1984-06-12T04:28:35.377Z", "migrationVersion": 32858656 } }, { "_id": "03914bb28c9e60431228d3d9", "provenance": "sed Ut laboris eiusmod", "name": "Ut", "description": "aute nostrud ad proident sit", "memberOf": [ { "groupId": "edc6c51cc1c3e53ff072da21", "aaaManaged": true }, { "groupId": "8e5aad110fb15caf4b20f3e0", "aaaManaged": false }, { "groupId": "df9f7d0c3687fef7bf49aac8", "aaaManaged": false }, { "groupId": "c5674704e7abe9871e028cb0", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "eiusmod Ut ut" }, { "roleId": "incididunt dolor labore occaecat officia" }, { "roleId": "enim" } ], "inactive": true, "_meta": { "created": "1962-11-07T16:42:23.824Z", "updated": "1958-04-19T04:56:33.375Z", "migrationVersion": -47433563 } }, { "_id": "7858905062ed42aa15fb837d", "provenance": "nulla voluptate consectetur irure", "name": "in esse", "description": "irure et", "memberOf": [ { "groupId": "cc35f1f8c23f1b8e246753d8", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "est sunt pariatur Lorem" }, { "roleId": "esse enim ea nulla reprehenderit" }, { "roleId": "in dolore sint deserunt" } ], "inactive": true, "_meta": { "created": "1975-07-07T21:29:55.41Z", "updated": "1981-08-03T22:53:33.281Z", "migrationVersion": -17866910 } } ], "type": "manual", "metrics": { "start_time": "enim quis ipsum mollit", "claim_time": "1971-04-21T14:48:22.749Z", "end_time": 22455087.497967556, "server_id": "consequat in", "finish_state": "success", "run_time": -8329220.281641543, "user": "340f07bafb8e7b0380302c2f", "owner": "6cf1b0fc869a8386526f342d" } }, { "_id": "AAF87f14-cfFF-Db47-5Fa8-1D73378E2dDB", "location": "Broker", "view": null, "status": "complete", "app": "incididunt", "name": "Duis", "variables": { "decorators": [ { "type": "encryption", "pointer": "/ADGHW9" }, { "type": "encryption", "pointer": "/tvpQifvz//~0/Huc3cF/~0/xEwb" }, { "type": "encryption", "pointer": "/kbsNUwGxs/~0/VQ,VBEkpa/P" } ] }, "last_updated": "1971-10-02T14:04:12.052Z", "encodingVersion": 1, "job": { "_id": "aa14a1c8ede3b64d18bacbde", "task": "e28f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": [ "9ae1935a464b4ce7715325f7" ] }, "groups": [ { "_id": "0ead8035443afdd43167ff99", "provenance": "qui magna ipsum dolor Duis", "name": "aute dolore in nulla", "description": "sed amet officia Ut", "memberOf": [ { "groupId": "5cb4a04bf56ff3b9909cc6c0", "aaaManaged": true }, { "groupId": "55a2469f433decb94f7a2fd5", "aaaManaged": false }, { "groupId": "2e63a05109d41072567d3073", "aaaManaged": true }, { "groupId": "8deb1f2cfa068c245325e95b", "aaaManaged": false }, { "groupId": "22e6b7167d7ce0684c60306b", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "Lorem aliqua Excepteur id" }, { "roleId": "proident ut elit ullamco esse" } ], "inactive": true, "_meta": { "created": "1967-06-07T09:57:16.759Z", "updated": "1997-08-28T08:13:07.67Z", "migrationVersion": 67904066 } }, "d9a74c899791f0c110084f13" ], "type": "manual", "metrics": { "start_time": "eu fugiat", "claim_time": "1989-06-26T18:09:12.057Z", "end_time": -5583186.992466956, "server_id": "dolore occaecat consequat labore", "finish_state": "success", "run_time": 47061816.20535585, "user": "32fc64f50ca0000898b1c7df", "owner": "" } } ], "metadata": { "skip": 85979558, "limit": -52868854, "total": 91436283, "nextPageSkip": null, "previousPageSkip": 73139452, "currentPageSize": 50602810 } }
{ "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" } } } ] }