Skip to main content

Change Requests API

Change request management with impact analysis, quality validation, and field-level lineage tracing.

Endpoints Overview

MethodEndpointDescription
POST/products/{pid}/change-requestsCreate change request
GET/products/{pid}/change-requestsList product change requests
POST/products/{pid}/change-requests/{id}/transitionTransition status
POST/products/{pid}/change-requests/{id}/validateRe-run quality checks
GET/products/{pid}/impact-previewPreview impact analysis
GET/products/{pid}/field-downstream-usageField downstream usage
GET/products/{pid}/field-upstream-sourcesField upstream sources
GET/products/{pid}/fields/{fid}/quality-checksField quality checks
POST/products/{pid}/ai-impact-assessmentAI impact assessment

Create Change Request

POST /products/{product_id}/change-requests

Automatically performs impact analysis and creates notifications for downstream owners.

{
"title": "Add email validation column",
"description": "Adding a derived column for email format validation",
"change_type": "schema_change",
"proposed_schema": { "columns": [...] },
"target_date": "2026-03-15T00:00:00Z"
}

Transition Status

POST /products/{product_id}/change-requests/{request_id}/transition
{
"status": "approved"
}

Valid transitions:

  • pendingunder_review | cancelled
  • under_reviewapproved | rejected | cancelled
  • approvedimplemented | cancelled

Preview Impact Analysis

GET /products/{product_id}/impact-preview

Returns downstream products, affected owners, impacted contracts, and breaking change assessment.


AI Impact Assessment

POST /products/{product_id}/ai-impact-assessment

Generates an AI-powered impact assessment including risk level, business impact, and affected downstream products.


Error Responses

StatusDescription
400Invalid state transition
404Product or change request not found