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": "draft-v4", "options": { "weights": { "error": -42353557.76464007, "warning": 77749854.52983966, "info": 41232440.716086805 }, "nodePath": "base/US East/Atlanta" } }
{ "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": "review", "total": 68842067, "devices": [ "xr9kv-atl", "xr9kv-atl", "xr9kv-atl", "xr9kv-atl" ], "records": [ { "deviceName": "xr9kv-atl", "reportId": "5c35355dbebaa82eaf8113f0", "nodePath": "base/US East/Atlanta", "timestamp": "2019-04-12T14:42:47.958Z", "score": 272906.35495872796, "grade": "fail" }, { "deviceName": "xr9kv-atl", "reportId": "5c35355dbebaa82eaf8113f0", "nodePath": "base/US East/Atlanta", "timestamp": "2019-04-12T14:42:47.958Z", "score": -60217433.644067466, "grade": "fail" } ] }, { "grade": "pass", "total": 7499928, "devices": [ "xr9kv-atl" ], "records": [ { "deviceName": "xr9kv-atl", "reportId": "5c35355dbebaa82eaf8113f0", "nodePath": "base/US East", "timestamp": "2019-04-12T14:42:47.958Z", "score": -86463156.70023488, "grade": "fail" }, { "deviceName": "xr9kv-atl", "reportId": "5c35355dbebaa82eaf8113f0", "nodePath": "base/US East", "timestamp": "2019-04-12T14:42:47.958Z", "score": 38750589.60137129, "grade": "review" }, { "deviceName": "xr9kv-atl", "reportId": "5c35355dbebaa82eaf8113f0", "nodePath": "base/US East", "timestamp": "2019-04-12T14:42:47.958Z", "score": 1642366.0444861948, "grade": "review" }, { "deviceName": "xr9kv-atl", "reportId": "5c35355dbebaa82eaf8113f0", "nodePath": "base", "timestamp": "2019-04-12T14:42:47.958Z", "score": -77409976.83094575, "grade": "review" }, { "deviceName": "xr9kv-atl", "reportId": "5c35355dbebaa82eaf8113f0", "nodePath": "base/US East/Atlanta", "timestamp": "2019-04-12T14:42:47.958Z", "score": 22030624.179629266, "grade": "fail" } ] }, { "grade": "pass", "total": 48013646, "devices": [ "xr9kv-atl", "xr9kv-atl" ], "records": [ { "deviceName": "xr9kv-atl", "reportId": "5c35355dbebaa82eaf8113f0", "nodePath": "base/US East", "timestamp": "2019-04-12T14:42:47.958Z", "score": -89022708.07965662, "grade": "fail" }, { "deviceName": "xr9kv-atl", "reportId": "5c35355dbebaa82eaf8113f0", "nodePath": "base/US East", "timestamp": "2019-04-12T14:42:47.958Z", "score": -72037207.64678355, "grade": "review" }, { "deviceName": "xr9kv-atl", "reportId": "5c35355dbebaa82eaf8113f0", "nodePath": "base/US East", "timestamp": "2019-04-12T14:42:47.958Z", "score": -98150274.75631876, "grade": "fail" }, { "deviceName": "xr9kv-atl", "reportId": "5c35355dbebaa82eaf8113f0", "nodePath": "base/US East/Atlanta", "timestamp": "2019-04-12T14:42:47.958Z", "score": 50381982.211054355, "grade": "pass" }, { "deviceName": "xr9kv-atl", "reportId": "5c35355dbebaa82eaf8113f0", "nodePath": "base", "timestamp": "2019-04-12T14:42:47.958Z", "score": 67469923.8741943, "grade": "review" } ] }, { "grade": "review", "total": 11757674, "devices": [ "xr9kv-atl" ], "records": [ { "deviceName": "xr9kv-atl", "reportId": "5c35355dbebaa82eaf8113f0", "nodePath": "base/US East/Atlanta", "timestamp": "2019-04-12T14:42:47.958Z", "score": -23672896.835090727, "grade": "pass" }, { "deviceName": "xr9kv-atl", "reportId": "5c35355dbebaa82eaf8113f0", "nodePath": "base/US East/Atlanta", "timestamp": "2019-04-12T14:42:47.958Z", "score": 94547501.4376865, "grade": "fail" }, { "deviceName": "xr9kv-atl", "reportId": "5c35355dbebaa82eaf8113f0", "nodePath": "base/US East", "timestamp": "2019-04-12T14:42:47.958Z", "score": 28458051.869525343, "grade": "fail" }, { "deviceName": "xr9kv-atl", "reportId": "5c35355dbebaa82eaf8113f0", "nodePath": "base", "timestamp": "2019-04-12T14:42:47.958Z", "score": 10161156.407524124, "grade": "fail" }, { "deviceName": "xr9kv-atl", "reportId": "5c35355dbebaa82eaf8113f0", "nodePath": "base/US East/Atlanta", "timestamp": "2019-04-12T14:42:47.958Z", "score": 5493716.668973073, "grade": "pass" } ] } ]
{ "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" ] } } } } } } }