Get a column by FQN

Get a specific column by its fully qualified name (FQN).

The FQN format is: service.database.schema.table.column Example: PostgreSQL.dvdrental.public.customer.email

Args: fqn: Fully qualified name of the column. ctx: Request context for authentication. service: Data assets service instance.

Returns: Column domain model.

Raises: HTTPException: 404 if column not found.

GET /api/data-readiness/data-assets/columns/by-fqn

Get a column by FQN

cURL

curl --request GET \
  --url https://api.example.com/api/data-readiness/data-assets/columns/by-fqn \
  --header 'Authorization: Bearer <token>'

200

{
  "name": "<string>",
  "id": "<string>",
  "fqn": "<string>",
  "data_type": "<string>",
  "description": "<string>",
  "display_name": "<string>",
  "data_type_display": "<string>",
  "business_rules": "<string>",
  "business_definition": "<string>",
  "constraint": {},
  "column_relationships": [
    {}
  ],
  "tags": [
    {}
  ],
  "data_quality": [
    {}
  ]
}

Authorizations

Authorization · string · header · required

JWT Bearer token authentication. Include the token in the Authorization header as: Authorization: Bearer <token>. The JWT must contain valid client_id, and project_id claims for tenant isolation and SDK routing.

Query Parameters

fqn · string · required

Fully qualified name of the column (e.g., service.database.schema.table.column)

Minimum string length: 1

Response

200

application/json

Successful Response

Column domain model for API responses and requests.

Clean DTO representing a table column with comprehensive technical and business metadata. Supports business context enrichment through business_rules and business_definition fields. Used for nested column creation within tables.

name · string · required

Column name

id · string | null

Unique column identifier (UUID)

fqn · string | null

Fully qualified name

data_type · string | null

SQL data type (e.g., VARCHAR(255), INTEGER, NUMERIC(15,2))

description · string | null

Technical description of the column

display_name · string | null

User-friendly display name

data_type_display · string | null

Human-readable data type description

business_rules · string | null

Business rules governing this column (max 1000 chars)

business_definition · string | null

Business meaning and purpose (max 1000 chars)

constraint · Constraint · object

Column constraint as structured JSONB (constraintType, referenceTable, etc.)

column_relationships · Column Relationships · object[] | null

Relationships to other columns (FK references, etc.)

tags · Tags · object[] | null

List of tag dicts with tagFQN, name, justification, etc.

data_quality · Data Quality · object[] | null

DQ tags with nested rules and execution results