TaskExecutions

Introduction

TaskExecutions represent concrete task instances for users or departments.

Executions are usually created from TaskAssignments and TaskTemplates.

Model Definition

Alias

taskExecution

Relations

Relation
Key
Type
Relation Field(s)

taskProgressFields

Has many

task_progress_fields.task_id

taskAssignment

Belongs to

task_assignment_id

taskTemplate

Belongs to

task_template_id

TaskStatus

taskStatus

Has one

tasks_status_id

lastActivityUser

Belongs to

last_activity_user_id

parent

Belongs to

parent_id

children

Has many

parent_id

Task status indicators

Possible values for task_status_id:

  • open

  • in_progress

  • in_progress_delayed

  • done

  • done_delayed

  • denied

  • missed

List by date range

Definition

GET /api/tasks-2/executions

Request Keys

Key
Type
Default
Description

period_start

datetime

-

Start of date range.

period_end

datetime

-

End of date range.

Example Request

Example Response

List by assignment and date range

Definition

GET /api/tasks-2/assignments/{taskAssignment}/executions

Request Keys

Key
Type
Default
Description

taskAssignment

integer

-

TaskAssignment ID.

period_start

datetime

-

Start of date range.

period_end

datetime

-

End of date range.

Example Request

Example Response

Count

Definition

GET /api/tasks-2/executions/count

Request Keys

No additional request keys.

Example Request

Example Response

Show

Definition

GET /api/tasks-2/executions/{taskExecution}

Request Keys

Key
Type
Default
Description

taskExecution

integer

-

TaskExecution ID.

Example Request

Example Response

Create

Definition

POST /api/tasks-2/executions

Request Keys

Key
Type
Default
Description

task_assignment_id*

integer

-

Related TaskAssignment ID.

task_template_id*

integer

-

Related TaskTemplate ID.

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.

Example Request

Example Response

Progress

Definition

PUT /api/tasks-2/executions/{taskExecution}/progress

Request Keys

Key
Type
Default
Description

taskExecution

integer

-

Route parameter. TaskExecution ID.

{field-key}

field type

-

Field value keyed by TaskField key.

{field-key}_additional_information

string

null

Optional additional information for the field value.

Example Request

Example Response

Finish

Definition

POST /api/tasks-2/executions/{taskExecution}/progress/finish

Request Keys

Key
Type
Default
Description

taskExecution

integer

-

Route parameter. TaskExecution ID.

{field-key}

field type

-

Field value keyed by TaskField key.

{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

Definition

POST /api/tasks-2/executions/{taskExecution}/deny

Request Keys

Key
Type
Default
Description

taskExecution

integer

-

Route parameter. TaskExecution ID.

deny_reason

string

null

Deny reason (required when assignment policy requires it).

Example Request

Example Response

Reset

Definition

POST /api/tasks-2/executions/{taskExecution}/reset

Request Keys

Key
Type
Default
Description

taskExecution

integer

-

TaskExecution ID.

Example Request

Example Response

Update state

Definition

PUT /api/tasks-2/executions/{taskExecution}/status

Request Keys

Key
Type
Default
Description

taskExecution

integer

-

Route parameter. TaskExecution ID.

task_status_id*

string

-

New task status ID.

Keys with * are required.

Example Request

Example Response

List previous workflow nodes

Definition

GET /api/tasks-2/executions/{taskAssignment}/workflow-nodes/previous

Request Keys

Key
Type
Default
Description

taskAssignment

integer

-

TaskAssignment ID used as workflow root.

levels

integer

0

Maximum levels to resolve (0 resolves all previous levels).

Example Request

Example Response

Show previous workflow node

Definition

GET /api/tasks-2/executions/{taskAssignment}/workflow-nodes/previous/{level}

Request Keys

Key
Type
Default
Description

taskAssignment

integer

-

TaskAssignment ID used as workflow root.

level

integer

-

Previous workflow level to return.

Example Request

Example Response

Show previous workflow node dispatchable

Definition

GET /api/tasks-2/executions/{taskAssignment}/workflow-nodes/previous/{level}/dispatchable

Request Keys

Key
Type
Default
Description

taskAssignment

integer

-

TaskAssignment ID used as workflow root.

level

integer

-

Previous workflow level whose dispatchable is returned.

include

string

-

Optional result-control include parameter.

appends

string

-

Optional result-control appends parameter.

Example Request

Example Response

Last updated