Get compliance check details

POST

https://example.itential.io/configuration_manager/compliance_reports/details

POST

/configuration_manager/compliance_reports/details

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

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

Get details of a particular set of compliance checks.

Authentication

AuthorizationBasic

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

Request

request body

reportIdslist of stringsOptional

Response

complianceReportsDetail

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

Errors

500

Internal Server Error