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": 1, "order": 1, "sort": "name", "include": "name,description", "exclude": "_id", "in": "fugiat enim eu", "not-in": "id sit voluptate", "equals": "sunt fugiat incididunt", "contains": "non fugiat do quis eiusmod", "starts-with": "minim", "ends-with": "tempor quis exercitation non nisi", "dereference": "id officia nisi qui", "gt": "dolore", "gte": "laborum cupidatat incididunt commodo laboris", "lt": "et minim", "lte": "dolore Lorem", "q": "sit enim irure", "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": "a8F1079b-fEbf-E0df-6FD7-D4d4f5A1D4b9", "location": "Adapter", "view": "nulla amet elit commodo", "status": "running", "app": "sint labore dolore velit", "name": "adipisicing", "variables": { "decorators": [ { "type": "encryption", "pointer": "/~1" }, { "type": "encryption", "pointer": "/~1/ny-xaO-r/~0/OlllQnevwT/nxxeD/qzyUKwIq" }, { "type": "encryption", "pointer": "/DHofRcsSHv6/ez+x8w/~1/~0/~1" }, { "type": "encryption", "pointer": "/AiV+oA42H/wBiP/EUP" } ] }, "last_updated": "1954-05-08T05:36:47.486Z", "encodingVersion": 1, "job": { "_id": "ece4c9519df844f4e679b588", "task": "e28f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": null }, "groups": [ { "_id": "ddfa499a0c2e4bc6a5a50b2b", "provenance": "exercitation ipsum ullamco", "name": "voluptate irure nisi elit tempor", "description": "sint consectetur", "memberOf": [ { "groupId": "4e1d9b4e9dc17c2f1776168a", "aaaManaged": false }, { "groupId": "ad3cda88a5eee43266bffd7c", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "dolor aliquip" }, { "roleId": "tempor pariatur" }, { "roleId": "qui occaecat" } ], "inactive": true, "_meta": { "created": "2023-11-25T19:50:08.495Z", "updated": "1974-01-17T14:19:24.284Z", "migrationVersion": -56803404 } }, "4e2672d806002683d89e5ec1", { "_id": "f95caf738670ad7fc24f074c", "provenance": "Ut ut consectetur anim culpa", "name": "laborum adipisicing nulla velit dolor", "description": "qui cupidatat", "memberOf": [ { "groupId": "6bf43a4ada24c804a53cd54d", "aaaManaged": false }, { "groupId": "cc4c89100f327fdda8eda154", "aaaManaged": false }, { "groupId": "8dd87b0f3bf1174576eccd81", "aaaManaged": false }, { "groupId": "54848172e5bea94e429c0a78", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "mollit consequat ullamco" }, { "roleId": "eiusmod Excepteur" }, { "roleId": "pariatur consectetur labore" }, { "roleId": "officia laborum consectetur aliquip reprehenderit" }, { "roleId": "cupidatat et occaecat" } ], "inactive": false, "_meta": { "created": "2024-10-19T01:43:41.89Z", "updated": "1993-11-16T12:43:08.72Z", "migrationVersion": -87898507 } }, { "_id": "204ea8a24d906500c9f2a634", "provenance": "sint Duis", "name": "ad", "description": "aute fugiat aliquip", "memberOf": [ { "groupId": "87e20d44b79f639aaab026bb", "aaaManaged": false }, { "groupId": "eb56baf441d94818887cf309", "aaaManaged": true }, { "groupId": "39b506e59676dac615d93eac", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "adipisicing minim laboris elit" }, { "roleId": "sit irure proident" } ], "inactive": false, "_meta": { "created": "1987-04-22T05:48:18.318Z", "updated": "1984-01-14T19:16:57.476Z", "migrationVersion": 77197006 } }, { "_id": "9e26a6e66e68e60d3dfd75d3", "provenance": "in commodo sunt", "name": "aliquip", "description": "proident eiusmod dolore sit", "memberOf": [ { "groupId": "2e48948dd49b10abe5383871", "aaaManaged": true }, { "groupId": "0a04321b1033a18ac95b2a09", "aaaManaged": true }, { "groupId": "c8dd50f0cc8ee1dc6d42d196", "aaaManaged": false }, { "groupId": "e2401a89220fa6c0614dc663", "aaaManaged": false }, { "groupId": "156d3645708f14958a8aada2", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "labore" }, { "roleId": "dolore" }, { "roleId": "dolor Lorem deserunt fugiat ea" }, { "roleId": "in Duis id commodo" } ], "inactive": true, "_meta": { "created": "1950-04-25T16:38:55.843Z", "updated": "1955-12-15T06:45:35.562Z", "migrationVersion": -62925983 } } ], "type": "manual", "metrics": { "start_time": "in ullamco", "claim_time": "1965-09-13T01:19:17.846Z", "end_time": 1968573.8857413381, "server_id": "dolor", "finish_state": "canceled", "run_time": 95619237.99876237, "user": "1714d4f3535d763398e90cec", "owner": "019812902a1d455fc08927fd" } } ], "metadata": { "skip": -33266323, "limit": 11912469, "total": 65030977, "nextPageSkip": null, "previousPageSkip": null, "currentPageSize": -41461584 } }
{ "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" } } } ] }