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": "v3",
"options": {
"weights": {
"error": -83060545.70227897,
"warning": 99769576.80103636,
"info": 69279794.64786848
},
"nodePath": "base/US East/Atlanta"
}
}
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": 33681478,
"devices": [
"xr9kv-atl"
],
"records": [
{
"deviceName": "xr9kv-atl",
"reportId": "5c35355dbebaa82eaf8113f0",
"nodePath": "base/US East/Atlanta",
"timestamp": "2019-04-12T14:42:47.958Z",
"score": 32396185.435356945,
"grade": "pass"
},
{
"deviceName": "xr9kv-atl",
"reportId": "5c35355dbebaa82eaf8113f0",
"nodePath": "base",
"timestamp": "2019-04-12T14:42:47.958Z",
"score": -53010663.19530552,
"grade": "fail"
},
{
"deviceName": "xr9kv-atl",
"reportId": "5c35355dbebaa82eaf8113f0",
"nodePath": "base",
"timestamp": "2019-04-12T14:42:47.958Z",
"score": 76561641.46220124,
"grade": "pass"
}
]
},
{
"grade": "fail",
"total": 29587769,
"devices": [
"xr9kv-atl"
],
"records": [
{
"deviceName": "xr9kv-atl",
"reportId": "5c35355dbebaa82eaf8113f0",
"nodePath": "base/US East",
"timestamp": "2019-04-12T14:42:47.958Z",
"score": 97430602.60617623,
"grade": "review"
}
]
},
{
"grade": "fail",
"total": 25700954,
"devices": [
"xr9kv-atl",
"xr9kv-atl",
"xr9kv-atl"
],
"records": [
{
"deviceName": "xr9kv-atl",
"reportId": "5c35355dbebaa82eaf8113f0",
"nodePath": "base/US East",
"timestamp": "2019-04-12T14:42:47.958Z",
"score": 85493709.09586424,
"grade": "review"
},
{
"deviceName": "xr9kv-atl",
"reportId": "5c35355dbebaa82eaf8113f0",
"nodePath": "base/US East",
"timestamp": "2019-04-12T14:42:47.958Z",
"score": 27870153.63882999,
"grade": "review"
},
{
"deviceName": "xr9kv-atl",
"reportId": "5c35355dbebaa82eaf8113f0",
"nodePath": "base/US East/Atlanta",
"timestamp": "2019-04-12T14:42:47.958Z",
"score": -3426713.77133739,
"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"
]
}
}
}
}
}
}
}