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": "draft-v4",
"nodePath": "base/US East",
"filter": {
"deviceName": "xr9kv-atl",
"taskId": "5c35355dbebaa82eaf8113f0"
},
"options": {
"weights": {
"error": -89260578.74742535,
"warning": 15103847.769747376,
"info": 9658195.331096038
},
"limit": 20471570
}
}
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": -58642193.60356846,
"history": [
{
"id": "5c35355dbebaa82eaf8113f0",
"nodePath": "base/US East/Atlanta",
"deviceName": "xr9kv-atl",
"timestamp": "2019-04-12T14:42:47.958Z",
"error": 3125312,
"warning": 7205835,
"info": 95627010,
"pass": 69975154,
"score": 38.18246304646698,
"grade": "pass"
},
{
"id": "5c35355dbebaa82eaf8113f0",
"nodePath": "base/US East/Atlanta",
"deviceName": "xr9kv-atl",
"timestamp": "2019-04-12T14:42:47.958Z",
"error": 74323558,
"warning": 60115138,
"info": 46051828,
"pass": 73214106,
"score": 72.98050468634297,
"grade": "pass"
},
{
"id": "5c35355dbebaa82eaf8113f0",
"nodePath": "base/US East/Atlanta",
"deviceName": "xr9kv-atl",
"timestamp": "2019-04-12T14:42:47.958Z",
"error": 42979828,
"warning": 5753921,
"info": 596301,
"pass": 21205463,
"score": 15.712477265096947,
"grade": "fail"
}
]
}