# UserTasks

#Available from v.3.11.0 User tasks are used to create tasks for users in the system.

GET /usertasks Get all user tasks in the system

Request parameters

Property name Parameter type Data type Description
page query integer

Response status OK (200)

object : UserTaskResultset
UserTaskResultset
Property name Data type Description
Page integer

Page of the paged result

PageSize integer

Page size of the paged result

Total integer

Total number of user tasks

UserTasks array : UserTask

User tasks on this pagge

UserTask
Property name Data type Description
Uid string

Unique id of the task

Created string

Timestamp at which the task was created

CreatedBy string

Id of the user who created the task

Deadline string

Deadline for the task, if any

Title string

Title for the task

Description string

Description of the task

Status string

Current status of the task

AssignedUsers array

Ids of specific users to which the task is assigned

AssignedUserGroups array

Ids of user groups to which the task is assigned

Comments array : UserTaskComment

List of comments made by users to the task

AttachedEntities array : UserTaskEntity

Entities in the system attached to this task

Files array
UserTaskComment
Property name Data type Description
Uid string

Unique id of the comment

Comment string

The actual comment

UserId string

Id of the user who created the comment

Name string

Name of the user who created the comment

Created string

Timestamp of when the comment was created

LastModified string

Timestamp for the last modification of the comment

IsSystemGenerated boolean

Indicates whether the comment was generated automatically by the system

UserTaskEntity
Property name Data type Description
EntityType string

Type of entity

EntityId string

Id of entity, represented as string to support non-integer ids in the future

Status string

Status for the attached entity on this task


PUT /usertasks Update a user task

Request parameters

Property name Parameter type Data type Description
userTask body object : UpdateUserTaskModel

User task to update

UpdateUserTaskModel
Property name Data type Description
Uid string

Unique id of the task

Deadline string

Deadline for the task, if any

Title string

Title for the task

Description string

Description of the task

Status string

Current status of the task

AssignedUsers array

Ids of specific users to which the task is assigned

AssignedUserGroups array

Ids of user groups to which the task is assigned

AttachedEntities array : UserTaskEntityModel

Entities in the system attached to this task

UserTaskEntityModel
Property name Data type Description
EntityType string

Type of entity

EntityId string

Id of entity, represented as string to support non-integer ids in the future

Response status OK (200)

No body message is returned

POST /usertasks Create a user task

Request parameters

Property name Parameter type Data type Description
userTask body object : CreateUserTaskModel

User task to create

CreateUserTaskModel
Property name Data type Description
Uid string

Unique id of user task

AssignedUserGroups array

Ids of user groups to which the task is assigned

AssignedUsers array

Ids of specific users to which the task is assigned

Title string

Title for the task

Description string

Description of the task

Deadline string

Deadline for the task, if any

AttachedEntities array : UserTaskEntityModel

Entities in the system attached to this task

UserTaskEntityModel
Property name Data type Description
EntityType string

Type of entity

EntityId string

Id of entity, represented as string to support non-integer ids in the future

Response status OK (200)

No body message is returned

DELETE /usertasks Delete a user task

Request parameters

Property name Parameter type Data type Description
uid query string

Unique id of user task to delete

Response status OK (200)

No body message is returned

GET /usertasks/{uid} Get a user task from its uid

Request parameters

Property name Parameter type Data type Description
uid path string

Unique id of user task to get

Response status OK (200)

object : UserTask
UserTask
Property name Data type Description
Uid string

Unique id of the task

Created string

Timestamp at which the task was created

CreatedBy string

Id of the user who created the task

Deadline string

Deadline for the task, if any

Title string

Title for the task

Description string

Description of the task

Status string

Current status of the task

AssignedUsers array

Ids of specific users to which the task is assigned

AssignedUserGroups array

Ids of user groups to which the task is assigned

Comments array : UserTaskComment

List of comments made by users to the task

AttachedEntities array : UserTaskEntity

Entities in the system attached to this task

Files array
UserTaskComment
Property name Data type Description
Uid string

Unique id of the comment

Comment string

The actual comment

UserId string

Id of the user who created the comment

Name string

Name of the user who created the comment

Created string

Timestamp of when the comment was created

LastModified string

Timestamp for the last modification of the comment

IsSystemGenerated boolean

Indicates whether the comment was generated automatically by the system

UserTaskEntity
Property name Data type Description
EntityType string

Type of entity

EntityId string

Id of entity, represented as string to support non-integer ids in the future

Status string

Status for the attached entity on this task


PUT /usertasks/{uid}/comments Update a comment on a user task

Request parameters

Property name Parameter type Data type Description
uid path string

Uid of user task

comment body object : UpdateUserTaskCommentModel

Comment to update

UpdateUserTaskCommentModel
Property name Data type Description
Uid string
Comment string

Response status OK (200)

No body message is returned

POST /usertasks/{uid}/comments Create a comment on a user task

Request parameters

Property name Parameter type Data type Description
uid path string

Uid of user task

comment body object : CreateUserTaskCommentModel

Comment to add to user task

CreateUserTaskCommentModel
Property name Data type Description
Uid string

Unique id of comment

Comment string

Comment itself

Response status OK (200)

No body message is returned

DELETE /usertasks/{uid}/comments Delete a user task

Request parameters

Property name Parameter type Data type Description
uid path string

Uid of user task

commentUid query string

Unique id of comment to delete

Response status OK (200)

No body message is returned

POST /usertasks/batch Get a batch of user tasks by uids

Request parameters

Property name Parameter type Data type Description
userTaskUids body array : string

Response status OK (200)

array : UserTask
UserTask
Property name Data type Description
Uid string

Unique id of the task

Created string

Timestamp at which the task was created

CreatedBy string

Id of the user who created the task

Deadline string

Deadline for the task, if any

Title string

Title for the task

Description string

Description of the task

Status string

Current status of the task

AssignedUsers array

Ids of specific users to which the task is assigned

AssignedUserGroups array

Ids of user groups to which the task is assigned

Comments array : UserTaskComment

List of comments made by users to the task

AttachedEntities array : UserTaskEntity

Entities in the system attached to this task

Files array
UserTaskComment
Property name Data type Description
Uid string

Unique id of the comment

Comment string

The actual comment

UserId string

Id of the user who created the comment

Name string

Name of the user who created the comment

Created string

Timestamp of when the comment was created

LastModified string

Timestamp for the last modification of the comment

IsSystemGenerated boolean

Indicates whether the comment was generated automatically by the system

UserTaskEntity
Property name Data type Description
EntityType string

Type of entity

EntityId string

Id of entity, represented as string to support non-integer ids in the future

Status string

Status for the attached entity on this task