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": 1, "skip": 0, "order": 1, "sort": "name", "include": "description", "exclude": "description", "in": "elit veniam", "not-in": "qui", "equals": "Lorem Ut reprehenderit", "contains": "commodo ullamco", "starts-with": "enim", "ends-with": "eu occaecat labore", "dereference": "velit incididunt cillum mollit anim", "gt": "veniam id nisi", "gte": "et in", "lt": "in nostrud incididunt", "lte": "pariatur Duis Ut voluptate", "q": "non eu Excepteur", "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": "CdC3800b-05E8-4FAB-43fE-e3fEd473Ead9", "location": "Broker", "view": null, "status": "incomplete", "app": "in", "name": "cillum labore nisi", "variables": { "decorators": [ { "type": "encryption", "pointer": "/T/~1/D6Grv4H/pb/~1/m/~1" }, { "type": "encryption", "pointer": "/~0/~0/dt..CW/Bp+,hKI+RoV/cawED1Ab3x/~0/iCJ-4mj2kQ/I0lr8Exjv/fxTt-/aRy/~0" }, { "type": "encryption", "pointer": "/~0/~1/~1/~0/~1/~1/~0" }, { "type": "encryption", "pointer": "/RcxY/~1/H,6mn/~1/g9AVxFy" } ] }, "last_updated": "1995-06-13T17:29:19.33Z", "encodingVersion": 1, "job": { "_id": "7e9695ce33b5161954cf42cf", "task": "3a1f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": [ "9c346b5b400ca53318f027bb", "a59e3b2b60359deb6092e47a", "0a52d9a664df9516a1cd1ea7", "6e019d1d30239c7009f6e90c" ] }, "groups": [ "05635987002e21c07678773c", "9cb8877adb2c96539be2b53c" ], "type": "manual", "metrics": { "start_time": "ut id", "claim_time": "1970-09-18T09:02:56.423Z", "end_time": 26358498.66736777, "server_id": "fugiat", "finish_state": "success", "run_time": -42163061.86893956, "user": { "_id": "a85d0bd2508adfab519f4edc", "provenance": "amet nostrud velit minim", "username": "sed elit", "firstname": "laborum", "memberOf": [ { "groupId": "cd41336467ee8c2050425911", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "minim" }, { "roleId": "sit" }, { "roleId": "mollit esse consectetur nisi Duis" }, { "roleId": "mollit Duis laborum sunt nostrud" }, { "roleId": "in id ad" } ], "inactive": false, "lastLogin": "1993-09-30T20:49:50.503Z", "_meta": { "created": "1964-06-12T10:59:32.097Z", "updated": "1974-01-12T08:23:32.089Z", "migrationVersion": 9941961 }, "email": "ullamco tempor dolor Ut id" }, "owner": { "_id": "5c434485e4f2806bfe2265d3", "provenance": "cupidatat qui occaecat id nulla", "username": "adipisicing mollit commodo proident fugiat", "firstname": "incididunt dolore adipisicing commodo velit", "memberOf": [ { "groupId": "bfbb917c14fe3455aa8e06b5", "aaaManaged": true }, { "groupId": "8b6a31cb1b3491c817635531", "aaaManaged": false }, { "groupId": "12953add03bdc84be2bf7d41", "aaaManaged": true }, { "groupId": "07a2e1bee08581b302b730a5", "aaaManaged": false }, { "groupId": "15edd6abc424018943f7c78e", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "pariatur adipisicing eu" }, { "roleId": "ad dolor consectetur esse ex" }, { "roleId": "Excepteur est elit id" }, { "roleId": "ipsum Lorem" } ], "inactive": true, "lastLogin": "1991-06-05T06:34:04.584Z", "_meta": { "created": "1961-02-15T07:37:26.136Z", "updated": "2006-06-16T10:18:38.954Z", "migrationVersion": 83902395 }, "email": "dolore quis esse culpa" } } }, { "_id": "35F4AECd-ACb2-601B-BaCD-c457Cd3fde53", "location": "Application", "view": "ut nulla fugiat ea in", "status": "scheduled", "app": "amet tempor", "name": "exercitation voluptate", "variables": { "decorators": [ { "type": "encryption", "pointer": "/kSeZ/aYNRR/G-xQj/C,N/eEWI8FaA/~1/aRj/S.RMA//Xspj/IXHHDU1" }, { "type": "encryption", "pointer": "/svh" } ] }, "last_updated": "2004-06-08T11:46:41.859Z", "encodingVersion": 1, "job": { "_id": "88e71bc7d6b6591fb1a1783e", "task": "3a1f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": null }, "groups": [ { "_id": "63a1b6fa161b0b300ab92529", "provenance": "amet officia magna est sint", "name": "tempor fugiat", "description": "cillum Duis laboris veniam", "memberOf": [ { "groupId": "fc6e867c4dd6fb397abc26ee", "aaaManaged": true }, { "groupId": "b0daffc776148b87331ead8b", "aaaManaged": true }, { "groupId": "27b9b1dc5ee38e6c1921180c", "aaaManaged": false }, { "groupId": "a7608b895f35a0d4c3fd42dd", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "cupidatat deserunt Duis ut" }, { "roleId": "magna nisi irure commodo mollit" } ], "inactive": false, "_meta": { "created": "2001-02-27T14:50:39.285Z", "updated": "1972-07-16T14:50:45.766Z", "migrationVersion": -24587603 } }, "695cfa0a03b42d3b106c6a84", { "_id": "9bd70056e1f93286b427e8a0", "provenance": "dolor in", "name": "mollit minim in dolor", "description": "in id sit sed eu", "memberOf": [ { "groupId": "584e9decaf2b5afe358b7b45", "aaaManaged": false }, { "groupId": "b152fcf2cc639e9d91cd5277", "aaaManaged": true }, { "groupId": "43ccc381c7634bfa7a096d90", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "nostrud occaecat" }, { "roleId": "cillum tempor irure fugiat" } ], "inactive": true, "_meta": { "created": "2017-10-12T20:23:57.994Z", "updated": "1964-03-05T16:40:41.294Z", "migrationVersion": -76915931 } }, "531e84699c794350b36ae3a1", { "_id": "3398890ad435d92930408ae9", "provenance": "reprehenderit", "name": "nostrud Duis", "description": "deserunt in proident elit", "memberOf": [ { "groupId": "5097c03ac3fb7faa3ae80f04", "aaaManaged": false }, { "groupId": "1244c9246ccc04f5b088fc62", "aaaManaged": false }, { "groupId": "c34fa8ce0c3b62f2dca9d58a", "aaaManaged": false }, { "groupId": "c703d4c1abe4b51ec8387ced", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "quis in" }, { "roleId": "anim et" } ], "inactive": false, "_meta": { "created": "1985-11-27T16:52:43.043Z", "updated": "2022-02-13T22:53:44.078Z", "migrationVersion": 18834829 } } ], "type": "manual", "metrics": { "start_time": "occaecat cupidatat sint dolor incididunt", "claim_time": "1969-03-20T20:11:34.755Z", "end_time": -78447364.21620646, "server_id": "officia ut amet ipsum aliquip", "finish_state": "incomplete", "run_time": 32459485.45679958, "user": "", "owner": "Pronghorn" } }, { "_id": "afb6ba23-52E5-0DcA-4D39-ab3ccCdA2A1F", "location": "Broker", "view": null, "status": "running", "app": "mollit et Excepteur", "name": "dolor consectetur quis commodo", "variables": { "decorators": [ { "type": "encryption", "pointer": "/vk4LAGjGc/~1" }, { "type": "encryption", "pointer": "/AO-7xauyN/VCeHi/~1/t9s1+zUGWtz/qZQYtCQGx" }, { "type": "encryption", "pointer": "/hxm4pRt/~0/~1/~1/~0/oSgYmA5/~1/A/JnzyVAE9/GUkr+7S" }, { "type": "encryption", "pointer": "/Ks/AI+ewL/~1/~0/SOIhbZgbNTj/~1/~1/~0/~0/VKCL" }, { "type": "encryption", "pointer": "/~1/~0/Bc,FsLxZ8/EKc+c8V/qqcw6Iy0M/SK/kF8aQbsmva/AqfKuBvGG" } ] }, "last_updated": "1946-07-10T21:49:04.899Z", "encodingVersion": 1, "job": { "_id": "d4692c6f8b527fbc6f1dd55a", "task": "3a1f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": null }, "groups": [ { "_id": "a3b40d7fe0ec9ad8b7597f5b", "provenance": "officia nisi adipisicing", "name": "Excepteur sed", "description": "adipisicing deserunt irure", "memberOf": [ { "groupId": "8aef56cb2696fea2cd283228", "aaaManaged": true }, { "groupId": "517cb00c9e837c3c9a5a41e7", "aaaManaged": true }, { "groupId": "4d1429efda65e098b979a928", "aaaManaged": false }, { "groupId": "dce3d66e16539b7cedbb45f9", "aaaManaged": false }, { "groupId": "2ebf2e14420dbe7dd226a4ee", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "do" }, { "roleId": "laborum anim consectetur" }, { "roleId": "mollit et consequat sint nulla" } ], "inactive": true, "_meta": { "created": "1964-08-04T09:57:20.023Z", "updated": "1976-09-29T13:06:40.249Z", "migrationVersion": -3861842 } }, "9175309b7347aaf213cb138b", { "_id": "46b0a98212c916e4f4e2e76d", "provenance": "aliquip aute", "name": "sed quis deserunt incididunt Excepteur", "description": "magna ut", "memberOf": [ { "groupId": "d6a1cc352e1f21dc93f5e41c", "aaaManaged": true }, { "groupId": "52f8e3333e444e8aaac64954", "aaaManaged": false }, { "groupId": "3d1d96be9d5385e3951e3b23", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "id" }, { "roleId": "et fugiat Duis" }, { "roleId": "id" } ], "inactive": true, "_meta": { "created": "2012-10-04T16:03:53.163Z", "updated": "1967-06-25T04:04:23.186Z", "migrationVersion": 65235621 } }, "ee0deb9dd5d9695951ee41c8" ], "type": "manual", "metrics": { "start_time": "aliquip magna reprehenderit", "claim_time": "2002-01-05T14:03:35.457Z", "end_time": -71383351.11603577, "server_id": "id sit in aliqua", "finish_state": "error", "run_time": 47751498.32427031, "user": { "_id": "decce4773af409950929fba4", "provenance": "ut enim reprehenderit laborum aliquip", "username": "Ut do esse id", "firstname": "fugiat Lorem laborum sunt in", "memberOf": [ { "groupId": "5d73ff16e13552735465983d", "aaaManaged": false }, { "groupId": "8b99f8fdf4092e618e09dd48", "aaaManaged": true }, { "groupId": "f39050e94b0185c8d8f5d956", "aaaManaged": false }, { "groupId": "c49108188187f3f1579b5c2b", "aaaManaged": true }, { "groupId": "25a846b502fc538111116d06", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "in" } ], "inactive": false, "lastLogin": "1983-10-21T10:10:53.046Z", "_meta": { "created": "2016-12-30T04:00:14.824Z", "updated": "2008-02-28T17:20:26.4Z", "migrationVersion": -30214614 }, "email": "do tempor sed Ut dolor" }, "owner": { "_id": "36f8937fb72a0a40826f771a", "provenance": "ex", "username": "dolor cillum in veniam", "firstname": "ullamco ex velit id culpa", "memberOf": [ { "groupId": "229bbe6563012d9c5b018368", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "id quis magna" }, { "roleId": "consectetur in Duis velit sunt" }, { "roleId": "esse et" }, { "roleId": "in officia ad consequat Duis" } ], "inactive": true, "lastLogin": "1958-01-22T03:07:56.496Z", "_meta": { "created": "2003-07-30T00:33:48.372Z", "updated": "2013-04-18T19:27:20.918Z", "migrationVersion": -69932025 }, "email": "do consequat cupidatat Excepteur" } } } ], "metadata": { "skip": -57198929, "limit": 32745695, "total": 83630241, "nextPageSkip": 1829009, "previousPageSkip": null, "currentPageSize": -67846997 } }
{ "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" } } } ] }