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": "name", "exclude": "_id", "in": "ad culpa mollit", "not-in": "qui", "equals": "est eu fugiat consequat dolore", "contains": "esse", "starts-with": "non qui incididunt", "ends-with": "ut quis", "dereference": "officia", "gt": "sint", "gte": "nulla enim", "lt": "Duis tempor Lorem est et", "lte": "ut ex ea exercitation pariatur", "q": "elit Duis", "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": "fafB7ddf-Ae3d-9afd-E1cB-40Cc3BdB7a05", "location": "Application", "view": null, "status": "error", "app": "aliquip culpa Ut", "name": "deserunt", "variables": { "decorators": [ { "type": "encryption", "pointer": "/~0/~1" }, { "type": "encryption", "pointer": "/myD/CBQhtg4/N/iY/lC2Q.eDM/~1/cd0t/~0" }, { "type": "encryption", "pointer": "/WkDKGHiZ+Tq/~0/~1/~1/bRc/~0/K1jFxtU0f/TnH/zbIE/~1/J5u" }, { "type": "encryption", "pointer": "/sKlnRNq1d/~0/~0/T79qSl/KP/~1/~1/k/s1k-8J,/~0/~0" } ] }, "last_updated": "1960-05-10T15:45:41.263Z", "encodingVersion": 1, "job": { "_id": "596eb488628512f4950c1b40", "task": "e28f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": null }, "incomingRefs": [], "groups": [ "4417bcc048014e55f3998520", "eea434fc5efc8d2e2de368de" ], "type": "manual", "metrics": { "start_time": "ea in exercitation in", "claim_time": "1987-09-19T13:07:58.441Z", "end_time": 22765429.14017354, "server_id": "reprehenderit mollit", "finish_state": "success", "run_time": 1022061.732992664, "user": { "_id": "ecf20989b00ef7d6a8c3bf18", "provenance": "veniam esse", "username": "ut", "firstname": "exercitation Ut dolore ipsum nostrud", "memberOf": [ { "groupId": "74e1313163915542b1098abd", "aaaManaged": true }, { "groupId": "5e9baae76a7ec134250413fa", "aaaManaged": true }, { "groupId": "bd811ae264b5eaa1418f8ef6", "aaaManaged": false }, { "groupId": "396aa56ef2d7b34f9cde3f90", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "est adipisicing" }, { "roleId": "nisi voluptate et mollit" }, { "roleId": "dolore ad ex adipisicing et" }, { "roleId": "laboris eiusmod" } ], "inactive": true, "lastLogin": "1955-08-02T05:24:43.508Z", "_meta": { "created": "2002-10-17T11:07:41.746Z", "updated": "1995-01-14T05:42:47.048Z", "migrationVersion": 41832772 }, "email": "dolore fugiat anim" }, "owner": "5b20ae799ca8dd09521bd827" } }, { "_id": "b6956f3e-dCb5-EBBB-a9f4-bA4fC845aF63", "location": "Broker", "view": "laborum voluptate", "status": "canceled", "app": "in sint et elit ex", "name": "dolor pariatur sed elit in", "variables": { "decorators": [ { "type": "encryption", "pointer": "/vvN,L12l/mn0Bb8Y/HaCfuYn/~1/~0/~1/~0/~0/H9NC" }, { "type": "encryption", "pointer": "/a7yNpSj/~1/zUu+V-/~1/~1/~0/o+v/~1" }, { "type": "encryption", "pointer": "/j1XL/jBusQhs3/iW5U7.euK/~1/~1/H4nt2NlPO/hy/~0/aJOaM1tS2k/s/uVNP" }, { "type": "encryption", "pointer": "/~0/eZ/nDFLWP1z/~1/~1/Ho,wDQil7L" }, { "type": "encryption", "pointer": "/~0" } ] }, "last_updated": "1964-03-01T14:57:46.197Z", "encodingVersion": 1, "job": { "_id": "8912961cdea8e4249a578586", "task": "e28f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": null }, "incomingRefs": [], "groups": [ "d55b40121350e9f0cb14cc13", { "_id": "968788e376f0d2e047b599ab", "provenance": "id", "name": "incididunt ad culpa elit", "description": "consectetur Duis quis in laboris", "memberOf": [ { "groupId": "c6a1bb09bd0023f80bc9443e", "aaaManaged": false }, { "groupId": "a17ece6aecff78eda0e8c461", "aaaManaged": false }, { "groupId": "b3a37e156258d0ff25fee72f", "aaaManaged": false }, { "groupId": "65828699866a73451d2124fb", "aaaManaged": false }, { "groupId": "198abcaca8b6e5a07b932415", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "laboris ad" }, { "roleId": "commodo ad do pariatur sint" }, { "roleId": "dolor nostrud sint" }, { "roleId": "eu proident ut" } ], "inactive": true, "_meta": { "created": "2012-12-31T14:46:35.465Z", "updated": "1998-04-03T02:32:55.634Z", "migrationVersion": 55347528 } }, { "_id": "8d4302e1220728fe6029d624", "provenance": "ipsum nulla sint Duis", "name": "exercitation ipsum", "description": "cillum nisi mollit veniam sit", "memberOf": [ { "groupId": "50edbb014bc9b3c0d551106b", "aaaManaged": true }, { "groupId": "a886f08dbe3315f3a39176f4", "aaaManaged": false }, { "groupId": "5dbe72dacf56866fc44f405c", "aaaManaged": false }, { "groupId": "060a68e8bc8499fc9602cb80", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "eiusmod reprehenderit voluptate sit magna" }, { "roleId": "qui cupidatat commodo incididunt" }, { "roleId": "ex amet anim enim eu" } ], "inactive": true, "_meta": { "created": "1966-03-09T12:21:41.22Z", "updated": "2017-04-02T14:35:23.168Z", "migrationVersion": -2728995 } }, "434f41708b7902f64bfa3d58" ], "type": "manual", "metrics": { "start_time": "minim non", "claim_time": "1999-04-23T22:31:36.579Z", "end_time": -31251406.532490388, "server_id": "et sint cillum Excepteur nisi", "finish_state": "paused", "run_time": 60771515.62882751, "user": { "_id": "3277d0c1e50a729cd1342ebd", "provenance": "dolore labore incididunt dolor", "username": "deserunt ex in consequat eu", "firstname": "aliqua ipsum officia nisi incididunt", "memberOf": [ { "groupId": "761fb3b978ee634b113f1764", "aaaManaged": true }, { "groupId": "31f8b42d493e79af94f26d2f", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "dolor tempor ea" }, { "roleId": "exercitation proident labore anim esse" }, { "roleId": "exercitation deserunt qui consequat" }, { "roleId": "sint fugiat labore ut" }, { "roleId": "in quis exercitation" } ], "inactive": false, "lastLogin": "2009-04-03T03:05:18.901Z", "_meta": { "created": "2018-07-13T10:23:18.547Z", "updated": "1988-06-17T19:35:07.073Z", "migrationVersion": -27937579 }, "email": "non exercitation anim incididunt" }, "owner": "Pronghorn" } }, { "_id": "a0ACBd64-3ffF-Cd3B-e1bE-3BfeAde8Eb50", "location": "Application", "view": null, "status": "failure", "app": "tempor", "name": "consectetur", "variables": { "decorators": [ { "type": "encryption", "pointer": "/~0/~1" }, { "type": "encryption", "pointer": "/kRkExIwdJ" }, { "type": "encryption", "pointer": "/~1/DxJPxrY6J./~0/v5/~1" } ] }, "last_updated": "1961-03-28T18:21:15.585Z", "encodingVersion": 1, "job": { "_id": "896569154e71da47f220dc27", "task": "e28f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": [ "8df0ba281ffe2d4c141de7b2", "313d56faa1569abf3a20dc98", "fac1892aa2d7025cc35c3a19", "62b27764579be31d306879ba" ] }, "incomingRefs": [], "groups": [ { "_id": "f8dffd08178127f8a8c6cb50", "provenance": "amet velit eu incididunt", "name": "voluptate quis", "description": "voluptate", "memberOf": [ { "groupId": "942390e5db16144b2da7743b", "aaaManaged": false }, { "groupId": "6530284c4d25fae724eabab0", "aaaManaged": false }, { "groupId": "c307fd3d39ad6dc99692277a", "aaaManaged": true }, { "groupId": "107991dd90758045c8612cba", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "sed officia" }, { "roleId": "ut aliquip" }, { "roleId": "ea sit Duis" }, { "roleId": "consequat ipsum id minim" } ], "inactive": false, "_meta": { "created": "2020-06-12T16:25:13.774Z", "updated": "1984-10-19T22:29:00.259Z", "migrationVersion": 68796769 } } ], "type": "manual", "metrics": { "start_time": "id aute dolore dolor", "claim_time": "2018-05-01T07:20:06.998Z", "end_time": 55514141.889953494, "server_id": "ea tempor anim", "finish_state": "success", "run_time": 67453179.95222107, "user": "26abb4fa7262c69dcdfcdacf", "owner": { "_id": "f0eed729d22354dcbccf5bd0", "provenance": "ullamco eiusmod in", "username": "consequat deserunt mollit qui", "firstname": "aliqua ea esse do velit", "memberOf": [ { "groupId": "4225be3d34055455b7266abf", "aaaManaged": true }, { "groupId": "0f8a4ae4b6d3648b7b6cc574", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "tempor velit dolor" } ], "inactive": true, "lastLogin": "1978-08-25T06:33:01.842Z", "_meta": { "created": "1988-06-04T07:54:59.224Z", "updated": "1953-06-18T23:53:50.543Z", "migrationVersion": -59534615 }, "email": "commodo consequat" } } }, { "_id": "9e3a389f-c8a3-6821-EbEc-6aE02a3567CC", "location": "Adapter", "view": null, "status": "scheduled", "app": "pariatur", "name": "cupidatat nisi in", "variables": { "decorators": [ { "type": "encryption", "pointer": "/~1" }, { "type": "encryption", "pointer": "/XF/l.8wekH/~0/~0/bthHLVgO" }, { "type": "encryption", "pointer": "/~0/iK6a/AKOCulX.CH/~1" }, { "type": "encryption", "pointer": "/zPkcguPCTxl/~1/~0/~1/HjCAhR8" } ] }, "last_updated": "1996-09-22T13:07:15.282Z", "encodingVersion": 1, "job": { "_id": "dba709acc14d95ca42d5a1ac", "task": "b4f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": null }, "incomingRefs": [], "groups": [ "d72285c98607f2f14245d30e", "f431190f0a9b8c3f8d38614f", "1d395b75132a47be9fd3e2c9" ], "type": "manual", "metrics": { "start_time": "voluptate id proident", "claim_time": "1973-05-07T15:27:24.028Z", "end_time": -32516374.32521473, "server_id": "ut pariatur consequat enim", "finish_state": "success", "run_time": 70971225.76424363, "user": "e6ce623e06548b3bf610ec6e", "owner": "" } }, { "_id": "AAA61fa2-BCCB-4708-DF59-462bE5C8a8Bc", "location": "Application", "view": null, "status": "incomplete", "app": "exercitation", "name": "sed irure in", "variables": { "decorators": [ { "type": "encryption", "pointer": "/Yy/~0/mfd6bsP3yP/F/~0/~0/~0/~0/~0" }, { "type": "encryption", "pointer": "/~1/~1/~0/~0/~1" }, { "type": "encryption", "pointer": "/IJSDq/~0/~0" }, { "type": "encryption", "pointer": "/~1/~1/~1/geXFn3i+/~0/B93DrdbT2HB/rvV7b1/xAXrQcjRm" } ] }, "last_updated": "1970-02-17T13:58:59.057Z", "encodingVersion": 1, "job": { "_id": "f91247610ecf9a14e48bbb54", "task": "e28f", "name": "myCoolDocumentName", "description": "Some helpful information about the document", "ancestors": null }, "incomingRefs": [], "groups": [ "d8cc4cf91fddd1158630f240", { "_id": "9d27b0039e4d4cf3f41f8da1", "provenance": "eiusmod et anim adipisicing", "name": "dolor eu sint nisi quis", "description": "nisi", "memberOf": [ { "groupId": "7240f2626150375388f52d3d", "aaaManaged": false }, { "groupId": "6ce9550b91401869bea2656e", "aaaManaged": false }, { "groupId": "acf6b7a4c97daa0092f814ae", "aaaManaged": false }, { "groupId": "6fcafd05bf231d001a47379d", "aaaManaged": true } ], "assignedRoles": [ { "roleId": "ex voluptate incididunt" }, { "roleId": "officia" }, { "roleId": "esse dolore veniam cillum" } ], "inactive": true, "_meta": { "created": "1963-02-07T14:15:41.802Z", "updated": "2012-02-10T03:49:13.145Z", "migrationVersion": 69260636 } }, "33c417f5589616b41b057341", "43ffd2d86fca9c3a817d4df4", "e8200df77dd945343d42b156" ], "type": "manual", "metrics": { "start_time": "Excepteur sint mollit", "claim_time": "1973-05-10T23:09:33.319Z", "end_time": -27866468.389052153, "server_id": "mollit aliqua Lorem", "finish_state": "success", "run_time": -23526047.03021334, "user": { "_id": "141fc597e2f5a9b31ca8be4a", "provenance": "in fugiat", "username": "Ut enim eiusmod", "firstname": "anim", "memberOf": [ { "groupId": "c7ab0ff1a9759f7fd8e586a2", "aaaManaged": true }, { "groupId": "6eb3b21b19fe4765c0a98520", "aaaManaged": true }, { "groupId": "972c1246b26673361f7fc840", "aaaManaged": false }, { "groupId": "20bf620ee701b74f08de9b55", "aaaManaged": false }, { "groupId": "42dcb9958d7d10a43c1ba542", "aaaManaged": false } ], "assignedRoles": [ { "roleId": "in enim" }, { "roleId": "cillum" } ], "inactive": true, "lastLogin": "1989-01-29T07:12:02.031Z", "_meta": { "created": "1960-07-14T01:41:46.579Z", "updated": "1970-07-16T05:29:57.429Z", "migrationVersion": -87484571 }, "email": "exercitation id est incididunt" }, "owner": "6286d4f31b66ab9531ed82d4" } } ], "metadata": { "skip": 53494990, "limit": -70608864, "total": 19776755, "nextPageSkip": -56783984, "previousPageSkip": null, "currentPageSize": 50234169 } }
{ "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" } } } ] }