When retrieving sprints, most attributes names and values are self-explanatory. Here is the correspondance between those that aren’t:
– state: 1: todo, 2: in progress, 3: done
GET http://:server/ws/p/:pkey/sprint
[ { "startDate": "2012-06-06T00:00:00Z", "dailyWorkTime": 8, "closeDate": "2012-06-06T15:56:28Z", "state": 3, "resource": null, "lastUpdated": "2012-06-06T15:56:28Z", "endDate": "2012-06-19T00:00:00Z", "tasks": [ {"id": 1370}, {"id": 1360}, {"id": 1378}, {"id": 1376}, {"id": 1354}, {"id": 1364} ], "activationDate": "2012-06-06T15:56:28Z", "goal": "Generated Sprint", "numberOfDays": 13, "id": 40, "retrospective": null, "stories": [ {"id": 431}, {"id": 432}, {"id": 424}, {"id": 426}, {"id": 430}, {"id": 425}, {"id": 427}, {"id": 429} ], "doneDefinition": null, "orderNumber": 1, "parentRelease": {"id": 38}, "velocity": 40, "capacity": 40 }, { "startDate": "2012-06-20T00:00:00Z", "dailyWorkTime": 8, "closeDate": "2012-06-06T15:56:30Z", "state": 3, "resource": null, "lastUpdated": "2012-06-06T15:56:30Z", "endDate": "2012-07-03T00:00:00Z", "tasks": [ {"id": 1410}, {"id": 1400}, {"id": 1418}, {"id": 1394}, {"id": 1416} ], "activationDate": "2012-06-06T15:56:29Z", "goal": "Generated Sprint", "numberOfDays": 13, "id": 41, "retrospective": null, "stories": [ {"id": 436}, {"id": 434}, {"id": 435}, {"id": 441}, {"id": 439}, {"id": 437}, {"id": 440}, {"id": 442} ], "doneDefinition": null, "orderNumber": 2, "parentRelease": {"id": 38}, "velocity": 40, "capacity": 40 }, { "startDate": "2012-07-04T00:00:00Z", "dailyWorkTime": 8, "closeDate": "2012-06-06T15:56:32Z", "state": 3, "resource": null, "lastUpdated": "2012-06-06T15:56:32Z", "endDate": "2012-07-17T00:00:00Z", "tasks": [ {"id": 1448}, {"id": 1442}, {"id": 1458}, {"id": 1473}, {"id": 1474}, {"id": 1475}, {"id": 1476}, {"id": 1477} ], "activationDate": "2012-06-06T15:56:31Z", "goal": "Generated Sprint", "numberOfDays": 13, "id": 42, "retrospective": null, "stories": [ {"id": 446}, {"id": 445}, {"id": 444}, {"id": 451}, {"id": 449}, {"id": 452}, {"id": 447}, {"id": 450} ], "doneDefinition": null, "orderNumber": 3, "parentRelease": {"id": 38}, "velocity": 40, "capacity": 40 } ]
<?xml version="1.0" encoding="UTF-8"?> <set> <sprint id="40"> <activationDate>2012-06-06 15:56:28.246 UTC</activationDate> <capacity>40.0</capacity> <closeDate>2012-06-06 15:56:28.946 UTC</closeDate> <dailyWorkTime>8.0</dailyWorkTime> <doneDefinition/> <endDate>2012-06-19 00:00:00.0 UTC</endDate> <goal>Generated Sprint</goal> <lastUpdated>2012-06-06 15:56:28.968 UTC</lastUpdated> <numberOfDays>13</numberOfDays> <orderNumber>1</orderNumber> <parentRelease id="38"/> <resource/> <retrospective/> <startDate>2012-06-06 00:00:00.0 UTC</startDate> <state>3</state> <stories> <story id="431"/> <story id="432"/> <story id="424"/> <story id="426"/> <story id="430"/> <story id="425"/> <story id="427"/> <story id="429"/> </stories> <tasks> <task id="1370"/> <task id="1360"/> <task id="1378"/> <task id="1376"/> <task id="1354"/> <task id="1364"/> <task id="1366"/> <task id="1358"/> </tasks> <velocity>40.0</velocity> </sprint> <sprint id="41"> <activationDate>2012-06-06 15:56:29.645 UTC</activationDate> <capacity>40.0</capacity> <closeDate>2012-06-06 15:56:30.481 UTC</closeDate> <dailyWorkTime>8.0</dailyWorkTime> <doneDefinition/> <endDate>2012-07-03 00:00:00.0 UTC</endDate> <goal>Generated Sprint</goal> <lastUpdated>2012-06-06 15:56:30.511 UTC</lastUpdated> <numberOfDays>13</numberOfDays> <orderNumber>2</orderNumber> <parentRelease id="38"/> <resource/> <retrospective/> <startDate>2012-06-20 00:00:00.0 UTC</startDate> <state>3</state> <stories> <story id="436"/> <story id="434"/> <story id="435"/> <story id="441"/> <story id="439"/> <story id="437"/> <story id="440"/> <story id="442"/> </stories> <tasks> <task id="1410"/> <task id="1400"/> <task id="1418"/> <task id="1394"/> </tasks> <velocity>40.0</velocity> </sprint> <sprint id="42"> <activationDate>2012-06-06 15:56:31.277 UTC</activationDate> <capacity>40.0</capacity> <closeDate>2012-06-06 15:56:32.210 UTC</closeDate> <dailyWorkTime>8.0</dailyWorkTime> <doneDefinition/> <endDate>2012-07-17 00:00:00.0 UTC</endDate> <goal>Generated Sprint</goal> <lastUpdated>2012-06-06 15:56:32.249 UTC</lastUpdated> <numberOfDays>13</numberOfDays> <orderNumber>3</orderNumber> <parentRelease id="38"/> <resource/> <retrospective/> <startDate>2012-07-04 00:00:00.0 UTC</startDate> <state>3</state> <stories> <story id="446"/> <story id="445"/> <story id="444"/> <story id="451"/> <story id="449"/> <story id="452"/> <story id="447"/> <story id="450"/> </stories> <tasks> <task id="1448"/> <task id="1442"/> <task id="1458"/> </tasks> <velocity>40.0</velocity> </sprint> </set>
GET http://:server/ws/p/:pkey/:releaseid/sprint
[ { "startDate": "2012-06-06T00:00:00Z", "dailyWorkTime": 8, "closeDate": "2012-06-06T15:56:28Z", "state": 3, "resource": null, "lastUpdated": "2012-06-06T15:56:28Z", "endDate": "2012-06-19T00:00:00Z", "tasks": [ {"id": 1370}, {"id": 1360}, {"id": 1378}, {"id": 1376}, {"id": 1354}, {"id": 1364} ], "activationDate": "2012-06-06T15:56:28Z", "goal": "Generated Sprint", "numberOfDays": 13, "id": 40, "retrospective": null, "stories": [ {"id": 431}, {"id": 432}, {"id": 424}, {"id": 426}, {"id": 430}, {"id": 425}, {"id": 427}, {"id": 429} ], "doneDefinition": null, "orderNumber": 1, "parentRelease": {"id": 38}, "velocity": 40, "capacity": 40 }, { "startDate": "2012-06-20T00:00:00Z", "dailyWorkTime": 8, "closeDate": "2012-06-06T15:56:30Z", "state": 3, "resource": null, "lastUpdated": "2012-06-06T15:56:30Z", "endDate": "2012-07-03T00:00:00Z", "tasks": [ {"id": 1410}, {"id": 1400}, {"id": 1418}, {"id": 1394}, {"id": 1416}, {"id": 1404} ], "activationDate": "2012-06-06T15:56:29Z", "goal": "Generated Sprint", "numberOfDays": 13, "id": 41, "retrospective": null, "stories": [ {"id": 436}, {"id": 434}, {"id": 435}, {"id": 441}, {"id": 439}, {"id": 437}, {"id": 440}, {"id": 442} ], "doneDefinition": null, "orderNumber": 2, "parentRelease": {"id": 38}, "velocity": 40, "capacity": 40 }, { "startDate": "2012-07-04T00:00:00Z", "dailyWorkTime": 8, "closeDate": "2012-06-06T15:56:32Z", "state": 3, "resource": null, "lastUpdated": "2012-06-06T15:56:32Z", "endDate": "2012-07-17T00:00:00Z", "tasks": [ {"id": 1448}, {"id": 1442}, {"id": 1458} ], "activationDate": "2012-06-06T15:56:31Z", "goal": "Generated Sprint", "numberOfDays": 13, "id": 42, "retrospective": null, "stories": [ {"id": 446}, {"id": 445}, {"id": 444}, {"id": 451}, {"id": 449}, {"id": 452}, {"id": 447}, {"id": 450} ], "doneDefinition": null, "orderNumber": 3, "parentRelease": {"id": 38}, "velocity": 40, "capacity": 40 } ]
<?xml version="1.0" encoding="UTF-8"?> <set> <sprint id="40"> <activationDate>2012-06-06 15:56:28.246 UTC</activationDate> <capacity>40.0</capacity> <closeDate>2012-06-06 15:56:28.946 UTC</closeDate> <dailyWorkTime>8.0</dailyWorkTime> <doneDefinition/> <endDate>2012-06-19 00:00:00.0 UTC</endDate> <goal>Generated Sprint</goal> <lastUpdated>2012-06-06 15:56:28.968 UTC</lastUpdated> <numberOfDays>13</numberOfDays> <orderNumber>1</orderNumber> <parentRelease id="38"/> <resource/> <retrospective/> <startDate>2012-06-06 00:00:00.0 UTC</startDate> <state>3</state> <stories> <story id="431"/> <story id="432"/> <story id="424"/> <story id="426"/> <story id="430"/> <story id="425"/> <story id="427"/> <story id="429"/> </stories> <tasks> <task id="1370"/> <task id="1360"/> <task id="1378"/> <task id="1376"/> <task id="1354"/> <task id="1364"/> <task id="1366"/> <task id="1358"/> </tasks> <velocity>40.0</velocity> </sprint> <sprint id="41"> <activationDate>2012-06-06 15:56:29.645 UTC</activationDate> <capacity>40.0</capacity> <closeDate>2012-06-06 15:56:30.481 UTC</closeDate> <dailyWorkTime>8.0</dailyWorkTime> <doneDefinition/> <endDate>2012-07-03 00:00:00.0 UTC</endDate> <goal>Generated Sprint</goal> <lastUpdated>2012-06-06 15:56:30.511 UTC</lastUpdated> <numberOfDays>13</numberOfDays> <orderNumber>2</orderNumber> <parentRelease id="38"/> <resource/> <retrospective/> <startDate>2012-06-20 00:00:00.0 UTC</startDate> <state>3</state> <stories> <story id="436"/> <story id="434"/> <story id="435"/> <story id="441"/> <story id="439"/> <story id="437"/> <story id="440"/> <story id="442"/> </stories> <tasks> <task id="1410"/> <task id="1400"/> <task id="1418"/> <task id="1394"/> <task id="1416"/> <task id="1404"/> <task id="1425"/> </tasks> <velocity>40.0</velocity> </sprint> <sprint id="42"> <activationDate>2012-06-06 15:56:31.277 UTC</activationDate> <capacity>40.0</capacity> <closeDate>2012-06-06 15:56:32.210 UTC</closeDate> <dailyWorkTime>8.0</dailyWorkTime> <doneDefinition/> <endDate>2012-07-17 00:00:00.0 UTC</endDate> <goal>Generated Sprint</goal> <lastUpdated>2012-06-06 15:56:32.249 UTC</lastUpdated> <numberOfDays>13</numberOfDays> <orderNumber>3</orderNumber> <parentRelease id="38"/> <resource/> <retrospective/> <startDate>2012-07-04 00:00:00.0 UTC</startDate> <state>3</state> <stories> <story id="446"/> <story id="445"/> <story id="444"/> <story id="451"/> <story id="449"/> <story id="452"/> <story id="447"/> <story id="450"/> </stories> <tasks> <task id="1448"/> <task id="1442"/> <task id="1458"/> </tasks> <velocity>40.0</velocity> </sprint> </set>
GET http://:server/ws/p/:pkey/sprint/:id
{ "startDate": "2012-06-06T00:00:00Z", "dailyWorkTime": 8, "closeDate": "2012-06-06T15:56:28Z", "state": 3, "resource": null, "lastUpdated": "2012-06-06T15:56:28Z", "endDate": "2012-06-19T00:00:00Z", "tasks": [ {"id": 1370}, {"id": 1360}, {"id": 1378}, {"id": 1376}, {"id": 1354}, {"id": 1364}, {"id": 1366}, {"id": 1358}, {"id": 1380}, {"id": 1346} ], "activationDate": "2012-06-06T15:56:28Z", "goal": "Generated Sprint", "numberOfDays": 13, "id": 40, "retrospective": null, "stories": [ {"id": 431}, {"id": 432}, {"id": 424}, {"id": 426}, {"id": 430}, {"id": 425}, {"id": 427}, {"id": 429} ], "doneDefinition": null, "orderNumber": 1, "parentRelease": {"id": 38}, "velocity": 40, "capacity": 40 }
<?xml version="1.0" encoding="UTF-8"?> <sprint id="40"> <activationDate>2012-06-06 15:56:28.246 UTC</activationDate> <capacity>40.0</capacity> <closeDate>2012-06-06 15:56:28.946 UTC</closeDate> <dailyWorkTime>8.0</dailyWorkTime> <doneDefinition/> <endDate>2012-06-19 00:00:00.0 UTC</endDate> <goal>Generated Sprint</goal> <lastUpdated>2012-06-06 15:56:28.968 UTC</lastUpdated> <numberOfDays>13</numberOfDays> <orderNumber>1</orderNumber> <parentRelease id="38"/> <resource/> <retrospective/> <startDate>2012-06-06 00:00:00.0 UTC</startDate> <state>3</state> <stories> <story id="431"/> <story id="432"/> <story id="424"/> <story id="426"/> <story id="430"/> <story id="425"/> <story id="427"/> <story id="429"/> </stories> <tasks> <task id="1370"/> <task id="1360"/> <task id="1378"/> <task id="1376"/> <task id="1354"/> <task id="1364"/> <task id="1366"/> <task id="1358"/> <task id="1380"/> <task id="1346"/> </tasks> <velocity>40.0</velocity> </sprint>
POST http://:server/ws/p/:pkey/sprint
{ "startDate": "2012-09-27T00:00:00Z", "dailyWorkTime": 8, "closeDate": null, "state": 1, "resource": null, "lastUpdated": "2012-06-07T15:32:56Z", "endDate": "2012-09-29T00:00:00Z", "tasks": null, "activationDate": null, "goal": "create a new sprint", "numberOfDays": 2, "id": 12, "retrospective": null, "stories": null, "doneDefinition": null, "orderNumber": 9, "parentRelease": {"id": 2}, "velocity": 0, "capacity": 0 }
<?xml version="1.0" encoding="UTF-8"?> <sprint id="13"> <activationDate/> <capacity>0.0</capacity> <closeDate/> <dailyWorkTime>8.0</dailyWorkTime> <doneDefinition/> <endDate>2012-10-02 00:00:00.0 UTC</endDate> <goal>create a new sprint</goal> <lastUpdated>2012-06-07 15:33:45.192 UTC</lastUpdated> <numberOfDays>2</numberOfDays> <orderNumber>10</orderNumber> <parentRelease id="2"/> <resource/> <retrospective/> <startDate>2012-09-30 00:00:00.0 UTC</startDate> <state>1</state> <stories/> <tasks/> <velocity>0.0</velocity> </sprint>
PUT http://:server/ws/p/:pkey/sprint/:id
{ "startDate": "2012-08-30T00:00:00Z", "dailyWorkTime": 8, "closeDate": null, "state": 1, "resource": null, "lastUpdated": "2012-06-06T15:56:46Z", "endDate": "2012-09-10T00:00:00Z", "tasks": [ {"id": 1745}, {"id": 1746}, {"id": 1747}, {"id": 1748}, {"id": 1720}, {"id": 1749}, {"id": 1730}, {"id": 1750}, {"id": 1751} ], "activationDate": null, "goal": "Generated Sprint updated", "numberOfDays": 11, "id": 46, "retrospective": null, "stories": [ {"id": 491}, {"id": 487}, {"id": 484}, {"id": 489}, {"id": 492}, {"id": 490}, {"id": 486}, {"id": 485} ], "doneDefinition": null, "orderNumber": 7, "parentRelease": {"id": 38}, "velocity": 0, "capacity": 40 }
<?xml version="1.0" encoding="UTF-8"?> <sprint id="46"> <activationDate/> <capacity>40.0</capacity> <closeDate/> <dailyWorkTime>8.0</dailyWorkTime> <doneDefinition/> <endDate>2012-09-09 00:00:00.0 UTC</endDate> <goal>Generated Sprint updated updated</goal> <lastUpdated>2012-06-06 15:56:47.144 UTC</lastUpdated> <numberOfDays>9</numberOfDays> <orderNumber>7</orderNumber> <parentRelease id="38"/> <resource/> <retrospective/> <startDate>2012-08-31 00:00:00.0 UTC</startDate> <state>1</state> <stories> <story id="484"/> <story id="491"/> <story id="487"/> <story id="489"/> <story id="485"/> <story id="490"/> <story id="486"/> <story id="492"/> </stories> <tasks> <task id="1745"/> <task id="1746"/> <task id="1747"/> <task id="1748"/> </tasks> <velocity>0.0</velocity> </sprint>
POST http://:server/ws/p/:pkey/sprint/:id/unPlan
{ "startDate": "2012-08-31T00:00:00Z", "dailyWorkTime": 8, "closeDate": null, "state": 1, "resource": null, "lastUpdated": "2012-06-06T15:56:57Z", "endDate": "2012-09-09T00:00:00Z", "tasks": [ {"id": 1720}, {"id": 1730}, {"id": 1714}, {"id": 1718}, {"id": 1724}, {"id": 1712}, {"id": 1716}, {"id": 1722}, {"id": 1732}, {"id": 1706} ], "activationDate": null, "goal": "Generated Sprint updated updated", "numberOfDays": 9, "id": 46, "retrospective": null, "stories": [], "doneDefinition": null, "orderNumber": 7, "parentRelease": {"id": 38}, "velocity": 0, "capacity": 0 }
<?xml version="1.0" encoding="UTF-8"?> <sprint id="9"> <activationDate>2012-06-07 08:53:34.565 UTC</activationDate> <capacity>40.0</capacity> <closeDate/> <dailyWorkTime>8.0</dailyWorkTime> <doneDefinition/> <endDate>2012-08-29 00:00:00.0 UTC</endDate> <goal>Generated Sprint</goal> <lastUpdated>2012-06-07 08:54:11.832 UTC</lastUpdated> <numberOfDays>13</numberOfDays> <orderNumber>6</orderNumber> <parentRelease id="2"/> <resource/> <retrospective/> <startDate>2012-08-16 00:00:00.0 UTC</startDate> <state>2</state> <stories/> <tasks> <task id="306"/> <task id="296"/> <task id="304"/> <task id="310"/> <task id="294"/> <task id="300"/> <task id="308"/> <task id="298"/> </tasks> <velocity>0.0</velocity> </sprint>
POST http://:server/ws/p/:pkey/sprint/:id/activate
{ "startDate": "2012-08-31T00:00:00Z", "dailyWorkTime": 8, "closeDate": null, "state": 2, "resource": null, "lastUpdated": "2012-06-06T15:57:15Z", "endDate": "2012-09-09T00:00:00Z", "tasks": [ {"id": 1720}, {"id": 1640}, {"id": 1730}, {"id": 1650}, {"id": 1714}, {"id": 1634}, {"id": 1644} ], "activationDate": "2012-06-06T15:57:15Z", "goal": "Generated Sprint updated updated", "numberOfDays": 9, "id": 46, "retrospective": null, "stories": [], "doneDefinition": null, "orderNumber": 7, "parentRelease": {"id": 38}, "velocity": 0, "capacity": 0 }
<?xml version="1.0" encoding="UTF-8"?> <sprint id="10"> <activationDate>2012-06-07 08:54:14.653 UTC</activationDate> <capacity>0.0</capacity> <closeDate/> <dailyWorkTime>8.0</dailyWorkTime> <doneDefinition/> <endDate>2012-09-10 00:00:00.0 UTC</endDate> <goal>Generated Sprint updated updated</goal> <lastUpdated>2012-06-07 08:54:14.923 UTC</lastUpdated> <numberOfDays>9</numberOfDays> <orderNumber>7</orderNumber> <parentRelease id="2"/> <resource/> <retrospective/> <startDate>2012-09-01 00:00:00.0 UTC</startDate> <state>2</state> <stories/> <tasks> <task id="396"/> <task id="368"/> <task id="366"/> <task id="296"/> <task id="304"/> <task id="310"/> <task id="294"/> </tasks> <velocity>0.0</velocity> </sprint>
POST http://:server/ws/p/:pkey/sprint/:id/close
{ "startDate": "2012-08-15T00:00:00Z", "dailyWorkTime": 8, "closeDate": "2012-06-06T15:57:14Z", "state": 3, "resource": null, "lastUpdated": "2012-06-06T15:57:14Z", "endDate": "2012-08-28T00:00:00Z", "tasks": [ {"id": 1665}, {"id": 1642}, {"id": 1663}, {"id": 1661}, {"id": 1659}, {"id": 1657}, {"id": 1655}, {"id": 1653}, {"id": 1651} ], "activationDate": "2012-06-06T15:56:37Z", "goal": "Generated Sprint", "numberOfDays": 13, "id": 45, "retrospective": null, "stories": [], "doneDefinition": null, "orderNumber": 6, "parentRelease": {"id": 38}, "velocity": 0, "capacity": 40 }
<?xml version="1.0" encoding="UTF-8"?> <sprint id="9"> <activationDate>2012-06-07 08:53:34.565 UTC</activationDate> <capacity>40.0</capacity> <closeDate>2012-06-07 08:54:13.568 UTC</closeDate> <dailyWorkTime>8.0</dailyWorkTime> <doneDefinition/> <endDate>2012-08-29 00:00:00.0 UTC</endDate> <goal>Generated Sprint</goal> <lastUpdated>2012-06-07 08:54:13.587 UTC</lastUpdated> <numberOfDays>13</numberOfDays> <orderNumber>6</orderNumber> <parentRelease id="2"/> <resource/> <retrospective/> <startDate>2012-08-16 00:00:00.0 UTC</startDate> <state>3</state> <stories/> <tasks> <task id="306"/> <task id="284"/> <task id="319"/> <task id="317"/> <task id="315"/> <task id="313"/> <task id="311"/> <task id="309"/> </tasks> <velocity>0.0</velocity> </sprint>
DELETE http://:server/ws/p/:pkey/sprint/:id