Summary
Get graded compliance reports for a node.
Description
Get a set of graded and scored compliance reports for a node.
Route
POST /configuration_manager/compliance_reports/grade
Roles
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| treeId | string | yes | - |
| version | string | yes | - |
| options | object | yes | - |
{ "treeId": "5c35355dbebaa82eaf8113f0", "version": "v2", "options": { "weights": { "error": -37948276.92401061, "warning": -88077799.17948793, "info": -43180894.052083164 }, "nodePath": "base/US East" } }
{ "type": "object", "properties": { "treeId": { "title": "treeId", "$ref": "common#/definitions/mongoObjectId" }, "version": { "title": "version", "$ref": "goldenConfigData#/definitions/goldenConfigTreeVersionName" }, "options": { "title": "options", "allOf": [ { "$ref": "goldenConfigData#/definitions/reportGradingOptions" }, { "type": "object", "properties": { "nodePath": { "title": "nodePath", "$ref": "goldenConfigData#/definitions/goldenConfigNodePath" } } } ] } }, "required": [ "treeId", "version", "options" ], "additionalProperties": false }
Return
| Name | Type | Description |
|---|---|---|
| graded_compliance_reports | object | - |
[ { "grade": "fail", "total": 82053919, "devices": [ "xr9kv-atl" ], "records": [ { "deviceName": "xr9kv-atl", "reportId": "5c35355dbebaa82eaf8113f0", "nodePath": "base/US East/Atlanta", "timestamp": "2019-04-12T14:42:47.958Z", "score": 8595318.543127745, "grade": "fail" } ] }, { "grade": "review", "total": 41432272, "devices": [ "xr9kv-atl", "xr9kv-atl", "xr9kv-atl", "xr9kv-atl", "xr9kv-atl" ], "records": [ { "deviceName": "xr9kv-atl", "reportId": "5c35355dbebaa82eaf8113f0", "nodePath": "base/US East", "timestamp": "2019-04-12T14:42:47.958Z", "score": 91827572.94542348, "grade": "pass" }, { "deviceName": "xr9kv-atl", "reportId": "5c35355dbebaa82eaf8113f0", "nodePath": "base", "timestamp": "2019-04-12T14:42:47.958Z", "score": 8043568.43327944, "grade": "review" }, { "deviceName": "xr9kv-atl", "reportId": "5c35355dbebaa82eaf8113f0", "nodePath": "base", "timestamp": "2019-04-12T14:42:47.958Z", "score": -78868408.5434125, "grade": "fail" }, { "deviceName": "xr9kv-atl", "reportId": "5c35355dbebaa82eaf8113f0", "nodePath": "base", "timestamp": "2019-04-12T14:42:47.958Z", "score": 46009772.71848783, "grade": "fail" } ] }, { "grade": "fail", "total": 93403642, "devices": [ "xr9kv-atl", "xr9kv-atl", "xr9kv-atl" ], "records": [ { "deviceName": "xr9kv-atl", "reportId": "5c35355dbebaa82eaf8113f0", "nodePath": "base", "timestamp": "2019-04-12T14:42:47.958Z", "score": 52190314.50981367, "grade": "fail" }, { "deviceName": "xr9kv-atl", "reportId": "5c35355dbebaa82eaf8113f0", "nodePath": "base/US East", "timestamp": "2019-04-12T14:42:47.958Z", "score": -85211765.41311273, "grade": "pass" }, { "deviceName": "xr9kv-atl", "reportId": "5c35355dbebaa82eaf8113f0", "nodePath": "base/US East/Atlanta", "timestamp": "2019-04-12T14:42:47.958Z", "score": 1902308.471916303, "grade": "review" } ] }, { "grade": "fail", "total": 69677945, "devices": [ "xr9kv-atl", "xr9kv-atl", "xr9kv-atl", "xr9kv-atl", "xr9kv-atl" ], "records": [ { "deviceName": "xr9kv-atl", "reportId": "5c35355dbebaa82eaf8113f0", "nodePath": "base/US East", "timestamp": "2019-04-12T14:42:47.958Z", "score": 68092797.0610384, "grade": "pass" }, { "deviceName": "xr9kv-atl", "reportId": "5c35355dbebaa82eaf8113f0", "nodePath": "base", "timestamp": "2019-04-12T14:42:47.958Z", "score": 52237181.9552224, "grade": "pass" }, { "deviceName": "xr9kv-atl", "reportId": "5c35355dbebaa82eaf8113f0", "nodePath": "base/US East", "timestamp": "2019-04-12T14:42:47.958Z", "score": -53870940.895451106, "grade": "fail" }, { "deviceName": "xr9kv-atl", "reportId": "5c35355dbebaa82eaf8113f0", "nodePath": "base", "timestamp": "2019-04-12T14:42:47.958Z", "score": 49630083.51651785, "grade": "fail" } ] }, { "grade": "fail", "total": 55410747, "devices": [ "xr9kv-atl", "xr9kv-atl", "xr9kv-atl" ], "records": [ { "deviceName": "xr9kv-atl", "reportId": "5c35355dbebaa82eaf8113f0", "nodePath": "base", "timestamp": "2019-04-12T14:42:47.958Z", "score": 47252177.55628401, "grade": "review" }, { "deviceName": "xr9kv-atl", "reportId": "5c35355dbebaa82eaf8113f0", "nodePath": "base/US East", "timestamp": "2019-04-12T14:42:47.958Z", "score": -74535656.43293953, "grade": "fail" }, { "deviceName": "xr9kv-atl", "reportId": "5c35355dbebaa82eaf8113f0", "nodePath": "base", "timestamp": "2019-04-12T14:42:47.958Z", "score": -89113025.7414761, "grade": "fail" }, { "deviceName": "xr9kv-atl", "reportId": "5c35355dbebaa82eaf8113f0", "nodePath": "base", "timestamp": "2019-04-12T14:42:47.958Z", "score": 64580704.007939994, "grade": "fail" }, { "deviceName": "xr9kv-atl", "reportId": "5c35355dbebaa82eaf8113f0", "nodePath": "base", "timestamp": "2019-04-12T14:42:47.958Z", "score": -73461068.84252608, "grade": "fail" } ] } ]
{ "title": "graded_compliance_reports", "type": "array", "items": { "type": "object", "properties": { "grade": { "type": "string", "examples": [ "pass", "review", "fail" ] }, "total": { "type": "integer", "minimum": 0 }, "devices": { "type": "array", "items": { "$ref": "deviceData#/definitions/deviceName" } }, "records": { "type": "array", "items": { "type": "object", "properties": { "deviceName": { "$ref": "deviceData#/definitions/deviceName" }, "reportId": { "$ref": "common#/definitions/mongoObjectId" }, "nodePath": { "title": "nodePath", "$ref": "goldenConfigData#/definitions/goldenConfigNodePath" }, "timestamp": { "$ref": "common#/definitions/timestamp" }, "score": { "type": "number" }, "grade": { "type": "string", "examples": [ "pass", "review", "fail" ] } } } } } } }