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": "ipsum Ut in deserunt esse", "not-in": "exercitation magna dolor ex dolor", "equals": "in", "contains": "occaecat ea fugiat irure", "starts-with": "Duis dolor exercitation", "ends-with": "nulla laboris", "dereference": "sunt dolor", "gt": "voluptate Excepteur ea ullamco", "gte": "est ut laborum eiusmod Ut", "lt": "ad nisi", "lte": "ex cupidatat", "q": "ad sint nisi ea", "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 retrieved search results", "data": [ { "_id": "06518d0a-FDAD-F98b-e0B6-9E5f4cD126B7", "location": "Adapter", "view": "sit pariatur ea adipisicing velit", "status": "paused", "app": "nulla", "name": "labore Duis consequat esse", "variables": { "decorators": [ { "type": "encryption", "pointer": "/ajv1/xf/auB,U/Dc0B/N0C," } ] }, "last_updated": "1996-05-06T06:12:25.954Z", "encodingVersion": 1, "job": { "_id": "2c0c5ba4c53640ff964df500", "task": "3a1f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": [ "1418be29bafbf3f9a73aaca7", "d10a6f00a13da3e5b98b2203", "76aa4fee0eaccd0cfd618a1e", "aba1dd2802a5804dae855b7e" ] }, "incomingRefs": [], "groups": [ { "_id": "1353b51e987950637033078a", "provenance": "laborum", "name": "irure", "description": "laboris ullamco consectetur aliqua", "memberOf": [ { "groupId": "36bdf9705229d02d14719446", "aaaManaged": false }, { "groupId": "875799dd6e8e895c83ae4c7f", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "ullamco in fugiat adipisicing" }, { "roleId": "dolor culpa nulla" }, { "roleId": "est" }, { "roleId": "non aliqua" }, { "roleId": "commodo Excepteur et tempor" } ], "inactive": true, "_meta": { "created": "1972-02-28T05:46:10.433Z", "updated": "1983-09-02T21:33:14.462Z", "migrationVersion": -51271376 } } ], "type": "manual", "metrics": { "start_time": "non in", "claim_time": "2009-09-11T20:21:55.519Z", "end_time": -29846159.963673905, "server_id": "officia consequat ut consectetur", "finish_state": "success", "run_time": 25669688.350619912, "user": "7c1c5e771a6e9fb8cb15b0c1", "owner": "Pronghorn" } }, { "_id": "5FFb92B4-ff9d-3b1b-97fB-0AB378c9e6d2", "location": "Application", "view": "consectetur", "status": "paused", "app": "fugiat laborum incididunt commodo eiusmod", "name": "do ut", "variables": { "decorators": [ { "type": "encryption", "pointer": "/~0/Y" }, { "type": "encryption", "pointer": "/~1" }, { "type": "encryption", "pointer": "/~1/~0/~1/~0/XLL5JHQ9Wm-/~0/FHFaoq/O+3IQ/RSa/~1/WivUgHrM2/~1" } ] }, "last_updated": "1991-11-10T19:49:32.751Z", "encodingVersion": 1, "job": { "_id": "d3fbf87e09a3d72fb2e81ef9", "task": "b4f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": null }, "incomingRefs": [], "groups": [ "57b41c935eb7965cf05f58a2", "cd4179a6c82b3013b26fb5dc", { "_id": "c7027183795a1e6cc245e4d7", "provenance": "commodo do ullamco elit cillum", "name": "pariatur", "description": "pariatur laborum nostrud nisi", "memberOf": [ { "groupId": "36a74d92f148932bc7ba87b1", "aaaManaged": false }, { "groupId": "343a7988b5a53ff91947adf8", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "dolore eiusmod tempor proident" }, { "roleId": "aliqua" }, { "roleId": "consequat" } ], "inactive": true, "_meta": { "created": "2001-09-05T20:12:36.332Z", "updated": "2020-10-31T01:11:08.395Z", "migrationVersion": 40013628 } }, { "_id": "948188b35d576a92039f2d2d", "provenance": "occaecat", "name": "Ut commodo occaecat aute eu", "description": "esse qui amet", "memberOf": [ { "groupId": "c5c35d2c602ed32cec8c7f62", "aaaManaged": true }, { "groupId": "bdc3aaf36645c3d977492f64", "aaaManaged": true }, { "groupId": "854218273344000bc5db7339", "aaaManaged": false }, { "groupId": "f6664ed272ccbf5101834f3a", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "nulla incididunt sed" }, { "roleId": "reprehenderit" } ], "inactive": false, "_meta": { "created": "1993-02-13T14:36:53.082Z", "updated": "2000-01-21T09:58:37.322Z", "migrationVersion": 47770520 } } ], "type": "manual", "metrics": { "start_time": "nostrud tempor", "claim_time": "2022-12-16T18:59:26.086Z", "end_time": -6793206.721034288, "server_id": "aute", "finish_state": "success", "run_time": 71562041.94784728, "user": { "_id": "a09834e5665b73793d2291be", "provenance": "Duis Excepteur exercitation", "username": "culpa quis incididunt dolor", "firstname": "consequat aliquip irure nisi", "memberOf": [ { "groupId": "4ffc3c23944eaf83c3f8d347", "aaaManaged": true }, { "groupId": "572d83fd321c9dd169af87b2", "aaaManaged": false }, { "groupId": "0324bd10ea305aab345fd0ef", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "sunt in amet" }, { "roleId": "tempor nulla amet" }, { "roleId": "ullamco ut esse ad" } ], "inactive": true, "lastLogin": "1953-04-24T02:31:05.488Z", "_meta": { "created": "1986-07-23T03:40:39.978Z", "updated": "1996-06-12T19:01:31.423Z", "migrationVersion": 15858988 }, "email": "dolore Lorem id" }, "owner": { "_id": "faab1dc5fb050a7f624171da", "provenance": "cupidatat", "username": "nisi eiusmod sint consequat dolor", "firstname": "eu est qui", "memberOf": [ { "groupId": "5d4a93fa5cd421ede9596297", "aaaManaged": true }, { "groupId": "324841de4670ab6ba51aad28", "aaaManaged": true }, { "groupId": "c299934d757b9853c8763cec", "aaaManaged": true }, { "groupId": "40123b3d6633c9ef8d42931c", "aaaManaged": true }, { "groupId": "aaa3b69088141095b8707681", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "ex officia id" }, { "roleId": "enim Duis culpa" }, { "roleId": "in" }, { "roleId": "consectetur occaecat sunt incididunt" } ], "inactive": true, "lastLogin": "1975-06-30T05:20:58.66Z", "_meta": { "created": "2013-11-24T22:54:40.099Z", "updated": "1955-08-19T20:34:27.174Z", "migrationVersion": -76628224 }, "email": "deserunt" } } }, { "_id": "2Bec7f63-6Db1-91ca-1d46-4CD64ca2C6a0", "location": "Application", "view": null, "status": "error", "app": "nostrud magna id proident", "name": "nostrud commodo consequat", "variables": { "decorators": [ { "type": "encryption", "pointer": "/L/jaRFnT/qWZ/~1/v/~0" }, { "type": "encryption", "pointer": "/~0/~0/~0/~0" }, { "type": "encryption", "pointer": "/~1/DtEcFKYy/a+/SPy/f8.Jg/~0/~1/BhNXhVW/sJYrP7N/~0" }, { "type": "encryption", "pointer": "/P" }, { "type": "encryption", "pointer": "/~1/~1/A-3/~1/LD/~1/XM.pKrsEMD/P" } ] }, "last_updated": "2017-12-20T17:52:34.554Z", "encodingVersion": 1, "job": { "_id": "63bb4841a2b343963e61930d", "task": "e28f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": [ "c3f2b13d5107e5ad54a97f9b", "5f5a7cf73fd2280024a7f3b0", "ea84fc3c96a9916b6f99b5f7" ] }, "incomingRefs": [], "groups": [ { "_id": "958bff43bf632cd70e2a3fa2", "provenance": "deserunt", "name": "exercitation ullamco", "description": "Duis laboris est incididunt reprehenderit", "memberOf": [ { "groupId": "7bc540a12fbc29d611a98f62", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "quis ex" }, { "roleId": "tempor nostrud" }, { "roleId": "cillum fugiat labore laboris" }, { "roleId": "incididunt ex ipsum occaecat ea" }, { "roleId": "adipisicing" } ], "inactive": true, "_meta": { "created": "2003-03-02T00:38:08.43Z", "updated": "1972-01-23T20:34:54.128Z", "migrationVersion": 85437543 } } ], "type": "manual", "metrics": { "start_time": "Excepteur", "claim_time": "2012-11-06T22:22:19.954Z", "end_time": 35861436.09093225, "server_id": "elit tempor eiusmod", "finish_state": "running", "run_time": -44310546.42765973, "user": "04aae70b509fddb5eda0f86b", "owner": "0be2e54dc8ec987e40668888" } }, { "_id": "AA3A4f09-aA72-1cFd-bEB0-DBdc3B2ee21A", "location": "Application", "view": null, "status": "paused", "app": "esse", "name": "reprehenderit ex nulla", "variables": { "decorators": [ { "type": "encryption", "pointer": "/Oh0itJPp/~1/~0/~1" }, { "type": "encryption", "pointer": "/zY7kU/~1/pGFyahRWG/~0/Bq/~1/q/~1" }, { "type": "encryption", "pointer": "/XrHM2,zI7nr/zyGik/s-fJw,PCC" }, { "type": "encryption", "pointer": "/K/Op/~1/~1/~0/lKzbrb53/~1/~1/~0" }, { "type": "encryption", "pointer": "/~1/wa2vp+/vnO/KiAsuOp/~0/~1/pefoV5/~1" } ] }, "last_updated": "1969-05-12T10:04:25.806Z", "encodingVersion": 1, "job": { "_id": "0d1c0dab219225a11ef3919f", "task": "3a1f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": [ "2c5e0ad11049aba700f60038" ] }, "incomingRefs": [], "groups": [ { "_id": "152e9a5049bcf261351884e3", "provenance": "cillum laboris", "name": "esse aliquip sint", "description": "esse commodo laboris", "memberOf": [ { "groupId": "93a2838d081758da104a08bf", "aaaManaged": false }, { "groupId": "12d648266b3699361a222124", "aaaManaged": false }, { "groupId": "2e3107a79736f03d070bb603", "aaaManaged": false }, { "groupId": "9509a2e11beedb3b88a56834", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "ad minim" }, { "roleId": "in cupidatat esse exercitation nostrud" }, { "roleId": "ipsum dolore sit" }, { "roleId": "elit officia non ad" }, { "roleId": "amet minim laboris" } ], "inactive": true, "_meta": { "created": "1988-12-01T12:42:41.177Z", "updated": "1983-02-14T17:51:00.552Z", "migrationVersion": -93156934 } }, "7a15d29c8e6cd3603fbfd54e", "48fe162002556adafcbd0cad", { "_id": "5a6a52beeabf489df8475ab1", "provenance": "proident reprehenderit nisi eu", "name": "in exercitation nisi amet Lorem", "description": "tempor non mollit et id", "memberOf": [ { "groupId": "b66dbca88b2705dce4d36aeb", "aaaManaged": true }, { "groupId": "9aa7448f8aa9e68ae670bddb", "aaaManaged": false }, { "groupId": "a7edb1c4cd233e2bc73e17ab", "aaaManaged": true }, { "groupId": "3752c3db982f96b73a0d9562", "aaaManaged": false }, { "groupId": "8855569fe5a16992fe86070e", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "quis qui ipsum et sed" } ], "inactive": true, "_meta": { "created": "1992-09-22T03:20:07.035Z", "updated": "1971-01-07T22:20:01.444Z", "migrationVersion": 33251893 } } ], "type": "manual", "metrics": { "start_time": "sed fugiat", "claim_time": "1968-12-10T23:59:35.814Z", "end_time": 17750999.148269475, "server_id": "amet anim sint nulla dolor", "finish_state": "paused", "run_time": -31946030.075431645, "user": { "_id": "43f5fc6572bc29b979f95194", "provenance": "Ut laborum fugiat ullamco", "username": "magna sed", "firstname": "dolore tempor nisi eu qui", "memberOf": [ { "groupId": "51f434b222e67870a0255377", "aaaManaged": true }, { "groupId": "48f8c8bd6354b1f930eef5bd", "aaaManaged": true }, { "groupId": "5233fe55eb3230dccd48c0f7", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "aliqua laboris Excepteur ipsum" }, { "roleId": "Lorem veniam non" }, { "roleId": "incididunt laborum in qui sunt" }, { "roleId": "Duis Lorem" }, { "roleId": "dolor irure reprehenderit ea minim" } ], "inactive": true, "lastLogin": "2001-04-22T21:55:49.965Z", "_meta": { "created": "1950-03-11T18:51:40.478Z", "updated": "1949-09-22T10:35:51.571Z", "migrationVersion": 84360932 }, "email": "culpa commodo qui" }, "owner": "2e082e361f6dff8e891d6115" } }, { "_id": "0F836276-ca7F-fD7B-F3b7-ecC2b3ff764b", "location": "Broker", "view": null, "status": "error", "app": "commodo ullamco", "name": "in", "variables": { "decorators": [ { "type": "encryption", "pointer": "/pSg1/~1" }, { "type": "encryption", "pointer": "/~0/cj/PBY7d6/~1" }, { "type": "encryption", "pointer": "/~1" }, { "type": "encryption", "pointer": "/q/waBu6TEwkq//DmJMCYj.T/~1/~0/p,akE,EQX" } ] }, "last_updated": "1955-08-07T09:19:47.824Z", "encodingVersion": 1, "job": { "_id": "42f8ac1cf54fe1a0d31e9b20", "task": "e28f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": [ "f77465ae6e243495c0bfbf6c" ] }, "incomingRefs": [], "groups": [ { "_id": "bcc415958d2a5e5fbb3a70d8", "provenance": "Excepteur", "name": "laborum", "description": "ex pariatur aliqua", "memberOf": [ { "groupId": "376165f814cf51418545ad21", "aaaManaged": true }, { "groupId": "66d9f382d875f8e12f3f4b49", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "fugiat dolore" }, { "roleId": "laborum enim occaecat est consectetur" }, { "roleId": "pariatur enim" } ], "inactive": true, "_meta": { "created": "1988-10-26T07:06:22.002Z", "updated": "1976-04-10T05:42:26.188Z", "migrationVersion": -13330370 } }, "0c23cfde9f7af28ea1797623", "dff9d1ee3b46c896b34d2897", "a810cb5aebea81bd51f75bd7" ], "type": "manual", "metrics": { "start_time": "aliquip", "claim_time": "1983-12-03T09:09:32.896Z", "end_time": -55100749.9510229, "server_id": "Ut dolore anim", "finish_state": "success", "run_time": 4182193.791799411, "user": "5b23907ab20f4b49a1693542", "owner": { "_id": "d5f7eae70223ca9856365516", "provenance": "aliquip ipsum id aliqua", "username": "veniam sunt", "firstname": "voluptate occaecat", "memberOf": [ { "groupId": "e92e4f6b9ed4046e80da69fe", "aaaManaged": true }, { "groupId": "32a84db1281ad24a25ec3ac0", "aaaManaged": false }, { "groupId": "dd53a35b30792a705a13aa58", "aaaManaged": false }, { "groupId": "1cbd4bc8261c0a0f2c18449c", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "laborum enim" }, { "roleId": "nulla esse cupidatat" }, { "roleId": "consectetur nostrud" }, { "roleId": "culpa ea" } ], "inactive": true, "lastLogin": "1957-08-08T04:54:59.139Z", "_meta": { "created": "1998-10-27T08:02:46.41Z", "updated": "1957-04-23T04:58:29.127Z", "migrationVersion": -37229257 }, "email": "enim Duis laborum" } } } ], "metadata": { "skip": -39010314, "limit": -15397299, "total": 99500177, "nextPageSkip": -99327489, "previousPageSkip": -36612238, "currentPageSize": -87225664 } }
{ "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" } } } ] }