Impact Analysis Job Status

Output representation of the details of the bulk impact analysis job.

JSON Example

1{
2  "status": "Completed",
3  "totalBatches": 3,
4  "processedBatches": 3,
5  "lastRunTimeStamp": "2026-01-05T15:45:32.000Z",
6  "totalClausesAnalyzed": 12,
7  "successfulClausesCount": 10,
8  "failedClausesCount": 2,
9  "errors": [],
10  "sourceRecordId": "1EiSG00000017U50AI",
11  "selectedClauseVersionIds": [
12    "1Ehxx0000004CAKCA2",
13    "1Ehxx0000004CALCA2",
14    "1Ehxx0000004CAMCA2"
15  ],
16  "selectedTargetObjects": [
17    "CompliancePlcyClauseVersion",
18    "ComplianceControlVersion",
19    "BusinessOperationsProcess"
20  ],
21  "results": {
22    "CompliancePlcyClauseVersion": {
23      "totalResponseCount": 150,
24      "impactedRecords": [
25        {
26          "impactedRecordId": "1Joxx0000004CFUCA2",
27          "impactedBy": ["1Ehxx0000004CAKCA2", "1Ehxx0000004CALCA2"]
28        }
29      ]
30    },
31    "ComplianceControlVersion": {
32      "totalResponseCount": 1,
33      "impactedRecords": [
34        {
35          "impactedRecordId": "18txx0000004CDsAAM",
36          "impactedBy": ["1Ehxx0000004CAMCA2"]
37        }
38      ]
39    },
40    "BusinessOperationsProcess": {
41      "totalResponseCount": 100,
42      "impactedRecords": [
43        {
44          "impactedRecordId": "1Ekxx0000004CCGCA2",
45          "impactedBy": ["1Ehxx0000004CALCA2"]
46        }
47      ]
48    }
49  }
50}

Properties

Property Name	Type	Description	Filter Group and Version	Available Version
`errors`	String[]	Error messages that are encountered during impact analysis.	Big, 67.0	67.0
`failedClausesCount`	Integer	Number of clause versions that failed during analysis.	Big, 67.0	67.0
`lastRunTimeStamp`	String	Date and time indicating when the impact analysis was last run.	Big, 67.0	67.0
`processedBatches`	Integer	Number of batches processed so far. Each batch contains up to five clause versions. This value increases as each batch completes and reaches `totalBatches` when the job is complete.	Big, 67.0	67.0
`results`	Map<String, Impact Analysis Result>	Impact analysis results grouped by target objects. Valid keys are `CompliancePlcyClauseVersion`, `ComplianceControlVersion`, and `BusinessOperationsProcess`. Empty while the job status is `InProgress`. Populated when the status is `Completed`.	Big, 67.0	67.0
`selectedClauseVersionIds`	String[]	IDs of the clause versions that are selected for analysis.	Big, 67.0	67.0
`selectedTargetObjects`	String[]	Target objects that are included in the impact analysis.	Big, 67.0	67.0
`sourceRecordId`	String	ID of the source record, such as a regulation version or policy version record.	Big, 67.0	67.0
`status`	String	Status of the bulk impact analysis job. Valid values are: `NotStarted`—Indicates that the job is not started. `InProgress`—Indicates that the job is still being processed. `Completed`—Indicates that the job has finished and the `results` field is populated. `Failed`—Indicates that the job encountered an error during processing.	Big, 67.0	67.0
`successfulClausesCount`	Integer	Number of clause versions that are successfully analyzed.	Big, 67.0	67.0
`totalBatches`	Integer	Total number of batches created for processing. The value is calculated by grouping clause version IDs into sets of five.	Big, 67.0	67.0
`totalClausesAnalyzed`	Integer	Total number of clause version IDs that are specified for impact analysis.	Big, 67.0	67.0