Skip to content
AveraAveraAvera Documentation

Analyze the impact of a change request's staged changes

POST
/api/v1/projects/{projectId}/schema/sandboxes/{sandboxId}/analyze
curl --request POST \
  --url https://app.avera.io/api/v1/projects/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/schema/sandboxes/example/analyze

Runs verification and impact analysis over the staged changes and reports whether the change request can be promoted. Promotion re-runs the same analysis.

Parameters

Section titled “Parameters”

Path Parameters

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

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media type*/*
object
sandboxId
required
string
overallRisk
required
string
Allowed values: NONE LOW MEDIUM HIGH CRITICAL
canMerge
required
boolean
changes
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>
warnings
required
Array<string>
blockers
required
Array<string>