...
Milestones are the steps on the road to a Project’s completion. These contain the individual hour and dollar budget for that portion of the overall Project, and are then grouped together under the Project’s Workflow, and along with the Tasks created against these Milestones, combine to form the overall budget and final invoice for the Project.
Endpoints
| METHOD | ENDPOINT | DescriptionDESCRIPTION | |
|---|---|---|---|
| GET | componentsmilestones | Returns a list of Milestones. | |
| GET | componentsmilestones/count | Returns the total number of milestones. | |
| GET | componentsmilestones/:id | Returns a milestone identified by its id. | |
| DELETE milestones/:id | |||
| POST milestones | |||
| PUT milestones/:id |
Filters
Filters can be used to filter through lists of milestones. You can defined filters in the _filter parameter.
| standing(S1,S2,SN) | Array of standing status strings. For example standing(pending,active)- filter out milestones that do not have the supplied standing (status). |
|---|---|
| job(ID1,ID2,IDN) | Array of job IDs. For example, job(1,435,24) would only show milestones against jobs with ids 1, 435 or 24. If you want milestones for a single job we recommend you use the /jobs/:job_id/milestones endpoint. |
| parent(ID1,ID2,IDN) | Array of milestone IDs. For example, milestone(23) would return milestones with parent 23. |
| manager(ID1,ID2,IDN) | Array of staff IDs. For example, manager(1,2) would return milestones where the manager is either staff with ID 1 or 2. |
| status(ID1,ID2,IDN) | Array of milestone status IDs. For example, status(1,2) would only return milestones with status IDs 1 or 2. If you wish to search on a status string. Please use the standing filter. |
| rate(ID1,ID2,IDN) | Array of rate IDs. For example, rate(1,53,4) would only return milestones with rate with IDs 1, 53 or 4. |
...
| GET | /milestones/:id/profiles/values | Returns an array of profile values for the milestone. |
| PUT | /milestones/:id/profiles/values/:profile_value_id | Update an existing profile value for the milestone. |
| GET | /milestones/:id/progressions | Returns an array of available progressions for the milestone. |
| [PUT|POST] | /milestones/:id/progressions/:progression_id/auto | Runs a status update for the given progression on the given milestone. |
| GET | /milestones/profiles/fields | Returns an array of profile fields for milestone. |
| POST | /milestones/:milestone_id/profiles/fields/:profile_field_id | Creates a profile value for a milestone. |