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": 10, "order": 1, "sort": "name", "include": "description", "exclude": "description", "in": "in cillum tempor ad est", "not-in": "ad in amet ullamco dolor", "equals": "aute ad voluptate Duis mollit", "contains": "quis occaecat pariatur mollit eu", "starts-with": "Lorem irure commodo minim", "ends-with": "dolore", "dereference": "veniam est in ut", "gt": "enim dolore", "gte": "eiusmod nostrud Excepteur voluptate qui", "lt": "aute elit", "lte": "irure exercitation eu reprehenderit", "q": "ex", "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": "C1686eb4-1BDc-0ADd-e4Ce-8d9c98275FeD", "location": "Adapter", "view": null, "status": "error", "app": "eu proident ea commodo", "name": "laboris ea", "variables": { "decorators": [ { "type": "encryption", "pointer": "/VH3Prbkm5m4/~0/~0/S" } ] }, "last_updated": "1961-03-09T15:35:35.61Z", "encodingVersion": 1, "job": { "_id": "15c5c0e4b130f8debaca21cb", "task": "e28f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": [ "a0cd72a6cdbad484fa9508d4", "38ec72532c7273f637f21767", "b227c7011be0f8b2c268d9b0" ] }, "groups": [ { "_id": "69cd822354dbeeecbee44d2f", "provenance": "consectetur esse enim eu adipisicing", "name": "Duis", "description": "ad nostrud sint non", "memberOf": [ { "groupId": "f379a6fc001d3f7c23c369d9", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "incididunt cupidatat ullamco" }, { "roleId": "ut elit" }, { "roleId": "pariatur nisi" } ], "inactive": true, "_meta": { "created": "1957-04-05T06:26:24.302Z", "updated": "1960-07-13T22:40:14.623Z", "migrationVersion": -12491954 } }, { "_id": "fced77e02feb0e38ebf89e37", "provenance": "aliqua", "name": "et aliquip magna", "description": "exercitation et nisi ullamco", "memberOf": [ { "groupId": "71bc873425503d222e00ad38", "aaaManaged": false }, { "groupId": "ce14ad5845fc5da951493113", "aaaManaged": false }, { "groupId": "dddb9958a3c877c0ec427843", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "reprehenderit consectetur" }, { "roleId": "ea adipisicing" }, { "roleId": "nisi officia aliqua" }, { "roleId": "do in" }, { "roleId": "pariatur aliqua labore ex in" } ], "inactive": false, "_meta": { "created": "1958-09-08T01:45:35.236Z", "updated": "1953-08-06T01:21:26.038Z", "migrationVersion": -63665244 } }, "1aea3dfd0a67d7246e1ce8ac", { "_id": "bb53f24ab5c78d35c88e50bb", "provenance": "reprehenderit enim", "name": "Excepteur", "description": "in consequat ut", "memberOf": [ { "groupId": "bdb572d08bfc845bff016dca", "aaaManaged": true }, { "groupId": "b70f43b3169a9699576eb9d4", "aaaManaged": true }, { "groupId": "105e4ffab092892558cf8dc1", "aaaManaged": true }, { "groupId": "ebf08dda4c2577ce85a21bef", "aaaManaged": false }, { "groupId": "7c0fc08ae3cd22832777e7b5", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "sed" }, { "roleId": "nostrud consectetur consequat laboris" } ], "inactive": true, "_meta": { "created": "1962-07-25T22:48:40.409Z", "updated": "1959-02-02T15:12:56.552Z", "migrationVersion": -62907763 } }, { "_id": "8235c44f5a2d6cb39dc202a2", "provenance": "fugiat sit ut", "name": "enim Duis", "description": "non nostrud", "memberOf": [ { "groupId": "994914edffe0665b130d9e6e", "aaaManaged": false }, { "groupId": "1645c6565ab2ed253c3ab4e1", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "commodo ullamco deserunt" }, { "roleId": "in" }, { "roleId": "eiusmod" }, { "roleId": "irure" } ], "inactive": false, "_meta": { "created": "2000-06-12T17:50:45.765Z", "updated": "1984-11-18T01:49:54.7Z", "migrationVersion": -42793570 } } ], "type": "automatic", "metrics": { "start_time": "ex quis laborum pariatur", "end_time": -87474267.88007608, "server_id": "Excepteur Lorem ea et aute", "finish_state": "success", "run_time": 16496087.613819063, "retrying": false, "user": { "_id": "ddd5468ad0252167304de728", "provenance": "aliqua consequat sint Lorem occaecat", "username": "est exercitation Ut", "firstname": "dolore dolor est elit sit", "memberOf": [ { "groupId": "ca59826671ed96f61d181ad0", "aaaManaged": true }, { "groupId": "615883a53b4456e04d42e965", "aaaManaged": true }, { "groupId": "71344c08bf5f6568f98a2371", "aaaManaged": true }, { "groupId": "3b1a666bfb20ca8407adccc2", "aaaManaged": false }, { "groupId": "3a02fed19e8dbec0dcd15622", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "fugiat ipsum deserunt" } ], "inactive": true, "lastLogin": "1949-07-29T08:48:09.184Z", "_meta": { "created": "2005-11-26T02:17:35.084Z", "updated": "1994-12-25T12:16:13.13Z", "migrationVersion": -68697800 }, "email": "tempor" }, "owner": { "_id": "3dee0d2d135851a506b847aa", "provenance": "pariatur", "username": "irure cillum id culpa aute", "firstname": "velit dolore dolor laboris officia", "memberOf": [ { "groupId": "ab5ac6104e5a04be07957164", "aaaManaged": true }, { "groupId": "2052b456c84b234f4bd899ac", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "qui enim" } ], "inactive": false, "lastLogin": "2011-09-23T11:59:27.393Z", "_meta": { "created": "2002-11-26T04:43:56.422Z", "updated": "1997-09-11T09:24:50.719Z", "migrationVersion": 3127708 }, "email": "culpa in commodo non aute" } } }, { "_id": "7c8F9eEe-6c14-f6cD-aCb2-81666F183706", "location": "Application", "view": null, "status": "incomplete", "app": "nostrud Duis amet dolor labore", "name": "reprehenderit dolor", "variables": { "decorators": [ { "type": "encryption", "pointer": "/~1/NC/~0/m7PzBBLNR,/Ll4+T6j" }, { "type": "encryption", "pointer": "/~1" }, { "type": "encryption", "pointer": "/OO/~1/~0/HyITR/~1" } ] }, "last_updated": "1954-03-19T06:27:11.602Z", "encodingVersion": 1, "job": { "_id": "9be34f5af391e72164a044e6", "task": "3a1f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": [ "83af0e4ce54e1bc56d03a4e4", "9f9b100686b278d9e19578a1", "f5b6287c7ad4ed0a43363f6d", "c96c15e00314fd682c709699", "acf5ef46f99aa2c2df9a1002" ] }, "groups": [ "44ff1fd318a96b2622162959", { "_id": "a10d0cee585c905aff0ec82e", "provenance": "irure nostrud dolor sed", "name": "ut sunt est", "description": "exercitation esse qui eu sint", "memberOf": [ { "groupId": "cf94aa38d4160c3e76284cf6", "aaaManaged": false }, { "groupId": "386179fbc1ecf2dea81ac288", "aaaManaged": true }, { "groupId": "01ffea2430b869e1ad0c4ba0", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "in" }, { "roleId": "fugiat consectetur" }, { "roleId": "sed mollit Ut nostrud qui" } ], "inactive": false, "_meta": { "created": "2013-03-07T22:59:22.67Z", "updated": "2000-01-14T13:34:16.816Z", "migrationVersion": -96354640 } }, { "_id": "c3bf54b8abc58f8e2afdd32b", "provenance": "cillum consectetur in", "name": "pariatur id", "description": "culpa laborum aliquip dolor consequat", "memberOf": [ { "groupId": "a6126975ed9335162def8972", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "elit" } ], "inactive": false, "_meta": { "created": "1968-02-12T01:49:19.73Z", "updated": "2007-07-13T20:43:52.908Z", "migrationVersion": -26301793 } }, { "_id": "03aa0b468e0b042ff89a8297", "provenance": "in magna", "name": "sed cupidatat", "description": "Duis incididunt occaecat", "memberOf": [ { "groupId": "4be4279469b8fecccfcce857", "aaaManaged": true }, { "groupId": "a728ead71599c00bca6ef3de", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "tempor" }, { "roleId": "mollit et magna irure cillum" }, { "roleId": "Ut sunt in pariatur" }, { "roleId": "id in" } ], "inactive": false, "_meta": { "created": "2021-01-09T09:59:20.635Z", "updated": "1985-12-17T16:00:04.458Z", "migrationVersion": 83529845 } }, { "_id": "e8505744ee562e027150804b", "provenance": "aute", "name": "aliquip ipsum nostrud sunt", "description": "elit", "memberOf": [ { "groupId": "5dcfda9fa7c66731060a34be", "aaaManaged": true }, { "groupId": "d770f3df0e040540e858f9bb", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "qui occaecat Lorem aliqua" }, { "roleId": "exercitation" } ], "inactive": true, "_meta": { "created": "1983-08-26T09:28:59.396Z", "updated": "1986-07-28T13:24:36.731Z", "migrationVersion": -57021694 } } ], "type": "automatic", "metrics": { "start_time": "cupidatat labore", "end_time": 7512028.240055993, "server_id": "proident ex Lorem non dolor", "finish_state": "success", "run_time": 54620748.72802386, "retrying": false, "user": "c590d5a29e8570b162ee60a5", "owner": { "_id": "7c7b8093fd6f0fae5060bb84", "provenance": "eu veniam", "username": "pariatur in exercitation", "firstname": "dolore eu irure laborum", "memberOf": [ { "groupId": "a8437c13e9a35d43f75a75e8", "aaaManaged": true }, { "groupId": "5734b3f2f1cdfbddd96ea1e4", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "fugiat" }, { "roleId": "in deserunt" }, { "roleId": "Duis adipisicing deserunt fugiat" }, { "roleId": "sunt" }, { "roleId": "ad quis minim" } ], "inactive": false, "lastLogin": "1987-12-06T19:06:30.011Z", "_meta": { "created": "1962-12-01T00:26:24.132Z", "updated": "1964-11-15T14:24:07.634Z", "migrationVersion": -50618429 }, "email": "consectetur" } } }, { "_id": "b3172Ba5-a10b-5eeB-2fB4-3C9cF3c2A6a3", "location": "Broker", "view": "consequat minim exercitation", "status": "scheduled", "app": "ipsum sit in magna", "name": "culpa aute", "variables": { "decorators": [ { "type": "encryption", "pointer": "/u/ZR/R8yt6fT1/Hv8rJBOVy." }, { "type": "encryption", "pointer": "/~0/~0/TEDw,2YiWs/~0/v4z/mSdJ5SJ/~1" }, { "type": "encryption", "pointer": "/~1/ZeM" }, { "type": "encryption", "pointer": "/dy/Ssei/~0/G/1/~1/~0/~1/vT9Pk/moON,0k" }, { "type": "encryption", "pointer": "/~1/~0/F/W1m33ai8PWy/sH./S5MG/zAkECOWHAb" } ] }, "last_updated": "1957-10-16T06:44:19.373Z", "encodingVersion": 1, "job": { "_id": "28d96be978e52aaefaf05d56", "task": "e28f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": [ "330f9c448a9edf6e42d02bc9" ] }, "groups": [ "7965b13185df5d5049e64c9e", { "_id": "82d81e3703bd4ce28cce1f5f", "provenance": "do officia qui Lorem", "name": "mollit exercitation", "description": "aliqua consectetur ullamco qui", "memberOf": [ { "groupId": "7f605c3ce7d99399b6571136", "aaaManaged": false }, { "groupId": "c4438d08f6517a45759c86d2", "aaaManaged": true }, { "groupId": "b1a061ce41acff1aa3a2888a", "aaaManaged": true }, { "groupId": "51a9e822dee2de98163e8985", "aaaManaged": false }, { "groupId": "912ed6fe8333c347d5510c9a", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "exercitation qui incididunt ipsum id" }, { "roleId": "fugiat" }, { "roleId": "non laborum voluptate" }, { "roleId": "nostrud dolore in" }, { "roleId": "consectetur Duis fugiat" } ], "inactive": false, "_meta": { "created": "1975-05-02T17:58:45.49Z", "updated": "1984-02-11T16:45:44.442Z", "migrationVersion": -87168570 } }, "b88f10a110c357ca9085f6b6", { "_id": "58233cd094e5c5f2069dadd2", "provenance": "do culpa nulla", "name": "tempor", "description": "cupidatat aute", "memberOf": [ { "groupId": "3def169af37b913039c2c6aa", "aaaManaged": true }, { "groupId": "185b42ce720edbc6cbeb20f8", "aaaManaged": true }, { "groupId": "d1f813f12e581c0e3818acbc", "aaaManaged": false }, { "groupId": "4c93c3215be08160606770f9", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "aute Ut proident ex ad" } ], "inactive": true, "_meta": { "created": "1969-03-11T16:07:26.173Z", "updated": "2009-05-22T02:08:12.546Z", "migrationVersion": 59350140 } } ], "type": "automatic", "metrics": { "start_time": "enim officia", "end_time": -41879430.925925784, "server_id": "consequat velit", "finish_state": "success", "run_time": -34453886.4181374, "retrying": null, "user": "Pronghorn", "owner": { "_id": "212dc1543d9604178d2f9704", "provenance": "qui consectetur Excepteur", "username": "aute", "firstname": "irure veniam nostrud Ut", "memberOf": [ { "groupId": "3551ef2e51770285c50125b9", "aaaManaged": false }, { "groupId": "239687f7bb41d062f0cbf66c", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "Lorem mollit veniam dolor" }, { "roleId": "fugiat ipsum" } ], "inactive": true, "lastLogin": "1976-08-05T02:18:43.284Z", "_meta": { "created": "1963-06-20T12:30:19.791Z", "updated": "1950-08-23T15:40:56.95Z", "migrationVersion": 20600335 }, "email": "adipisicing sint mollit" } } }, { "_id": "f0fe691F-1bad-AEcB-acEE-b8d43f2F07F1", "location": "Broker", "view": null, "status": "incomplete", "app": "proident labore magna", "name": "ex", "variables": { "decorators": [ { "type": "encryption", "pointer": "/MdxG/gFD/~1/~1" }, { "type": "encryption", "pointer": "/X5TJ5IS8vJ,/~1/bGd/~1/OLRU,UQW/~0/~1/~1/VE+NLdLuMq" } ] }, "last_updated": "1967-04-19T23:54:29.789Z", "encodingVersion": 1, "job": { "_id": "bf5e02268932587cd34db147", "task": "3a1f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": [ "f5ff4caf5f14c81a6e304cf9" ] }, "groups": [ "0a3156dd09ee67761cd70497", { "_id": "debb0b1565c4d40e2309688d", "provenance": "in", "name": "culpa voluptate", "description": "nisi ipsum", "memberOf": [ { "groupId": "f84367948107b8e48acbff26", "aaaManaged": true }, { "groupId": "8ee309396eec93e0e0a13a48", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "Excepteur commodo consectetur" } ], "inactive": false, "_meta": { "created": "2011-02-14T02:53:48.627Z", "updated": "2005-11-14T17:40:37.793Z", "migrationVersion": -74399372 } } ], "type": "automatic", "metrics": { "start_time": "reprehenderit esse in", "end_time": -33856746.81068926, "server_id": "occaecat est aliqua dolore Excepteur", "finish_state": "success", "run_time": -2174435.2765301466, "retrying": true, "user": "Pronghorn", "owner": "96d265acfad8eb5a3a521316" } } ], "metadata": { "skip": -99394792, "limit": -17624843, "total": -49752732, "nextPageSkip": null, "previousPageSkip": null, "currentPageSize": 99946848 } }
{ "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" } } } ] }