A task is a piece of work to be done or undertaken by a User or Team.
Attributes
Attribute | Type | Description |
---|---|---|
id | Integer | The unique id of the Task. |
tenant_id | Integer | The id of the Tenant the Task belongs to. |
project_id | Integer | The id of the Project the Task belongs to. |
created_by | Integer | The id of the User that created the task. |
completed_by | Integer | The id of the User that completed the task. |
assignee_type | Enum|String | The type of resource the task is assigned to. "u" for User or "t" for Team. |
assignee_id | Integer | The id of the User or Team the task is assigned to. |
related_to_type | Enum|String | The type of resource the task is related to. |
related_to_id | Integer | The if of the resource the task is related to. |
assignee_name | String | The full name of the User or Team that the task is assigned to. |
is_complete | Boolean | Determines if the task has been completed. |
is_high_priority | Boolean | Determines if the task is high priority. |
subject | String | The main subject or title of the task. |
comment | String | A brief description of the task. |
created_by_name | String | The full name of the user who created the task. |
notifies_on_create | Boolean | Determines if notifications go out when the task is created. |
notifies_on_complete | Boolean | Determines if notifications go out when the task is completed. |
due_at | DateTime | The date time of when the task is due. |
created_at | DateTime | The date time of when the task was created. |
updated_at | DateTime | The date time of when the task was last updated. |
completed_at | DateTime | The date time of when the task was completed. |
Allowed includes
Relation | Type | Description |
---|---|---|
tenant | Tenant | The Tenant the Task belongs to. |
project | Project | The Project that Task belongs to. |
account | Account | The Account the Task belongs to. |
creator | User | The User that created the Task. |
assignee | User|Team | The User or Team the task is assigned to. |
completer | User | The User who completed the Task. |
Allowed filters
Name | Type | Description |
---|---|---|
id | Integer | Filter Tasks by their id. |
project_id | Integer | Filter Tasks that belong to a specific Project(s). |
created_by | Integer | Filter Tasks that where created by a specific User(s). |
completed_by | Integer | Filter Tasks that where completed by a specific User(s). |
is_complete | Boolean | Filter Tasks by whether they have been completed or not. |
is_high_priority | Boolean | Filter Tasks by their priority. |
user_assigned | Boolean | Filter Tasks that are only assigned to Users. |
team_assigned | Boolean | Filter Tasks that are only assigned to Teams. |
assigned_to_user | Integer | Filter Tasks that are directly assigned to a User with the specified id. |
assigned_to_team | Integer | Filter Tasks that are directly assigned to a Team with the specified id. |
assigned_to_user_with_teams | Integer | Filter Tasks that are assigned directly or indirectly (via a user's team) to a User with the specified id. |
Allowed sorts
Name | Description |
---|---|
created_at | Sort Tasks by when they where created. |
due_at | Sort Tasks by when they are due. |
is_high_priority | Sort Tasks by their priority. |
is_complete | Sort Tasks by whether they have been completed or not. |
completed_at | Sort Tasks by when they where completed. |
updated_at | Sort Tasks by when they where last updated. |