TaskAssignments
Introduction
TaskAssignments define when and for whom tasks should be executed.
Assignment data and related TaskTemplates are used to create TaskExecutions for users and departments.
Model Definition
Alias
taskAssignment
Relations
[Adm.] List
Definition
GET /api/administration/tasks-2/assignments
Request Keys
No additional request keys.
Example Request
Example Response
[Adm.] Show
Definition
GET /api/administration/tasks-2/assignments/{taskAssignment}
Request Keys
taskAssignment
integer
-
TaskAssignment ID
Example Request
Example Response
[Adm.] Create
Definition
POST /api/administration/tasks-2/assignments
Request Keys
title*
string
-
Assignment title.
description
string
null
Assignment description (HTML).
creator_user_id
integer
current user
Creator user ID.
assign_mode
string
all
Assignment mode (all, any_of, one_of, any_of_user, one_of_user).
start_date
date
null
Start date (YYYY-MM-DD).
start_time
time
null
Start time (H:i:s).
show_before_interval
interval
null
Visibility lead interval (ISO 8601 duration).
executable_before_interval
interval
null
Executable-before interval (ISO 8601 duration).
executable_after_interval
interval
null
Executable-after interval (ISO 8601 duration).
interval
string
null
iCal RRULE.
interval_end
date
null
End date for recurrence.
active
boolean
true
Active state.
always_executable
boolean
false
Allows execution without time restrictions.
user_confirmation_required
boolean
true
Requires real-user confirmation.
delayed_reason_required
boolean
true
Requires delayed reason for delayed finish.
deny_reason_required
boolean
true
Requires deny reason on deny action.
reset_allowed
boolean
true
Allows reset action for related executions.
sort_number
integer
auto
Sort number.
department_ids
array
[]
Target departments.
user_ids
array
[]
Target users.
Example Request
Example Response
Create quick assignment
Definition
POST /api/tasks-2/assignments/quick-assignment
Request Keys
title*
string
-
Assignment title.
assign_mode
string
all
Assignment mode.
start_date
date
null
Start date.
start_time
time
null
Start time.
department_ids
array
[]
Target departments.
user_ids
array
[]
Target users.
Example Request
Example Response
[Adm.] Update
Definition
PUT /api/administration/tasks-2/assignments/{taskAssignment}
Request Keys
taskAssignment
integer
Route parameter. TaskAssignment ID.
title
string
New assignment title.
description
string
New description.
task_template_id
integer
New template ID.
assign_mode
string
New assignment mode.
start_date
date
New start date.
start_time
time
New start time.
show_before_interval
interval
New visibility interval.
executable_before_interval
interval
New executable-before interval.
executable_after_interval
interval
New executable-after interval.
interval
string
New RRULE.
interval_end
date
New recurrence end date.
active
boolean
New active state.
always_executable
boolean
New always-executable state.
user_confirmation_required
boolean
New confirmation requirement.
delayed_reason_required
boolean
New delayed-reason requirement.
deny_reason_required
boolean
New deny-reason requirement.
reset_allowed
boolean
New reset-allowed state.
sort_number
integer
New sort number.
department_ids
array
Updated target departments.
user_ids
array
Updated target users.
Example Request
Example Response
[Adm.] Delete
Definition
DELETE /api/administration/tasks-2/assignments/{taskAssignment}
Request Keys
taskAssignment
integer
-
TaskAssignment ID
Example Request
Example Response
Last updated