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": "initial",
"nodePath": "base",
"filter": {
"deviceName": "xr9kv-atl",
"taskId": "5c35355dbebaa82eaf8113f0"
},
"options": {
"weights": {
"error": 1802800.3296584934,
"warning": -44552774.706733935,
"info": -93490093.15097451
},
"limit": 2696225
}
}
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": -3288561.787416145,
"history": [
{
"id": "5c35355dbebaa82eaf8113f0",
"nodePath": "base/US East/Atlanta",
"deviceName": "xr9kv-atl",
"timestamp": "2019-04-12T14:42:47.958Z",
"error": 14695068,
"warning": 51984898,
"info": 82731884,
"pass": 47538914,
"score": 9.836118520137592,
"grade": "pass"
},
{
"id": "5c35355dbebaa82eaf8113f0",
"nodePath": "base/US East/Atlanta",
"deviceName": "xr9kv-atl",
"timestamp": "2019-04-12T14:42:47.958Z",
"error": 38579968,
"warning": 49912306,
"info": 80647282,
"pass": 50119653,
"score": 14.410835742546091,
"grade": "fail"
},
{
"id": "5c35355dbebaa82eaf8113f0",
"nodePath": "base/US East/Atlanta",
"deviceName": "xr9kv-atl",
"timestamp": "2019-04-12T14:42:47.958Z",
"error": 11456484,
"warning": 35701387,
"info": 65881256,
"pass": 72474425,
"score": 91.10039061278053,
"grade": "review"
},
{
"id": "5c35355dbebaa82eaf8113f0",
"nodePath": "base/US East/Atlanta",
"deviceName": "xr9kv-atl",
"timestamp": "2019-04-12T14:42:47.958Z",
"error": 66073326,
"warning": 50973169,
"info": 47409122,
"pass": 12961386,
"score": 29.141481236997734,
"grade": "review"
}
]
}