> ## Documentation Index
> Fetch the complete documentation index at: https://docs.emergence.ai/llms.txt
> Use this file to discover all available pages before exploring further.

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



## OpenAPI

````yaml /openapi/em-data-readiness-v2.yaml get /api/data-readiness/workflows/definitions/{definition_id}
openapi: 3.1.0
info:
  title: EM Data Readiness Service
  description: Data Readiness Service API for managing workflows, metrics, and data quality
  version: 4.3.0-dev1
servers: []
security:
  - BearerAuth: []
tags:
  - name: Health
    description: Service health monitoring. Check service status and version information.
  - name: Root
    description: Root endpoint providing service information and navigation links.
  - name: Configuration
    description: Service configuration endpoints. View current configuration values.
  - name: Workflows
    description: >-
      Workflow configuration and execution management. Create, configure, and
      run data quality workflows including definitions, configurations, runs,
      and tasks.
  - name: Data Assets
    description: >-
      Data catalog entity management. Manage databases, schemas, and tables
      metadata.
  - name: Metrics
    description: >-
      Data quality metrics and scorecards. Calculate scores, view trends, and
      analyze dimensions.
  - name: Violations
    description: >-
      Data quality violation management. View, acknowledge, and remediate
      detected violations.
  - name: Glossary
    description: >-
      Business glossary management. Create, verify, and organize business terms
      and definitions.
paths:
  /api/data-readiness/workflows/definitions/{definition_id}:
    get:
      tags:
        - Workflows
      summary: Get Workflow Definition
      description: >-
        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.
      operationId: get_workflow_definition
      parameters:
        - name: definition_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
            description: Unique workflow definition identifier
            examples:
              - 550e8400-e29b-41d4-a716-446655440000
            title: Definition Id
          description: Unique workflow definition identifier
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkflowDefinitionResponse'
        '404':
          description: Workflow definition not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - BearerAuth: []
components:
  schemas:
    WorkflowDefinitionResponse:
      properties:
        workflow_type:
          $ref: '#/components/schemas/WorkflowType'
          description: Type of workflow
          examples:
            - generate-pii-tags
        id:
          type: string
          format: uuid
          title: Id
          description: Unique workflow definition identifier
          examples:
            - 123e4567-e89b-12d3-a456-426614174001
        name:
          type: string
          title: Name
          description: Workflow name
          examples:
            - Generate PII Tags
        category:
          $ref: '#/components/schemas/WorkflowCategory'
          description: Workflow category
          examples:
            - enrichment
        data_asset_types:
          items:
            type: string
          type: array
          title: Data Asset Types
          description: Supported data asset types
          examples:
            - - table
        description:
          anyOf:
            - type: string
            - type: 'null'
          title: Description
          description: Workflow description
          examples:
            - Detects and tags PII data in tables
        is_active:
          type: boolean
          title: Is Active
          description: Whether workflow is active
          examples:
            - true
        created_at:
          type: string
          title: Created At
          description: Creation timestamp (ISO 8601)
          examples:
            - '2024-01-01T00:00:00Z'
        default_config:
          additionalProperties: true
          type: object
          title: Default Config
          description: Default configuration
          examples:
            - confidence_threshold: 0.8
        require_reference_pack:
          type: boolean
          title: Require Reference Pack
          readOnly: true
        supports_multi_table_selection:
          type: boolean
          title: Supports Multi Table Selection
          readOnly: true
        requires_approval:
          type: boolean
          title: Requires Approval
          readOnly: true
        stream:
          type: boolean
          title: Stream
          readOnly: true
      type: object
      required:
        - workflow_type
        - id
        - name
        - category
        - data_asset_types
        - is_active
        - created_at
        - require_reference_pack
        - supports_multi_table_selection
        - requires_approval
        - stream
      title: WorkflowDefinitionResponse
      description: |-
        Response for workflow definition operations.

        Inherits common fields from WorkflowDefinitionBaseFields.
      example:
        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
        supports_multi_table_selection: false
        workflow_type: generate-pii-tags
    ErrorResponse:
      properties:
        error:
          $ref: '#/components/schemas/ErrorInfo'
          description: >-
            Error information object containing code, message, and optional
            details
        request_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Request Id
          description: Request ID for debugging and support
          examples:
            - req_abc123xyz
      type: object
      required:
        - error
      title: ErrorResponse
      description: >-
        Standard error response model for API errors.


        Matches the structure returned by _handle_service_error in
        workflows/routes.py.

        The actual API response format is:

        {
            "error": {
                "code": "ERROR_CODE",
                "message": "Error message",
                "details": {...}
            },
            "request_id": "optional-request-id"
        }
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    WorkflowType:
      type: string
      enum:
        - 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
      title: WorkflowType
      description: >-
        Workflow types available in the system.


        These values match the Prefect deployment names defined in

        ``scripts/prefect/deploy.py`` to enable direct mapping when triggering
        workflows.
    WorkflowCategory:
      type: string
      enum:
        - ingestion
        - enrichment
        - data_quality
        - assessment
        - intelligence
      title: WorkflowCategory
      description: |-
        Workflow categories for grouping workflows.

        Categories help organize workflows into logical groups for UI display
        and filtering purposes.
    ErrorInfo:
      properties:
        code:
          type: string
          title: Code
          description: >-
            Error code identifier (e.g., 'WORKFLOW_NOT_FOUND',
            'VALIDATION_ERROR')
          examples:
            - WORKFLOW_NOT_FOUND
        message:
          type: string
          title: Message
          description: Human-readable error message
          examples:
            - >-
              Workflow configuration with id
              '123e4567-e89b-12d3-a456-426614174000' not found
        details:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Details
          description: >-
            Additional error details as a dictionary (flexible structure for
            business logic errors)
          examples:
            - workflow_id: 123e4567-e89b-12d3-a456-426614174000
      type: object
      required:
        - code
        - message
      title: ErrorInfo
      description: >-
        Nested error information object.


        Note: This model uses an untyped dict for `details` to match the
        flexible error

        structure used throughout the service layer (see WorkflowServiceError
        and similar).

        This is distinct from ErrorDetail, which is used for structured
        validation errors.
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        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.

````