Summary
Get historical graded compliance reports with pagination support.
Description
Get historical graded compliance reports for a device on a node with pagination support.
Route
POST /configuration_manager/compliance_reports/query/history
Roles
admin
apiwrite
Parameters
DetailsExampleSchema
Name |
Type |
Required |
Description |
treeId |
string |
yes |
- |
version |
string |
yes |
- |
nodePath |
string |
yes |
- |
filter |
object |
yes |
- |
options |
object |
yes |
- |
Copied to Clipboard
{
"treeId": "5c35355dbebaa82eaf8113f0",
"version": "v3",
"nodePath": "base/US East/Atlanta",
"filter": {
"deviceName": "xr9kv-atl",
"taskId": "5c35355dbebaa82eaf8113f0"
},
"options": {
"weights": {
"error": -31846356.743428797,
"warning": -36836997.41334166,
"info": 40153367.36372471
},
"limit": 57411214
}
}
Copied to Clipboard
{
"type": "object",
"properties": {
"treeId": {
"title": "treeId",
"$ref": "common#/definitions/mongoObjectId"
},
"version": {
"title": "version",
"$ref": "goldenConfigData#/definitions/goldenConfigTreeVersionName"
},
"nodePath": {
"title": "nodePath",
"$ref": "goldenConfigData#/definitions/goldenConfigNodePath"
},
"filter": {
"title": "filter",
"properties": {
"deviceName": {
"$ref": "deviceData#/definitions/deviceName"
},
"taskId": {
"$ref": "common#/definitions/mongoObjectId"
}
}
},
"options": {
"title": "options",
"$ref": "goldenConfigData#/definitions/gradeDeviceComplianceHistoryOptions"
}
},
"required": [
"treeId",
"version",
"nodePath",
"filter",
"options"
],
"additionalProperties": false
}
Return
DetailsExampleSchema
Name |
Type |
Description |
graded_compliance_history |
object |
- |
Copied to Clipboard
{
"total": 86203048.54608572,
"history": [
{
"id": "5c35355dbebaa82eaf8113f0",
"nodePath": "base/US East/Atlanta",
"deviceName": "xr9kv-atl",
"timestamp": "2019-04-12T14:42:47.958Z",
"error": 29219280,
"warning": 39631781,
"info": 97684771,
"pass": 8213645,
"score": 42.601410404907995,
"grade": "review"
},
{
"id": "5c35355dbebaa82eaf8113f0",
"nodePath": "base/US East/Atlanta",
"deviceName": "xr9kv-atl",
"timestamp": "2019-04-12T14:42:47.958Z",
"error": 44705182,
"warning": 27200896,
"info": 49831768,
"pass": 16535187,
"score": 45.43466496514432,
"grade": "fail"
},
{
"id": "5c35355dbebaa82eaf8113f0",
"nodePath": "base/US East/Atlanta",
"deviceName": "xr9kv-atl",
"timestamp": "2019-04-12T14:42:47.958Z",
"error": 74120229,
"warning": 66089745,
"info": 18104925,
"pass": 79058985,
"score": 64.40501250238297,
"grade": "pass"
},
{
"id": "5c35355dbebaa82eaf8113f0",
"nodePath": "base/US East/Atlanta",
"deviceName": "xr9kv-atl",
"timestamp": "2019-04-12T14:42:47.958Z",
"error": 85405783,
"warning": 46613458,
"info": 54384171,
"pass": 11181568,
"score": 38.735919405273634,
"grade": "review"
},
{
"id": "5c35355dbebaa82eaf8113f0",
"nodePath": "base/US East/Atlanta",
"deviceName": "xr9kv-atl",
"timestamp": "2019-04-12T14:42:47.958Z",
"error": 17294355,
"warning": 53814998,
"info": 55022608,
"pass": 75091997,
"score": 38.15185799820324,
"grade": "pass"
}
]
}