Impact Analysis (POST)

Resource

1/connect/compliance/impact-analysis

Resource example

1https://yourInstance.salesforce.com/services/data/v67.0/connect/compliance/impact-analysis

Available version

67.0

HTTP methods

POST

Request body for POST

JSON example

1{
2  "sourceRecordId": "1Eiv00000000PP2AAO",
3  "selectedClauseVersionIds": [
4    "1G500000000AA2AAO",
5    "1G500000000AA3AAO"
6  ],
7  "selectedTargetObjects": [
8    "CompliancePlcyClauseVersion",
9    "ComplianceControlVersion",
10    "BusinessOperationsProcess"
11  ]
12}

Properties

Name	Type	Description	Required or Optional	Available Version
selected​Clause​Version​Ids	String[]	IDs of the clause versions to analyze for impact. The clause versions must be active and associated with the specified source record, such as a regulation version or policy version record. The analysis runs only on the specified clause versions, even if the source record has additional active clause versions. The clause version IDs are processed in batches of five. For example, if 10 clause version IDs are specified, the API processes the impact analysis in two batches.	Required	67.0
selected​Target​Objects	String[]	Types of records to find impacted results for. Valid values depend on the type of source record that's specified in sourceRecordId: If the source record is a regulation version, valid values for this parameter are ComplianceControlVersion, BusinessOperationsProcess, and CompliancePlcyClauseVersion. If the source record is a policy version, valid values for this parameter are ComplianceControlVersion and BusinessOperationsProcess.	Required	67.0
sourceRecordId	String	ID of the regulation version or policy version record on which you want to perform impact analysis. The clause versions specified in selectedClauseVersionIds must be associated with this record.	Required	67.0

Response body for POST

Bulk Impact Analysis Async Response

Because impact analysis runs asynchronously, use sourceRecordId with the Impact Analysis Results resource to check the job status and retrieve results after the job is complete.