Summary
Run Compliance Report
Description
Begin a compliance report run for a device.
Route
No Northbound API Available
Roles
admin
apiread
Parameters
DetailsExampleSchema
| Name |
Type |
Required |
Description |
| treeId |
string |
yes |
- |
| version |
string |
yes |
- |
| deviceName |
string |
yes |
- |
| variables |
object |
no |
- |
| grading |
object |
no |
- |
Copied to Clipboard
{
"treeId": "5c35355dbebaa82eaf8113f0",
"version": "v3",
"deviceName": "xr9kv-atl",
"grading": {
"weights": {
"error": -85668839.48859227,
"warning": -36506369.75701542,
"info": -60384034.83783554
}
}
}
Copied to Clipboard
{
"type": "object",
"properties": {
"treeId": {
"title": "treeId",
"$ref": "common#/definitions/mongoObjectId"
},
"version": {
"title": "version",
"$ref": "goldenConfigData#/definitions/goldenConfigTreeVersionName"
},
"deviceName": {
"title": "deviceName",
"$ref": "deviceData#/definitions/deviceName"
},
"variables": {
"title": "variables",
"$ref": "goldenConfigData#/definitions/goldenConfigVariables"
},
"grading": {
"title": "grading",
"$ref": "goldenConfigData#/definitions/reportGradingOptions"
}
},
"required": [
"treeId",
"version",
"deviceName"
],
"additionalProperties": false
}
Return
DetailsExampleSchema
| Name |
Type |
Description |
| runComplianceBatchResult |
object |
- |
Copied to Clipboard
{
"status": 202,
"message": "compliance batch ${batchId} started",
"batchId": "5c35355dbebaa82eaf8113f0",
"reports": [
{
"reportId": "5c35355dbebaa82eaf8113f0",
"device": "xr9kv-atl",
"score": 20.67524198899793,
"grade": "fail"
},
{
"reportId": "5c35355dbebaa82eaf8113f0",
"device": "xr9kv-atl",
"score": 14.803020833307245,
"grade": "fail"
},
{
"reportId": "5c35355dbebaa82eaf8113f0",
"device": "xr9kv-atl",
"score": 20.54167622472345,
"grade": "fail"
},
{
"reportId": "5c35355dbebaa82eaf8113f0",
"device": "xr9kv-atl",
"score": 82.34553138056107,
"grade": "review"
},
{
"reportId": "5c35355dbebaa82eaf8113f0",
"device": "xr9kv-atl",
"score": 23.034925345802492,
"grade": "fail"
}
]
}
Copied to Clipboard
{
"title": "runComplianceBatchResult",
"type": "object",
"properties": {
"status": {
"type": "integer",
"const": 202
},
"message": {
"type": "string",
"examples": [
"compliance batch ${batchId} started"
]
},
"batchId": {
"$ref": "common#/definitions/mongoObjectId"
},
"reports": {
"type": "array",
"items": {
"type": "object",
"properties": {
"reportId": {
"$ref": "common#/definitions/mongoObjectId"
},
"device": {
"$ref": "deviceData#/definitions/deviceName"
},
"score": {
"type": "number",
"minimum": 0,
"maximum": 100
},
"grade": {
"type": "string",
"examples": [
"pass",
"fail",
"review"
]
}
}
}
}
}
}
