API Docs / Schemas / UpdateWorkflowStepRequest

UpdateWorkflowStepRequest

Comprehensive request DTO for updating workflow step properties.
Allows updating status, assignment, and other step properties in a single operation.

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",
    "notes": "Completed review - all items approved",
    "timeSpent": 120
}

Properties

Name Type Description
statusenum

NotStarted InProgress Blocked Completed Skipped

NotStarted InProgress Blocked Completed Skipped

assignedUserCodestring

The user code to assign this step to (optional).
Must be a valid user code for an active user in the tenant.
If null, the assignment will not be changed.

The user code to assign this step to (optional).
Must be a valid user code for an active user in the tenant.
If null, the assignment will not be changed.

notesstring

Optional notes or comments about the step or status change.
Can include completion details, blocking issues, or general progress notes.
If null, existing notes will not be changed.

Optional notes or comments about the step or status change.
Can include completion details, blocking issues, or general progress notes.
If null, existing notes will not be changed.

timeSpentinteger

Time spent on this step in minutes (optional).
Used for time tracking and productivity analysis.
If null, time spent will not be updated.

Time spent on this step in minutes (optional).
Used for time tracking and productivity analysis.
If null, time spent will not be updated.

hasUpdatesboolean

Validates that at least one property is being updated.

Validates that at least one property is being updated.

JSON Example

{
  "status": "NotStarted",
  "assignedUserCode": "string",
  "notes": "string",
  "timeSpent": 0,
  "hasUpdates": false
}

Used By Operations