Get a database by FQN

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

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

Returns: Database domain model.

Raises: HTTPException: 404 if database not found.

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

Get a database by FQN

cURL

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

200

{
  "name": "<string>",
  "fqn": "<string>",
  "id": "<string>",
  "description": "<string>",
  "owners": [
    "<string>"
  ],
  "tags": [
    {}
  ],
  "version": 123,
  "schemas": [
    {
      "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 database (e.g., PostgreSQL.dvdrental)

Minimum string length: 1

Response

200

application/json

Successful Response

Database domain model for API responses and requests.

Clean DTO (Data Transfer Object) representing a database without ORM metadata. Used in API layer for requests and responses. Does not expose infrastructure concerns like client_id, timestamps, or soft delete flags.

Note: ID is returned as string (UUID) after creation for referencing in subsequent operations (e.g., creating schemas).

name · string · required

Database name

fqn · string · required

Fully qualified name

id · string | null

Unique database identifier (UUID)

description · string | null

Database 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

schemas · Schema · object[] | null

Nested schemas (populated on request)

Show child attributes