Skip to content
AveraAveraAvera Documentation

Preview the impact of accepting a proposal batch

GET
/api/v1/projects/{projectId}/config-actions/batches/{batchId}/preview
curl --request GET \
  --url https://app.avera.io/api/v1/projects/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/config-actions/batches/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/preview

The mandatory impact preview is a real dry run: the batch is staged into its change request, analyzed by the same machinery promotion re-runs, and rolled back. Accepting is refused until the accepting surface confirms this preview was seen.

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
projectId
required
string format: uuid
batchId
required
string format: uuid

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media type*/*
object
batchId
required
string format: uuid
changeRequestId
required
string
actions
required
Array<object>
object
actionId
required
string format: uuid
type
required
string
Allowed values: ITEM_TYPE_CREATE ITEM_TYPE_EDIT ITEM_TYPE_RETIRE ITEM_TYPE_CATEGORY_CREATE ITEM_TYPE_CATEGORY_EDIT ITEM_TYPE_CATEGORY_DELETE ATTRIBUTE_DEFINITION_CREATE ATTRIBUTE_DEFINITION_EDIT ATTRIBUTE_DEFINITION_RETIRE ATTRIBUTE_ASSIGNMENT_ADD ATTRIBUTE_ASSIGNMENT_EDIT ATTRIBUTE_ASSIGNMENT_REMOVE RELATIONSHIP_TYPE_CREATE RELATIONSHIP_TYPE_EDIT RELATIONSHIP_TYPE_RETIRE LIFECYCLE_CREATE LIFECYCLE_EDIT LIFECYCLE_DELETE ROLE_DEFINITION_CREATE ROLE_DEFINITION_EDIT ROLE_DEFINITION_DELETE PERMISSION_RULE_CREATE PERMISSION_RULE_EDIT PERMISSION_RULE_DELETE FORM_LAYOUT_CREATE FORM_LAYOUT_EDIT FORM_LAYOUT_DELETE
targetType
required
string
targetId
string | null
impacts
required
Array<object>
object
changeId
required
string
changeType
required
string
Allowed values: CREATE_RELATIONSHIP_TYPE MODIFY_RELATIONSHIP_TYPE DELETE_RELATIONSHIP_TYPE CREATE_ITEM_TYPE MODIFY_ITEM_TYPE ARCHIVE_ITEM_TYPE RESTORE_ITEM_TYPE CREATE_ITEM_TYPE_CATEGORY MODIFY_ITEM_TYPE_CATEGORY DELETE_ITEM_TYPE_CATEGORY CREATE_ATTRIBUTE MODIFY_ATTRIBUTE RENAME_ATTRIBUTE DELETE_ATTRIBUTE REORDER_ATTRIBUTES ASSIGN_ITEM_TYPE_ATTRIBUTE MODIFY_ITEM_TYPE_ATTRIBUTE UNASSIGN_ITEM_TYPE_ATTRIBUTE CREATE_WORKFLOW MODIFY_WORKFLOW DELETE_WORKFLOW CREATE_WORKFLOW_STATE MODIFY_WORKFLOW_STATE DELETE_WORKFLOW_STATE CREATE_WORKFLOW_TRANSITION MODIFY_WORKFLOW_TRANSITION DELETE_WORKFLOW_TRANSITION CREATE_VALIDATION_RULE MODIFY_VALIDATION_RULE DELETE_VALIDATION_RULE CREATE_FORM_LAYOUT MODIFY_FORM_LAYOUT DELETE_FORM_LAYOUT CREATE_SIGNATURE_POLICY MODIFY_SIGNATURE_POLICY DELETE_SIGNATURE_POLICY CREATE_ROLE MODIFY_ROLE DELETE_ROLE CREATE_PERMISSION_RULE MODIFY_PERMISSION_RULE DELETE_PERMISSION_RULE
targetName
required
string
riskLevel
required
string
Allowed values: NONE LOW MEDIUM HIGH CRITICAL
requiresMigration
required
boolean
breakingChange
required
boolean
affectedItemCount
required
integer format: int32
affectedRelationshipCount
required
integer format: int32
affectedByBranch
required
Array<object>
object
branchId
required
string
branchName
required
string
branchIsMain
required
boolean
itemCount
required
integer format: int32
relationshipCount
required
integer format: int32
warnings
required
Array<string>
blockers
required
Array<string>
aiActionsAffected
required
Array<string>
notes
required
Array<string>
blockers
required
Array<string>
overallRisk
required
string
Allowed values: NONE LOW MEDIUM HIGH CRITICAL
canMergeAfterAccept
required
boolean
generalWarnings
required
Array<string>
generalBlockers
required
Array<string>