Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.

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    ]
Property Name Type Description Filter Group and Version Available Version
compliance​ControlId String ID of the compliance control. Big, 65.0 65.0
complianceControl​VersionId String ID of the compliance control version. Big, 65.0 65.0
compliance​Message String Reason a control passes or fails a compliance check. Big, 65.0 65.0
errorId String ID of the error that's associated with the compliance control during evaluation. Big, 65.0 65.0
errorMessage String Message for the error that's associated with the compliance control during evaluation. Big, 65.0 65.0
isCompliant Boolean Indicates whether the control has passed the compliance check (true) or not (false). Big, 65.0 65.0
status String Compliance 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.0 65.0