Task
A kanban task: one card on an employee's board, filed under a budget of a project, carrying an estimate in minutes that time is logged against.
- Summary view
- TaskList, 17 fields. What a list returns by default.
- Detail view
- Task, 17 fields. The default for a single read and for every write.
- Read with
- api:
read: andkanban::kanban manage_self - Write with
- api:
write: andkanban::kanban manage_self
Tasks are per-user, so a caller sees only their own unless they hold kanban::manage_for_others.
Used by
Fields
- Detail only
- Only in the detail view.
- Only with include
- Only when you ask for it with include.
- Server-assigned
- Set by plnnrly, never by a request.
Budget the task is filed under. This is the task's only link to a project (a task has no project_id of its own), and it is settable at create time only; a task cannot be re-budgeted through the API.
The employee the task belongs to. Always the authenticated user on create; not writable. Null on a task left unassigned in plnnrly.
Team the task is filed under. Nothing on the API path assigns it, so a task created through the API always carries null; plnnrly itself is the only place a team is set. Not writable, and there is no team object beside it.
Day the task is due. Required when creating a task through the API, and clearable afterwards; tasks created in plnnrly may carry null.
Short description shown on the kanban card. This is the task's label and the only field ?q= searches.
Whether the task is done. Cross-synced with status on every write: setting status to finished sets this true and any other status sets it false, while setting this false on a finished task moves status back to active. status wins when both are sent.
Whether time logged on this task is billable. Defaults to true when a task is created through the API, regardless of the budget's own setting.
Kanban column the card sits in.
on-holdnewactiveinternal-testexternal-testfinished
New values may be added.
Position on the kanban board, lowest first. Appended to the end of the board on create and changed when someone drags the card in plnnrly. Not writable.
The budget this task is filed under.
The employee the task belongs to.
Variants
TaskList 17 fields
What a collection returns, and what ?view=summary returns on a single record.
The same fields as the detail object.
TaskSummary 2 fields
The embedded form: what you get when another resource carries this one and you did not include it.
Leaves out: budget_id, user_id, team_id, due_date, minutes, comment, is_finished, is_billable, status, order_column, created_at, updated_at, budget, user, links
TaskLinks 1 field
The links object on this resource.
Keys: self
Something wrong or missing on this page? Tell us