...
| Resource | Description |
|---|---|
| GET components | Returns a list of Milestones. |
| GET components/count | Returns the total number of milestones. |
| GET components/:id | Returns a milestone identified by its id. |
| DELETE milestones/:id | Removes a milestone identified by its id. |
| POST milestones | Creates a new milestone. |
| PUT milestones/:id | Updates a milestone identified by its 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. |
| date_type_before (unix timestamp) | Accepts a unix timestamp. It will then filter milestones that have a timestamp before the supplied one. This supports types: created, modified, started, commenced, due and completed. For example, date_completed_before(<todays timestamp>) would only return milestones completed before today. |
| date_type_after (unix timestamp) | Accepts a unix timestamp. It will then filter milestones that have a timestamp after the supplied one. This supports types: created, modified, started, commenced, due and completed. For example, date_due_after(<todays timestamp>) would only return milestones due in the future (hopefully this is all of your jobs) |
For example: You may have a reporting screen that displayed a list of jobs retrieved using the /jobs/recent endpoint. Under each job you wish to show an array of completed milestones that belong to the currently selected user.
| Code Block |
|---|
/milestones.json?_filter=job(job_ids),manager(current_staff_id),standing(complete) |