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
admin
apiwrite
Parameters
DetailsExampleSchema
Name |
Type |
Required |
Description |
treeId |
string |
yes |
- |
version |
string |
yes |
- |
options |
object |
yes |
- |
Copied to Clipboard
{
"treeId": "5c35355dbebaa82eaf8113f0",
"version": "draft-v4",
"options": {
"weights": {
"error": -16906712.46254833,
"warning": 4584088.125152469,
"info": -76859879.51321112
},
"nodePath": "base"
}
}
Copied to Clipboard
{
"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
DetailsExampleSchema
Name |
Type |
Description |
graded_compliance_reports |
object |
- |
Copied to Clipboard
[
{
"grade": "pass",
"total": 25234078,
"devices": [
"xr9kv-atl"
],
"records": [
{
"deviceName": "xr9kv-atl",
"reportId": "5c35355dbebaa82eaf8113f0",
"nodePath": "base",
"timestamp": "2019-04-12T14:42:47.958Z",
"score": -62191398.26476474,
"grade": "pass"
},
{
"deviceName": "xr9kv-atl",
"reportId": "5c35355dbebaa82eaf8113f0",
"nodePath": "base/US East/Atlanta",
"timestamp": "2019-04-12T14:42:47.958Z",
"score": 94378263.90709856,
"grade": "fail"
}
]
},
{
"grade": "fail",
"total": 88536337,
"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": 80938171.10460088,
"grade": "pass"
},
{
"deviceName": "xr9kv-atl",
"reportId": "5c35355dbebaa82eaf8113f0",
"nodePath": "base/US East",
"timestamp": "2019-04-12T14:42:47.958Z",
"score": -51653282.3557518,
"grade": "fail"
},
{
"deviceName": "xr9kv-atl",
"reportId": "5c35355dbebaa82eaf8113f0",
"nodePath": "base/US East/Atlanta",
"timestamp": "2019-04-12T14:42:47.958Z",
"score": 91541156.63528949,
"grade": "fail"
},
{
"deviceName": "xr9kv-atl",
"reportId": "5c35355dbebaa82eaf8113f0",
"nodePath": "base/US East",
"timestamp": "2019-04-12T14:42:47.958Z",
"score": 321255.0685085058,
"grade": "fail"
},
{
"deviceName": "xr9kv-atl",
"reportId": "5c35355dbebaa82eaf8113f0",
"nodePath": "base/US East",
"timestamp": "2019-04-12T14:42:47.958Z",
"score": 97926358.76498905,
"grade": "fail"
}
]
},
{
"grade": "fail",
"total": 30506703,
"devices": [
"xr9kv-atl",
"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": 68906304.53679603,
"grade": "review"
}
]
},
{
"grade": "fail",
"total": 69370441,
"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": -16274071.603176668,
"grade": "review"
},
{
"deviceName": "xr9kv-atl",
"reportId": "5c35355dbebaa82eaf8113f0",
"nodePath": "base/US East",
"timestamp": "2019-04-12T14:42:47.958Z",
"score": -53384414.667534985,
"grade": "fail"
},
{
"deviceName": "xr9kv-atl",
"reportId": "5c35355dbebaa82eaf8113f0",
"nodePath": "base",
"timestamp": "2019-04-12T14:42:47.958Z",
"score": 33192714.62297602,
"grade": "pass"
}
]
}
]
Copied to Clipboard
{
"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"
]
}
}
}
}
}
}
}