Create Workflow Configuration

Create a new workflow configuration with custom settings, schedule, and triggers.

This creates a configuration that can be used to run workflows with specific settings.

Required:

• workflow_definition_id: ID of the workflow definition to configure

Optional:

• config: Configuration overrides
• schedule: Schedule configuration for automated execution
• triggers: Event-based triggers for workflow execution

POST /api/data-readiness/workflows

Create Workflow Configuration

cURL

curl --request POST \
  --url https://api.example.com/api/data-readiness/workflows \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "config": {
    "enable_profiling": true
  },
  "schedule": {
    "cron_expression": "0 0 * * *",
    "enabled": true
  },
  "workflow_definition_id": "550e8400-e29b-41d4-a716-446655440001"
}
'

201

{
  "config": {
    "confidence_threshold": 0.85
  },
  "configuration_id": "123e4567-e89b-12d3-a456-426614174000",
  "created_at": "2024-01-15T10:30:00Z",
  "triggers": []
}

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 configuration.

workflow_definition_id · string<uuid> · required

ID of the workflow definition to configure

Example:

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

config · Config · object

Configuration overrides for this workflow configuration.

Example:

{
  "processor_config": {
    "enable_profiling": true,
    "profile_sample": 1000
  },
  "source_config": {
    "database": "analytics",
    "host": "db.example.com",
    "port": 5432,
    "type": "postgres"
  }
}

schedule · ScheduleConfig · object

Schedule configuration for automated execution

Show child attributes

triggers · TriggerConfig · object[] | null

Event-based triggers for workflow execution

Show child attributes

Response

201

application/json

Successful Response

Response for workflow configuration creation.

configuration_id · string<uuid> · required

Created configuration identifier

Example:

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

created_at · string · required

Creation timestamp (ISO 8601)

Example:

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

config · Config · object

Applied configuration

Example:

{ "confidence_threshold": 0.85 }

schedule · ScheduleSummary · object

Schedule summary

Show child attributes

Example:

{
  "cron_expression": "0 0 * * *",
  "enabled": true
}

triggers · TriggerSummary · object[]

List of triggers

Show child attributes