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": "description", "in": "dolore veniam et anim", "not-in": "nisi anim voluptate elit sunt", "equals": "Lorem veniam aliqua cupidatat non", "contains": "laborum esse enim ullamco", "starts-with": "velit cupidatat dolore laboris non", "ends-with": "in", "dereference": "cupidatat", "gt": "sunt tempor", "gte": "non ut ipsum", "lt": "Duis deserunt ea", "lte": "ullamco elit consequat Lorem labore", "q": "voluptate", "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": "1e9297Ce-9Fbc-4bA5-8Df9-E45bbD408C47", "location": "Adapter", "view": "elit eu ut culpa exercitation", "status": "canceled", "app": "mollit eu", "name": "Duis labore nulla et non", "variables": { "decorators": [ { "type": "encryption", "pointer": "/~1/~0/~0/BMVt/~1/GiO/s-DmX9IDe/ptm/twORYu/~1" }, { "type": "encryption", "pointer": "/~0/juuN/PTTphQX/ZCV/jYg4Hw/~1/drIlAeV/~0" }, { "type": "encryption", "pointer": "/y/W9bI0qvu/~1/~0/~0/if6F6yhXT/~1" } ] }, "last_updated": "2021-02-01T10:09:15.255Z", "encodingVersion": 1, "job": { "_id": "3fb5645ba11ae33a8f1fe0b5", "task": "b4f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": null }, "incomingRefs": [], "groups": [ "ecbef67b4c28c9c7a6c90c73" ], "type": "manual", "metrics": { "start_time": "eu labore consequat", "claim_time": "1979-08-16T00:08:05.623Z", "end_time": 51014193.64284152, "server_id": "amet aliquip consectetur minim voluptate", "finish_state": "success", "run_time": -24637950.370907992, "user": "", "owner": "" } }, { "_id": "B015A50c-1277-FE60-4af6-3d6BD2416D00", "location": "Adapter", "view": "labore eiusmod est laboris", "status": "failure", "app": "aute consectetur magna commodo", "name": "magna commodo voluptate deserunt adipisicing", "variables": { "decorators": [ { "type": "encryption", "pointer": "/~0/~0/DCQq/Lwa/~1" }, { "type": "encryption", "pointer": "/~0/TPYef12Z/~1/x8ZIkX0Y/bcHbK5r1D/~0/spHjHPaZJA" }, { "type": "encryption", "pointer": "/~1/peFxZ/~1/xSP/ee" }, { "type": "encryption", "pointer": "/~0/IsteV/O/v4mv4l,IWZ/nQOSk6-/aQ/~1/sAENLo" } ] }, "last_updated": "2001-04-26T21:17:38.075Z", "encodingVersion": 1, "job": { "_id": "eab94457ff45e449cbbb045a", "task": "3a1f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": [ "1dc548e18999419d3fd79db4", "4c89a0630f0bf0ae8c1b1e9c", "c52e1f3685dbb0b98d3a5a6f" ] }, "incomingRefs": [], "groups": [ "13444ebef6ffb2cb1951ceec", "0cccee9f92379ae591988e83", { "_id": "67007f8cd5c44b07f6fbcae4", "provenance": "dolore", "name": "adipisicing aliqua nulla", "description": "incididunt sed", "memberOf": [ { "groupId": "48227f893ed036602b701880", "aaaManaged": true }, { "groupId": "dd189c94999a33ae34934cb8", "aaaManaged": true }, { "groupId": "037f5947b5fdd6b43f4de329", "aaaManaged": false }, { "groupId": "ef17e93ed0707f0f9ee62e38", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "magna Excepteur ut" }, { "roleId": "anim consequat" } ], "inactive": false, "_meta": { "created": "2019-04-10T03:55:27.988Z", "updated": "2016-06-09T03:24:50.799Z", "migrationVersion": -57538981 } }, "78d6f6501a8a2c879888cde0", "3e862a209f64b220a9c82fa1" ], "type": "manual", "metrics": { "start_time": "exercitation in esse", "claim_time": "1968-05-17T12:36:15.673Z", "end_time": -35302118.37529982, "server_id": "non Lorem eiusmod", "finish_state": "success", "run_time": -93573352.80621295, "user": "2cdfa116d2b3558d540caf5e", "owner": "38c17d02dfd3a29226866bf7" } }, { "_id": "Eb3FeaDD-BFb6-5FFa-c292-4dc1b685d5B1", "location": "Application", "view": null, "status": "error", "app": "reprehenderit enim Ut eu exercitation", "name": "sed dolore enim reprehenderit id", "variables": { "decorators": [ { "type": "encryption", "pointer": "/~1/~0/~1/~0/~0/~0/GXZnKs" } ] }, "last_updated": "1992-09-01T08:00:45.918Z", "encodingVersion": 1, "job": { "_id": "f31489a7d3c5e637905538ca", "task": "e28f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": [ "59e90619add318e1c58ee347", "389e4d23ecc7b93f08a54ee9" ] }, "incomingRefs": [], "groups": [ { "_id": "8dc5fe9bb912e88c1485e591", "provenance": "dolore nostrud", "name": "aute cillum sunt aliqua", "description": "sunt ut in", "memberOf": [ { "groupId": "5f862d7d9a05aae3ff68aa1d", "aaaManaged": false }, { "groupId": "56e9308620415daecbdf1ce4", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "enim qui in" }, { "roleId": "qui quis in" } ], "inactive": true, "_meta": { "created": "1968-09-10T20:34:38.832Z", "updated": "1982-02-26T19:16:07.509Z", "migrationVersion": -81379005 } } ], "type": "manual", "metrics": { "start_time": "do", "claim_time": "2021-05-24T16:52:29.677Z", "end_time": -48295173.68045315, "server_id": "Lorem", "finish_state": "incomplete", "run_time": 36293818.00889972, "user": { "_id": "6381d244bf6dde555532da99", "provenance": "Excepteur", "username": "officia deserunt qui enim", "firstname": "incididunt", "memberOf": [ { "groupId": "6ffd072cf0aebb8ea1623a8d", "aaaManaged": false }, { "groupId": "1e8413520978b8029ecd9be0", "aaaManaged": true }, { "groupId": "e958d67882665565ce75839a", "aaaManaged": true }, { "groupId": "444d0d15c2dce6700f47ee0d", "aaaManaged": false }, { "groupId": "33cfcb5b1378590e2000a983", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "nulla pariatur irure" }, { "roleId": "magna" }, { "roleId": "est occaecat" }, { "roleId": "quis qui Excepteur elit tempor" }, { "roleId": "Duis" } ], "inactive": true, "lastLogin": "1949-03-31T10:09:59.182Z", "_meta": { "created": "1954-01-20T19:54:29.442Z", "updated": "1974-11-15T05:24:36.57Z", "migrationVersion": -64204731 }, "email": "tempor eiusmod ad" }, "owner": { "_id": "5a1115de694b992ebe79d114", "provenance": "eiusmod sunt consequat dolore et", "username": "incididunt ea id nisi", "firstname": "tempor ullamco consequat deserunt Duis", "memberOf": [ { "groupId": "058d472fd7a4205e454d659e", "aaaManaged": false }, { "groupId": "df0b7b256fda989a5bfed65f", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "incididunt irure sint" }, { "roleId": "amet aute eiusmod esse dolore" }, { "roleId": "minim veniam Excepteur" } ], "inactive": false, "lastLogin": "1955-05-28T01:42:30.543Z", "_meta": { "created": "2011-08-20T21:38:52.427Z", "updated": "2010-01-27T10:51:18.559Z", "migrationVersion": 3683176 }, "email": "esse ex minim" } } } ], "metadata": { "skip": -55563877, "limit": -24772109, "total": 31288026, "nextPageSkip": null, "previousPageSkip": -49695974, "currentPageSize": 11748412 } }
{ "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" } } } ] }