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", "exclude": "_id", "in": "voluptate elit tempor dolore anim", "not-in": "irure consequat aute", "equals": "aliquip laborum esse", "contains": "velit esse magna Duis", "starts-with": "deserunt consequat nulla labore tempor", "ends-with": "do esse fugiat Ut cupidatat", "dereference": "voluptate", "gt": "dolore ipsum est fugiat anim", "gte": "do ullamco aliqua", "lt": "mollit Duis ullamco", "lte": "sint occaecat sit", "q": "nisi do", "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": "dFDac6Ea-86d1-c6AD-e063-ecE66959bDD8", "location": "Adapter", "view": null, "status": "running", "app": "est ipsum minim ullamco", "name": "pariatur", "variables": { "decorators": [ { "type": "encryption", "pointer": "/EzoEG.5/rSIoxKVjx/IKC246/E/qr4TW7I,/CvV0rml/kJ" } ] }, "last_updated": "2002-05-08T20:40:24.327Z", "encodingVersion": 1, "job": { "_id": "80481874d5d5e89e2204de48", "task": "3a1f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": null }, "incomingRefs": [], "groups": [ { "_id": "56111c03b044e81853a8747c", "provenance": "quis", "name": "deserunt fugiat consectetur Ut in", "description": "nulla tempor ipsum veniam", "memberOf": [ { "groupId": "8d741b1639ee8e862e01405d", "aaaManaged": false }, { "groupId": "efd3b00f86f9db233893c879", "aaaManaged": true }, { "groupId": "9a0f76b218f3af3429ca77cc", "aaaManaged": false }, { "groupId": "2fe8d1a914b03d649b8fabc3", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "Excepteur" }, { "roleId": "consequat" } ], "inactive": true, "_meta": { "created": "2015-01-08T23:38:31.411Z", "updated": "2001-12-30T07:03:48.339Z", "migrationVersion": 55878631 } }, "b4ae121768ffbbe70c5e42a0", { "_id": "4227b21652004cddbb9b192b", "provenance": "amet irure Lorem tempor", "name": "nostrud", "description": "ad", "memberOf": [ { "groupId": "97c0c362acc0a803d02510ea", "aaaManaged": false }, { "groupId": "6bebd1f365c6c998a9426bbc", "aaaManaged": true }, { "groupId": "16ca014dacf8fa7b472dda14", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "velit sed dolore do incididunt" }, { "roleId": "laboris reprehenderit" }, { "roleId": "nisi et sint cillum" } ], "inactive": false, "_meta": { "created": "1965-02-03T01:40:47.039Z", "updated": "2010-02-01T09:23:52.374Z", "migrationVersion": -90161825 } }, { "_id": "c22714ba104cfc8c8d1e1b98", "provenance": "in aliquip sit consequat", "name": "et veniam", "description": "est", "memberOf": [ { "groupId": "673f4bfe8350cd04410b55db", "aaaManaged": false }, { "groupId": "38176b5b3cfbf5f04039a278", "aaaManaged": false }, { "groupId": "db46d59ac41f820deeb4fb5c", "aaaManaged": false }, { "groupId": "342e7793fd103176e1455b8b", "aaaManaged": false }, { "groupId": "0ce20ae900cc820ae7a62b27", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "occaecat cupidatat" }, { "roleId": "Duis laboris minim" }, { "roleId": "laborum aute" }, { "roleId": "enim id in nostrud pariatur" }, { "roleId": "laborum" } ], "inactive": true, "_meta": { "created": "1965-06-01T14:31:24.498Z", "updated": "1988-04-06T03:20:25.313Z", "migrationVersion": 69112024 } }, "7a5772507e0c9c822efc23c8" ], "type": "manual", "metrics": { "start_time": "deserunt magna est non ad", "claim_time": "1971-09-11T12:36:44.214Z", "end_time": -73155057.5714253, "server_id": "fugiat aute", "finish_state": "paused", "run_time": -56623829.23137779, "user": "84f9727afec2510538bba196", "owner": "Pronghorn" } }, { "_id": "ef11ba4a-bafb-1CDD-Ea1C-dD89f1B052CE", "location": "Broker", "view": null, "status": "canceled", "app": "Lorem incididunt", "name": "sint quis", "variables": { "decorators": [ { "type": "encryption", "pointer": "/wv/t/~0/~1/fbtfJ95/~1/~1" }, { "type": "encryption", "pointer": "/KAtvAIn9TNZ/Iy5K6/~0/TK/~0/~1/XxP/~0/Q+sJm-r/B3/~0" } ] }, "last_updated": "2018-11-29T15:30:51.768Z", "encodingVersion": 1, "job": { "_id": "5dbab0936f6df3f2f3dd93cc", "task": "3a1f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": null }, "incomingRefs": [], "groups": [ "af8651df73fe21d51212e9ad", "d3bab0e69843a93b22a8cb99" ], "type": "manual", "metrics": { "start_time": "in quis", "claim_time": "1972-04-30T11:24:33.817Z", "end_time": 28597907.78286171, "server_id": "ex cupidatat laboris", "finish_state": "incomplete", "run_time": 94228846.90586847, "user": "", "owner": "" } }, { "_id": "C32F4f0f-BcDf-3D3e-325B-5b68ddB134A4", "location": "Broker", "view": null, "status": "running", "app": "consequat qui magna tempor", "name": "magna fugiat", "variables": { "decorators": [ { "type": "encryption", "pointer": "/~0/~0/~0/~1/FP/YYMoIKYj/qoneU0gio1/~0/~0/~1/~0/kPRoa" }, { "type": "encryption", "pointer": "/QW7svBPPK6U/XWV8n+vXHt" } ] }, "last_updated": "2002-10-23T20:01:09.62Z", "encodingVersion": 1, "job": { "_id": "b3385b4c8014b060f8c8c77a", "task": "e28f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": null }, "incomingRefs": [], "groups": [ "d8c523a85d3fb76556b1ea3f", "5dffaed1e27848dfb24bb23e", "14ac33d03bde1a8319d94f1d", { "_id": "97e59521cc33f99e0d36df95", "provenance": "nisi magna proident", "name": "enim cillum", "description": "sed", "memberOf": [ { "groupId": "6e7910c816a81de839523479", "aaaManaged": true }, { "groupId": "959d83525d748b5816c907b9", "aaaManaged": false }, { "groupId": "cd9d0b544d4867b19d3c8ff1", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "Duis est voluptate" }, { "roleId": "minim esse cillum commodo non" } ], "inactive": false, "_meta": { "created": "1948-12-11T19:41:03.024Z", "updated": "1977-02-05T03:07:51.852Z", "migrationVersion": 2944420 } }, "b97dfa3e340ade8474fc7522" ], "type": "manual", "metrics": { "start_time": "fugiat", "claim_time": "1977-11-04T18:32:16.135Z", "end_time": 62341852.7341038, "server_id": "pariatur ullamco voluptate irure aliquip", "finish_state": "incomplete", "run_time": 80629024.33661273, "user": "7446275d863388746704380e", "owner": "d9ef06e052ea72988f69848c" } }, { "_id": "A8b43d5b-6f20-bcba-dfF4-b6Fac2a922b1", "location": "Application", "view": "dolore adipisicing in", "status": "running", "app": "sed non irure dolor", "name": "exercitation nulla", "variables": { "decorators": [ { "type": "encryption", "pointer": "/ZBb/MMAYhE2/~1/jOAyLKIgD/~0/~0/EBbq/~1/Q" } ] }, "last_updated": "1979-12-31T14:44:54.099Z", "encodingVersion": 1, "job": { "_id": "f164ba0ea7ac7bf8830bf7bd", "task": "b4f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": [ "aefa55f3b6b7da0720aef602", "e9612ba876574ad0413d3d06", "54591e79aba8bc46e39c7a80" ] }, "incomingRefs": [], "groups": [ { "_id": "8e5fa8f50fca7d5d69c48811", "provenance": "Excepteur in fugiat consequat", "name": "irure voluptate dolore amet", "description": "non do voluptate", "memberOf": [ { "groupId": "b429bcdc9f43172f9bc8f519", "aaaManaged": true }, { "groupId": "cc8bfa5cb9059df87efad0f8", "aaaManaged": true }, { "groupId": "0b156dbbe9edb539a398be30", "aaaManaged": true }, { "groupId": "43c638f9c76b8f6c98dbb0c0", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "qui esse dolor fugiat" } ], "inactive": false, "_meta": { "created": "1951-01-17T07:14:00.181Z", "updated": "1950-09-04T03:36:46.027Z", "migrationVersion": 70656368 } } ], "type": "manual", "metrics": { "start_time": "sed ipsum cillum incididunt velit", "claim_time": "2005-02-18T03:00:59.941Z", "end_time": 14043703.93517685, "server_id": "exercitation", "finish_state": "success", "run_time": -52820209.71581805, "user": "99cd87b990d9744ac5e67590", "owner": "" } }, { "_id": "299bfaA8-FF49-cfB0-2Abb-9Cfa3d38843e", "location": "Broker", "view": null, "status": "error", "app": "aliquip commodo magna do officia", "name": "consequat", "variables": { "decorators": [ { "type": "encryption", "pointer": "/~1/LY19/yNYKZ/t1PsdHFmUO/N/QI/PZD/nS.reJl4BX/~0/~0" }, { "type": "encryption", "pointer": "/~0/~1/cUmYBkLJbie/d9nD/~1" }, { "type": "encryption", "pointer": "/a/~1/ce7VP7U/~1/~0" } ] }, "last_updated": "2018-06-02T10:01:37.231Z", "encodingVersion": 1, "job": { "_id": "472ebd1e3c6da2f457c4a826", "task": "e28f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": null }, "incomingRefs": [], "groups": [ { "_id": "18f8c7f7740a90166471b3f2", "provenance": "incididunt minim magna nostrud", "name": "dolore voluptate enim", "description": "voluptate proident", "memberOf": [ { "groupId": "273c2ffc2b024a23d59db018", "aaaManaged": true }, { "groupId": "e97265eaf20f560cf419419c", "aaaManaged": false }, { "groupId": "608ca588a28c69819d0d36ad", "aaaManaged": false }, { "groupId": "d9a4eb781dfc69a8b659b669", "aaaManaged": true }, { "groupId": "cb26b7b07adce45ed285b672", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "exercitation" } ], "inactive": false, "_meta": { "created": "1989-03-04T04:51:07.191Z", "updated": "1975-11-12T17:33:57.83Z", "migrationVersion": -94551282 } }, "04503d05553d8f61650d9f7e", "7738794c1853b3eb6938d493", "62eb2831408082624900fd08", "340d835cc5197f2baa31effe" ], "type": "manual", "metrics": { "start_time": "sed dolor", "claim_time": "1951-03-02T02:00:17.681Z", "end_time": -44594243.300427295, "server_id": "ipsum ad reprehenderit anim commodo", "finish_state": "success", "run_time": 38782040.16020867, "user": "e945101562fb92baeb7a82e0", "owner": "Pronghorn" } } ], "metadata": { "skip": -82820707, "limit": 51571582, "total": 8028421, "nextPageSkip": 97984789, "previousPageSkip": null, "currentPageSize": 69119131 } }
{ "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" } } } ] }