This user guide only applies if your account and project is on our old platform, i.e. if your project's URL begins with https://xp-dev.com rather than https://<your-account>.xp-dev.com. If your account is on our new platform, you should be using this user guide instead.
Each Iteration Object has the following attributes:
Attribute | Description |
---|---|
id | Unique iteration ID |
name | Iteration name |
start | Start time (number of milliseconds from Epoch) |
projectId | Project ID that the iteration belongs to |
stories | List of Story IDs that are part of the iteration |
bugs | List of Bug IDs that are part of the iteration |
closed | Whether the iteration is closed/completed or not |
GET
request to
https://xp-dev.com/api/v1/iterations/project/<project-id>
:
curl https://xp-dev.com/api/v1/iterations/project/3
Responses will be a list of Iteration Objects:
{"response":[
{
"name":"first sprint",
"id":3,
"closed":false,
"end":1344268800000,
"start":1343059200000,
"stories":[4],
"bugs":[4],
"projectId":3
},
...
}
POST
request to https://xp-dev.com/api/v1/iterations/
with the
following attributes:
Mandatory:
Example request:
curl -X POST -H 'Content-Type: application/json' -d ''{"projectId":3,"name": "some iteration","start": 1000000000,"end": 1002000000,"closed": false}' https://xp-dev.com/api/v1/iterations/
Responses will be in the form of a single Iteration Object
GET
request to https://xp-dev.com/api/v1/iterations/<iteration-id>
.
For example:
curl https://xp-dev.com/api/v1/iterations/12
Responses will be in the form of a single Iteration Object
PUT
request to https://xp-dev.com/api/v1/iterations/<iteration-id>
with the following attributes:
Mandatory:
Example request:
curl -X PUT -H 'Content-Type: application/json' -d '{"projectId":3,"name": "new iteration","start": 1000000000,"end": 1002000000,"closed": true}' https://xp-dev.com/api/v1/iterations/12
Responses will be in the form of a single Iteration Object
DELETE
request to
https://xp-dev.com/api/v1/iterations/<iteration-id>
:
curl -X DELETE https://xp-dev.com/api/v1/iterations/12
GET
request to
https://xp-dev.com/api/v1/iterations/backlog/<project-id>
:
curl https://xp-dev.com/api/v1/iterations/backlog/3
Responses will be a list of Iteration Objects.
Each Iteration-Metrics Object has the following attributes:
Attribute | Description |
---|---|
bugs | Number of total, completed and remaining bugs |
stories | Number of total, completed and remaining stories |
tasks | Number of total, completed and remaining tasks |
hours | Total number of hours estimated, added, remaining and percentage completion |
GET
request to
https://xp-dev.com/api/v1/iterations/metrics/<iteration-id>
:
curl https://xp-dev.com/api/v1/iterations/metrics/3
Responses will be an Iteration-Metrics Object:
{"response":{
"hours":{
"total":10.0,
"remaining":9.0,
"added":7.0,
"completion":70.0
},
"stories":{
"total":1,
"remaining":1,
"completed":0
},
"tasks":{
"total":1,
"remaining":1,
"completed":0
},
"bugs":{
"total":1,
"remaining":1,
"completed":0
}
}}
GET
request to
https://xp-dev.com/api/v1/iterations/backlog/metrics/<project-id>
:
curl https://xp-dev.com/api/v1/iterations/backlog/metrics/3
Responses will be an Iteration-Metrics Object.
Feel free to contact us if you need any assistance.