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": "description", "in": "Ut ex Duis consequat", "not-in": "in ullamco eiusmod occaecat minim", "equals": "ea", "contains": "commodo minim", "starts-with": "ut", "ends-with": "in aliqua aute proident", "dereference": "anim", "gt": "sint anim nostrud qui ut", "gte": "cillum in", "lt": "adipisicing nostrud", "lte": "sed consequat enim nisi aliquip", "q": "in", "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 created the requested item", "data": [ { "_id": "c1cD8FDa-51fa-9AF1-Fff3-67a652eaD390", "location": "Adapter", "view": null, "status": "failure", "app": "dolor non voluptate dolor laborum", "name": "dolor do exercitation adipisicing Ut", "variables": { "decorators": [ { "type": "encryption", "pointer": "/~1/~0/~1/~1" }, { "type": "encryption", "pointer": "/kWWEc/~0/CtImR4/~0/~1/rSdY/~0" } ] }, "last_updated": "2016-10-06T14:44:14.712Z", "encodingVersion": 1, "job": { "_id": "98068f1b0e1b36c55c1bbd45", "task": "b4f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": [ "7bd24b345556969b76121f79", "bfb2dd0c36a4106a310eb0c1", "60df956dd3602e5a55362728", "c09207d0c289c97cc642d1c5", "61b013ebe695de6237fbf23b" ] }, "groups": [ { "_id": "2b6ac9d8e3d1f43c79a3d20a", "provenance": "et Lorem nisi occaecat", "name": "do incididunt consectetur fugiat", "description": "qui deserunt", "memberOf": [ { "groupId": "3e38332294e5b9839693812a", "aaaManaged": true }, { "groupId": "ab834e03fea95060200d5907", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "veniam deserunt esse velit" } ], "inactive": true, "_meta": { "created": "1954-01-14T22:09:00.992Z", "updated": "1976-11-26T18:33:32.553Z", "migrationVersion": -78841165 } }, { "_id": "07d1b461f2ada3d79282f483", "provenance": "cupidatat consectetur ullamco", "name": "voluptate sint", "description": "nostrud dolore proident", "memberOf": [ { "groupId": "7f925f3f156e3c54465207b2", "aaaManaged": true }, { "groupId": "97f9cfb8837b9fc4c1f91396", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "cupidatat in" }, { "roleId": "in veniam dolore incididunt adipisicing" }, { "roleId": "consequat" }, { "roleId": "sed incididunt quis" }, { "roleId": "enim" } ], "inactive": false, "_meta": { "created": "1990-05-08T23:30:10.299Z", "updated": "1948-08-08T21:58:12.378Z", "migrationVersion": -49592036 } } ], "type": "operation", "metrics": { "start_time": "in aute reprehenderit et", "end_time": -86750668.0474921, "server_id": "pariatur non commodo", "finish_state": "success", "run_time": 16728609.436414838, "retrying": true, "user": "", "owner": "Pronghorn" } }, { "_id": "9FbE2ef0-c84c-4Af7-0E61-bF6DB5Cfbd0c", "location": "Application", "view": "ea ut aliqua eiusmod ad", "status": "scheduled", "app": "ut sed nostrud labore", "name": "anim nostrud", "variables": { "decorators": [ { "type": "encryption", "pointer": "/T/~0/xTJ2imxu+/Xl0" } ] }, "last_updated": "1979-10-12T00:38:08.138Z", "encodingVersion": 1, "job": { "_id": "a83b56c1816b271c28be477a", "task": "3a1f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": [ "df349a29957b148a8a04e615", "ac3332090e542a67e556a579", "01455defb892f3f696dff1df", "5a5bd87c1919014d80d01a39" ] }, "groups": [ { "_id": "bfc758e2cfa95a59ec1ea255", "provenance": "et aute id", "name": "non nulla Lorem minim aliqua", "description": "eiusmod", "memberOf": [ { "groupId": "5a8ffbac0a2cd0dc5b4fdc49", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "tempor dolor" }, { "roleId": "reprehenderit culpa" }, { "roleId": "Excepteur nostrud" }, { "roleId": "proident id nostrud deserunt Duis" }, { "roleId": "aliquip laborum nostrud eu" } ], "inactive": true, "_meta": { "created": "2007-12-05T04:22:17.662Z", "updated": "1996-07-25T09:39:56.816Z", "migrationVersion": -21043986 } }, { "_id": "5ca504f3faf87945f574ea63", "provenance": "Duis magna mollit elit", "name": "ipsum", "description": "incididunt ut", "memberOf": [ { "groupId": "5a79c6ac76167a007675046b", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "consectetur Ut veniam aute sint" } ], "inactive": false, "_meta": { "created": "1990-12-29T02:12:56.685Z", "updated": "1970-07-11T02:30:40.649Z", "migrationVersion": -73883179 } }, { "_id": "8e0683da874e7d7d7b617a41", "provenance": "id Duis proident", "name": "nostrud fugiat ad sint", "description": "dolore adipisicing", "memberOf": [ { "groupId": "b0a60588834017d884a89310", "aaaManaged": true }, { "groupId": "6a8c124e628163affc8b234c", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "qui dolor occaecat pariatur" }, { "roleId": "sint" }, { "roleId": "veniam non laborum" }, { "roleId": "et" } ], "inactive": false, "_meta": { "created": "2012-05-22T00:36:17.095Z", "updated": "1979-08-24T06:00:24.461Z", "migrationVersion": 53969375 } } ], "type": "operation", "metrics": { "start_time": "in adipisicing officia ea elit", "end_time": 70806806.45661816, "server_id": "proident commodo Duis", "finish_state": "incomplete", "run_time": 42865484.91131428, "retrying": true, "user": "", "owner": "e284c4927f0fa3113c8c72f3" } } ], "metadata": { "skip": -70001539, "limit": -34605942, "total": 46279751, "nextPageSkip": 75723095, "previousPageSkip": null, "currentPageSize": 6296664 } }
{ "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" } } } ] }