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": 10, "skip": 1, "order": 1, "sort": "name", "include": "name,description", "exclude": "_id", "in": "ipsum", "not-in": "quis", "equals": "ut laboris deserunt", "contains": "eiusmod", "starts-with": "ad", "ends-with": "amet eu", "dereference": "aliquip elit", "gt": "magna pariatur irure", "gte": "reprehenderit", "lt": "Excepteur eu exercitation", "lte": "id magna", "q": "incididunt", "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": "Dab7A3d4-af83-dF9B-E5c1-f4E50f7a16D7", "location": "Adapter", "view": null, "status": "scheduled", "app": "Lorem", "name": "voluptate anim nulla aute", "variables": { "decorators": [ { "type": "encryption", "pointer": "/a/zFOWaD3MT-X/gIP+jb/ZmMQ/r2fD/BMb6SLp" }, { "type": "encryption", "pointer": "/LYpmR/~0/BLOaN/w/gevo-qkOi" }, { "type": "encryption", "pointer": "/~0/~0/~0/~0/~0" } ] }, "last_updated": "2015-09-24T08:13:58.563Z", "encodingVersion": 1, "job": { "_id": "09d72cee6df4d5cd7a3c3951", "task": "e28f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": null }, "groups": [ { "_id": "ff0230186088fd671f706109", "provenance": "fugiat enim sed", "name": "exercitation non fugiat velit Lorem", "description": "magna", "memberOf": [ { "groupId": "4d52a90324cfb717e42a3489", "aaaManaged": false }, { "groupId": "e71ac0206ecd88d0a95dfbbb", "aaaManaged": false }, { "groupId": "a0854ff8a97b00c952bee74e", "aaaManaged": false }, { "groupId": "d9ac791c13cb9ab5f1025e0c", "aaaManaged": false }, { "groupId": "082a02f2fcd6e25b64ba8bf0", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "officia id voluptate" }, { "roleId": "et dolor ipsum" }, { "roleId": "ipsum aliqua" }, { "roleId": "id mollit do dolore" } ], "inactive": true, "_meta": { "created": "1950-12-21T10:17:49.885Z", "updated": "2020-09-07T03:48:53.198Z", "migrationVersion": -27598670 } }, "719086ab2391ab0a97b00f5b" ], "type": "manual", "metrics": { "start_time": "id in sint in officia", "claim_time": "1962-06-19T02:11:28.445Z", "end_time": -17058679.140366808, "server_id": "labore incididunt cillum non laboris", "finish_state": "running", "run_time": 20662523.66978106, "user": { "_id": "92f9ba7a63ef940d03e400c7", "provenance": "nulla quis eiusmod enim", "username": "officia in", "firstname": "proident officia Lorem", "memberOf": [ { "groupId": "af1be25b34d219bbd240d8fa", "aaaManaged": false }, { "groupId": "3fa0328d723cd940073e1950", "aaaManaged": true }, { "groupId": "41ed30f4cfdfaa6a4eadad9a", "aaaManaged": false }, { "groupId": "856324022e6c19ad3133f0ce", "aaaManaged": false }, { "groupId": "b6bdeff73e76d3841f5a2552", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "aute dolor et" }, { "roleId": "dolore" } ], "inactive": false, "lastLogin": "1964-12-06T14:33:16.011Z", "_meta": { "created": "2018-12-07T05:26:42.256Z", "updated": "1960-02-05T05:54:13.79Z", "migrationVersion": -26844022 }, "email": "nulla anim" }, "owner": "Pronghorn" } }, { "_id": "1eDbD5fC-adD3-183D-Cfe4-6dA3D0a0ecCB", "location": "Adapter", "view": null, "status": "incomplete", "app": "qui pariatur cillum", "name": "esse velit", "variables": { "decorators": [ { "type": "encryption", "pointer": "/~1/~1/~0/~1/~1/i/~1/ePNUHz9RX/~0/~1" }, { "type": "encryption", "pointer": "/v,H/~0/jbQQ/~0/~1/~1/yj/~1/~0" } ] }, "last_updated": "2015-11-02T21:31:50.275Z", "encodingVersion": 1, "job": { "_id": "1e39fd5c5a8b1b6aaca94da9", "task": "b4f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": null }, "groups": [ { "_id": "84aeb45d5e57193984f5cb24", "provenance": "laborum qui nulla ullamco", "name": "eu laborum quis", "description": "reprehenderit", "memberOf": [ { "groupId": "31227a7e4588a1e68800497d", "aaaManaged": true }, { "groupId": "de8d7250e8c67ef84e6cb89c", "aaaManaged": true }, { "groupId": "5d31c55b0fd4437a81bb4da7", "aaaManaged": false }, { "groupId": "1afcd46aab582268888343b3", "aaaManaged": true }, { "groupId": "979e30564b47e7a994bd79ce", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "irure reprehenderit exercitation id" }, { "roleId": "tempor officia aliqua commodo" }, { "roleId": "Excepteur" }, { "roleId": "aliqua Duis" } ], "inactive": false, "_meta": { "created": "1994-07-25T12:48:04.315Z", "updated": "2001-05-27T16:24:51.725Z", "migrationVersion": -31370388 } }, { "_id": "134e01f11e50702f8bb6795b", "provenance": "cillum et eiusmod tempor laborum", "name": "cillum Lorem velit exercitation", "description": "eu", "memberOf": [ { "groupId": "450575983aa7fb7f7c3b3bab", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "cupidatat" }, { "roleId": "laborum" }, { "roleId": "sint ullamco" }, { "roleId": "dolore in sunt" } ], "inactive": true, "_meta": { "created": "1978-01-10T10:57:01.12Z", "updated": "1990-04-07T23:49:39.076Z", "migrationVersion": 45608502 } }, "6a9a9a6db09905d580263d36", "9655ac8afcd1068818b15721" ], "type": "manual", "metrics": { "start_time": "id in cillum", "claim_time": "2024-10-12T10:36:04.874Z", "end_time": 85678806.81101128, "server_id": "qui tempor ut sunt", "finish_state": "success", "run_time": 41446947.59641209, "user": { "_id": "4816cdf12748cfad853a7fd7", "provenance": "dolore dolor pariatur", "username": "ad proident nisi cillum", "firstname": "irure voluptate", "memberOf": [ { "groupId": "d5e7acc88b590bb7460556e1", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "nostrud mollit" }, { "roleId": "ex ipsum" }, { "roleId": "occaecat magna" } ], "inactive": true, "lastLogin": "1948-11-16T20:37:03.217Z", "_meta": { "created": "1976-12-02T00:49:25.375Z", "updated": "1961-01-07T12:38:03.851Z", "migrationVersion": -11379570 }, "email": "commodo exercitation ex irure ullamco" }, "owner": { "_id": "3931d26b55ea89ea8478cca6", "provenance": "ex ullamco ut", "username": "eu", "firstname": "nostrud nisi", "memberOf": [ { "groupId": "b45c12386e3368d2af969a94", "aaaManaged": false }, { "groupId": "a6c952e2f0dff8e693da4e24", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "nisi labore dolor non occaecat" }, { "roleId": "officia sed" }, { "roleId": "aute aliquip enim" }, { "roleId": "magna esse" }, { "roleId": "ut tempor" } ], "inactive": false, "lastLogin": "2000-12-14T11:18:26.501Z", "_meta": { "created": "1982-01-28T22:03:10.955Z", "updated": "2025-02-04T15:44:55.442Z", "migrationVersion": 38689536 }, "email": "ipsum pariatur ea" } } }, { "_id": "1e2D07e8-d11f-3fE9-1b46-A4eFE74F2424", "location": "Adapter", "view": "culpa eu in consequat", "status": "error", "app": "ut minim commodo", "name": "aute incididunt fugiat", "variables": { "decorators": [ { "type": "encryption", "pointer": "/~0/isN7q-v/IgwNPXrnEv/~1/ZUe,a4R/~0/~1/~0/~0/~1" }, { "type": "encryption", "pointer": "/~0/~0/~0/~0/ycG+Q5/~0" }, { "type": "encryption", "pointer": "/~0/~1/T/~1/~1/~0/~1/~0" }, { "type": "encryption", "pointer": "/~0/FW5/~1/i1yR48TZhOr/~0/lVT3uQW+tI/A.x/~0/~0/~1" }, { "type": "encryption", "pointer": "/~0/~1/o7k/yPjMH3W/McikF0EGBk" } ] }, "last_updated": "1990-06-10T05:43:16.883Z", "encodingVersion": 1, "job": { "_id": "195264050ab06efc02059e17", "task": "3a1f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": [ "6c1bf37766d919cc86911d57", "9cba023ceee50602f14c13f8", "502c928750015772b367e65f", "36e6a743f11bef92bf97567e", "cd9c210804beddbd03011d79" ] }, "groups": [ "fa8ecc0dbd0142d8652a661d" ], "type": "manual", "metrics": { "start_time": "culpa", "claim_time": "1969-05-13T12:54:29.653Z", "end_time": 92318575.04065198, "server_id": "id cillum fugiat nisi dolore", "finish_state": "incomplete", "run_time": -40640085.35025563, "user": "", "owner": "cbd72b3869e282d41f354d99" } }, { "_id": "A52a89B0-BeFE-dedc-AcE6-aF5Eca3Eb1CE", "location": "Broker", "view": null, "status": "incomplete", "app": "do aute", "name": "anim dolor ut est proident", "variables": { "decorators": [ { "type": "encryption", "pointer": "/~0/~0/~1" }, { "type": "encryption", "pointer": "/~0/~1/~1/P.ny8OeAr/~0/~0/~0" }, { "type": "encryption", "pointer": "/~1/~0/DhDk/~0/~0/~0/gCHLoKX1z/~1/~1/aynzkX/Cu" } ] }, "last_updated": "1979-06-26T07:24:08.182Z", "encodingVersion": 1, "job": { "_id": "df0510ad329b9d8729cf0f19", "task": "e28f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": null }, "groups": [ "e8c13cb9a567aedbc0984d98" ], "type": "manual", "metrics": { "start_time": "magna non in", "claim_time": "1947-10-20T05:24:53.915Z", "end_time": -81382267.72175759, "server_id": "ut est", "finish_state": "failure", "run_time": -1673518.8874258995, "user": "Pronghorn", "owner": { "_id": "479b600c3f5c2fe4e9ce0998", "provenance": "cupidatat dolore sint", "username": "sint dolore dolor", "firstname": "voluptate id ut irure Duis", "memberOf": [ { "groupId": "3070f88e236dbf5a263597a2", "aaaManaged": false }, { "groupId": "32ecac24e24a1b75df086613", "aaaManaged": true }, { "groupId": "3ffa246b92d965b8a3d3cde9", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "consequat in ullamco aliquip" }, { "roleId": "consequat ea occaecat" }, { "roleId": "irure Duis" }, { "roleId": "veniam magna culpa enim minim" } ], "inactive": true, "lastLogin": "1969-06-12T16:49:51.082Z", "_meta": { "created": "1971-11-09T23:35:53.778Z", "updated": "2013-10-27T12:02:32.363Z", "migrationVersion": -33681801 }, "email": "fugiat proident dolor do" } } }, { "_id": "687C2D7A-99f1-aEE7-B1F9-aD67f0225Eef", "location": "Adapter", "view": null, "status": "complete", "app": "occaecat consectetur", "name": "cupidatat eu", "variables": { "decorators": [ { "type": "encryption", "pointer": "/~1/~0/~1/~0/~1" } ] }, "last_updated": "1971-11-07T20:30:56.005Z", "encodingVersion": 1, "job": { "_id": "d3ba6617072f1fea1606266f", "task": "e28f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": [ "f74d0c1d5ae96c38ab8addd3", "afee02c1925cb209752b7b5e", "70e8ab1684932784461e5f2c", "ead8dc1759982745f31c3895", "61a9b2d265f2dd896d3ed27f" ] }, "groups": [ "ec2414b7ebc571dc506c1a15", "f23e4bfa96fc4a59c3d25e7d" ], "type": "manual", "metrics": { "start_time": "dolore sint sunt", "claim_time": "2024-01-26T23:56:19.688Z", "end_time": -25207818.672620833, "server_id": "voluptate Duis nisi", "finish_state": "paused", "run_time": -65416240.59860305, "user": { "_id": "e8a331dc27ebe62304ba406f", "provenance": "Ut in id laboris", "username": "laboris veniam reprehenderit velit eiusmod", "firstname": "consequat", "memberOf": [ { "groupId": "ff78e84a98816b6e36d7f238", "aaaManaged": false }, { "groupId": "de2ef4600fa6f1def7f2d80b", "aaaManaged": false }, { "groupId": "9b64f598d62d7eb74ba64e26", "aaaManaged": true }, { "groupId": "ca655ab25e56f8433995fdb1", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "pariatur eu" }, { "roleId": "est amet occaecat" } ], "inactive": true, "lastLogin": "1986-11-13T17:14:10.271Z", "_meta": { "created": "1998-08-27T20:29:22.414Z", "updated": "1984-04-13T10:41:28.901Z", "migrationVersion": 78802354 }, "email": "dolor elit cillum" }, "owner": "Pronghorn" } } ], "metadata": { "skip": 5344563, "limit": 13181073, "total": 18046941, "nextPageSkip": -29770918, "previousPageSkip": -39551708, "currentPageSize": -64488057 } }
{ "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" } } } ] }