UpdateWorkflowStepRequest
Request DTO for updating workflow step properties.
Supports updating status, assignment, time tracking, and email configuration.
At least one property must be provided.
API Usage:
- PUT /api/tenants/{tenant}/tasks/{taskCode}/workflow/steps/{stepId}
- Supports updating multiple fields at once or individual fields
- Validates that changes are appropriate and permissions are met
Example Usage:
PUT /api/tenants/acme/tasks/TASK-001/workflow/steps/123
{
"status": "Completed",
"assignedUserCode": "john.doe",
"timeSpent": 120
}
Properties
| Name | Type | Description |
|---|---|---|
| status | enum | NotStarted InProgress Blocked Completed Skipped |
NotStarted InProgress Blocked Completed Skipped | ||
| blockedReason | string | The reason the step is blocked (optional). Only used when setting status to "Blocked". |
The reason the step is blocked (optional). Only used when setting status to "Blocked". | ||
| assignedUserCode | string | The user code to assign this step to (optional). |
The user code to assign this step to (optional). | ||
| timeSpent | integer | Time spent on this step in minutes (optional). |
Time spent on this step in minutes (optional). | ||
| emailStepConfiguration | EmailStepConfigDto | |
| hasUpdates | boolean | Validates that at least one property is being updated |
Validates that at least one property is being updated | ||
JSON Example
{
"status": "NotStarted",
"blockedReason": "string",
"assignedUserCode": "string",
"timeSpent": 0,
"emailStepConfiguration": {
"executionMode": "...",
"contentBlockCode": "string",
"recipientContactTypes": [
"..."
],
"recipientUserTypes": [
"..."
],
"additionalEmailAddresses": [
"..."
]
}
}