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": 10, "order": 1, "sort": "name", "include": "name,description", "exclude": "_id,description", "in": "deserunt voluptate Ut cillum enim", "not-in": "pariatur consequat ea labore in", "equals": "id", "contains": "irure ipsum officia dolor", "starts-with": "id velit amet ut", "ends-with": "ea sunt ex in eiusmod", "dereference": "eu aliqua", "gt": "irure", "gte": "officia quis nulla", "lt": "fugiat pariatur", "lte": "Ut esse qui quis elit", "q": "in commodo", "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": "caBfFF93-4bE0-c1E0-EDba-CcB73FDa576f", "location": "Broker", "view": "ipsum", "status": "complete", "app": "ea ullamco laborum dolore", "name": "consectetur Lorem labore", "variables": { "decorators": [ { "type": "encryption", "pointer": "/uxv8+hN/~0" }, { "type": "encryption", "pointer": "/~1/~0/hIzw/Y/ccL0Ts/Bd-o1Dq/~0/CtR4vfSqI" }, { "type": "encryption", "pointer": "/~0/u" }, { "type": "encryption", "pointer": "/~0/p2/~0/aUnhGYC3Zx/~1/~1/l/5/~0/~0/~0/O4hRFVhrg" } ] }, "last_updated": "1988-02-26T14:42:26.131Z", "encodingVersion": 1, "job": { "_id": "c0f251c99759c7b9637f9167", "task": "3a1f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": [ "682d44d41f6b25efae9e5882", "2353ffcf826883394ab241c0" ] }, "incomingRefs": [], "groups": [ "78df1afa3c7ebed0a0656e21" ], "type": "operation", "metrics": { "start_time": "dolore cillum", "end_time": 91949446.00634551, "server_id": "velit", "finish_state": "success", "run_time": 62532085.728889495, "retrying": true, "user": "0ac79e861fd6650e8369d1c5", "owner": "1f79b31797d7d4483f6541f7" } }, { "_id": "93aedb9A-5922-1f0D-5b78-57F6BbD67ddb", "location": "Adapter", "view": "veniam eiusmod occaecat fugiat dolor", "status": "complete", "app": "reprehenderit sint", "name": "dolore", "variables": { "decorators": [ { "type": "encryption", "pointer": "/~1/~1/~1/Opl/~1/~1/LmSlxNyIMTz/I-E/~0/~0/Q" }, { "type": "encryption", "pointer": "/e.+/z/~0/~0/~0/U/XqYLR-/wDn5LmeKV/JwS" }, { "type": "encryption", "pointer": "/~0/J/~1/QHM/MmQ1P/b+T3yn+/BD/~1/~0" }, { "type": "encryption", "pointer": "/~0/~0/~0/a4tyVd/dC/W1P/~0/q/~1/~0" } ] }, "last_updated": "1981-01-23T05:04:47.016Z", "encodingVersion": 1, "job": { "_id": "e6d15b682167b59b285565a5", "task": "e28f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": null }, "incomingRefs": [], "groups": [ "8766e3a9587cb84f44bce662", "e77f643337d3a4fe666ad9d2", "14908c54a8335740a30a4134" ], "type": "operation", "metrics": { "start_time": "nostrud Excepteur velit quis elit", "end_time": -69903404.77937984, "server_id": "consequat", "finish_state": "success", "run_time": 92719813.01817954, "retrying": true, "user": "Pronghorn", "owner": "84fa314fdddae3f829629335" } }, { "_id": "f8FfD58F-7Abc-E21d-D7bF-9BEfEc8CD2F0", "location": "Application", "view": null, "status": "paused", "app": "ex veniam eiusmod in cillum", "name": "ut Ut officia tempor elit", "variables": { "decorators": [ { "type": "encryption", "pointer": "/r+6A/~0/WE/W9F4oGW/pNk77hj/sWHbFpf/wBsN5gS/O/~0/~1/s6Y/~0" }, { "type": "encryption", "pointer": "/~0/~1/QhY5/yTOI/~0/Y/raEiavfWFWa/Mrqx/~1/~1" }, { "type": "encryption", "pointer": "/~1/~0/~1/~1/oTKKAI-U4XK" }, { "type": "encryption", "pointer": "/~0/r-wiLB8/~0/~1/wmBVD.PW/r6/~1/uQo-5rhg9/JooX-5/~0/~1" } ] }, "last_updated": "1969-12-31T20:14:59.569Z", "encodingVersion": 1, "job": { "_id": "3cf24df49ee06c461625c15c", "task": "3a1f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": null }, "incomingRefs": [], "groups": [ "ea68fb2b0981f5c3fba07189", "7f79c8de051d0718f64c4c57", "dbed5c33f4e2a337a8b747c4" ], "type": "operation", "metrics": { "start_time": "Duis", "end_time": 56632103.0980801, "server_id": "irure veniam ullamco", "finish_state": "success", "run_time": -52980672.130959935, "retrying": false, "user": "e97dd3878c1eb44429494b97", "owner": "78a24fc9dadcdf21ab5ef3d5" } }, { "_id": "EfbacbCb-1C2C-f4Be-De64-2ED23F4A3Aa2", "location": "Broker", "view": null, "status": "paused", "app": "sed incididunt consequat", "name": "aute laborum", "variables": { "decorators": [ { "type": "encryption", "pointer": "/~1/ozuLjV/QjiFDP/~1/~0/~1/~0" }, { "type": "encryption", "pointer": "/~0/F/~0/gDgBlUS/~0" }, { "type": "encryption", "pointer": "/~1/~1/~0/lD5rh5oyx/~0/~0/~0/~0" }, { "type": "encryption", "pointer": "/~0/PqQ/~0/~0/~1/S0/8Gj5pXWY/~0/cjHgjMz4t1s/~0/~0" }, { "type": "encryption", "pointer": "/u6DrroW52F/lW/~0/Yne6L6qi5/bHEQIvwQ-T/HuKtjYO.c2/~1/UABZmO" } ] }, "last_updated": "1968-03-14T14:35:40.003Z", "encodingVersion": 1, "job": { "_id": "413db3b2d1b5a5e963dd777c", "task": "3a1f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": null }, "incomingRefs": [], "groups": [ { "_id": "2dd177f42b3528015dfdf4d3", "provenance": "fugiat cupidatat irure", "name": "minim enim aliqua dolore velit", "description": "sunt enim eu", "memberOf": [ { "groupId": "9ccdc3e7a9087db638f23731", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "nulla ut" } ], "inactive": false, "_meta": { "created": "2018-01-03T20:16:54.029Z", "updated": "1988-08-08T17:25:36.699Z", "migrationVersion": -35545058 } } ], "type": "operation", "metrics": { "start_time": "mollit laboris dolor irure ad", "end_time": 54986562.06524187, "server_id": "consectetur est cupidatat", "finish_state": "success", "run_time": 38106633.05764952, "retrying": null, "user": "eea51455ab2032bd7bb1864f", "owner": "Pronghorn" } } ], "metadata": { "skip": -65689865, "limit": 33602816, "total": 72076139, "nextPageSkip": null, "previousPageSkip": 27176914, "currentPageSize": -38404364 } }
{ "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" } } } ] }