Obsolete iceScrum documention (R6#14+) This documentation applies only to old iceScrum R6. For new iceScrum v7, click here.
Contents
Story API
When retrieving stories, most attributes names and values are self-explanatory. Here is the correspondance between those that aren’t:
– state: 1: suggested (sandbox), 2: accepted (backlog), 3: estimated (backlog), 4: planned (sprint), 5: in progress (sprint), 7: done (sprint)
– type: 0: user story, 2: defect, 3: technical story
– testState (summary of story’s acceptance tests states): 0: no test, 1: to check, 5: failed, 10: success
Get all stories
GET http://:server/ws/p/:pkey/story
[
{
"uid": 1,
"inProgressDate": null,
"executionFrequency": 1,
"state": 1,
"actor": {"id": 4},
"type": 3,
"creator": {"id": 2},
"id": 1,
"doneDate": null,
"rank": 0,
"description": "As a user, I can do something awesome",
"name": "A story 0",
"feature": {"id": 1},
"acceptanceTests": [],
"acceptedDate": null,
"effort": null,
"lastUpdated": "2012-06-07T12:03:41Z",
"tasks": [],
"tags":[],
"dependsOn":null,
"dependences": [],
"parentSprint": null,
"estimatedDate": null,
"creationDate": "2012-06-07T12:03:29Z",
"plannedDate": null,
"suggestedDate": "2012-06-07T12:03:29Z",
"notes": "<b>Un texte en gras</b> hahaha ! <em>et en italique</em>"
},
{
"uid": 2,
"inProgressDate": "2012-06-07T12:04:21Z",
"executionFrequency": 1,
"state": 7,
"actor": {"id": 2},
"type": 0,
"creator": {"id": 2},
"id": 2,
"doneDate": "2012-06-07T12:04:22Z",
"rank": 2,
"description": "As a user, I can do something awesome",
"name": "A story 1",
"feature": {"id": 2},
"acceptanceTests": [],
"acceptedDate": null,
"effort": 5,
"lastUpdated": "2012-06-07T12:04:23Z",
"tasks": [],
"tags":[],
"dependsOn":null,
"dependences": [],
"parentSprint": {"id": 4},
"estimatedDate": "2012-06-07T12:03:36Z",
"creationDate": "2012-06-07T12:03:36Z",
"plannedDate": "2012-06-07T12:03:43Z",
"suggestedDate": "2012-06-07T12:03:36Z",
"notes": "<b>Un texte en gras</b> hahaha ! <em>et en italique</em>"
},
{
"uid": 3,
"inProgressDate": "2012-06-07T12:04:21Z",
"executionFrequency": 1,
"state": 7,
"actor": {"id": 2},
"type": 0,
"creator": {"id": 2},
"id": 3,
"doneDate": "2012-06-07T12:04:22Z",
"rank": 3,
"description": "As a user, I can do something awesome",
"name": "A story 2",
"feature": {"id": 2},
"acceptanceTests": [],
"acceptedDate": null,
"effort": 5,
"lastUpdated": "2012-06-07T12:04:23Z",
"tasks": [],
"tags":[],
"dependsOn":null,
"dependences": [],
"parentSprint": {"id": 4},
"estimatedDate": "2012-06-07T12:03:36Z",
"creationDate": "2012-06-07T12:03:36Z",
"plannedDate": "2012-06-07T12:03:44Z",
"suggestedDate": "2012-06-07T12:03:36Z",
"notes": "<b>Un texte en gras</b> hahaha ! <em>et en italique</em>"
},
{
"uid": 4,
"inProgressDate": "2012-06-07T12:04:21Z",
"executionFrequency": 1,
"state": 7,
"actor": {"id": 3},
"type": 0,
"creator": {"id": 2},
"id": 4,
"doneDate": "2012-06-07T12:04:22Z",
"rank": 4,
"description": "As a user, I can do something awesome",
"name": "A story 3",
"feature": {"id": 3},
"acceptanceTests": [],
"acceptedDate": null,
"effort": 5,
"lastUpdated": "2012-06-07T12:04:23Z",
"tasks": [],
"tags":[],
"dependsOn":null,
"dependences": [],
"parentSprint": {"id": 4},
"estimatedDate": "2012-06-07T12:03:36Z",
"creationDate": "2012-06-07T12:03:36Z",
"plannedDate": "2012-06-07T12:03:46Z",
"suggestedDate": "2012-06-07T12:03:36Z",
"notes": "<b>Un texte en gras</b> hahaha ! <em>et en italique</em>"
}
]
<?xml version="1.0" encoding="UTF-8"?>
<list>
<story id="1">
<acceptanceTests/>
<acceptedDate/>
<actor id="4"/>
<creationDate>2012-06-07 12:03:29.799 UTC</creationDate>
<creator id="2"/>
<description>As a user, I can do something awesome</description>
<doneDate/>
<effort/>
<estimatedDate/>
<executionFrequency>1</executionFrequency>
<feature id="1"/>
<inProgressDate/>
<lastUpdated>2012-06-07 12:03:41.950 UTC</lastUpdated>
<name>A story 0</name>
<notes><b>Un texte en gras</b> hahaha ! <em>et en italique</em></notes>
<parentSprint/>
<plannedDate/>
<rank>0</rank>
<state>1</state>
<suggestedDate>2012-06-07 12:03:29.800 UTC</suggestedDate>
<tasks/>
<tags/>
<dependsOn/>
<dependences/>
<type>3</type>
<uid>1</uid>
</story>
<story id="2">
<acceptanceTests/>
<acceptedDate/>
<actor id="2"/>
<creationDate>2012-06-07 12:03:36.512 UTC</creationDate>
<creator id="2"/>
<description>As a user, I can do something awesome</description>
<doneDate>2012-06-07 12:04:22.765 UTC</doneDate>
<effort>5</effort>
<estimatedDate>2012-06-07 12:03:36.512 UTC</estimatedDate>
<executionFrequency>1</executionFrequency>
<feature id="2"/>
<inProgressDate>2012-06-07 12:04:21.20 UTC</inProgressDate>
<lastUpdated>2012-06-07 12:04:23.193 UTC</lastUpdated>
<name>A story 1</name>
<notes><b>Un texte en gras</b> hahaha ! <em>et en italique</em></notes>
<parentSprint id="4"/>
<plannedDate>2012-06-07 12:03:43.179 UTC</plannedDate>
<rank>2</rank>
<state>7</state>
<suggestedDate>2012-06-07 12:03:36.512 UTC</suggestedDate>
<tasks/>
<tags/>
<dependsOn/>
<dependences/>
<type>0</type>
<uid>2</uid>
</story>
<story id="3">
<acceptanceTests/>
<acceptedDate/>
<actor id="2"/>
<creationDate>2012-06-07 12:03:36.577 UTC</creationDate>
<creator id="2"/>
<description>As a user, I can do something awesome</description>
<doneDate>2012-06-07 12:04:22.771 UTC</doneDate>
<effort>5</effort>
<estimatedDate>2012-06-07 12:03:36.577 UTC</estimatedDate>
<executionFrequency>1</executionFrequency>
<feature id="2"/>
<inProgressDate>2012-06-07 12:04:21.28 UTC</inProgressDate>
<lastUpdated>2012-06-07 12:04:23.199 UTC</lastUpdated>
<name>A story 2</name>
<notes><b>Un texte en gras</b> hahaha ! <em>et en italique</em></notes>
<parentSprint id="4"/>
<plannedDate>2012-06-07 12:03:44.735 UTC</plannedDate>
<rank>3</rank>
<state>7</state>
<suggestedDate>2012-06-07 12:03:36.577 UTC</suggestedDate>
<tasks/>
<tags/>
<dependsOn/>
<dependences/>
<type>0</type>
<uid>3</uid>
</story>
<story id="4">
<acceptanceTests/>
<acceptedDate/>
<actor id="3"/>
<creationDate>2012-06-07 12:03:36.637 UTC</creationDate>
<creator id="2"/>
<description>As a user, I can do something awesome</description>
<doneDate>2012-06-07 12:04:22.773 UTC</doneDate>
<effort>5</effort>
<estimatedDate>2012-06-07 12:03:36.637 UTC</estimatedDate>
<executionFrequency>1</executionFrequency>
<feature id="3"/>
<inProgressDate>2012-06-07 12:04:21.30 UTC</inProgressDate>
<lastUpdated>2012-06-07 12:04:23.204 UTC</lastUpdated>
<name>A story 3</name>
<notes><b>Un texte en gras</b> hahaha ! <em>et en italique</em></notes>
<parentSprint id="4"/>
<plannedDate>2012-06-07 12:03:46.84 UTC</plannedDate>
<rank>4</rank>
<state>7</state>
<suggestedDate>2012-06-07 12:03:36.637 UTC</suggestedDate>
<tasks/>
<tags/>
<dependsOn/>
<dependences/>
<type>0</type>
<uid>4</uid>
</story>
</list>
Get a story
GET http://:server/ws/p/:pkey/story/:id
{
"uid": 1,
"inProgressDate": null,
"executionFrequency": 1,
"state": 1,
"actor": {"id": 4},
"type": 3,
"creator": {"id": 2},
"id": 1,
"doneDate": null,
"rank": 0,
"description": "As a user, I can do something awesome",
"name": "A story 0",
"feature": {"id": 1},
"acceptanceTests": [],
"acceptedDate": null,
"effort": null,
"lastUpdated": "2012-06-07T12:03:41Z",
"tasks": [],
"tags":[],
"dependsOn":null,
"dependences": [],
"parentSprint": null,
"estimatedDate": null,
"creationDate": "2012-06-07T12:03:29Z",
"plannedDate": null,
"suggestedDate": "2012-06-07T12:03:29Z",
"notes": "<b>Un texte en gras</b> hahaha ! <em>et en italique</em>"
}
<?xml version="1.0" encoding="UTF-8"?>
<story id="1">
<acceptanceTests/>
<acceptedDate/>
<actor id="4"/>
<creationDate>2012-06-07 12:03:29.799 UTC</creationDate>
<creator id="2"/>
<description>As a user, I can do something awesome</description>
<doneDate/>
<effort/>
<estimatedDate/>
<executionFrequency>1</executionFrequency>
<feature id="1"/>
<inProgressDate/>
<lastUpdated>2012-06-07 12:03:41.950 UTC</lastUpdated>
<name>A story 0</name>
<notes><b>Un texte en gras</b> hahaha ! <em>et en italique</em></notes>
<parentSprint/>
<plannedDate/>
<rank>0</rank>
<state>1</state>
<suggestedDate>2012-06-07 12:03:29.800 UTC</suggestedDate>
<tasks/>
<tags/>
<dependsOn/>
<dependences/>
<type>3</type>
<uid>1</uid>
</story>
Create a story
POST http://:server/ws/p/:pkey/story
Input
- story.name
- Required
- story.type
- Optional integer - 0: user story, 2: defect, 3: technical story
- story.description
- Optional
- story.notes
- Optional - You can use the textile markup
- story.feature.id
- Optional integer
- story.dependsOn.id
- Optional integer
- story.tags
- Optional - Use commas for multiple tags
{
"uid": 141,
"inProgressDate": null,
"executionFrequency": 1,
"state": 1,
"actor": null,
"type": 0,
"creator": {"id": 2},
"id": 141,
"doneDate": null,
"rank": 0,
"description": "testing create a new story",
"name": "test storyapplication/json",
"feature": null,
"acceptanceTests": null,
"acceptedDate": null,
"effort": null,
"lastUpdated": "2012-06-07T12:04:58Z",
"tasks": null,
"tags":[],
"dependsOn":null,
"dependences": [],
"parentSprint": null,
"estimatedDate": null,
"creationDate": "2012-06-07T12:04:58Z",
"plannedDate": null,
"suggestedDate": "2012-06-07T12:04:58Z",
"notes": null
}
<?xml version="1.0" encoding="UTF-8"?>
<story id="142">
<acceptanceTests/>
<acceptedDate/>
<actor/>
<creationDate>2012-06-07 12:05:00.281 UTC</creationDate>
<creator id="2"/>
<description>testing create a new story</description>
<doneDate/>
<effort/>
<estimatedDate/>
<executionFrequency>1</executionFrequency>
<feature/>
<inProgressDate/>
<lastUpdated>2012-06-07 12:05:00.335 UTC</lastUpdated>
<name>test storyapplication/xml</name>
<notes/>
<parentSprint/>
<plannedDate/>
<rank>0</rank>
<state>1</state>
<suggestedDate>2012-06-07 12:05:00.326 UTC</suggestedDate>
<tasks/>
<tags/>
<dependsOn/>
<dependences/>
<type>0</type>
<uid>142</uid>
</story>
Update a story
PUT http://:server/ws/p/:pkey/story/:id
Input
- story.name
- Optional
- story.type
- Optional integer - 0: user story, 2: defect, 3: technical story
- story.description
- Optional
- story.notes
- Optional - You can use the textile markup
- story.feature.id
- Optional integer
- story.sprint.id
- Optional integer
- story.rank
- Optional integer - Relative position in the stories list
- story.effort
- Optional integer
- story.dependsOn.id
- Optional integer
- story.tags
- Optional - Requires the manageTags parameter, use commas for multiple tags
- manageTags
- Optional boolean - Required if you want to update tags
{
"uid": 52,
"inProgressDate": "2012-06-07T12:04:39Z",
"executionFrequency": 1,
"state": 5,
"actor": null,
"type": 0,
"creator": {"id": 2},
"id": 52,
"doneDate": null,
"rank": 2,
"description": "testing update existing story",
"name": "Update 5 application/json",
"feature": {"id": 3},
"acceptanceTests": [],
"acceptedDate": null,
"effort": 5,
"lastUpdated": "2012-06-07T12:05:02Z",
"tasks": [
{"id": 341},
{"id": 331},
{"id": 345},
{"id": 352},
{"id": 335}
],
"tags":[],
"dependsOn":null,
"dependences": [],
"parentSprint": {"id": 9},
"estimatedDate": "2012-06-07T12:03:39Z",
"creationDate": "2012-06-07T12:03:39Z",
"plannedDate": "2012-06-07T12:04:14Z",
"suggestedDate": "2012-06-07T12:03:39Z",
"notes": "<b>Un texte en gras</b> hahaha ! <em>et en italique</em>"
}
<?xml version="1.0" encoding="UTF-8"?>
<story id="53">
<acceptanceTests/>
<acceptedDate/>
<actor/>
<creationDate>2012-06-07 12:03:39.986 UTC</creationDate>
<creator id="2"/>
<description>testing update existing story</description>
<doneDate/>
<effort>5</effort>
<estimatedDate>2012-06-07 12:03:39.986 UTC</estimatedDate>
<executionFrequency>1</executionFrequency>
<feature id="1"/>
<inProgressDate>2012-06-07 12:04:39.778 UTC</inProgressDate>
<lastUpdated>2012-06-07 12:05:04.359 UTC</lastUpdated>
<name>Update 5 application/xml</name>
<notes><b>Un texte en gras</b> hahaha ! <em>et en italique</em></notes>
<parentSprint id="9"/>
<plannedDate>2012-06-07 12:04:14.945 UTC</plannedDate>
<rank>3</rank>
<state>5</state>
<suggestedDate>2012-06-07 12:03:39.986 UTC</suggestedDate>
<tasks>
<task id="343"/>
<task id="332"/>
<task id="346"/>
<task id="348"/>
<task id="336"/>
</tasks>
<tags/>
<dependsOn/>
<dependences/>
<type>2</type>
<uid>53</uid>
</story>
Associate a story to a feature
POST http://:server/ws/p/:pkey/story/:id/associateFeature
Input
- feature.id
- Required integer
{
"uid": 26,
"inProgressDate": null,
"executionFrequency": 1,
"state": 1,
"actor": {"id": 4},
"type": 0,
"creator": {"id": 2},
"id": 26,
"doneDate": null,
"rank": 0,
"description": "As a user, I can do something awesome",
"name": "A story 25",
"feature": {"id": 4},
"acceptanceTests": [],
"acceptedDate": null,
"effort": null,
"lastUpdated": "2012-06-07T12:06:00Z",
"tasks": [],
"tags":[],
"dependsOn":null,
"dependences": [],
"parentSprint": null,
"estimatedDate": null,
"creationDate": "2012-06-07T12:03:38Z",
"plannedDate": null,
"suggestedDate": "2012-06-07T12:03:38Z",
"notes": "<b>Un texte en gras</b> hahaha ! <em>et en italique</em>"
}
<?xml version="1.0" encoding="UTF-8"?>
<story id="26">
<acceptanceTests/>
<acceptedDate/>
<actor id="4"/>
<creationDate>2012-06-07 12:03:38.275 UTC</creationDate>
<creator id="2"/>
<description>As a user, I can do something awesome</description>
<doneDate/>
<effort/>
<estimatedDate/>
<executionFrequency>1</executionFrequency>
<feature id="5"/>
<inProgressDate/>
<lastUpdated>2012-06-07 12:06:01.58 UTC</lastUpdated>
<name>A story 25</name>
<notes><b>Un texte en gras</b> hahaha ! <em>et en italique</em></notes>
<parentSprint/>
<plannedDate/>
<rank>0</rank>
<state>1</state>
<suggestedDate>2012-06-07 12:03:38.275 UTC</suggestedDate>
<tasks/>
<tags/>
<dependsOn/>
<dependences/>
<type>0</type>
<uid>26</uid>
</story>
Accept a story
POST http://:server/ws/p/:pkey/story/:id/accept
Input
- type
- Required - One of feature, story, task
[{
"uid": 1,
"inProgressDate": null,
"executionFrequency": 1,
"state": 2,
"actor": null,
"type": 3,
"creator": {"id": 2},
"id": 1,
"doneDate": null,
"rank": 59,
"description": "testing update existing story",
"name": "Update bis application/json",
"feature": {"id": 1},
"acceptanceTests": [],
"acceptedDate": "2012-06-07T12:06:26Z",
"effort": null,
"lastUpdated": "2012-06-07T12:06:26Z",
"tasks": [],
"tags":[],
"dependsOn":null,
"dependences": [],
"parentSprint": null,
"estimatedDate": null,
"creationDate": "2012-06-07T12:03:29Z",
"plannedDate": null,
"suggestedDate": "2012-06-07T12:03:29Z",
"notes": "<b>Un texte en gras</b> hahaha ! <em>et en italique</em>"
}]
<?xml version="1.0" encoding="UTF-8"?>
<list>
<story id="6">
<acceptanceTests/>
<acceptedDate>2012-06-07 12:06:26.901 UTC</acceptedDate>
<actor id="4"/>
<creationDate>2012-06-07 12:03:36.766 UTC</creationDate>
<creator id="2"/>
<description>As a user, I can do something awesome</description>
<doneDate/>
<effort/>
<estimatedDate/>
<executionFrequency>1</executionFrequency>
<feature id="2"/>
<inProgressDate/>
<lastUpdated>2012-06-07 12:06:26.915 UTC</lastUpdated>
<name>A story 5</name>
<notes><b>Un texte en gras</b> hahaha ! <em>et en italique</em></notes>
<parentSprint/>
<plannedDate/>
<rank>60</rank>
<state>2</state>
<suggestedDate>2012-06-07 12:03:36.766 UTC</suggestedDate>
<tasks/>
<tags/>
<dependsOn/>
<dependences/>
<type>0</type>
<uid>6</uid>
</story>
</list>
Update the priority of a story
POST http://:server/ws/p/:pkey/story/:id/rank
Input
- story.rank
- Required integer - Relative position in the stories list
{
"uid": 62,
"inProgressDate": null,
"executionFrequency": 1,
"state": 4,
"actor": null,
"type": 0,
"creator": {"id": 2},
"id": 62,
"doneDate": null,
"rank": 1,
"description": "As a user, I can do something awesome",
"name": "A story 61",
"feature": null,
"acceptanceTests": [],
"acceptedDate": null,
"effort": 5,
"lastUpdated": "2012-06-07T12:05:27Z",
"tasks": [
{"id": 418},
{"id": 420},
{"id": 442},
{"id": 435},
{"id": 414},
{"id": 413}
],
"tags":[],
"dependsOn":null,
"dependences": [],
"parentSprint": {"id": 10},
"estimatedDate": "2012-06-07T12:03:40Z",
"creationDate": "2012-06-07T12:03:40Z",
"plannedDate": "2012-06-07T12:04:16Z",
"suggestedDate": "2012-06-07T12:03:40Z",
"notes": "<b>Un texte en gras</b> hahaha ! <em>et en italique</em>"
}
<?xml version="1.0" encoding="UTF-8"?>
<story id="62">
<acceptanceTests/>
<acceptedDate/>
<actor/>
<creationDate>2012-06-07 13:15:18.910 UTC</creationDate>
<creator id="2"/>
<description>As a user, I can do something awesome</description>
<doneDate/>
<effort>5</effort>
<estimatedDate>2012-06-07 13:15:18.910 UTC</estimatedDate>
<executionFrequency>1</executionFrequency>
<feature/>
<inProgressDate/>
<lastUpdated>2012-06-07 13:16:57.295 UTC</lastUpdated>
<name>A story 61</name>
<notes><b>Un texte en gras</b> hahaha ! <em>et en italique</em></notes>
<parentSprint id="10"/>
<plannedDate>2012-06-07 13:15:53.146 UTC</plannedDate>
<rank>1</rank>
<state>4</state>
<suggestedDate>2012-06-07 13:15:18.910 UTC</suggestedDate>
<tasks>
<task id="418"/>
<task id="420"/>
<task id="442"/>
<task id="435"/>
<task id="414"/>
<task id="413"/>
</tasks>
<tags/>
<dependsOn/>
<dependences/>
<type>0</type>
<uid>62</uid>
</story>
Estimate a story
POST http://:server/ws/p/:pkey/story/:id/estimate
Input
- story.effort
- Optional integer
{
"uid": 111,
"inProgressDate": null,
"executionFrequency": 1,
"state": 3,
"actor": {"id": 4},
"type": 0,
"creator": {"id": 2},
"id": 111,
"doneDate": null,
"rank": 56,
"description": "As a user, I can do something awesome",
"name": "A story 110",
"feature": {"id": 2},
"acceptanceTests": [],
"acceptedDate": null,
"effort": 5,
"lastUpdated": "2012-06-07T12:05:32Z",
"tasks": [],
"tags":[],
"dependsOn":null,
"dependences": [],
"parentSprint": null,
"estimatedDate": "2012-06-07T12:05:32Z",
"creationDate": "2012-06-07T12:04:32Z",
"plannedDate": null,
"suggestedDate": "2012-06-07T12:04:32Z",
"notes": "<b>Un texte en gras</b> hahaha ! <em>et en italique</em>"
}
<?xml version="1.0" encoding="UTF-8"?>
<story id="114">
<acceptanceTests/>
<acceptedDate/>
<actor id="2"/>
<creationDate>2012-06-07 12:04:32.591 UTC</creationDate>
<creator id="2"/>
<description>As a user, I can do something awesome</description>
<doneDate/>
<effort>5</effort>
<estimatedDate>2012-06-07 12:05:33.386 UTC</estimatedDate>
<executionFrequency>1</executionFrequency>
<feature id="2"/>
<inProgressDate/>
<lastUpdated>2012-06-07 12:05:33.513 UTC</lastUpdated>
<name>A story 113</name>
<notes><b>Un texte en gras</b> hahaha ! <em>et en italique</em></notes>
<parentSprint/>
<plannedDate/>
<rank>3</rank>
<state>3</state>
<suggestedDate>2012-06-07 12:04:32.591 UTC</suggestedDate>
<tasks/>
<tags/>
<dependsOn/>
<dependences/>
<type>0</type>
<uid>114</uid>
</story>
Plan a story in a sprint
POST http://:server/ws/p/:pkey/story/:id/plan
Input
- sprint.id
- Required integer
{
"id": 2624,
"acceptanceTests": [],
"acceptedDate": null,
"actor": {"id": 115},
"creationDate": "2012-06-01T16:41:17Z",
"creator": {"id": 58},
"description": "As a user, I can do something awesome",
"doneDate": null,
"effort": 5,
"estimatedDate": "2012-06-01T16:41:17Z",
"executionFrequency": 1,
"feature": null,
"inProgressDate": "2012-06-08T12:53:42Z",
"lastUpdated": "2012-06-08T12:53:43Z",
"name": "A story 97",
"notes": "<b>Un texte en gras</b> hahaha ! <em>et en italique</em>",
"parentSprint": {"id": 220},
"plannedDate": "2012-06-08T12:53:42Z",
"rank": 10,
"state": 5,
"suggestedDate": "2012-06-01T16:41:17Z",
"tasks": [],
"tags":[],
"dependsOn":null,
"dependences": [],
"type": 0,
"uid": 98
}
<?xml version="1.0" encoding="UTF-8"?>
<story id="2662">
<acceptanceTests />
<acceptedDate />
<actor id="117" />
<creationDate>2012-06-01 16:41:47.0 UTC</creationDate>
<creator id="58" />
<description>As a user, I can do something awesome</description>
<doneDate />
<effort>5</effort>
<estimatedDate>2012-06-01 16:41:47.0 UTC</estimatedDate>
<executionFrequency>1</executionFrequency>
<feature id="70" />
<inProgressDate>2012-06-08 13:00:18.817 UTC</inProgressDate>
<lastUpdated>2012-06-08 13:00:19.113 UTC</lastUpdated>
<name>A story 135</name>
<notes><b>Un texte en gras</b> hahaha ! <em>et en italique</em></notes>
<parentSprint id="220" />
<plannedDate>2012-06-08 13:00:18.817 UTC</plannedDate>
<rank>13</rank>
<state>5</state>
<suggestedDate>2012-06-01 16:41:47.0 UTC</suggestedDate>
<tasks />
<tags/>
<dependsOn/>
<dependences/>
<type>0</type>
<uid>136</uid>
</story>
Unplan a story
GET http://:server/ws/p/:pkey/story/:id/unPlan
Input
- shiftToNext
- Optional boolean - If true, the story is shifted to the next sprint
{
"uid": 62,
"inProgressDate": null,
"executionFrequency": 1,
"state": 3,
"actor": null,
"type": 0,
"creator": {"id": 2},
"id": 62,
"doneDate": null,
"rank": 1,
"description": "As a user, I can do something awesome",
"name": "A story 61",
"feature": null,
"acceptanceTests": [],
"acceptedDate": null,
"effort": 5,
"lastUpdated": "2012-06-07T12:05:53Z",
"tasks": [],
"tags":[],
"dependsOn":null,
"dependences": [],
"parentSprint": null,
"estimatedDate": "2012-06-07T12:03:40Z",
"creationDate": "2012-06-07T12:03:40Z",
"plannedDate": null,
"suggestedDate": "2012-06-07T12:03:40Z",
"notes": "<b>Un texte en gras</b> hahaha ! <em>et en italique</em>"
}
<?xml version="1.0" encoding="UTF-8"?>
<story id="63">
<acceptanceTests/>
<acceptedDate/>
<actor id="2"/>
<creationDate>2012-06-07 12:03:40.679 UTC</creationDate>
<creator id="2"/>
<description>As a user, I can do something awesome</description>
<doneDate/>
<effort>5</effort>
<estimatedDate>2012-06-07 12:03:40.679 UTC</estimatedDate>
<executionFrequency>1</executionFrequency>
<feature id="2"/>
<inProgressDate/>
<lastUpdated>2012-06-07 12:05:58.628 UTC</lastUpdated>
<name>A story 62</name>
<notes><b>Un texte en gras</b> hahaha ! <em>et en italique</em></notes>
<parentSprint/>
<plannedDate/>
<rank>1</rank>
<state>3</state>
<suggestedDate>2012-06-07 12:03:40.679 UTC</suggestedDate>
<tasks/>
<tags/>
<dependsOn/>
<dependences/>
<type>0</type>
<uid>63</uid>
</story>
Set a story to done
POST http://:server/ws/p/:pkey/story/:id/done
{
"uid": 54,
"inProgressDate": "2012-06-07T12:04:39Z",
"executionFrequency": 1,
"state": 7,
"actor": null,
"type": 0,
"creator": {"id": 2},
"id": 54,
"doneDate": "2012-06-07T12:06:01Z",
"rank": 8,
"description": "As a user, I can do something awesome",
"name": "A story 53",
"feature": null,
"acceptanceTests": [],
"acceptedDate": null,
"effort": 5,
"lastUpdated": "2012-06-07T12:06:01Z",
"tasks": [
{"id": 333},
{"id": 347},
{"id": 350},
{"id": 353},
{"id": 337}
],
"tags":[],
"dependsOn":null,
"dependences": [],
"parentSprint": {"id": 9},
"estimatedDate": "2012-06-07T12:03:40Z",
"creationDate": "2012-06-07T12:03:40Z",
"plannedDate": "2012-06-07T12:04:15Z",
"suggestedDate": "2012-06-07T12:03:40Z",
"notes": "<b>Un texte en gras</b> hahaha ! <em>et en italique</em>"
}
<?xml version="1.0" encoding="UTF-8"?>
<story id="55">
<acceptanceTests/>
<acceptedDate/>
<actor id="3"/>
<creationDate>2012-06-07 12:03:40.173 UTC</creationDate>
<creator id="2"/>
<description>As a user, I can do something awesome</description>
<doneDate>2012-06-07 12:06:06.501 UTC</doneDate>
<effort>5</effort>
<estimatedDate>2012-06-07 12:03:40.173 UTC</estimatedDate>
<executionFrequency>1</executionFrequency>
<feature id="3"/>
<inProgressDate>2012-06-07 12:04:39.767 UTC</inProgressDate>
<lastUpdated>2012-06-07 12:06:06.516 UTC</lastUpdated>
<name>A story 54</name>
<notes><b>Un texte en gras</b> hahaha ! <em>et en italique</em></notes>
<parentSprint id="9"/>
<plannedDate>2012-06-07 12:04:15.554 UTC</plannedDate>
<rank>7</rank>
<state>7</state>
<suggestedDate>2012-06-07 12:03:40.173 UTC</suggestedDate>
<tasks>
<task id="344"/>
<task id="334"/>
<task id="351"/>
<task id="354"/>
<task id="338"/>
</tasks>
<tags/>
<dependsOn/>
<dependences/>
<type>3</type>
<uid>55</uid>
</story>
Set a story to undone
POST http://:server/ws/p/:pkey/story/:id/unDone
{
"uid": 54,
"inProgressDate": "2012-06-07T12:06:19Z",
"executionFrequency": 1,
"state": 5,
"actor": null,
"type": 0,
"creator": {"id": 2},
"id": 54,
"doneDate": null,
"rank": 7,
"description": "As a user, I can do something awesome",
"name": "A story 53",
"feature": null,
"acceptanceTests": [],
"acceptedDate": null,
"effort": 5,
"lastUpdated": "2012-06-07T12:06:19Z",
"tasks": [
{"id": 333},
{"id": 347},
{"id": 350},
{"id": 353},
{"id": 337}
],
"tags":[],
"dependsOn":null,
"dependences": [],
"parentSprint": {"id": 9},
"estimatedDate": "2012-06-07T12:03:40Z",
"creationDate": "2012-06-07T12:03:40Z",
"plannedDate": "2012-06-07T12:04:15Z",
"suggestedDate": "2012-06-07T12:03:40Z",
"notes": "<b>Un texte en gras</b> hahaha ! <em>et en italique</em>"
}
<?xml version="1.0" encoding="UTF-8"?>
<story id="55">
<acceptanceTests/>
<acceptedDate/>
<actor id="3"/>
<creationDate>2012-06-07 12:03:40.173 UTC</creationDate>
<creator id="2"/>
<description>As a user, I can do something awesome</description>
<doneDate/>
<effort>5</effort>
<estimatedDate>2012-06-07 12:03:40.173 UTC</estimatedDate>
<executionFrequency>1</executionFrequency>
<feature id="3"/>
<inProgressDate>2012-06-07 12:06:22.820 UTC</inProgressDate>
<lastUpdated>2012-06-07 12:06:22.885 UTC</lastUpdated>
<name>A story 54</name>
<notes><b>Un texte en gras</b> hahaha ! <em>et en italique</em></notes>
<parentSprint id="9"/>
<plannedDate>2012-06-07 12:04:15.554 UTC</plannedDate>
<rank>8</rank>
<state>5</state>
<suggestedDate>2012-06-07 12:03:40.173 UTC</suggestedDate>
<tasks>
<task id="344"/>
<task id="334"/>
<task id="351"/>
<task id="354"/>
<task id="338"/>
</tasks>
<tags/>
<dependsOn/>
<dependences/>
<type>3</type>
<uid>55</uid>
</story>
Copy a story
POST http://:server/ws/p/:pkey/story/:id/copy
[{
"uid": 143,
"inProgressDate": null,
"executionFrequency": 1,
"state": 1,
"actor": {"id": 1},
"type": 2,
"creator": {"id": 2},
"id": 143,
"doneDate": null,
"rank": 0,
"description": "As a user, I can do something awesome",
"name": "A story 116_1",
"feature": {"id": 1},
"acceptanceTests": null,
"acceptedDate": null,
"effort": null,
"lastUpdated": "2012-06-07T12:06:39Z",
"tasks": null,
"tags":[],
"dependsOn":null,
"dependences": [],
"parentSprint": null,
"estimatedDate": null,
"creationDate": "2012-06-07T12:06:39Z",
"plannedDate": null,
"suggestedDate": "2012-06-07T12:06:39Z",
"notes": "<b>Un texte en gras</b> hahaha ! <em>et en italique</em>"
}]
<?xml version="1.0" encoding="UTF-8"?>
<list>
<story id="144">
<acceptanceTests/>
<acceptedDate/>
<actor id="1"/>
<creationDate>2012-06-07 12:06:41.358 UTC</creationDate>
<creator id="2"/>
<description>As a user, I can do something awesome</description>
<doneDate/>
<effort/>
<estimatedDate/>
<executionFrequency>1</executionFrequency>
<feature id="1"/>
<inProgressDate/>
<lastUpdated>2012-06-07 12:06:41.427 UTC</lastUpdated>
<name>A story 116_2</name>
<notes><b>Un texte en gras</b> hahaha ! <em>et en italique</em></notes>
<parentSprint/>
<plannedDate/>
<rank>0</rank>
<state>1</state>
<suggestedDate>2012-06-07 12:06:41.422 UTC</suggestedDate>
<tasks/>
<tags/>
<dependsOn/>
<dependences/>
<type>2</type>
<uid>144</uid>
</story>
</list>
Delete a story
DELETE http://:server/ws/p/:pkey/story/:id
