Create Workflow Definition

Create a new workflow definition (template).

Workflow definitions are the deployed pipeline templates that can be configured with custom settings, schedules, and triggers.

This endpoint is typically used by administrators to define new workflow types.

Required:

• name: Human-readable workflow name
• workflow_type: Type of workflow (generate-pii-tags, generate-dq-tags, etc.)
• data_asset_types: List of supported data asset types

Optional:

• description: Workflow description
• default_config: Default configuration for this workflow type
• is_active: Whether the workflow is active (default: true)

POST /api/data-readiness/workflows/definitions

Create Workflow Definition

cURL

curl --request POST \
  --url https://api.example.com/api/data-readiness/workflows/definitions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "data_asset_types": [
    "<string>"
  ],
  "description": "Profiles table schema and data quality",
  "default_config": {},
  "is_active": true
}
'

201

{
  "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.

Body

application/json

Request body for creating a workflow definition.

name · string · required

Human-readable workflow name

Required string length: 1 - 255

Examples:

"Table Profiling Workflow"

"PII Detection Workflow"

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

Examples:

"generate-pii-tags"

"generate-dq-tags"

"generate-table-description"

category · enum<string> · required

Workflow category for grouping

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

Examples:

"enrichment"

"data_quality"

"assessment"

"ingestion"

data_asset_types · string[] · required

List of supported data asset types

Examples:

["table"]

["table", "topic"]

description · string | null

Optional workflow description

Example:

"Profiles table schema and data quality"

default_config · Default Config · object

Default configuration for this workflow type

is_active · boolean · default: true

Whether the workflow is active and available for use

Response

201

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 }