Compliance Control Evaluation

Output representation details of a compliance control evaluation.

JSON Example 

1[
2      {
3        "complianceControlId": "18QXX0001234501",
4        "complianceControlVersionId": "18tXX0001234501",
5        "status": "SUCCESS",
6        "isCompliant": true,
7        "complianceMessage": "Control A passed",
8        "errorId": [],
9        "errorMessage": []
10      }
11    ]

Properties 

Property NameTypeDescriptionFilter Group and VersionAvailable Version
compliance​ControlIdStringID of the compliance control.Big, 65.065.0
complianceControl​VersionIdStringID of the compliance control version.Big, 65.065.0
compliance​MessageStringReason a control passes or fails a compliance check.Big, 65.065.0
errorIdStringID of the error that’s associated with the compliance control during evaluation.Big, 65.065.0
errorMessageStringMessage for the error that’s associated with the compliance control during evaluation.Big, 65.065.0
isCompliantBooleanIndicates whether the control has passed the compliance check (true) or not (false).Big, 65.065.0
statusStringCompliance control status. Valid values are:
  • Error
  • Skipped—If a compliance control version is in Retired state, the API ignores the control during the compliance evaluation request.
  • Success
Big, 65.065.0