Skip to main content
GET
/
api
/
data-readiness
/
workflows
/
{configuration_id}
Get Workflow Configuration
curl --request GET \
  --url https://api.example.com/api/data-readiness/workflows/{configuration_id} \
  --header 'Authorization: Bearer <token>'
{
  "category": "enrichment",
  "config": {
    "confidence_threshold": 0.85
  },
  "created_at": "2024-01-15T10:30:00Z",
  "data_asset_types": [
    "table"
  ],
  "description": "Detects and tags PII in production tables",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "is_default": false,
  "name": "PII Detection - Production",
  "require_reference_pack": true,
  "schedule": {
    "cron_expression": "0 0 * * *",
    "enabled": true,
    "timezone": "UTC"
  },
  "status": "active",
  "supports_multi_table_selection": false,
  "triggers": [],
  "updated_at": "2024-01-16T14:20:00Z",
  "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

Unique configuration identifier

Example:

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

Response

Successful Response

Full workflow configuration information for detail responses.

​
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"

​
id
string<uuid>
required

Unique configuration identifier

Example:

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

​
name
string
required

Workflow name

Example:

"PII Detection - Production"

​
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"]
​
status
string
required

Configuration status

Example:

"active"

​
is_default
boolean
required

Whether this is the default configuration

Example:

false

​
created_at
string
required

Creation timestamp (ISO 8601)

Example:

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

​
updated_at
string
required

Last update timestamp (ISO 8601)

Example:

"2024-01-16T14:20:00Z"

​
require_reference_pack
boolean
required
read-only
​
supports_multi_table_selection
boolean
required
read-only
​
description
string | null

Workflow description

Example:

"Detects and tags PII in production tables"

​
config
Config · object

Configuration overrides

Example:
{ "confidence_threshold": 0.85 }
​
schedule
ScheduleDetail · object

Full schedule configuration

Example:
{
  "cron_expression": "0 0 * * *",
  "enabled": true,
  "start_date": "2024-01-01T00:00:00Z",
  "timezone": "America/New_York"
}
​
triggers
TriggerSummary · object[]

List of triggers