The commands listed in this article are used for manipulation with Milestones via API in your activeCollab projects.

About Milestones #

The following Milestone fields are available via API:

• name (string) - The Milestone name is a required field when creating a Milestone.
• body (text) - The Milestone description.
• start_on (date) - The Milestone start date is mandatory.
• due_on (date) - The Milestone due date is mandatory.
• priority (integer) - The Milestone priority can have five integer values ranging from -2 (lowest) to 2 (highest). 0 is normal.
• assignee_id (array) - The ID defines the user who is responsible for this Milestone.
• other_assignees (array) - An array of people IDs assigned to the object.

You can find a list of resources used by Milestones in the articles Comments and Reminders.

More commands for working with Milestones can be found on the following pages:

• Subscription Related Commands
• Completion Status Related commands
• Object State Related Commands

projects/:project_id/milestones #

This command lists all active Milestones for a specific Project.

Method: GET

Response example:

1
2
3
4
5
6
7
8
9

<milestones>
  <milestone>
    <id>9</id>
    <name>
      <![CDATA[Example milestone]]>
    </name>
     ...
  </milestone>
</milestones>

projects/:project_id/milestones/add #

This command creates a new Milestone.

Method: POST

Example request:

1
2
3
4

milestone[name]=Creating New Milestone
milestone[start_on]=2012-07-18
milestone[due_on]=2012-07-20
submitted=submitted

Response:

1
2
3
4
5
6
7
8
9
10
11
12
13
14

<milestone>
  <id>10</id>
  <name>
    <![CDATA[Creating New Milestone]]>
  </name>
  ...
  <start_on>
    <![CDATA[2012-07-18]]>
  </start_on>
  <due_on>
    <![CDATA[2012-07-20]]>
  </due_on>
  ...
</milestone>

projects/:project_id/milestones/:milestone_id #

This command displays Milestone details.

Method: GET

Example response:

1
2
3
4
5
6
7

<milestone>
  <id>10</id>
  <name>
    <![CDATA[Example Milestone]]>
  </name>
  ...
</milestone>

projects/:project_id/milestones/:milestone_id/edit #

This command updates the Milestone details.

Method: POST

Request example:

1
2

milestone[name]=New Milestone Name
submitted=submitted

Response:

1
2
3
4
5
6
7

<milestone>
  <id>10</id>
  <name>
    <![CDATA[New Milestone Name]]>
  </name>
   ...
</milestone>

projects/:project_id/milestones/:milestone_id/reschedule #

Reschedules the current Milestone.

Method: POST

Request example:

1
2

milestone[start_on]=2012-08-17
submitted=submitted

Response:

1
2
3
4
5
6
7
8
9
10

<milestone>
  <id>10</id>
  <name>
    <![CDATA[Example Milestone]]>
  </name>
   ...
  <start_on>
    <![CDATA[2012-08-17]]>
  </start_on>
</milestone>