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": -77102463.59937853, "warning": -55402742.02001454, "info": -73213123.0051431 }, "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": "review", "total": 66590759, "devices": [ "xr9kv-atl", "xr9kv-atl" ], "records": [ { "deviceName": "xr9kv-atl", "reportId": "5c35355dbebaa82eaf8113f0", "nodePath": "base", "timestamp": "2019-04-12T14:42:47.958Z", "score": 63103680.328763366, "grade": "pass" }, { "deviceName": "xr9kv-atl", "reportId": "5c35355dbebaa82eaf8113f0", "nodePath": "base/US East/Atlanta", "timestamp": "2019-04-12T14:42:47.958Z", "score": 21364162.77666591, "grade": "fail" } ] }, { "grade": "pass", "total": 14199637, "devices": [ "xr9kv-atl", "xr9kv-atl", "xr9kv-atl", "xr9kv-atl" ], "records": [ { "deviceName": "xr9kv-atl", "reportId": "5c35355dbebaa82eaf8113f0", "nodePath": "base", "timestamp": "2019-04-12T14:42:47.958Z", "score": -98409858.83846818, "grade": "pass" } ] }, { "grade": "review", "total": 60269740, "devices": [ "xr9kv-atl", "xr9kv-atl", "xr9kv-atl" ], "records": [ { "deviceName": "xr9kv-atl", "reportId": "5c35355dbebaa82eaf8113f0", "nodePath": "base", "timestamp": "2019-04-12T14:42:47.958Z", "score": 22842089.451115787, "grade": "review" }, { "deviceName": "xr9kv-atl", "reportId": "5c35355dbebaa82eaf8113f0", "nodePath": "base/US East", "timestamp": "2019-04-12T14:42:47.958Z", "score": 21185847.603258386, "grade": "pass" } ] }, { "grade": "pass", "total": 72434630, "devices": [ "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": 60947337.33078411, "grade": "pass" }, { "deviceName": "xr9kv-atl", "reportId": "5c35355dbebaa82eaf8113f0", "nodePath": "base/US East", "timestamp": "2019-04-12T14:42:47.958Z", "score": -85464529.57636665, "grade": "review" }, { "deviceName": "xr9kv-atl", "reportId": "5c35355dbebaa82eaf8113f0", "nodePath": "base/US East/Atlanta", "timestamp": "2019-04-12T14:42:47.958Z", "score": -62805968.13136929, "grade": "fail" }, { "deviceName": "xr9kv-atl", "reportId": "5c35355dbebaa82eaf8113f0", "nodePath": "base/US East", "timestamp": "2019-04-12T14:42:47.958Z", "score": 65620362.52535376, "grade": "review" }, { "deviceName": "xr9kv-atl", "reportId": "5c35355dbebaa82eaf8113f0", "nodePath": "base/US East/Atlanta", "timestamp": "2019-04-12T14:42:47.958Z", "score": 86190573.48410496, "grade": "fail" } ] }, { "grade": "fail", "total": 53070286, "devices": [ "xr9kv-atl" ], "records": [ { "deviceName": "xr9kv-atl", "reportId": "5c35355dbebaa82eaf8113f0", "nodePath": "base/US East", "timestamp": "2019-04-12T14:42:47.958Z", "score": -95920801.46989654, "grade": "review" }, { "deviceName": "xr9kv-atl", "reportId": "5c35355dbebaa82eaf8113f0", "nodePath": "base/US East/Atlanta", "timestamp": "2019-04-12T14:42:47.958Z", "score": 17064391.74629715, "grade": "pass" }, { "deviceName": "xr9kv-atl", "reportId": "5c35355dbebaa82eaf8113f0", "nodePath": "base", "timestamp": "2019-04-12T14:42:47.958Z", "score": 51553016.398344904, "grade": "review" }, { "deviceName": "xr9kv-atl", "reportId": "5c35355dbebaa82eaf8113f0", "nodePath": "base/US East", "timestamp": "2019-04-12T14:42:47.958Z", "score": -27733129.023203015, "grade": "review" }, { "deviceName": "xr9kv-atl", "reportId": "5c35355dbebaa82eaf8113f0", "nodePath": "base/US East", "timestamp": "2019-04-12T14:42:47.958Z", "score": 25445577.365655586, "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" ] } } } } } } }