Summary
Run Compliance Reports.
Description
Begin a compliance report run for a device group.
Route
No Northbound API Available
Roles
admin
apiread
Parameters
DetailsExampleSchema
| Name |
Type |
Required |
Description |
| treeId |
string |
yes |
- |
| version |
string |
yes |
- |
| deviceGroupId |
string |
yes |
- |
| variables |
object |
no |
- |
| grading |
object |
no |
- |
Copied to Clipboard
{
"treeId": "5c35355dbebaa82eaf8113f0",
"version": "v3",
"deviceGroupId": "5c35355dbebaa82eaf8113f0",
"variables": [
{
"name": "variable name",
"type": "regex",
"value": "variable value"
},
{
"name": "variable name",
"type": "regex",
"value": "variable value"
},
{
"name": "variable name",
"type": "regex",
"value": "variable value"
},
{
"name": "variable name",
"type": "regex",
"value": "variable value"
},
{
"name": "variable name",
"type": "regex",
"value": "variable value"
}
],
"grading": {
"weights": {
"error": 6299835.89245446,
"warning": -87978103.33744524,
"info": -65101894.82411115
}
}
}
Copied to Clipboard
{
"type": "object",
"properties": {
"treeId": {
"title": "treeId",
"$ref": "common#/definitions/mongoObjectId"
},
"version": {
"title": "version",
"$ref": "goldenConfigData#/definitions/goldenConfigTreeVersionName"
},
"deviceGroupId": {
"title": "deviceGroupId",
"$ref": "common#/definitions/mongoObjectId"
},
"variables": {
"title": "variables",
"$ref": "goldenConfigData#/definitions/goldenConfigVariables"
},
"grading": {
"title": "grading",
"$ref": "goldenConfigData#/definitions/reportGradingOptions"
}
},
"required": [
"treeId",
"version",
"deviceGroupId"
],
"additionalProperties": false
}
Return
DetailsExampleSchema
| Name |
Type |
Description |
| runComplianceBatchResult |
object |
- |
Copied to Clipboard
{
"status": 202,
"message": "compliance batch ${batchId} completed",
"batchId": "5c35355dbebaa82eaf8113f0",
"reports": [
{
"reportId": "5c35355dbebaa82eaf8113f0",
"device": "xr9kv-atl",
"score": 47.78302950415896,
"grade": "pass"
},
{
"reportId": "5c35355dbebaa82eaf8113f0",
"device": "xr9kv-atl",
"score": 12.670105994312198,
"grade": "pass"
},
{
"reportId": "5c35355dbebaa82eaf8113f0",
"device": "xr9kv-atl",
"score": 94.27504064005059,
"grade": "review"
},
{
"reportId": "5c35355dbebaa82eaf8113f0",
"device": "xr9kv-atl",
"score": 8.999314320714348,
"grade": "fail"
},
{
"reportId": "5c35355dbebaa82eaf8113f0",
"device": "xr9kv-atl",
"score": 2.828205903513892,
"grade": "review"
}
]
}
Copied to Clipboard
{
"title": "runComplianceBatchResult",
"type": "object",
"properties": {
"status": {
"type": "integer",
"const": 202
},
"message": {
"type": "string",
"examples": [
"compliance batch ${batchId} completed"
]
},
"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"
]
}
}
}
}
}
}
