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": "description", "exclude": "_id,description", "in": "in quis aliqua do ipsum", "not-in": "eu in ullamco voluptate", "equals": "reprehenderit", "contains": "cillum Lorem deserunt", "starts-with": "est ex", "ends-with": "cupidatat elit laborum", "dereference": "cillum mollit est pariatur dolore", "gt": "aliquip", "gte": "magna sit", "lt": "est laborum ut anim ullamco", "lte": "exercitation Lorem", "q": "laboris 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": "Def22D7c-eF8d-b7F5-8d06-5d3Ae4b19dDE", "location": "Broker", "view": "dolor eu", "status": "paused", "app": "ut", "name": "tempor eiusmod", "variables": { "decorators": [ { "type": "encryption", "pointer": "/~1/W80u.f/Alw/~1/r7,/~0/~0/dg/~1" }, { "type": "encryption", "pointer": "/FppCaDj1uh/x0AZ6w8TC6/~0" }, { "type": "encryption", "pointer": "/RYH" }, { "type": "encryption", "pointer": "/P/u5/~0/~1/~1/YfH" } ] }, "last_updated": "1966-06-22T04:26:06.066Z", "encodingVersion": 1, "job": { "_id": "0d1db6a4d9050f7d24b9290c", "task": "b4f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": null }, "groups": [ "1600f4e883f7cdbb984d1810", { "_id": "e727d06bf1a81deb9bcf6e97", "provenance": "est sit velit", "name": "tempor labore", "description": "velit qui Excepteur", "memberOf": [ { "groupId": "f9ef9ce190cd40d7062451ea", "aaaManaged": false }, { "groupId": "2430c5cc500aeb53ece3af3b", "aaaManaged": true }, { "groupId": "068b5ae7f548db358ec76af7", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "do quis ad nisi" }, { "roleId": "consequat qui labore voluptate" }, { "roleId": "enim Duis quis in esse" }, { "roleId": "esse enim" } ], "inactive": false, "_meta": { "created": "2000-05-30T03:36:24.765Z", "updated": "2002-11-04T04:42:49.215Z", "migrationVersion": 1149144 } }, "0b6d54c1efd6b973150826b0", "ade3fb301af8a8f32603e0e7", "1c185799c8d3289f0405838d" ], "type": "operation", "metrics": { "start_time": "ullamco", "end_time": -8001272.076244876, "server_id": "esse sint incididunt amet Excepteur", "finish_state": "success", "run_time": 42488656.3328549, "retrying": null, "user": "Pronghorn", "owner": "a2906df6cf7c87a9824c5c74" } }, { "_id": "4b810FdA-c8db-21Cb-EE5C-DFbE2bB2d1E0", "location": "Adapter", "view": "sunt esse magna anim", "status": "scheduled", "app": "non eu", "name": "aliqua qui reprehenderit dolor", "variables": { "decorators": [ { "type": "encryption", "pointer": "/~0/~0/mQ,ZG.Ej/A/r7/~1" } ] }, "last_updated": "1993-01-10T11:55:33.744Z", "encodingVersion": 1, "job": { "_id": "ca44b1e937f9c9d789ad765b", "task": "e28f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": null }, "groups": [ { "_id": "845416dd2c11f29f49fee8af", "provenance": "incididunt", "name": "culpa", "description": "dolore dolore dolor commodo", "memberOf": [ { "groupId": "d0be46ed17a6cc7776140b94", "aaaManaged": false }, { "groupId": "1c6ef8bd4e3b2a54b2d9178e", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "nulla reprehenderit Duis" }, { "roleId": "sunt" }, { "roleId": "et exercitation" } ], "inactive": true, "_meta": { "created": "2018-11-20T19:13:30.397Z", "updated": "2012-12-15T09:05:59.505Z", "migrationVersion": 75534842 } } ], "type": "operation", "metrics": { "start_time": "eiusmod id dolore", "end_time": 51289021.729243845, "server_id": "sint Excepteur", "finish_state": "complete", "run_time": 55000736.881776154, "retrying": false, "user": "700eba3f33ccff87599a8b90", "owner": "fea000b1be7b65216bb2447a" } } ], "metadata": { "skip": -26618380, "limit": -99499755, "total": 47687146, "nextPageSkip": null, "previousPageSkip": null, "currentPageSize": 3038128 } }
{ "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" } } } ] }