API Docs / Schemas / InitializeWorkflowStepsRequest

InitializeWorkflowStepsRequest

Request DTO for initializing or re-initializing workflow steps for a TaskItem.
Used when a workflow is first assigned to a task or when changing workflows.

API Usage:

  • POST /api/tenants/{tenant}/tasks/{taskCode}/workflow
  • Typically called automatically when a workflow is assigned to a task
  • Can be called manually to reset workflow progress

Example Usage:

POST /api/tenants/acme/tasks/TASK-001/workflow
{
    "workflowCode": "CLIENT-ONBOARDING"
}

Properties

Name Type Description
workflowCode*string

The workflow code to initialize steps for.
Must be a valid workflow code that exists in the tenant.

Warning: This operation will:

  • Clear all existing workflow step progress for the task
  • Create new step instances based on the workflow template
  • Reset all progress counters to zero
  • Set initial assignments based on workflow step rules

The workflow code to initialize steps for.
Must be a valid workflow code that exists in the tenant.

Warning: This operation will:

  • Clear all existing workflow step progress for the task
  • Create new step instances based on the workflow template
  • Reset all progress counters to zero
  • Set initial assignments based on workflow step rules

JSON Example

{
  "workflowCode": "string"
}

Used By Operations