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": 10, "order": 1, "sort": "name", "include": "description", "exclude": "_id,description", "in": "velit mollit", "not-in": "in", "equals": "ut sit ad magna", "contains": "Excepteur Ut", "starts-with": "veniam anim", "ends-with": "minim reprehenderit veniam dolore", "dereference": "Excepteur labore", "gt": "in adipisicing sunt dolor minim", "gte": "nostrud aliquip eu veniam", "lt": "culpa", "lte": "consequat in velit ex Lorem", "q": "incididunt sunt cupidatat consectetur velit", "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": "2822168c-95d8-73d0-99Ea-0Dc5070d8db1", "location": "Broker", "view": "dolor", "status": "incomplete", "app": "ad commodo pariatur dolor", "name": "voluptate pariatur id", "variables": { "decorators": [ { "type": "encryption", "pointer": "/aS" }, { "type": "encryption", "pointer": "/uDx/eUHDtbtmYNE/~1/OBaRnUgkM" } ] }, "last_updated": "1957-08-09T07:44:21.499Z", "encodingVersion": 1, "job": { "_id": "97af556a4db514c5f7d52b87", "task": "e28f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": [ "d7de63d0e08b3bac45229f4d", "207ebbcd23f359e76eff85e7", "127e5c9d394a79c9e17c5de1", "033bc076c4a2070c5d5943b4" ] }, "groups": [ { "_id": "aab9f775e19df103d9e8bd6c", "provenance": "elit qui ea cupidatat", "name": "et est deserunt enim in", "description": "exercitation", "memberOf": [ { "groupId": "ebdd60437edc581813525027", "aaaManaged": false }, { "groupId": "2620772330b514753182c32e", "aaaManaged": false }, { "groupId": "0d5279cabe85db403209c089", "aaaManaged": true }, { "groupId": "b0bb9403ba789dc4e332b195", "aaaManaged": false }, { "groupId": "c73ca71f71c05b358721946e", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "cillum aliqua minim pariatur" }, { "roleId": "fugiat laborum" } ], "inactive": false, "_meta": { "created": "1947-01-13T16:31:03.23Z", "updated": "1969-07-14T03:06:41.221Z", "migrationVersion": 82812446 } }, "6b57cbc902bd2077e71a189a", { "_id": "07444b5a7f7fa8be9b9c916f", "provenance": "exercitation culpa amet minim anim", "name": "mollit ullamco sed dolor", "description": "occaecat magna", "memberOf": [ { "groupId": "1e96e9e735dbbf6e240df057", "aaaManaged": true }, { "groupId": "6f5f47ebffc350bdd61ea4a5", "aaaManaged": true }, { "groupId": "70ac774831e06ee586ee3fdc", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "magna in dolore qui" }, { "roleId": "Lorem reprehenderit officia" } ], "inactive": false, "_meta": { "created": "1970-07-01T22:05:03.877Z", "updated": "1990-03-01T19:53:28.905Z", "migrationVersion": -94554411 } } ], "type": "automatic", "metrics": { "start_time": "in reprehenderit ipsum enim ea", "end_time": 79273773.10232121, "server_id": "et velit", "finish_state": "success", "run_time": 62297296.45621851, "retrying": null, "user": "", "owner": { "_id": "941cd9f98a859067fe6f9de4", "provenance": "occaecat enim ex Excepteur", "username": "consequat cupidatat Excepteur irure anim", "firstname": "enim adipisicing nulla qui", "memberOf": [ { "groupId": "f732ebab585e1f2fb70d0df0", "aaaManaged": true }, { "groupId": "ad184da54b86c0ebb96e5ae7", "aaaManaged": false }, { "groupId": "816171be6a433fae872be31a", "aaaManaged": true }, { "groupId": "6c92e0a164d1a53c0119fe1a", "aaaManaged": false }, { "groupId": "09de8f91c60509a75f5063df", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "non dolor reprehenderit" }, { "roleId": "eu" }, { "roleId": "pariatur" }, { "roleId": "deserunt Duis in" }, { "roleId": "in enim dolor laborum anim" } ], "inactive": false, "lastLogin": "2006-03-07T02:02:23.173Z", "_meta": { "created": "1990-06-14T07:06:34.984Z", "updated": "1991-06-11T18:55:30.284Z", "migrationVersion": -27078837 }, "email": "laboris in ea dolore" } } }, { "_id": "c7F75De6-e677-cD9a-37C1-4F47c73d546A", "location": "Application", "view": null, "status": "error", "app": "irure", "name": "do", "variables": { "decorators": [ { "type": "encryption", "pointer": "/~1/~1/~1/fR-n/J9EdHakhp" }, { "type": "encryption", "pointer": "/Rj/~1/xFjaFwl/coIm/~0/XMB/~1" }, { "type": "encryption", "pointer": "/FHy5O5dtIH/OtNfRL/j/NK/lh3Svq7qGv/T5vPo/~1/~0" }, { "type": "encryption", "pointer": "/~0/~1/~0/an-e1we/Svdu" } ] }, "last_updated": "1967-01-05T17:24:02.218Z", "encodingVersion": 1, "job": { "_id": "3bc2f0746010baac18c34553", "task": "3a1f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": null }, "groups": [ { "_id": "a08e4853c5a6f86a2eee85ca", "provenance": "voluptate in nulla", "name": "est nulla anim", "description": "irure do occaecat nulla aliqua", "memberOf": [ { "groupId": "3fe39f35f519b90034522047", "aaaManaged": false }, { "groupId": "a70b1c2999c7416705d50b36", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "aliquip sunt incididunt eiusmod Duis" }, { "roleId": "deserunt" }, { "roleId": "Ut sint sed aliquip" } ], "inactive": true, "_meta": { "created": "1946-05-19T20:01:53.877Z", "updated": "1951-12-31T15:12:26.596Z", "migrationVersion": 93547155 } }, { "_id": "3423fcfe38ed2f99b265718b", "provenance": "non mollit Ut ea ipsum", "name": "voluptate dolore aliquip", "description": "ut proident dolor", "memberOf": [ { "groupId": "0934424a020792277ea24d59", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "in irure sint" }, { "roleId": "Lorem" }, { "roleId": "incididunt adipisicing tempor" } ], "inactive": false, "_meta": { "created": "1976-06-07T06:59:56.778Z", "updated": "1965-03-20T03:16:24.689Z", "migrationVersion": 15326680 } }, { "_id": "14d5943dcd58140a4a97ebc7", "provenance": "elit nulla", "name": "ut ullamco adipisicing", "description": "ex minim quis voluptate Ut", "memberOf": [ { "groupId": "bdecce6f730f6bb00b9fc1ae", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "Duis dolor" }, { "roleId": "fugiat" }, { "roleId": "sunt pariatur id culpa" } ], "inactive": true, "_meta": { "created": "1959-07-31T11:05:18.317Z", "updated": "1964-04-12T07:06:39.527Z", "migrationVersion": 3614460 } } ], "type": "automatic", "metrics": { "start_time": "id laboris dolore", "end_time": 61324342.356965244, "server_id": "nostrud tempor ipsum", "finish_state": "complete", "run_time": -76408132.93795907, "retrying": null, "user": "8c4b9109b11169b27a3661e1", "owner": "Pronghorn" } }, { "_id": "cBabc06F-a878-Cb0E-aCc1-62Ccc3565eAA", "location": "Adapter", "view": "consectetur quis qui ad", "status": "incomplete", "app": "incididunt non", "name": "in commodo in fugiat", "variables": { "decorators": [ { "type": "encryption", "pointer": "/~1/wbERRh/X82/~1/~1/VaVtHj.NmYX/DlDp6K/~0" }, { "type": "encryption", "pointer": "/~1/~1/iLQ0--cu8u/~0/~0" }, { "type": "encryption", "pointer": "/~0/ZaAjKoXJhT/~0/~1/~0/~1/PVRmwL/m/xR61c/4STS/WPQI" }, { "type": "encryption", "pointer": "/~0/~1/PVGcX/~1/QVv9yhiA/fG.C/~1/mQTlDO4/fK" }, { "type": "encryption", "pointer": "/~0/~0/xt-ACz/~0/~1/~1/~0" } ] }, "last_updated": "1984-06-16T00:07:30.788Z", "encodingVersion": 1, "job": { "_id": "8072886e4696ed7b2aa24427", "task": "b4f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": null }, "groups": [ "f75bd2ebdfd4d46f336b7c04", { "_id": "be52fa36d0090cfd6c02a630", "provenance": "et in culpa", "name": "incididunt amet occaecat cupidatat", "description": "eu Duis Ut voluptate", "memberOf": [ { "groupId": "bd6b9d3f5542a25ac482e47d", "aaaManaged": false }, { "groupId": "831c10206f722899a041bd40", "aaaManaged": true }, { "groupId": "fd3962be3341e969d38b6677", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "exercitation ea sed adipisicing" }, { "roleId": "voluptate deserunt" }, { "roleId": "in Duis exercitation ad laborum" }, { "roleId": "enim anim cupidatat" }, { "roleId": "velit" } ], "inactive": true, "_meta": { "created": "2000-02-04T06:25:27.772Z", "updated": "2012-06-03T17:30:46.233Z", "migrationVersion": 55712250 } } ], "type": "automatic", "metrics": { "start_time": "Duis pariatur", "end_time": -59052317.501752324, "server_id": "officia labore magna veniam", "finish_state": "success", "run_time": 81998970.25494707, "retrying": true, "user": { "_id": "235698aea7a46cbdec23c435", "provenance": "sint", "username": "ipsum sed ullamco", "firstname": "aliqua veniam dolor id", "memberOf": [ { "groupId": "5853be176def758689a2d6ac", "aaaManaged": true }, { "groupId": "70b9011264ef00cd7a4f26e6", "aaaManaged": false }, { "groupId": "7e11a5fa788513613120e183", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "in nostrud est elit eu" }, { "roleId": "eu ut" }, { "roleId": "adipisicing irure" } ], "inactive": false, "lastLogin": "2001-02-10T23:32:36.262Z", "_meta": { "created": "2018-09-23T16:02:03.061Z", "updated": "1972-02-19T05:47:46.939Z", "migrationVersion": -49648701 }, "email": "commodo" }, "owner": "f05516b3c28c66a404857de1" } }, { "_id": "dfbb0f9F-3a67-7dB4-3756-C0fDc9cdDd15", "location": "Application", "view": "exercitation", "status": "scheduled", "app": "dolor nisi sit", "name": "et labore mollit quis", "variables": { "decorators": [ { "type": "encryption", "pointer": "/~0/~0" }, { "type": "encryption", "pointer": "/~1/aC" }, { "type": "encryption", "pointer": "/~0/hQ/ICN/dGRZUQa/tGKEnlFFyq/yJtGqa1/+Vh/~0/~0" }, { "type": "encryption", "pointer": "/~0/oq/GX-/~0/~1/~0/~0/j1z7wtZ,O/~0/~0/y,-q6-yR7y" }, { "type": "encryption", "pointer": "/Bt9U/FJ9gbKLOU" } ] }, "last_updated": "1991-09-30T13:05:31.311Z", "encodingVersion": 1, "job": { "_id": "a6854671466f902a56d7afd7", "task": "e28f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": null }, "groups": [ { "_id": "c2929d7df5ee8bc547dd9b65", "provenance": "qui ut sit minim aliqua", "name": "aliqua in amet", "description": "mollit", "memberOf": [ { "groupId": "12e4fbae758edc3dc0015a4f", "aaaManaged": true }, { "groupId": "a76e9f1f7e1bf6e73a64fd96", "aaaManaged": true }, { "groupId": "586f0a1de8545e7b83e58103", "aaaManaged": false }, { "groupId": "8f120f677409cd973b4cfd30", "aaaManaged": true }, { "groupId": "4a588864f58dc52e148f0eea", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "dolore eu cillum" }, { "roleId": "elit consectetur cillum irure" } ], "inactive": true, "_meta": { "created": "1951-11-30T03:51:47.393Z", "updated": "1959-07-18T07:21:10.915Z", "migrationVersion": -11187534 } }, "2b3a3682136fb77f893cab9c", "46cb5d38fd1c9593afe8ec11", { "_id": "68768645e81cdcea5f61805d", "provenance": "consectetur laborum cillum sed exercitation", "name": "adipisicing voluptate", "description": "dolor enim Duis", "memberOf": [ { "groupId": "3cc8fe9314772f6f6e570004", "aaaManaged": false }, { "groupId": "6859e7b249e0faacfcf14e58", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "quis pariatur" }, { "roleId": "commodo" }, { "roleId": "in cupidatat" }, { "roleId": "occaecat" } ], "inactive": false, "_meta": { "created": "1954-11-14T23:03:49.7Z", "updated": "2016-09-16T05:31:24.633Z", "migrationVersion": -6610912 } } ], "type": "automatic", "metrics": { "start_time": "dolor et elit aliqua dolor", "end_time": -7979539.363595262, "server_id": "sunt nisi nulla sit consequat", "finish_state": "success", "run_time": 23453485.297231063, "retrying": false, "user": "", "owner": "" } } ], "metadata": { "skip": -3549915, "limit": 29746272, "total": -1317517, "nextPageSkip": null, "previousPageSkip": 97851619, "currentPageSize": -43949484 } }
{ "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" } } } ] }