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",
"filter": {
"deviceName": "xr9kv-atl",
"taskId": "5c35355dbebaa82eaf8113f0"
},
"options": {
"weights": {
"error": -98080543.0778247,
"warning": -93626232.5975335,
"info": 74103405.46842894
},
"limit": 51396315
}
}
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": -98615659.4631669,
"history": [
{
"id": "5c35355dbebaa82eaf8113f0",
"nodePath": "base/US East/Atlanta",
"deviceName": "xr9kv-atl",
"timestamp": "2019-04-12T14:42:47.958Z",
"error": 61940318,
"warning": 52771179,
"info": 16127464,
"pass": 19342082,
"score": 36.605353128555684,
"grade": "review"
},
{
"id": "5c35355dbebaa82eaf8113f0",
"nodePath": "base/US East/Atlanta",
"deviceName": "xr9kv-atl",
"timestamp": "2019-04-12T14:42:47.958Z",
"error": 32983058,
"warning": 42289978,
"info": 28763506,
"pass": 45588874,
"score": 96.1713823606606,
"grade": "pass"
},
{
"id": "5c35355dbebaa82eaf8113f0",
"nodePath": "base/US East/Atlanta",
"deviceName": "xr9kv-atl",
"timestamp": "2019-04-12T14:42:47.958Z",
"error": 4890746,
"warning": 97041735,
"info": 90221060,
"pass": 30321865,
"score": 77.74692912092507,
"grade": "fail"
},
{
"id": "5c35355dbebaa82eaf8113f0",
"nodePath": "base/US East/Atlanta",
"deviceName": "xr9kv-atl",
"timestamp": "2019-04-12T14:42:47.958Z",
"error": 42551797,
"warning": 52683664,
"info": 90746304,
"pass": 44422276,
"score": 24.371628766376553,
"grade": "pass"
},
{
"id": "5c35355dbebaa82eaf8113f0",
"nodePath": "base/US East/Atlanta",
"deviceName": "xr9kv-atl",
"timestamp": "2019-04-12T14:42:47.958Z",
"error": 42377571,
"warning": 92481647,
"info": 10884782,
"pass": 42521753,
"score": 99.41013823512486,
"grade": "pass"
}
]
}