Promote Field
POST/api/v1/schemas/:source_name/promote-field
Promote JSON path(s) into dedicated typed columns.
Creates a new schema version on the source's meta-schema (or on schema_path
when the source has none), adding one column per path with an @source directive
naming the bare record path, which is what dfe-loader reads to fill the column on
the next ingest. Existing rows are not backfilled. Core meta-schemas are forked to
{source_name}_{schema_stem} under the same parent path before promoting.
?dry_run=true returns the proposed diff and DDL without forking core schemas,
adding meta-schema versions, or updating the source. A core source, such as the
landing source main, is refused with 409 before any schema is resolved or
written, dry run included. Its json-paths and sample-rows reads stay open.
Request
Responses
- 200
- 401
- 403
- 409
- 422
- default
Successful Response
No valid session: the credentials are missing, invalid or expired, or the account behind them is disabled or blocked
Refused: the session lacks the action this route checks, or its account must replace an issued password first. A SCIM route answers a refused action in the RFC 7644 error envelope
The source is a core source the engine owns, such as the landing source main, whose columns no promotion may change (code conflict)
Validation Error
Problem details (RFC 9457)