Compliance Control Log Value Input

Input representation of the compliance control logs.

JSON Example 

1[
2  {
3  "controlVersionApiName": "LicenseCheckControl_V1",  // change to controlVersionAPIName
4  "isCompliant": true, // required
5  "inContextOf": "001xx0000ABCDE", // required, its a valid salesforce record
6  "status": "SUCCESS", // required ( Static enum )
7  "evaluationTime": "2022-10-31T09:00:00.594Z", // optional
8  "businessContextAndEvidence": { // optional
9  "clientId": "001Z9000002G3ygIAC",
10  "advisorId": "005xx0000000000001",
11  "productId": "00Pxx0000000000001",
12  "acceptableRisk": "true",
13  "productRisk": "85"
14  },
15  "complianceMessage": "Agent has an active license.", //optional
16  "transactionKey": "txn1234567890abcde", // optional , Customer generated
17  "errorId": "123", // optional
18  "errorMessage": "", // optional
19  "businessOperationsProcessApiName": "0022..." // optional
20  }
21]

Properties 

NameTypeDescriptionRequired or OptionalAvailable Version
businessContext​AndEvidenceMap<String,​ ComplianceLogging​BusinessContext​EvidenceValueInput>JSON object with name-value pairs that store information on the business context and evidence used in the evaluation.
The maximum size for name is 100 characters and maximum size for value is 1024 characters.
Optional64.0
businessOperations​ProcessApiNameStringAPI name of the business operations process.Optional64.0
compliance​MessageStringReason for a control failure or passed compliance. For example, the interest rate exceeds the maximum rate for veterans.
Maximum length is 1024 characters.
Optional64.0
controlVersion​ApiNameStringAPI name of the control version.Required64.0
errorIdStringError related to an evaluation compliance check.Optional64.0
errorMessageStringMessage for an error that occurs during an evaluation compliance check.Optional64.0
evaluationTimeStringTime when the compliance check is done. If no value is specified, the current time is used.Optional64.0
inContextOfStringReference ID (context) for which the control or procedure is used.Required64.0
isCompliantBooleanIndicates whether the control has passed the compliance check.Required64.0
statusStringSpecifies the status of the evaluation check.Required64.0
transactionKeyStringTransaction key to identify the log message.Optional64.0