Get Workflow Definition

Retrieve detailed information about a specific workflow definition.

Workflow definitions are the deployed pipeline templates that can be configured with custom settings. This endpoint returns the full definition including supported data asset types and default configuration.

GET /api/data-readiness/workflows/definitions/{definition_id}

Get Workflow Definition

cURL

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

200

{
  "category": "enrichment",
  "created_at": "2024-01-01T00:00:00Z",
  "data_asset_types": [
    "table"
  ],
  "default_config": {
    "confidence_threshold": 0.8
  },
  "description": "Detects and tags PII data in tables",
  "id": "123e4567-e89b-12d3-a456-426614174001",
  "is_active": true,
  "name": "Generate PII Tags",
  "require_reference_pack": true,
  "requires_approval": true,
  "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

definition_id · string<uuid> · required

Unique workflow definition identifier

Example:

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

Response

200

application/json

Successful Response

Response for workflow definition operations.

Inherits common fields from WorkflowDefinitionBaseFields.

id · string<uuid> · required

Unique workflow definition identifier

Example:

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

name · string · required

Workflow name

Example:

"Generate PII Tags"

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"

category · enum<string> · required

Workflow category

Available options: ingestion, enrichment, data_quality, assessment, intelligence

Example:

"enrichment"

data_asset_types · string[] · required

Supported data asset types

Example:

["table"]

is_active · boolean · required

Whether workflow is active

Example:

true

created_at · string · required

Creation timestamp (ISO 8601)

Example:

"2024-01-01T00:00:00Z"

requires_approval · boolean · required · read-only

require_reference_pack · boolean · required · read-only

stream · boolean · required · read-only

description · string | null

Workflow description

Example:

"Detects and tags PII data in tables"

default_config · Default Config · object

Default configuration

Example:

{ "confidence_threshold": 0.8 }