Get a schema by FQN

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

The FQN format is: service.database.schema Example: PostgreSQL.dvdrental.public

Args: fqn: Fully qualified name of the schema. ctx: Request context for authentication. service: Data assets service instance. workflow_asset_service: Workflow asset integration service instance. profile_service: Profile service for fetching profile data. include_tables: Whether to include tables in the schema (default: true). include_pending_workflow: Whether to include pending workflow info (default: false). include_profile: Whether to include profile summary per table (default: false). search: Filter tables by name or description (case-insensitive). Only applied when include_tables=true.

Returns: Schema domain model with tables if requested, SchemaWithProfileResponse if include_profile is true, or SchemaWithWorkflowResponse if include_pending_workflow is true.

Raises: HTTPException: 404 if schema not found.

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

Get a schema by FQN

cURL

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

200

{
  "name": "<string>",
  "fqn": "<string>",
  "id": "<string>",
  "description": "<string>",
  "owners": [
    "<string>"
  ],
  "tags": [
    {}
  ],
  "version": 123,
  "requires_approval": true,
  "tables": [
    {
      "name": "<string>",
      "fqn": "<string>",
      "id": "<string>",
      "description": "<string>",
      "owners": [
        "<string>"
      ],
      "tags": [
        {}
      ],
      "domain": "<string>",
      "version": 123,
      "columns": [
        {
          "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": [
            {}
          ]
        }
      ],
      "is_dq_tagged": false,
      "is_dq_rules_generated": false,
      "requires_approval": true
    }
  ]
}

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 schema (e.g., service.database.schema)

Minimum string length: 1

include_tables · boolean · default: true

Include tables in response

include_pending_workflow · boolean · default: false

Include pending workflow info and proposed changes

include_profile · boolean · default: false

Include latest table profile summary (row_count, column_count) for each table

search · string | null

Filter tables by name or description (case-insensitive text search). Only applied when include_tables=true.

Minimum string length: 1

Response

200

application/json

Successful Response

Schema

SchemaWithProfileResponse

SchemaWithWorkflowResponse

Schema domain model for API responses and requests.

Clean DTO representing a database schema (namespace) without ORM metadata. Schemas organize tables within a database. Used in API layer, excludes infrastructure concerns like tenant IDs and timestamps.

name · string · required

Schema name

fqn · string · required

Fully qualified name

id · string | null

Unique schema identifier (UUID as string)

description · string | null

Schema description

owners · string[] | null

List of owner names

tags · Tags · object[] | null

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

version · number | null

Entity version number

requires_approval · boolean | null

Whether the pending workflow for this schema requires human approval before saving

tables · Table · object[] | null

Nested tables (populated on request)

Show child attributes