<< Back to GForge REST API

Entity: Sprint

GET

getDetails

Get TrackerSprint data

Parameters (1)

Name Type Description
id int The database ID for the sprint to be retrieved. This is specified in the route, e.g., /api/sprint/:id

Related Entities (3)

rel= Type Description
summary mixed object with the total count of tracker Items in the sprint and the total amount of closed items.
trackerItems \gforge\plugins\tracker\models\api\TrackerItemBasic[] TrackerItems related to the sprint
remaining mixed array of objects with the amount of TI remaining grouped by user.

Return: (none)

POST

postSprint

Create or update a TrackerSprint

Parameters (7)

Name Type Description
id int The int ID for the desired sprint. if it is an update
project int|string The int ID or unix name for the desired project.
sprintStatus int Status you want to update for the sprint
sprintName string Name you want to update for the sprint
sprintProgression string Progression you want to update for the sprint
sprintStart \date Start date you want to update for the sprint
sprintEnd \date End start you want to update for the sprint

Return: (none)

PUT

DELETE

deleteSprint

Delete a TrackerSprint

Parameters (1)

Name Type Description
id int The int ID for the desired sprint

Return: (none)