TaskExecutions
Introduction
TaskExecutions represent concrete task instances for users or departments.
Executions are usually created from TaskAssignments and TaskTemplates.
The deny_reason and delayed_reason fields use the shared Rich Text HTML format.
Model Definition
Alias
taskExecution
Relations
taskStatus
TaskStatus
Belongs to
task_status_id
Computed Properties
hash- Stable encoded representation used by execution links.urlandstatic_url- Link to the execution page.visibility_start_time,execution_start_time, andexecution_end_time- Time-window boundaries calculated from the assignment.achieved_pointsandmax_points- Grade totals calculated from progress fields and child executions.
Capabilities
Targetables - Visibility and execution access derive from the parent assignment's users, departments, assignment mode, and active time window.
Entity Permissions - Execution grants are managed internally; these endpoints do not accept client-controlled Entity Permissions.
URL Context - Execution URLs resolve to access-checked context information using the assignment or template title.
Translations - The
deny_reasonanddelayed_reasonfields are translatable.
Task Status Indicators
Possible values for task_status_id:
openin_progressin_progress_delayeddonedone_delayeddeniedmissed
Admin: List
List executions accessible through administrable assignments, including soft-deleted records.
Definition
GET /api/administration/tasks-2/executions
Example Request
Example Response
Admin: Show
Show one execution, including a soft-deleted record or a temporary calculated execution.
Definition
GET /api/administration/tasks-2/executions/{taskExecution}
Route Parameters
taskExecution
integer | string
Execution ID or temporary execution hash.
Example Request
Example Response
Admin: List by TaskAssignment
List calculated and persisted executions for an assignment and date range, including executions retained from previous assignment revisions.
Definition
GET /api/administration/tasks-2/assignments/{taskAssignmentWithTrashed}/executions
Route Parameters
taskAssignmentWithTrashed
integer
Current or soft-deleted assignment ID.
Request Keys
period_start*
datetime
Start of the date range.
period_end*
datetime
End of the date range.
Keys with * are required.
Example Request
Example Response
List by Date Range
List visible TaskExecutions within a date range.
Definition
GET /api/tasks-2/executions
Request Keys
period_start
datetime
-
Start of date range.
period_end
datetime
-
End of date range.
Example Request
Example Response
List by Assignment and Date Range
List visible TaskExecutions for one assignment within a date range.
Definition
GET /api/tasks-2/assignments/{taskAssignment}/executions
Route Parameters
taskAssignment
integer
TaskAssignment ID.
Request Keys
period_start
datetime
-
Start of date range.
period_end
datetime
-
End of date range.
Example Request
Example Response
Count
Count visible TaskExecutions.
Definition
GET /api/tasks-2/executions/count
Request Keys
period_start*
datetime
Start of the counted date range.
period_end*
datetime
End of the counted date range.
Keys with * are required.
Example Request
Example Response
List Missed Executions
List missed and delayed in-progress executions relevant to the authenticated user.
Definition
GET /api/tasks-2/executions/missed
Request Keys
period_start
datetime
User creation time
Start of the inspected range.
period_end
datetime
Current time
End of the inspected range.
latest_recursions_only
boolean
true
Return only the latest recurrence for recurring assignments.
Example Request
Example Response
Count Missed Executions
Count executions returned by the missed-executions query.
Definition
GET /api/tasks-2/executions/missed/count
Request Keys
period_start
datetime
User creation time
Start of the inspected range.
period_end
datetime
Current time
End of the inspected range.
latest_recursions_only
boolean
true
Count only the latest recurrence for recurring assignments.
Example Request
Example Response
Show
Show one visible TaskExecution.
Definition
GET /api/tasks-2/executions/{taskExecution}
Route Parameters
taskExecution
integer
TaskExecution ID.
Example Request
Example Response
Create
Create a new TaskExecution.
Definition
POST /api/tasks-2/executions
Request Keys
parent_id
integer
null
Parent TaskExecution ID for child executions.
task_status_id
string
open
Initial status ID.
for_execution_date
datetime
null
Execution date/time.
Keys with * are required.
Behavior
user_idanddepartment_idare derived from the authenticated user and the assignment's targeting; client-provided values cannot choose another recipient.last_activity_user_idis derived from authentication and the initial status.If an equivalent relevant execution already exists, the repository returns it instead of creating a duplicate.
Example Request
Example Response
Create from Composition
Create one execution for each permitted child assignment of a composition assignment.
Definition
POST /api/tasks-2/executions/composition
Request Keys
Keys with * are required.
Behavior
user_idanddepartment_idare derived from the authenticated user and assignment targeting.Child assignments the real user cannot execute are skipped.
Existing equivalent executions and children that cannot produce an execution are omitted from the returned collection.
Example Request
Example Response
Progress
Update the progress values of one TaskExecution.
Definition
PUT /api/tasks-2/executions/{taskExecution}/progress
Route Parameters
taskExecution
integer
TaskExecution ID.
Request Keys
lang_id
string
system language
Language key stored with progress fields.
{field-key}_additional_information
string
null
Optional additional information for the field value.
Example Request
Example Response
Finish
Finish one TaskExecution.
Definition
POST /api/tasks-2/executions/{taskExecution}/progress/finish
Route Parameters
taskExecution
integer
TaskExecution ID.
Request Keys
lang_id
string
system language
Language key stored with progress fields.
{field-key}_additional_information
string
null
Optional additional information for the field value.
delayed_reason
string
null
Delayed reason if delayed-state completion requires it.
Example Request
Example Response
Deny
Deny one TaskExecution.
Definition
POST /api/tasks-2/executions/{taskExecution}/deny
Route Parameters
taskExecution
integer
TaskExecution ID.
Request Keys
lang_id
string
system language
Language key for the translated denial reason.
deny_reason
string
null
Deny reason (required when assignment policy requires it).
Example Request
Example Response
Reset
Reset one TaskExecution.
Definition
POST /api/tasks-2/executions/{taskExecution}/reset
Route Parameters
taskExecution
integer
TaskExecution ID.
Example Request
Example Response
Update State
Update the status of one TaskExecution.
Definition
PUT /api/tasks-2/executions/{taskExecution}/status
Route Parameters
taskExecution
integer
TaskExecution ID.
Request Keys
task_status_id*
string
-
New task status ID.
Keys with * are required.
Example Request
Example Response
List Previous Workflow Nodes
List previous workflow nodes for one TaskAssignment.
Definition
GET /api/tasks-2/executions/{taskAssignment}/workflow-nodes/previous
Route Parameters
taskAssignment
integer
TaskAssignment ID used as workflow root.
Request Keys
levels
integer
0
Maximum levels to resolve (0 resolves all previous levels).
Example Request
Example Response
Show Previous Workflow Node
Show one previous workflow node for a TaskAssignment.
Definition
GET /api/tasks-2/executions/{taskAssignment}/workflow-nodes/previous/{level}
Route Parameters
taskAssignment
integer
TaskAssignment ID used as workflow root.
level
integer
Previous workflow level to return.
Example Request
Example Response
Show Previous Workflow Node Dispatchable
Show the dispatchable entity of one previous workflow node.
Definition
GET /api/tasks-2/executions/{taskAssignment}/workflow-nodes/previous/{level}/dispatchable
Route Parameters
taskAssignment
integer
TaskAssignment ID used as workflow root.
level
integer
Previous workflow level whose dispatchable is returned.
Request Keys
include
string
-
Optional result-control include parameter.
appends
string
-
Optional result-control appends parameter.
Example Request
Example Response
Last updated