Working with Milestones

1. Milestone Fields

name (string) - Milestone summary. The value of this field is required when a milestone is created;
body (text) - File Description;
start_on (date) - Date when the milestone starts. A value for this field is required when a milestone is created;
due_on (date) - Date when the milestone is due. A value for this field is required when a milestone is created;
priority (integer) - Milestone priority. Priority can have five integer values ranging from -2 (lowest) to 2 (highest). 0 is normal;
assignees (array) - Array of people assigned to the object. First array element is list of assignees (as an array). Second parameter is an ID of the person responsible for a task (ID must be in the first list);
tags (string) - List of comma-separated tags for milestone;
visibility (integer) - Object visibility. 0 is private and 1 is normal visibility.

2. /projects/:project_id/milestones

Lists all active milestones for a specific project.

Method: GET.

Response example:

<milestones>
  <milestone>
    <id>18</id>
    <type>
      <![CDATA[Milestone]]>
    </type>
    <name>
      <![CDATA[Update name]]>
    </name>
    <body>...</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>
    <completed_on>...</completed_on>
    <completed_by_id>...</completed_by_id>
    <project_id>...</project_id>
    <parent_id>...</parent_id>
    <permissions>
      <can_edit>1</can_edit>
      <can_delete>1</can_delete>
      <can_change_visibility>1</can_change_visibility>
      <can_move>1</can_move>
      <can_copy>1</can_copy>
      <can_change_complete_status>1</can_change_complete_status>
    </permissions>
    <start_on>2008-05-05</start_on>
    <due_on>2008-05-08</due_on>
  </milestone>
</milestones>

3. /projects/:project_id/milestones/add

Creates a new milestone.

Method: POST.

Example request:

submitted = submitted
milestone[name] = Test milestone
milestone[start_on] = 2008-05-05
milestone[due_on] = 2008-05-08

Response:

<milestone>
  <id>18</id>
  <type>
    <![CDATA[Milestone]]>
  </type>
  <name>
    <![CDATA[Test milestone]]>
  </name>
  <body>
  </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>
  <completed_on>...</completed_on>
  <completed_by_id>...</completed_by_id>
  <project_id>...</project_id>
  <parent_id>...</parent_id>
  <permissions>
    <can_edit>1</can_edit>
    <can_delete>1</can_delete>
    <can_change_visibility>1</can_change_visibility>
    <can_move>1</can_move>
    <can_copy>1</can_copy>
    <can_change_complete_status>1</can_change_complete_status>
  </permissions>
  <start_on>2008-05-05</start_on>
  <due_on>2008-05-08</due_on>
</milestone>

4. /projects/:project_id/milestones/:milestone_id

Displays milestone details.

Method: GET

Example response:

<milestone>
  <id>18</id>
  <type>
    <![CDATA[Milestone]]>
  </type>
  <name>
    <![CDATA[Test milestone]]>
  </name>
  <body>...</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>
  <completed_on>...</completed_on>
  <completed_by_id>...</completed_by_id>
  <project_id>...</project_id>
  <parent_id>...</parent_id>
  <assignees>...</assignees>
  <permissions>
    <can_edit>1</can_edit>
    <can_delete>1</can_delete>
    <can_change_visibility>1</can_change_visibility>
    <can_move>1</can_move>
    <can_copy>1</can_copy>
    <can_change_complete_status>1</can_change_complete_status>
  </permissions>
  <start_on>2008-05-05</start_on>
  <due_on>2008-05-08</due_on>
</milestone>

5. /projects/:project_id/milestones/:milestone_id/edit

Updates milestone details

Method: POST.

Request example:

submitted = submitted
milestone[name] = Update name