Working with Subtasks

1. Task Fields

  1. body (text) - The task summary. A value for this field is required when a new task is added;
  2. priority (integer) - Priority can have five integer values ranging from -2 (lowest) to 2 (highest). 0 is normal;
  3. due_on (date) - When the task is due;
  4. assignees (array) - An array of people assigned to the object. The first element of the array is a list of assignees (as an array). The second parameter is the ID of the person responsible for the task (the ID must also be in the first list).

2. /projects/:project_id/tasks/add&parent_id=:parent_id

This command will create a new subtask and attach it to the parent object.

Method: POST

Request example:

submitted = submitted
task[body] = Go shopping
task[priority] = -2

Response:

<task>
  <id>25</id>
  <type>
    <![CDATA[Task]]>
  </type>
  <name>
    <![CDATA[Go shopping]]>
  </name>
  <body>
    <![CDATA[Go shopping]]>
  </body>
  <state>...</state>
  <visibility>...</visibility>
  <created_on>...</created_on>
  <created_by_id>...</created_by_id>
  <updated_on>...</updated_on>
  <updated_by_id>...</updated_by_id>
  <version>...</version>
  <permalink>...</permalink>
  <priority>-2</priority>
  <due_on>...</due_on>
  <completed_on>...</completed_on>
  <completed_by_id>...</completed_by_id>
  <project_id>...</project_id>
  <parent_id>...</parent_id>
  <milestone_id>...</milestone_id>
  <permissions>
    <can_edit>1</can_edit>
    <can_delete>1</can_delete>
    <can_change_visibility>1</can_change_visibility>
    <can_move>0</can_move>
    <can_copy>0</can_copy>
    <can_change_complete_status>1</can_change_complete_status>
  </permissions>
</task>

3. /projects/:project_id/tasks/:task_id

Displays task details.

Method: GET.

Example response:

<task>
  <id>25</id>
  <type>
    <![CDATA[Task]]>
  </type>
  <name>
    <![CDATA[Go shopping]]>
  </name>
  <body>
    <![CDATA[Go shopping]]>
  </body>
  <state>...</state>
  <visibility>...</visibility>
  <created_on>...</created_on>
  <created_by_id>...</created_by_id>
  <updated_on>...</updated_on>
  <updated_by_id>...</updated_by_id>
  <version>...</version>
  <permalink>...</permalink>
  <priority>-2</priority>
  <due_on>...</due_on>
  <completed_on>...</completed_on>
  <completed_by_id>...</completed_by_id>
  <project_id>...</project_id>
  <parent_id>...</parent_id>
  <milestone_id>...</milestone_id>
  <permissions>
    <can_edit>1</can_edit>
    <can_delete>1</can_delete>
    <can_change_visibility>1</can_change_visibility>
    <can_move>0</can_move>
    <can_copy>0</can_copy>
    <can_change_complete_status>1</can_change_complete_status>
  </permissions>
</task>

4. /projects/:project_id/tasks/:task_id/edit

Updates task details.

Method: POST

Request example:

submitted = submitted
task[priority] = 0

Response:

<task>
  <id>25</id>
  <type>
    <![CDATA[Task]]>
  </type>
  <name>
    <![CDATA[Go shopping]]>
  </name>
  <body>
    <![CDATA[Go shopping]]>
  </body>
  <state>...</state>
  <visibility>...</visibility>
  <created_on>...</created_on>
  <created_by_id>...</created_by_id>
  <updated_on>...</updated_on>
  <updated_by_id>...</updated_by_id>
  <version>...</version>
  <permalink>...</permalink>
  <priority>...</priority>
  <due_on>...</due_on>
  <completed_on>...</completed_on>
  <completed_by_id>...</completed_by_id>
  <project_id>...</project_id>
  <parent_id>...</parent_id>
  <milestone_id>...</milestone_id>
  <permissions>
    <can_edit>1</can_edit>
    <can_delete>1</can_delete>
    <can_change_visibility>1</can_change_visibility>
    <can_move>0</can_move>
    <can_copy>0</can_copy>
    <can_change_complete_status>1</can_change_complete_status>
  </permissions>
</task>