Grade report

POST

https://example.itential.io/configuration_manager/compliance_reports/grade/single

POST

/configuration_manager/compliance_reports/grade/single

$ curl -X POST https://example.itential.io/configuration_manager/compliance_reports/grade/single \
>      -H "Content-Type: application/json" \
>      -u "<username>:<password>" \
>      -d '{}'

1 {
2   "id": "5c35355dbebaa82eaf8113f0",
3   "batchId": "5c35355dbebaa82eaf8113f0",
4   "treeId": "5c35355dbebaa82eaf8113f0",
5   "version": "initial",
6   "nodePath": "base",
7   "deviceType": "cisco-ios",
8   "specId": "5c35355dbebaa82eaf8113f0",
9   "inheritedSpecIds": [
10     "5c35355dbebaa82eaf8113f0"
11   ],
12   "deviceName": "xr9kv-atl",
13   "variables": [
14     {
15       "name": "variable name",
16       "type": "literal",
17       "value": "variable value"
18     }
19   ],
20   "timestamp": "2019-04-12T14:42:47.958Z",
21   "totals": {
22     "errors": 1,
23     "warnings": 1,
24     "infos": 1,
25     "passes": 1
26   },
27   "issues": [
28     {
29       "severity": "error",
30       "type": "required",
31       "message": "Required config not found",
32       "specLineId": "5c353f69d085d85c",
33       "path": [
34         "interface GigE1"
35       ],
36       "spec": {
37         "id": "5c353f69d085d85c",
38         "evalMode": "required",
39         "severity": "error",
40         "words": [
41           {
42             "type": "literal",
43             "value": "<token from configuration> or <regex pattern> or <variable name>"
44           }
45         ],
46         "lines": [
47           null
48         ]
49       },
50       "configWords": [
51         {
52           "type": null,
53           "value": "word"
54         }
55       ],
56       "candidates": [
57         {
58           "type": null,
59           "value": "word"
60         }
61       ]
62     }
63   ],
64   "score": 1.1,
65   "grade": "pass"
66 }

Get graded compliance report.

Authentication

AuthorizationBasic

Basic authentication of the form Basic <base64(username:password)>.

Request

request body

reportIdstringOptionalformat: "^[0-9a-f]{24}$"

optionsobjectOptional

Response

graded_compliance_report

idstringOptionalformat: "^[0-9a-f]{24}$"

batchIdstringOptionalformat: "^[0-9a-f]{24}$"

treeIdstringOptionalformat: "^[0-9a-f]{24}$"

versionstringOptional

nodePathstringOptional

deviceTypestringOptional

specIdstringOptionalformat: "^[0-9a-f]{24}$"

inheritedSpecIdslist of stringsOptional

deviceNamestringOptional

variableslist of objectsOptional

timestampstringOptionalformat: "\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}.\d{3}Z"

totalsobjectOptional

issueslist of objectsOptional

scoredoubleOptional

gradestringOptional

Errors

500

Internal Server Error