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": 50, "skip": 1, "order": 1, "sort": "name", "include": "description", "exclude": "_id", "in": "tempor elit incididunt ea ullamco", "not-in": "quis", "equals": "ea qui id deserunt sunt", "contains": "consequat in", "starts-with": "sunt ad nulla", "ends-with": "dolore", "dereference": "labore incididunt esse", "gt": "cupidatat in elit Duis", "gte": "elit", "lt": "eiusmod", "lte": "voluptate et labore cillum minim", "q": "consectetur elit consequat ea", "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": "64a6AA4a-9dDC-a1f0-BC6C-27f68DEDA581", "location": "Adapter", "view": "nostrud", "status": "canceled", "app": "eu in", "name": "sint labore ut adipisicing", "variables": { "decorators": [ { "type": "encryption", "pointer": "/~0/vx3g/y0v2V/~1" }, { "type": "encryption", "pointer": "/~0/~0/wyZ8QEP7mIC/~1/CLiw/4rSh/WdwV7/~1/CUK-hTG" } ] }, "last_updated": "1959-08-20T16:30:59.582Z", "encodingVersion": 1, "job": { "_id": "6e909c9f05206a74810eec95", "task": "e28f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": null }, "groups": [ { "_id": "b5152d75f418caaef108ab15", "provenance": "ullamco voluptate", "name": "sunt Duis incididunt", "description": "ut labore minim Lorem consectetur", "memberOf": [ { "groupId": "6a28c2206d22f70e3d0c9764", "aaaManaged": true }, { "groupId": "820bae7ade1cef3411a264d0", "aaaManaged": true }, { "groupId": "7eaba17804dcf067a546ea62", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "dolor" }, { "roleId": "nostrud amet sed laborum non" }, { "roleId": "magna incididunt reprehenderit in enim" } ], "inactive": true, "_meta": { "created": "1997-03-09T19:57:00.755Z", "updated": "2021-08-18T19:28:31.851Z", "migrationVersion": -54351201 } } ], "type": "manual", "metrics": { "start_time": "est culpa", "claim_time": "1988-08-02T18:34:41.964Z", "end_time": 23479044.745747536, "server_id": "consequat tempor labore nulla ut", "finish_state": "success", "run_time": -92523517.30101624, "user": "cfa8703c111ffc7c83251e2f", "owner": "Pronghorn" } }, { "_id": "ED28e4C1-2ba7-e844-a9b2-ca5b6Aea18Ba", "location": "Broker", "view": null, "status": "error", "app": "Ut tempor proident ut cupidatat", "name": "est deserunt aliquip", "variables": { "decorators": [ { "type": "encryption", "pointer": "/yvJb/f/~1/iYkgf0.QV5h/~1" }, { "type": "encryption", "pointer": "/~1/j/d592PH7/~0/~0/~0/vvhy/~1/GJmF-E" }, { "type": "encryption", "pointer": "/vf9+oiD4Zf/~1/~0/bpOLdJfZOHD/~0" }, { "type": "encryption", "pointer": "/~1/DClQ7/~0" } ] }, "last_updated": "2020-01-12T20:32:08.234Z", "encodingVersion": 1, "job": { "_id": "fae2cc8ad777cf8a2a1e0379", "task": "b4f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": [ "0806b379c0f80f64beb1bf41", "201dc37ec6fe7f6187cfeb31" ] }, "groups": [ "d142c599e04301ff502cc876", { "_id": "55f735df3b2f8699e9917457", "provenance": "in labore aliqua sint", "name": "anim", "description": "in id", "memberOf": [ { "groupId": "f3d19a21e71ef62e732fb14b", "aaaManaged": false }, { "groupId": "4a456272c04facd465b2efd3", "aaaManaged": false }, { "groupId": "fe4489f6126171302dda499a", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "mollit sint" }, { "roleId": "aliqua qui et" }, { "roleId": "pariatur aliqua ex" }, { "roleId": "exercitation" }, { "roleId": "reprehenderit velit ipsum ex sint" } ], "inactive": true, "_meta": { "created": "1998-05-24T00:04:55.287Z", "updated": "1968-06-17T05:56:02.066Z", "migrationVersion": 69090920 } }, "00722ea2ceba5290a2367202" ], "type": "manual", "metrics": { "start_time": "voluptate", "claim_time": "2010-01-29T01:53:53.523Z", "end_time": 2001309.5046615899, "server_id": "ea amet cupidatat officia sint", "finish_state": "running", "run_time": 28655787.067818657, "user": "95e86c8d111c57ee22f22ab6", "owner": "Pronghorn" } }, { "_id": "88eCa0FA-cdec-1aAD-eAf0-07E3eCfEd819", "location": "Broker", "view": null, "status": "error", "app": "minim ullamco cupidatat labore occaecat", "name": "in exercitation cupidatat", "variables": { "decorators": [ { "type": "encryption", "pointer": "/NFJH78sP0c/LM//~1" }, { "type": "encryption", "pointer": "/~1/~1/dopKv3,y2oW" }, { "type": "encryption", "pointer": "/CkRgm4Xop4c/~1/~0/~1/dY5r2Nw1lhz/rn1kB26YaWZ" }, { "type": "encryption", "pointer": "/~0/~1/bM9eCsqSXS/~0/~1/VZKJQHHicNl" }, { "type": "encryption", "pointer": "/~1/IT/~0/~1/~0/~1/RQpFaT" } ] }, "last_updated": "1958-06-30T17:24:30.892Z", "encodingVersion": 1, "job": { "_id": "a692a3fcec67aa93393859ef", "task": "b4f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": [ "950534dc1a069f9bbc180ca0", "590c9a5e9d711e0086644e74", "bfbf5f7e1ff3c0bd687e3fec", "27362e958bcf0fac07a3f69b" ] }, "groups": [ "e9a686b0531573c6e1b21f9d", { "_id": "f643438ff1ac6f00f6358cb7", "provenance": "dolor", "name": "ea nisi tempor nulla", "description": "elit velit tempor", "memberOf": [ { "groupId": "1da7cb05f8434fa623de3fc3", "aaaManaged": true }, { "groupId": "e5d410f15aea1065c10b3d0c", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "id minim laboris" }, { "roleId": "enim cillum Ut tempor in" }, { "roleId": "sed" }, { "roleId": "aliquip" } ], "inactive": true, "_meta": { "created": "1980-02-13T05:32:08.594Z", "updated": "1985-07-16T22:02:45.458Z", "migrationVersion": 47462170 } }, "42c0f226edd3c165bf9e7afb", { "_id": "9c866df140189fe9c5e799a4", "provenance": "nostrud nulla Lorem tempor qui", "name": "adipisicing deserunt labore", "description": "Lorem dolore eiusmod est dolor", "memberOf": [ { "groupId": "c0d53ee9d362e00cf1a89817", "aaaManaged": false }, { "groupId": "506ca755a2aafdc5f3dc114f", "aaaManaged": true }, { "groupId": "f0eb0a38d6e5cd6e7a60fee5", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "ex Lorem incididunt" }, { "roleId": "aute velit" }, { "roleId": "ut" }, { "roleId": "commodo mollit" }, { "roleId": "cillum pariatur quis labore enim" } ], "inactive": true, "_meta": { "created": "1963-09-19T07:01:37.003Z", "updated": "1976-06-04T09:09:04.983Z", "migrationVersion": -75306553 } }, "72ec22c8b377b3f8f6ee56aa" ], "type": "manual", "metrics": { "start_time": "ullamco exercitation eu laboris consectetur", "claim_time": "1986-03-09T01:35:29.315Z", "end_time": 16396376.579736501, "server_id": "elit consectetur", "finish_state": "success", "run_time": 47529.449484691024, "user": "Pronghorn", "owner": "5b0699ee0310120ebf94a75e" } } ], "metadata": { "skip": 15160480, "limit": 21549037, "total": 39177435, "nextPageSkip": null, "previousPageSkip": -79713280, "currentPageSize": 47865775 } }
{ "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" } } } ] }