-
Notifications
You must be signed in to change notification settings - Fork 1
Milestone
Milestones are associated with project and one of the best ways to track the progress and timeline. It is similar to the small targets in a project. A milestone can be an important target such as a planned public software release, an internal test version, a new beta release for an important customer etc.
Once stakeholders add milestones to TestRail, users can assign test runs to specific milestones. It helps to track the milestone’s test results and progress separately. Especially if multiple milestones are in progress in parallel or if users have many test runs active at the same time.
| Name | Type | Description | Request Methods |
|---|---|---|---|
| completedOn | Timestamp | The date/time when the milestone was marked as completed (as UNIX timestamp) | getMilestone, getMilestones |
| id | Int | The unique ID of the milestone | getMilestone, getMilestones, updateMilestone, deleteMilestone |
| milestones | List<Milestone> | The sub milestones that belong to the milestone (if any); only available with get_milestone (available since TestRail 5.3) | getMilestone, getMilestones |
| projectId | Int | The ID of the project the milestone belongs to | getMilestone, getMilestones, addMilestone |
| startedOn | Timestamp | The date/time when the milestone was started (as UNIX timestamp) (available since TestRail 5.3) | getMilestone, getMilestones |
| url | String | The address/URL of the milestone in the user interface | getMilestone, getMilestones |
| name | String | The name of the milestone | getMilestone, getMilestones, addMilestone |
| description | String | The description of the milestone | getMilestone, getMilestones, addMilestone |
| dueOn | Timestamp | The due date/time of the milestone (as UNIX timestamp) | getMilestone, getMilestones, addMilestone |
| parentId | Int | The ID of the parent milestone the milestone belongs to (if any) (available since TestRail 5.3) | getMilestone, getMilestones, addMilestone, updateMilestone |
| startOn | Timestamp | The scheduled start date/time of the milestone (as UNIX timestamp) (available since TestRail 5.3) | getMilestone, getMilestones, addMilestone, updateMilestone |
| isCompleted | Boolean | True if the milestone is marked as completed and false otherwise | getMilestone, getMilestones, updateMilestone |
| isStarted | Boolean | True if the milestone is marked as started and false otherwise (available since TestRail 5.3) | getMilestone, getMilestones, updateMilestone |
Returns an existing milestone.
| Name | Type | Description | Required |
|---|---|---|---|
| milestoneId | Int | The unique ID of the milestone | Yes |
val someMilestone = Milestone().getMilestone(milestoneId = 1)
Returns the list of milestones for a project.
| Name | Type | Description | Required |
|---|---|---|---|
| projectId | Int | The ID of the project the milestone belongs to | Yes |
| isCompleted | Boolean | True to return completed milestones only. False to return open (active/upcoming) milestones only (available since TestRail 4.0). | No |
| isStarted | Boolean | True to return started milestones only. False to return upcoming milestones only (available since TestRail 5.3). | No |
- List<Milestone>
val someMilestonesList = Milestone().getMilestones(projectId = 1)
Creates a new milestone.
val someMilestone = Milestone(
projectId = 1,
name = "Some Milestone Name"
)
someMilestone.addMilestone()
Updates an existing milestone (partial updates are supported, i.e. you can submit and update specific fields only).
val someMilestone = Milestone(
id = 1,
name = "Some Updated Milestone Name"
)
someMilestone.updateMilestone()
Deletes an existing milestone.
val someMilestone = Milestone(
id = 1
)
someMilestone.deleteMilestone()