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": "name", "exclude": "_id,description", "in": "et exercitation nostrud mollit officia", "not-in": "Ut exercitation", "equals": "fugiat eu commodo", "contains": "do laborum dolor incididunt reprehenderit", "starts-with": "aliqua sint nulla", "ends-with": "proident in eiusmod incididunt", "dereference": "ullamco ut ipsum in anim", "gt": "Ut cupidatat in id", "gte": "culpa", "lt": "cupidatat deserunt ea Duis non", "lte": "laboris cupidatat mollit", "q": "sint nisi proident eiusmod aliquip", "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": "82B4951F-ccFe-Cb45-feD3-FEf12cDc6D4e", "location": "Adapter", "view": null, "status": "error", "app": "pariatur exercitation enim labore", "name": "voluptate pariatur magna irure cillum", "variables": { "decorators": [ { "type": "encryption", "pointer": "/KFOzAtEto/~1/KrCqLCq/ld1Tlf.cZE" }, { "type": "encryption", "pointer": "/~1/DS/~0/cP/Ng8HM16Wp-6/~0/j3xOAb/Bp4p/c5LFdVLmB8/jw1Mp5+aJ5" }, { "type": "encryption", "pointer": "/xqqFI6YLUB/rTFQOPeXg/~0/fJyt/~0/HK3/lq7f/~1" }, { "type": "encryption", "pointer": "/~1/~0/F.q1T/f/ZbdL8ZW,wjC/~1/~1/OO/SJJRv4J-T/~1" } ] }, "last_updated": "1961-09-07T23:15:32.105Z", "encodingVersion": 1, "job": { "_id": "f5a8d9d00ee1bb9486138138", "task": "b4f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": null }, "groups": [ { "_id": "64414101ba90f4835099b6d2", "provenance": "minim in", "name": "commodo quis dolor", "description": "sint dolor", "memberOf": [ { "groupId": "cafd60a968ddf30f10180191", "aaaManaged": true }, { "groupId": "a644fcb68753fdf55478f0e8", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "veniam in" }, { "roleId": "fugiat esse" }, { "roleId": "ex laboris aliquip" }, { "roleId": "culpa elit" }, { "roleId": "est" } ], "inactive": false, "_meta": { "created": "2021-03-22T11:16:17.322Z", "updated": "2022-10-25T06:15:52.447Z", "migrationVersion": 70935062 } }, { "_id": "d9decdd992f24878c8611fbc", "provenance": "deserunt eiusmod proident cupidatat", "name": "quis et ex aliquip id", "description": "sit", "memberOf": [ { "groupId": "bc2f5780582f693427977692", "aaaManaged": false }, { "groupId": "8a3880ef735913259aa8d4ce", "aaaManaged": true }, { "groupId": "b0f462ed8521db7de648951b", "aaaManaged": true }, { "groupId": "2d32b7c072c8b5c2e22399e7", "aaaManaged": true }, { "groupId": "e985fdc32ad78c8cc02f2333", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "culpa aliquip qui cupidatat" }, { "roleId": "elit ut dolore ullamco" }, { "roleId": "in cupidatat" }, { "roleId": "qui consequat culpa anim" }, { "roleId": "consequat veniam cillum elit" } ], "inactive": true, "_meta": { "created": "1948-03-11T21:16:49.448Z", "updated": "2011-12-26T09:02:15.86Z", "migrationVersion": 61724231 } } ], "type": "operation", "metrics": { "start_time": "officia adipisicing occaecat labore commodo", "end_time": -30298578.208973974, "server_id": "occaecat Excepteur ad aute Duis", "finish_state": "scheduled", "run_time": -96105551.96198733, "retrying": null, "user": "Pronghorn", "owner": "Pronghorn" } }, { "_id": "ACDC9Cc0-25AB-2E7B-6d06-Df56633abbAa", "location": "Broker", "view": "Excepteur occaecat ullamco ut", "status": "error", "app": "deserunt Ut reprehenderit nulla", "name": "eu elit ex", "variables": { "decorators": [ { "type": "encryption", "pointer": "/LfYvspu/P/~0/~1/H/~1/dxs6DKo0s/HY6Qm5cnB1/~1" }, { "type": "encryption", "pointer": "/~1/~0/U6Q4ncL,/sZR5/~1/zwrsj" } ] }, "last_updated": "2020-04-11T06:02:51.091Z", "encodingVersion": 1, "job": { "_id": "ca7cff597f343193abd50da7", "task": "3a1f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": [ "2e18facca42df1849b2bd06d", "1f45629f994ad291e8eb357b", "5fff73684982cb36cd7f1c14", "b816e6edbca9819e142e40c8", "b705e64a690be0746c30698f" ] }, "groups": [ { "_id": "5c0207ffb50b79bd99d50e74", "provenance": "Ut in non aliqua ipsum", "name": "cillum non", "description": "ut deserunt mollit ad", "memberOf": [ { "groupId": "6bacb5739513c87b9085f550", "aaaManaged": true }, { "groupId": "212faab13256aa267d7a00f8", "aaaManaged": true }, { "groupId": "2f6cb61e5a7b37d6e8134c01", "aaaManaged": true }, { "groupId": "c0eb1ab5a0da5b7c36de587d", "aaaManaged": false }, { "groupId": "425765726ffdfb8f089aa9d4", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "enim Excepteur fugiat sunt" }, { "roleId": "aliquip incididunt deserunt culpa ex" }, { "roleId": "ad labore eiusmod amet" }, { "roleId": "ad aute" } ], "inactive": true, "_meta": { "created": "1976-07-22T15:54:38.846Z", "updated": "1965-12-22T03:22:20.764Z", "migrationVersion": 36781703 } }, { "_id": "81aa51924ae065d1920b3c41", "provenance": "laboris", "name": "id aute sint Duis", "description": "Duis laborum fugiat", "memberOf": [ { "groupId": "de9a5d45c18d0582c08bb029", "aaaManaged": true }, { "groupId": "9a4a8a982245f7fb84033f7e", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "ea ullamco sed magna nisi" }, { "roleId": "amet non mollit" }, { "roleId": "ullamco voluptate" }, { "roleId": "commodo eiusmod quis" } ], "inactive": true, "_meta": { "created": "1975-06-11T00:31:09.14Z", "updated": "2023-11-11T20:55:31.141Z", "migrationVersion": 60154929 } }, "8157787f190678139c623e67", "4e518865bc1eb745c53b4f28" ], "type": "operation", "metrics": { "start_time": "in qui", "end_time": 37720309.98273292, "server_id": "sit ullamco veniam Excepteur cillum", "finish_state": "success", "run_time": 32203451.70910673, "retrying": null, "user": "", "owner": { "_id": "ee7d063d61510e8036fa32c9", "provenance": "eu sunt magna in", "username": "magna", "firstname": "ipsum irure aliquip anim", "memberOf": [ { "groupId": "be992a152438c865f788752c", "aaaManaged": false }, { "groupId": "eadaaa265b3244aed05b0204", "aaaManaged": false }, { "groupId": "568f73a906f416aaeea4ce6e", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "adipisicing veniam mollit" } ], "inactive": false, "lastLogin": "1986-05-01T15:16:43.956Z", "_meta": { "created": "1974-06-28T18:10:30.849Z", "updated": "1979-12-14T04:14:47.041Z", "migrationVersion": -44864383 }, "email": "aliqua adipisicing" } } } ], "metadata": { "skip": 29329214, "limit": 86109477, "total": 54313399, "nextPageSkip": -37506949, "previousPageSkip": -25269080, "currentPageSize": 909234 } }
{ "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" } } } ] }