Asynchronously evaluate a compliance validation procedure and create a procedure evaluation job ID.
This action is available in API version 65.0 and later.
To use this action, you must have the Compliance User permission set.
URI: /services/data/vXX.X/actions/standard/evalCmplVldProcedureAsync
Where XX.X is the latest API version.
Formats: JSON, XML
HTTP Methods: POST
Authentication: Authorization: Bearer TOKEN
Where TOKEN is a variable.
| Input | Type | Description |
|---|---|---|
cmplValidationProcedureApiName | string | Required. API name of the compliance validation procedure. |
cmplVldProcedureAsyncEvaluationRequest | Apex-defined | Required. An Apex ConnectApi.ComplianceProcedureEvaluationRequest record that contains the procedure evaluation API request. |
| Output | Type | Description |
|---|---|---|
complianceAsyncEvaluationJobId | string | ID of the asynchronous compliance evaluation job that’s created. |
This example shows a sample request for the Evaluate Compliance Validation Procedure Asynchronous action.
1{
2 "inputs": [
3 {
4 "cmplValidationProcedureApiName": "SenthilApexValidation",
5 "cmplVldProcedureAsyncEvaluationRequest": {
6 "evaluations": [
7 {
8 "inContextOf": "inContextOf1",
9 "transactionKey": "transactionKey1",
10 "businessContext": [
11 {
12 "paramName": "Param",
13 "paramValue": "001SG00000kGZNWYA4"
14 }
15 ]
16 }
17 ],
18 "businessOperationsProcess": "SenthilBusinessProcess"
19 }
20 }
21 ]
22}This is a sample request to call this invocable action from Apex code.
1public class EvaluationAsync {
2 public void evaluationAsync() {
3 List<ConnectApi.ComplianceProcedureBusinessContext> bizContextList =
4 new List<ConnectApi.ComplianceProcedureBusinessContext>();
5
6 ConnectApi.ComplianceProcedureBusinessContext bizContext =
7 new ConnectApi.ComplianceProcedureBusinessContext();
8 bizContext.paramName = 'Acc';
9 bizContext.paramValue = '001xx000003GYiCAAW';
10
11 ConnectApi.ComplianceProcedureBusinessContext bizContext2 =
12 new ConnectApi.ComplianceProcedureBusinessContext();
13 bizContext2.paramName = 'Con';
14 bizContext2.paramValue = '003xx000004WhFqAAK';
15 bizContextList.add(bizContext);
16 bizContextList.add(bizContext2);
17
18 String procedureAPIName = 'VP';
19 ConnectApi.ComplianceProcedureEvaluationInfo procInputReq =
20 new ConnectApi.ComplianceProcedureEvaluationInfo();
21 procInputReq.transactionKey = 'someKey';
22 procInputReq.inContextOf = 'a00xx000000boXlAAI';
23 procInputReq.businessContext = bizContextList;
24
25 List<ConnectApi.ComplianceProcedureEvaluationInfo> inputList =
26 new List<ConnectApi.ComplianceProcedureEvaluationInfo>{procInputReq};
27 ConnectApi.ComplianceProcedureEvaluationRequest input =
28 new ConnectApi.ComplianceProcedureEvaluationRequest();
29 input.evaluations = inputList;
30
31 // Call API
32 ConnectApi.ComplianceProcedureAsyncEvaluationRepresentation response =
33 ConnectApi
34 .IndustriesCompliance
35 .evaluateComplianceProcedureAsync(procedureAPIName, input);
36 System.debug('Response**********' + response);
37 }
38}
39
40// Execute the method
41EvaluationAsync evaluationAsync = new EvaluationAsync();
42evaluationAsync.evaluationAsync();
43
44public class JobStatus {
45 public void getJobStatus() {
46 String jobId = '<JOB ID>';
47 Integer pageSize = 10;
48 Integer offset = 0;
49
50 // Call API
51 ConnectApi.ComplianceJobStatusRepresentation response =
52 ConnectApi.IndustriesCompliance.getComplianceJobResults(jobId, pageSize,
53 offset);
54 System.debug('Response**********' + response);
55 }
56}
57
58// Execute the method
59JobStatus jobStatus = new JobStatus();
60jobStatus.getJobStatus();This example shows a sample response for the Evaluate Compliance Validation Procedure Asynchronous action.
1{
2 "actionName": "retrieveCmplAsyncEvalJobDtl",
3 "errors": null,
4 "invocationId": null,
5 "isSuccess": true,
6 "outcome": null,
7 "outputValues": {
8 "complianceAsyncEvaluationJobId": "1VUSG000000N4J3"
9 },
10 "sortOrder": -1,
11 "version": 1
12}
j