Get Workflow Run

Retrieve detailed information about a specific workflow run, including all associated tasks.

GET /api/data-readiness/workflows/{configuration_id}/runs/{run_id}

Get Workflow Run

cURL

curl --request GET \
  --url https://api.example.com/api/data-readiness/workflows/{configuration_id}/runs/{run_id} \
  --header 'Authorization: Bearer <token>'

200

{
  "asset_fqn": "PostgreSQL.dvdrental.public.customer",
  "completed_at": "2024-01-15T10:35:00Z",
  "configuration_id": "123e4567-e89b-12d3-a456-426614174000",
  "database_name": "dvdrental",
  "duration_seconds": 300.5,
  "id": "123e4567-e89b-12d3-a456-426614174002",
  "input": {
    "asset_fqn": "PostgreSQL.dvdrental.public.customer"
  },
  "output": {
    "tags_applied": 15
  },
  "schema_name": "public",
  "service_name": "PostgreSQL",
  "started_at": "2024-01-15T10:30:00Z",
  "status": "completed",
  "table_name": "customer",
  "tasks": [],
  "workflow_name": "PII Detection - Production",
  "workflow_type": "generate-pii-tags"
}

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

run_id · string<uuid> · required

Run ID

Response

200

application/json

Successful Response

Full workflow run information for detail responses.

Inherits common fields from WorkflowRunBaseFields.

id · string<uuid> · required

Unique 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

Run status

Example:

"completed"

workflow_name · string · required

Workflow name

Example:

"PII Detection - Production"

workflow_type · enum<string> · required

Type of workflow

Available options: generate-table-description, generate-pii-tags, generate-dq-tags, generate-sensitivity-tags, enrich-table-columns, service-ingestion, profiling, dq-rule-generation, dq-execution, metadata-assessment, dq-assessment, dq-tag-generation, intelligence, metadata-enrichment, run-all-enrichment

Example:

"generate-pii-tags"

asset_fqn · string | null

Fully qualified name of the data asset

Example:

"PostgreSQL.dvdrental.public.customer"

started_at · string | null

Run start timestamp (ISO 8601)

Example:

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

completed_at · string | null

Run completion timestamp (ISO 8601)

Example:

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

service_name · string | null

Service/connection name (derived from asset_fqn)

Example:

"PostgreSQL"

database_name · string | null

Database name (derived from asset_fqn)

Example:

"dvdrental"

schema_name · string | null

Schema name (derived from asset_fqn)

Example:

"public"

table_name · string | null

Table name (derived from asset_fqn, null for schema-level workflows)

Example:

"customer"

duration_seconds · number | null

Total run duration in seconds

Example:

300.5

error_message · string | null

Error message if run failed

Example:

null

input · Input · object

Input parameters for the run

Example:

{
  "asset_fqn": "PostgreSQL.dvdrental.public.customer"
}

output · Output · object

Output data from the run

Example:

{ "tags_applied": 15 }

tasks · TaskListItem · object[]

List of tasks associated with this workflow run

Show child attributes