Evaluate Compliance Validation Procedure Action

This action is available in API version 63.0 and later.

Special Access Rules

To use this action, you must have the Compliance User permission set.

Supported REST HTTP Methods

URI: /services/data/vXX.X/actions/standard/evalCmplValidationProcedure

Where XX.X is the latest API version.

Formats: JSON, XML

HTTP Methods: POST

Authentication: Authorization: Bearer TOKEN

Where TOKEN is a variable.

Inputs

Outputs

Example

POST

This example shows a sample request for the Evaluate Compliance Validation Procedure action.

1{
2  "inputs": [
3    {
4      "cmplValidationProcedureApiName": "VP",
5      "cmplVldProcedureEvaluationRequest": {
6        "inContextOf": "inContextOf",
7        "transactionKey": "transactionKey",
8        "businessContext": [
9          {
10            "paramName": "accountId",
11            "paramValue": "12345"
12          }
13        ]
14      },
15      "businessOperationsProcess": "BOP1"
16 
17   }
18  ]
19}

This is a sample request to call this invocable action from Apex code.

1public class TestSyncApi {
2
3    public void evaluate() {
4        
5        List<ConnectApi.ComplianceProcedureBusinessContext> bizContextList = new List<ConnectApi.ComplianceProcedureBusinessContext>();
6        ConnectApi.ComplianceProcedureBusinessContext bizContext = new ConnectApi.ComplianceProcedureBusinessContext();
7                bizContext.paramName = 'Acc';
8        bizContext.paramValue = '001xx000003GYiCAAW';
9        ConnectApi.ComplianceProcedureBusinessContext bizContext2 = new ConnectApi.ComplianceProcedureBusinessContext();
10                bizContext2.paramName = 'Con';
11        bizContext2.paramValue = '003xx000004WhFqAAK';
12        bizContextList.add(bizContext);
13        bizContextList.add(bizContext2);
14        
15        String procedureAPIName = 'VP';
16        ConnectApi.ComplianceProcedureEvaluationInfo procInputReq = new ConnectApi.ComplianceProcedureEvaluationInfo();
17        procInputReq.transactionKey = 'someKey';
18            procInputReq.inContextOf = 'a00xx000000boXlAAI';
19        procInputReq.businessContext = bizContextList;
20        
21            List<ConnectApi.ComplianceProcedureEvaluationInfo> inputList = new List<ConnectApi.ComplianceProcedureEvaluationInfo>{procInputReq};
22            ConnectApi.ComplianceProcedureEvaluationRequest input = new ConnectApi.ComplianceProcedureEvaluationRequest();
23            input.evaluations = inputList;
24
25            // Call API
26            ConnectApi.ComplianceProcedureEvaluationResponse response = ConnectApi.IndustriesCompliance.evaluateComplianceProcedure(procedureAPIName, input);
27        System.debug('Response**********' + response);
28    }
29}

This example shows a sample response for the Evaluate Compliance Validation Procedure action.

1{
2      "actionName": "evalCmplValidationProcedure",
3      "errors": null,
4      "invocationId": null,
5      "isSuccess": true,
6      "outcome": null,
7      "outputValues": {
8         "cmplVldProcedureEvaluationResp": {
9            "controls": [
10               {
11                  "complianceControlId": "18Qxx0000004C92EAE",
12                  "complianceControlVersionId": "18txx0000004C92AAE",
13                  "complianceMessage": "This message indicates result is compliant",
14                  "errorId": null,
15                  "errorMessage": null,
16                  "isCompliant": true,
17                  "status": "Success"
18               }
19            ],
20            "errorId": null,
21            "errorMessage": null,
22            "isCompliant": true,
23            "status": "Success",
24            "transactionId": "48aaccbe-5349-4d32-af34-9d4121f7f30c",
25            "transactionKey": "anyKey"
26         }
27      },
28      "sortOrder": -1,
29      "version": 1
30   }