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": -72520241.61591616, "warning": 16220163.066546485, "info": -63721785.55451144 }, "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": 87490604, "devices": [ "xr9kv-atl", "xr9kv-atl" ], "records": [ { "deviceName": "xr9kv-atl", "reportId": "5c35355dbebaa82eaf8113f0", "nodePath": "base/US East", "timestamp": "2019-04-12T14:42:47.958Z", "score": 79564515.55081508, "grade": "pass" }, { "deviceName": "xr9kv-atl", "reportId": "5c35355dbebaa82eaf8113f0", "nodePath": "base/US East", "timestamp": "2019-04-12T14:42:47.958Z", "score": 17394439.812003568, "grade": "fail" }, { "deviceName": "xr9kv-atl", "reportId": "5c35355dbebaa82eaf8113f0", "nodePath": "base/US East", "timestamp": "2019-04-12T14:42:47.958Z", "score": 43028941.38507566, "grade": "review" }, { "deviceName": "xr9kv-atl", "reportId": "5c35355dbebaa82eaf8113f0", "nodePath": "base", "timestamp": "2019-04-12T14:42:47.958Z", "score": 62227436.75424737, "grade": "fail" }, { "deviceName": "xr9kv-atl", "reportId": "5c35355dbebaa82eaf8113f0", "nodePath": "base/US East/Atlanta", "timestamp": "2019-04-12T14:42:47.958Z", "score": 55145916.959352046, "grade": "fail" } ] }, { "grade": "pass", "total": 66288551, "devices": [ "xr9kv-atl" ], "records": [ { "deviceName": "xr9kv-atl", "reportId": "5c35355dbebaa82eaf8113f0", "nodePath": "base/US East/Atlanta", "timestamp": "2019-04-12T14:42:47.958Z", "score": 99696856.82306212, "grade": "review" } ] }, { "grade": "fail", "total": 51894868, "devices": [ "xr9kv-atl", "xr9kv-atl", "xr9kv-atl", "xr9kv-atl", "xr9kv-atl" ], "records": [ { "deviceName": "xr9kv-atl", "reportId": "5c35355dbebaa82eaf8113f0", "nodePath": "base", "timestamp": "2019-04-12T14:42:47.958Z", "score": 87070959.38773552, "grade": "pass" }, { "deviceName": "xr9kv-atl", "reportId": "5c35355dbebaa82eaf8113f0", "nodePath": "base", "timestamp": "2019-04-12T14:42:47.958Z", "score": -86496723.9561917, "grade": "review" }, { "deviceName": "xr9kv-atl", "reportId": "5c35355dbebaa82eaf8113f0", "nodePath": "base/US East/Atlanta", "timestamp": "2019-04-12T14:42:47.958Z", "score": 17852586.756276608, "grade": "fail" }, { "deviceName": "xr9kv-atl", "reportId": "5c35355dbebaa82eaf8113f0", "nodePath": "base", "timestamp": "2019-04-12T14:42:47.958Z", "score": 81722622.18972322, "grade": "pass" }, { "deviceName": "xr9kv-atl", "reportId": "5c35355dbebaa82eaf8113f0", "nodePath": "base/US East/Atlanta", "timestamp": "2019-04-12T14:42:47.958Z", "score": -45255436.96776735, "grade": "pass" } ] }, { "grade": "fail", "total": 333171, "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": 12343492.27302882, "grade": "review" }, { "deviceName": "xr9kv-atl", "reportId": "5c35355dbebaa82eaf8113f0", "nodePath": "base/US East", "timestamp": "2019-04-12T14:42:47.958Z", "score": -24247260.636030138, "grade": "pass" }, { "deviceName": "xr9kv-atl", "reportId": "5c35355dbebaa82eaf8113f0", "nodePath": "base", "timestamp": "2019-04-12T14:42:47.958Z", "score": 38514022.01720378, "grade": "pass" }, { "deviceName": "xr9kv-atl", "reportId": "5c35355dbebaa82eaf8113f0", "nodePath": "base/US East/Atlanta", "timestamp": "2019-04-12T14:42:47.958Z", "score": 56979506.066213846, "grade": "review" } ] } ]
{ "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" ] } } } } } } }