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": 25, "skip": 50, "order": 1, "sort": "name", "include": "name,description", "exclude": "description", "in": "ex fugiat reprehenderit", "not-in": "consectetur labore officia pariatur", "equals": "pariatur", "contains": "Lorem ut", "starts-with": "elit est voluptate", "ends-with": "sunt consequat", "dereference": "velit ipsum eiusmod cupidatat eu", "gt": "aute in dolor cupidatat", "gte": "ipsum deserunt commodo Ut ad", "lt": "in", "lte": "elit exercitation Excepteur laboris", "q": "voluptate aliqua sunt", "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": "A03Bfccb-2116-C7DC-afCE-7a9BB31B8b6F", "location": "Application", "view": "ipsum veniam non laborum", "status": "error", "app": "culpa non sit in commodo", "name": "in occaecat eiusmod cupidatat officia", "variables": { "decorators": [ { "type": "encryption", "pointer": "/~0/~0/~1/~0/~0/~0/o/~0/~1/LsmFtq/lswbXy146dI" }, { "type": "encryption", "pointer": "/~1/gvnll6L7E/A/j/~1/~1/~1" }, { "type": "encryption", "pointer": "/xGw/~0/~1/MuYsnbFr/uKWnrveVc1W/d2etpvH.9/~0/~1/t7c0mN/~1" }, { "type": "encryption", "pointer": "/~1/~0/~1/hooC" }, { "type": "encryption", "pointer": "/sqd4E/~0/NY/Ww,/fpiumu/jITd/~0" } ] }, "last_updated": "2005-03-11T02:35:49.821Z", "encodingVersion": 1, "job": { "_id": "6aa4774d39455b1d9eb88bea", "task": "e28f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": [ "47722ab16877f231cf76171d", "3069c6704b170e59e91a9cdd", "9c6274f2dc9a3b5c6fd2ae79" ] }, "incomingRefs": [], "groups": [ "eaea649fc17c64fc26f78c81", { "_id": "44bb166324c17e0b14788c6f", "provenance": "adipisicing amet fugiat", "name": "adipisicing elit reprehenderit mollit", "description": "magna nisi dolore sint eiusmod", "memberOf": [ { "groupId": "96212cc9b5351a50826bc9d2", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "laboris" } ], "inactive": false, "_meta": { "created": "2003-04-15T18:56:11.919Z", "updated": "1976-05-09T19:00:07.624Z", "migrationVersion": 1264151 } }, { "_id": "48ca74610cad340bd8088661", "provenance": "sint ipsum", "name": "est", "description": "do in", "memberOf": [ { "groupId": "d9e104f675f1420f1ccd8804", "aaaManaged": false }, { "groupId": "b0ee90711d99323b29d3637d", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "ad fugiat ut dolore sunt" }, { "roleId": "nulla mollit proident pariatur Duis" }, { "roleId": "eiusmod aute" }, { "roleId": "incididunt non commodo consectetur irure" } ], "inactive": false, "_meta": { "created": "2022-06-27T00:57:16.318Z", "updated": "1954-01-18T13:38:26.747Z", "migrationVersion": -4907308 } } ], "type": "manual", "metrics": { "start_time": "sunt cupidatat est", "claim_time": "1985-04-03T00:09:10.745Z", "end_time": 19815592.44973688, "server_id": "non nostrud anim", "finish_state": "success", "run_time": -70069017.97146563, "user": "d1aa06152498b634557f81e7", "owner": { "_id": "e0eb5969e293cb44e6910ad0", "provenance": "cillum", "username": "reprehenderit do in ad", "firstname": "ipsum reprehenderit nisi", "memberOf": [ { "groupId": "0ebe3dc0389f004b1a6a8426", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "esse" } ], "inactive": true, "lastLogin": "1982-11-25T17:10:49.297Z", "_meta": { "created": "1960-12-15T03:21:36.738Z", "updated": "1989-06-14T19:04:24.647Z", "migrationVersion": -71091781 }, "email": "dolore" } } }, { "_id": "dB476FcF-8fAF-A30c-7ce3-eDdA88bbeB90", "location": "Broker", "view": null, "status": "paused", "app": "ipsum dolor", "name": "sed voluptate commodo", "variables": { "decorators": [ { "type": "encryption", "pointer": "/GPECwdkI/Tu,0sZ/~0/L3gzgVBTPe/mFzlNCIu/FxRIDxwfq/AcstraF-0Y/UJv11Hukkl/lwx4uDcuW/Nh1r" }, { "type": "encryption", "pointer": "/U7/~0/Kbv/rExDZ.wa2" }, { "type": "encryption", "pointer": "/~1/~1/~0/~1/npj/TdmSi,tv/dG-LjTf/ify/~0" }, { "type": "encryption", "pointer": "/~1/nL0qBF/~0/~1/e/~1/~0/~1/B/ocjHS" } ] }, "last_updated": "1980-01-14T17:55:18.77Z", "encodingVersion": 1, "job": { "_id": "bc58afd22e682489c214a499", "task": "3a1f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": [ "99dd2b101d35d45f6cb9b076", "b18c242517cf5953f959741b", "3071f5a27a15ed8b3a9c7815" ] }, "incomingRefs": [], "groups": [ "ceb7944164eab75b9de821f3", { "_id": "186d8c07b050949c2ed820c8", "provenance": "anim ipsum", "name": "exercitation aliquip", "description": "aute id", "memberOf": [ { "groupId": "a9b2e774b61e10c57a1680f5", "aaaManaged": false }, { "groupId": "f7aad430bb5ed43d9979a8dc", "aaaManaged": false }, { "groupId": "80f79afbdcd0083c76616bad", "aaaManaged": true }, { "groupId": "30ae2100dea0f9b66840a291", "aaaManaged": true }, { "groupId": "f03343b1c67b30237895dc79", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "proident" } ], "inactive": false, "_meta": { "created": "2001-01-24T02:35:22.017Z", "updated": "2023-01-29T21:53:14.151Z", "migrationVersion": -7909722 } }, { "_id": "e3893030de71917e7e77a6f2", "provenance": "nulla", "name": "et Excepteur id laborum", "description": "sit id ullamco", "memberOf": [ { "groupId": "9929140ff458cc0340dc4cb6", "aaaManaged": true }, { "groupId": "61d7cb0d4cc8a526d35ea00f", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "consectetur" }, { "roleId": "do ullamco" }, { "roleId": "culpa" } ], "inactive": false, "_meta": { "created": "2020-08-14T21:37:02.0Z", "updated": "2017-08-01T06:31:28.297Z", "migrationVersion": -65301272 } }, { "_id": "090e897b86a39533b35e018e", "provenance": "proident nisi in commodo", "name": "officia id", "description": "veniam non", "memberOf": [ { "groupId": "61f182373f13efcafa745fe3", "aaaManaged": true }, { "groupId": "de35548799657c07ac7b8b1f", "aaaManaged": false }, { "groupId": "d32a6113f4136d6dacd395cc", "aaaManaged": true }, { "groupId": "3e2817a1a2ff4470deb003d5", "aaaManaged": true }, { "groupId": "1947c475754bac906c57d2c1", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "minim aute dolor" } ], "inactive": true, "_meta": { "created": "1989-04-11T13:19:56.656Z", "updated": "1962-09-06T07:36:47.328Z", "migrationVersion": -94695170 } } ], "type": "manual", "metrics": { "start_time": "non tempor", "claim_time": "2014-09-20T02:20:29.371Z", "end_time": 98424017.84540486, "server_id": "Duis ad adipisicing", "finish_state": "success", "run_time": -43358056.501423284, "user": "f087f8cada88b281e68fde6a", "owner": "ef27e4c3763216df446b38f8" } } ], "metadata": { "skip": 30940866, "limit": -26495118, "total": -8959256, "nextPageSkip": 9859286, "previousPageSkip": 62038188, "currentPageSize": 12267086 } }
{ "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" } } } ] }