Create Workflow Run

Trigger a new run of a workflow by configuration ID.

This creates a workflow run record and triggers the associated Prefect deployment in fire-and-forget mode. The run status can be monitored via the get/list endpoints.

Headers:

• Authorization: Bearer token with JWT for authentication
• X-Project-ID: Project resource URI (e.g., ‘proj:customer-analytics’)

Optional:

• asset_fqn: Fully qualified name of the data asset (e.g., ‘PostgreSQL.dvdrental.public.customer’)
• parameters: Additional workflow execution parameters. For generate-table-description, use ‘include’ to specify a list of table FQNs to process.

POST /api/data-readiness/workflows/{configuration_id}/runs

Create Workflow Run

cURL

curl --request POST \
  --url https://api.example.com/api/data-readiness/workflows/{configuration_id}/runs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "asset_fqn": "PostgreSQL.dvdrental.public",
  "parameters": {
    "include": [
      "PostgreSQL.dvdrental.public.actor",
      "PostgreSQL.dvdrental.public.film"
    ],
    "industry_info": "E-commerce retail platform"
  },
  "save_all": true
}
'

201

{
  "asset_fqn": "PostgreSQL.dvdrental.public.customer",
  "configuration_id": "123e4567-e89b-12d3-a456-426614174000",
  "id": "123e4567-e89b-12d3-a456-426614174002",
  "save_all": true,
  "started_at": "2024-01-15T10:30:00Z",
  "status": "pending"
}

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.

Path Parameters

configuration_id · string<uuid> · required

Configuration ID

Example:

"550e8400-e29b-41d4-a716-446655440001"

Body

application/json

Request body for creating/triggering a workflow run.

The parameters field accepts workflow-specific options. Common parameters include:

Enrichment Workflows (generate-pii-tags, generate-table-description, enrich-table-columns):

• include: List of specific table FQNs to process (required for generate-table-description)
• industry_info: Industry context for domain-specific enrichment (e.g., "Banking", "Healthcare", "E-commerce")

DQ Workflows (generate-dq-tags, generate-dq-rules, dq-execution):

• industry_info: Industry context for domain-specific tagging (e.g., "Banking", "Healthcare") — generate-dq-tags only
• use_validation: Whether to validate generated SQL rules (default: true) — generate-dq-rules only
• Note: resource_uri and database_type are derived internally from the asset FQN, org_id, and project_id

Profiling Workflow:

• config.profile_all_databases: Profile all databases in the service
• config.database: Single database name to profile
• config.parallel_workers: Concurrent column queries per table (default: 10)
• config.sample_data_limit: Number of sample values per column (default: 5)

asset_fqn · string | null

Fully qualified name of the data asset for the workflow run (e.g., 'PostgreSQL.dvdrental.public.customer').

Example:

"PostgreSQL.dvdrental.public"

parameters · Parameters · object

Workflow-specific execution parameters. See class docstring for available options per workflow type.

Example:

{
  "include": [
    "PostgreSQL.dvdrental.public.actor",
    "PostgreSQL.dvdrental.public.film"
  ],
  "industry_info": "E-commerce retail platform"
}

save_all · boolean · default: true

When true, workflow results are auto-saved without requiring manual approval.

Response

201

application/json

Successful Response

Response for workflow run creation.

id · string<uuid> · required

Created run identifier

Example:

"123e4567-e89b-12d3-a456-426614174002"

configuration_id · string<uuid> · required

Workflow configuration ID

Example:

"123e4567-e89b-12d3-a456-426614174000"

status · string · required

Initial run status

Example:

"pending"

started_at · string · required

Run start timestamp (ISO 8601)

Example:

"2024-01-15T10:30:00Z"

asset_fqn · string | null

Fully qualified name of the data asset

Example:

"PostgreSQL.dvdrental.public.customer"

save_all · boolean · default: true

Whether workflow results are auto-saved without requiring manual approval.

Example:

true

pipeline_id · string<uuid> | null

PipelineRun ID for run-all-enrichment orchestrator runs