Skip to main content

Task

A work block scheduled within a chapter, with an estimated duration and a time slot.

Fields

FieldTypeDescription
idTaskIdUnique identifier
chapterChapterIdThe arc that contains the chapter
estimatedMinutesintThe estimated minutes on the task
completedMinutesintThe time spent on the task
startAtInstantThe time the task is scheduled
startedAtInstantThe time the task has been started by the user
completedAtInstantThe time the task has been completed by the user
statusTaskStatusThe status of the task
nameStringThe name of the task
descriptionStringThe description of the task (TBD)
tagIdTagIdThe tag of the task

Derived Fields

FieldDerived FromRule
endAtTaskThe time the task is supposed to end

Enums

TaskStatus

ValueDescription
PLANNEDTask has been planned
IN_PROGRESSTask is in progress
DONETask has been finished
SKIPPEDTask has been skipped (TBD)

Constraints

  • A finished task (DONE or SKIPPED) cannot be started or completed again
  • estimatedMinutes cannot exceed 1440 (number of minutes in a day)
  • completedMinutes cannot exceed 1440 (number of minutes in a day)
  • A task's startAt time slot cannot overlap with another task in the same chapter
  • Only one task can be IN_PROGRESS per chapter at a time

Lifecycle

  • Created as PLANNED
  • PLANNEDIN_PROGRESS when the task is started
  • PLANNED can skip directly to SKIPPED (TBD, no endpoint for it yet)
  • IN_PROGRESSDONE when the task is completed