Task API – iceScrum

Obsolete iceScrum documention (R6#14+) This documentation applies only to old iceScrum R6. For new iceScrum v7, click here.

Contents

Task API

When retrieving tasks, most attributes names and values are self-explanatory. Here is the correspondance between those that aren’t:
– state: 0: todo, 1: in progress, 2: done
– type: 10: recurrent, 11: urgent

Get all filtered tasks for the current sprint

GET http://:server/ws/p/:pkey/task/:filter

Input


:filter
Optional - "user":current user's tasks only, "free": free tasks only

[
    {
        "uid": 321,
        "inProgressDate": null,
        "responsible": {"id": 8},
        "initial": null,
        "estimation": 5,
        "parentStory": null,
        "state": 1,
        "lastUpdated": "2012-06-07T09:38:57Z",
        "type": 10,
        "participants": [],
        "creator": {"id": 8},
        "id": 1179,
        "creationDate": "2012-06-07T09:38:51Z",
        "doneDate": null,
        "rank": 0,
        "backlog": {"id": 31},
        "color": "yellow",
        "description": null,
        "name": "task recurrent 31",
        "blocked": false,
        "notes": null,
        "tags": []
    },
    {
        "uid": 322,
        "inProgressDate": null,
        "responsible": {"id": 8},
        "initial": null,
        "estimation": 4,
        "parentStory": null,
        "state": 1,
        "lastUpdated": "2012-06-07T09:38:57Z",
        "type": 11,
        "participants": [],
        "creator": {"id": 8},
        "id": 1180,
        "creationDate": "2012-06-07T09:38:51Z",
        "doneDate": null,
        "rank": 0,
        "backlog": {"id": 31},
        "color": "yellow",
        "description": null,
        "name": "task urgent 0 31",
        "blocked": false,
        "notes": null,
        "tags": []
    },
    {
        "uid": 323,
        "inProgressDate": null,
        "responsible": {"id": 8},
        "initial": null,
        "estimation": 5,
        "parentStory": null,
        "state": 1,
        "lastUpdated": "2012-06-07T09:38:57Z",
        "type": 10,
        "participants": [],
        "creator": {"id": 8},
        "id": 1181,
        "creationDate": "2012-06-07T09:38:51Z",
        "doneDate": null,
        "rank": 0,
        "backlog": {"id": 31},
        "color": "yellow",
        "description": null,
        "name": "task recurrent 31",
        "blocked": false,
        "notes": null,
        "tags": []
    }
]

<?xml version="1.0" encoding="UTF-8"?>
<list>
    <task id="1179">
        <backlog id="31"/>
        <blocked>false</blocked>
        <color>yellow</color>
        <creationDate>2012-06-07 09:38:51.476 UTC</creationDate>
        <creator id="8"/>
        <description/>
        <doneDate/>
        <estimation>5.0</estimation>
        <inProgressDate/>
        <initial/>
        <lastUpdated>2012-06-07 09:38:57.359 UTC</lastUpdated>
        <name>task recurrent 31</name>
        <notes/>
        <tags/>
        <parentStory/>
        <participants/>
        <rank>0</rank>
        <responsible id="8"/>
        <state>1</state>
        <type>10</type>
        <uid>321</uid>
    </task>
    <task id="1180">
        <backlog id="31"/>
        <blocked>false</blocked>
        <color>yellow</color>
        <creationDate>2012-06-07 09:38:51.495 UTC</creationDate>
        <creator id="8"/>
        <description/>
        <doneDate/>
        <estimation>4.0</estimation>
        <inProgressDate/>
        <initial/>
        <lastUpdated>2012-06-07 09:38:57.364 UTC</lastUpdated>
        <name>task urgent 0 31</name>
        <notes/>
        <tags/>
        <parentStory/>
        <participants/>
        <rank>0</rank>
        <responsible id="8"/>
        <state>1</state>
        <type>11</type>
        <uid>322</uid>
    </task>
    <task id="1181">
        <backlog id="31"/>
        <blocked>false</blocked>
        <color>yellow</color>
        <creationDate>2012-06-07 09:38:51.513 UTC</creationDate>
        <creator id="8"/>
        <description/>
        <doneDate/>
        <estimation>5.0</estimation>
        <inProgressDate/>
        <initial/>
        <lastUpdated>2012-06-07 09:38:57.368 UTC</lastUpdated>
        <name>task recurrent 31</name>
        <notes/>
        <tags/>
        <parentStory/>
        <participants/>
        <rank>0</rank>
        <responsible id="8"/>
        <state>1</state>
        <type>10</type>
        <uid>323</uid>
    </task>
</list>

Get all filtered tasks for a given sprint

GET http://:server/ws/p/:pkey/:sprintid/task/:filter
[
    {
        "uid": 409,
        "inProgressDate": null,
        "responsible": {"id": 8},
        "initial": null,
        "estimation": 5,
        "parentStory": null,
        "state": 0,
        "lastUpdated": "2012-06-07T09:38:55Z",
        "type": 10,
        "participants": [],
        "creator": {"id": 8},
        "id": 1259,
        "creationDate": "2012-06-07T09:38:55Z",
        "doneDate": null,
        "rank": 0,
        "backlog": {"id": 32},
        "color": "yellow",
        "description": null,
        "name": "task recurrent 32",
        "blocked": false,
        "notes": null,
        "tags": []
    },
    {
        "uid": 410,
        "inProgressDate": null,
        "responsible": {"id": 8},
        "initial": null,
        "estimation": 4,
        "parentStory": null,
        "state": 0,
        "lastUpdated": "2012-06-07T09:38:55Z",
        "type": 11,
        "participants": [],
        "creator": {"id": 8},
        "id": 1260,
        "creationDate": "2012-06-07T09:38:55Z",
        "doneDate": null,
        "rank": 0,
        "backlog": {"id": 32},
        "color": "yellow",
        "description": null,
        "name": "task urgent 0 32",
        "blocked": false,
        "notes": null,
        "tags": []
    },
    {
        "uid": 411,
        "inProgressDate": null,
        "responsible": {"id": 8},
        "initial": null,
        "estimation": 5,
        "parentStory": null,
        "state": 0,
        "lastUpdated": "2012-06-07T09:38:55Z",
        "type": 10,
        "participants": [],
        "creator": {"id": 8},
        "id": 1261,
        "creationDate": "2012-06-07T09:38:55Z",
        "doneDate": null,
        "rank": 0,
        "backlog": {"id": 32},
        "color": "yellow",
        "description": null,
        "name": "task recurrent 32",
        "blocked": false,
        "notes": null,
        "tags": []
    }
]

<?xml version="1.0" encoding="UTF-8"?>
<list>
    <task id="1259">
        <backlog id="32"/>
        <blocked>false</blocked>
        <color>yellow</color>
        <creationDate>2012-06-07 09:38:55.910 UTC</creationDate>
        <creator id="8"/>
        <description/>
        <doneDate/>
        <estimation>5.0</estimation>
        <inProgressDate/>
        <initial/>
        <lastUpdated>2012-06-07 09:38:55.930 UTC</lastUpdated>
        <name>task recurrent 32</name>
        <notes/>
        <tags/>
        <parentStory/>
        <participants/>
        <rank>0</rank>
        <responsible id="8"/>
        <state>0</state>
        <type>10</type>
        <uid>409</uid>
    </task>
    <task id="1260">
        <backlog id="32"/>
        <blocked>false</blocked>
        <color>yellow</color>
        <creationDate>2012-06-07 09:38:55.931 UTC</creationDate>
        <creator id="8"/>
        <description/>
        <doneDate/>
        <estimation>4.0</estimation>
        <inProgressDate/>
        <initial/>
        <lastUpdated>2012-06-07 09:38:55.956 UTC</lastUpdated>
        <name>task urgent 0 32</name>
        <notes/>
        <tags/>
        <parentStory/>
        <participants/>
        <rank>0</rank>
        <responsible id="8"/>
        <state>0</state>
        <type>11</type>
        <uid>410</uid>
    </task>
    <task id="1261">
        <backlog id="32"/>
        <blocked>false</blocked>
        <color>yellow</color>
        <creationDate>2012-06-07 09:38:55.958 UTC</creationDate>
        <creator id="8"/>
        <description/>
        <doneDate/>
        <estimation>5.0</estimation>
        <inProgressDate/>
        <initial/>
        <lastUpdated>2012-06-07 09:38:55.982 UTC</lastUpdated>
        <name>task recurrent 32</name>
        <notes/>
        <tags/>
        <parentStory/>
        <participants/>
        <rank>0</rank>
        <responsible id="8"/>
        <state>0</state>
        <type>10</type>
        <uid>411</uid>
    </task>
</list>

Get a task

GET http://:server/ws/p/:pkey/task/:id
{
    "uid": 34,
    "inProgressDate": null,
    "responsible": {"id": 8},
    "initial": null,
    "estimation": 4,
    "parentStory": null,
    "state": 2,
    "lastUpdated": "2012-06-07T09:38:31Z",
    "type": 11,
    "participants": [],
    "creator": {"id": 8},
    "id": 932,
    "creationDate": "2012-06-07T09:38:29Z",
    "doneDate": null,
    "rank": 0,
    "backlog": {"id": 26},
    "color": "yellow",
    "description": null,
    "name": "task urgent 16 26",
    "blocked": false,
    "notes": null,
    "tags": []
}

<?xml version="1.0" encoding="UTF-8"?>
<task id="932">
    <backlog id="26"/>
    <blocked>false</blocked>
    <color>yellow</color>
    <creationDate>2012-06-07 09:38:29.953 UTC</creationDate>
    <creator id="8"/>
    <description/>
    <doneDate/>
    <estimation>4.0</estimation>
    <inProgressDate/>
    <initial/>
    <lastUpdated>2012-06-07 09:38:31.689 UTC</lastUpdated>
    <name>task urgent 16 26</name>
    <notes/>
    <tags/>
    <parentStory/>
    <participants/>
    <rank>0</rank>
    <responsible id="8"/>
    <state>2</state>
    <type>11</type>
    <uid>34</uid>
</task>

Create a task

POST http://:server/ws/p/:pkey/task

Input


task.parentStory.id
Optional integer - required if no type is specified

task.type
Optional - "recurrent" or "urgent", required if no parentStory is specified

task.sprint.id
Required

task.name
Required

task.description
Optional

task.notes
Optional - You can use the textile markup

task.estimation
Optional float

task.color
Optional - One of: yellow, blue, green, red, orange, violet, gray, pink, bluelight

task.tags
Optional - Use commas for multiple tags

{
    "uid": 449,
    "inProgressDate": null,
    "responsible": null,
    "initial": null,
    "estimation": null,
    "parentStory": null,
    "state": 0,
    "lastUpdated": "2012-06-07T09:39:17Z",
    "type": 10,
    "participants": null,
    "creator": {"id": 8},
    "id": 1347,
    "creationDate": "2012-06-07T09:39:17Z",
    "doneDate": null,
    "rank": 141,
    "backlog": {"id": 32},
    "color": "yellow",
    "description": "huhuhu",
    "name": "task test application/json",
    "blocked": false,
    "notes": null,
    "tags": []
}

<?xml version="1.0" encoding="UTF-8"?>
<task id="1348">
    <backlog id="32"/>
    <blocked>false</blocked>
    <color>yellow</color>
    <creationDate>2012-06-07 09:39:19.285 UTC</creationDate>
    <creator id="8"/>
    <description>huhuhu</description>
    <doneDate/>
    <estimation/>
    <inProgressDate/>
    <initial/>
    <lastUpdated>2012-06-07 09:39:19.580 UTC</lastUpdated>
    <name>task test application/xml</name>
    <notes/>
    <tags/>
    <parentStory/>
    <participants/>
    <rank>142</rank>
    <responsible/>
    <state>0</state>
    <type>10</type>
    <uid>450</uid>
</task>

Update a task

PUT http://:server/ws/p/:pkey/task/:id

Input


task.name
Optional

task.description
Optional

task.notes
Optional - You can use the textile markup

task.estimation
Optional float

task.color
Optional - One of: yellow, blue, green, red, orange, violet, gray, pink, bluelight

task.tags
Optional - Requires the manageTags parameter, use commas for multiple tags

manageTags
Optional boolean - Required if you want to update tags

{
    "uid": 301,
    "inProgressDate": null,
    "responsible": {"id": 8},
    "initial": null,
    "estimation": 3,
    "parentStory": {"id": 352},
    "state": 0,
    "lastUpdated": "2012-06-07T09:39:23Z",
    "type": null,
    "participants": [],
    "creator": {"id": 8},
    "id": 1219,
    "creationDate": "2012-06-07T09:38:51Z",
    "doneDate": null,
    "rank": 5,
    "backlog": {"id": 31},
    "color": "yellow",
    "description": "huhuhu bis",
    "name": "task test updated 1219 application/json",
    "blocked": false,
    "notes": null,
    "tags": []
}

<?xml version="1.0" encoding="UTF-8"?>
<task id="1219">
    <backlog id="31"/>
    <blocked>false</blocked>
    <color>yellow</color>
    <creationDate>2012-06-07 09:38:51.80 UTC</creationDate>
    <creator id="8"/>
    <description>huhuhu bis</description>
    <doneDate/>
    <estimation>3.0</estimation>
    <inProgressDate/>
    <initial/>
    <lastUpdated>2012-06-07 09:39:25.169 UTC</lastUpdated>
    <name>task test updated 1219 application/xml</name>
    <notes/>
    <tags/>
    <parentStory id="352"/>
    <participants/>
    <rank>5</rank>
    <responsible id="8"/>
    <state>0</state>
    <type/>
    <uid>301</uid>
</task>

Estimate a task

POST http://:server/ws/p/:pkey/task/:id/estimate

Input


task.estimation
Optional float

{
    "uid": 338,
    "inProgressDate": "2012-06-07T09:39:45Z",
    "responsible": {"id": 8},
    "initial": 5,
    "estimation": 3,
    "parentStory": {"id": 347},
    "state": 1,
    "lastUpdated": "2012-06-07T09:39:52Z",
    "type": null,
    "participants": [],
    "creator": {"id": 8},
    "id": 1196,
    "creationDate": "2012-06-07T09:38:51Z",
    "doneDate": null,
    "rank": 0,
    "backlog": {"id": 31},
    "color": "yellow",
    "description": "huhuhu bis",
    "name": "task test updated 1196 application/xml",
    "blocked": false,
    "notes": null,
    "tags": []
}

<?xml version="1.0" encoding="UTF-8"?>
<task id="1196">
    <backlog id="31"/>
    <blocked>false</blocked>
    <color>yellow</color>
    <creationDate>2012-06-07 09:38:51.905 UTC</creationDate>
    <creator id="8"/>
    <description>huhuhu bis</description>
    <doneDate/>
    <estimation>3.0</estimation>
    <inProgressDate>2012-06-07 09:39:45.322 UTC</inProgressDate>
    <initial>5.0</initial>
    <lastUpdated>2012-06-07 09:39:52.515 UTC</lastUpdated>
    <name>task test updated 1196 application/xml</name>
    <notes/>
    <tags/>
    <parentStory id="347"/>
    <participants/>
    <rank>0</rank>
    <responsible id="8"/>
    <state>1</state>
    <type/>
    <uid>338</uid>
</task>

Update the state of a task

POST http://:server/ws/p/:pkey/task/:id/state

Input


task.state
Required integer - 0: todo, 1:in progress, 2:done

{
    "uid": 338,
    "inProgressDate": "2012-06-07T09:39:45Z",
    "responsible": {"id": 8},
    "initial": 5,
    "estimation": 0,
    "parentStory": {"id": 347},
    "state": 2,
    "lastUpdated": "2012-06-07T09:40:16Z",
    "type": null,
    "participants": [],
    "creator": {"id": 8},
    "id": 1196,
    "creationDate": "2012-06-07T09:38:51Z",
    "doneDate": "2012-06-07T09:40:16Z",
    "rank": 0,
    "backlog": {"id": 31},
    "color": "yellow",
    "description": "huhuhu bis",
    "name": "task test updated 1196 application/xml",
    "blocked": false,
    "notes": null,
    "tags": []
}

<?xml version="1.0" encoding="UTF-8"?>
<task id="1224">
    <backlog id="31"/>
    <blocked>false</blocked>
    <color>yellow</color>
    <creationDate>2012-06-07 09:38:51.230 UTC</creationDate>
    <creator id="8"/>
    <description/>
    <doneDate>2012-06-07 09:40:16.886 UTC</doneDate>
    <estimation>0.0</estimation>
    <inProgressDate>2012-06-07 09:40:12.298 UTC</inProgressDate>
    <initial>5.0</initial>
    <lastUpdated>2012-06-07 09:40:16.896 UTC</lastUpdated>
    <name>task 2 story : 344</name>
    <notes/>
    <tags/>
    <parentStory id="344"/>
    <participants/>
    <rank>3</rank>
    <responsible id="8"/>
    <state>2</state>
    <type/>
    <uid>309</uid>
</task>

Take a task

POST http://:server/ws/p/:pkey/task/:id/take
{
    "uid": 384,
    "inProgressDate": null,
    "responsible": {"id": 8},
    "initial": null,
    "estimation": 3,
    "parentStory": {"id": 362},
    "state": 0,
    "lastUpdated": "2012-06-07T09:40:04Z",
    "type": null,
    "participants": [],
    "creator": {"id": 8},
    "id": 1302,
    "creationDate": "2012-06-07T09:38:55Z",
    "doneDate": null,
    "rank": 5,
    "backlog": {"id": 32},
    "color": "yellow",
    "description": "huhuhu bis",
    "name": "task test updated 1302 application/xml",
    "blocked": false,
    "notes": null,
    "tags": []
}

<?xml version="1.0" encoding="UTF-8"?>
<task id="1302">
    <backlog id="32"/>
    <blocked>false</blocked>
    <color>yellow</color>
    <creationDate>2012-06-07 09:38:55.410 UTC</creationDate>
    <creator id="8"/>
    <description>huhuhu bis</description>
    <doneDate/>
    <estimation>3.0</estimation>
    <inProgressDate/>
    <initial/>
    <lastUpdated>2012-06-07 09:40:04.449 UTC</lastUpdated>
    <name>task test updated 1302 application/xml</name>
    <notes/>
    <tags/>
    <parentStory id="362"/>
    <participants/>
    <rank>5</rank>
    <responsible id="8"/>
    <state>0</state>
    <type/>
    <uid>384</uid>
</task>

Unassign a task

POST http://:server/ws/p/:pkey/task/:id/unassign
{
    "uid": 384,
    "inProgressDate": null,
    "responsible": null,
    "initial": null,
    "estimation": 3,
    "parentStory": {"id": 362},
    "state": 0,
    "lastUpdated": "2012-06-07T09:39:59Z",
    "type": null,
    "participants": [],
    "creator": {"id": 8},
    "id": 1302,
    "creationDate": "2012-06-07T09:38:55Z",
    "doneDate": null,
    "rank": 5,
    "backlog": {"id": 32},
    "color": "yellow",
    "description": "huhuhu bis",
    "name": "task test updated 1302 application/xml",
    "blocked": false,
    "notes": null,
    "tags": []
}

<?xml version="1.0" encoding="UTF-8"?>
<task id="1281">
    <backlog id="32"/>
    <blocked>false</blocked>
    <color>yellow</color>
    <creationDate>2012-06-07 09:38:56.350 UTC</creationDate>
    <creator id="8"/>
    <description>huhuhu bis</description>
    <doneDate/>
    <estimation>5.0</estimation>
    <inProgressDate/>
    <initial/>
    <lastUpdated>2012-06-07 09:40:00.279 UTC</lastUpdated>
    <name>task test updated 1281 application/json</name>
    <notes/>
    <tags/>
    <parentStory id="362"/>
    <participants/>
    <rank>0</rank>
    <responsible/>
    <state>0</state>
    <type/>
    <uid>431</uid>
</task>

Block a task

POST http://:server/ws/p/:pkey/task/:id/block
{
    "uid": 338,
    "inProgressDate": "2012-06-07T09:39:45Z",
    "responsible": {"id": 8},
    "initial": 5,
    "estimation": 3,
    "parentStory": {"id": 347},
    "state": 1,
    "lastUpdated": "2012-06-07T09:40:11Z",
    "type": null,
    "participants": [],
    "creator": {"id": 8},
    "id": 1196,
    "creationDate": "2012-06-07T09:38:51Z",
    "doneDate": null,
    "rank": 0,
    "backlog": {"id": 31},
    "color": "yellow",
    "description": "huhuhu bis",
    "name": "task test updated 1196 application/xml",
    "blocked": true,
    "notes": null,
    "tags": []
}

<?xml version="1.0" encoding="UTF-8"?>
<task id="1224">
    <backlog id="31"/>
    <blocked>true</blocked>
    <color>yellow</color>
    <creationDate>2012-06-07 09:38:51.230 UTC</creationDate>
    <creator id="8"/>
    <description/>
    <doneDate/>
    <estimation>3.0</estimation>
    <inProgressDate>2012-06-07 09:40:12.298 UTC</inProgressDate>
    <initial>5.0</initial>
    <lastUpdated>2012-06-07 09:40:12.308 UTC</lastUpdated>
    <name>task 2 story : 344</name>
    <notes/>
    <tags/>
    <parentStory id="344"/>
    <participants/>
    <rank>3</rank>
    <responsible id="8"/>
    <state>1</state>
    <type/>
    <uid>309</uid>
</task>

Unblock a task

POST http://:server/ws/p/:pkey/task/:id/unblock
{
    "uid": 338,
    "inProgressDate": "2012-06-07T09:39:45Z",
    "responsible": {"id": 8},
    "initial": 5,
    "estimation": 3,
    "parentStory": {"id": 347},
    "state": 1,
    "lastUpdated": "2012-06-07T09:40:15Z",
    "type": null,
    "participants": [],
    "creator": {"id": 8},
    "id": 1196,
    "creationDate": "2012-06-07T09:38:51Z",
    "doneDate": null,
    "rank": 0,
    "backlog": {"id": 31},
    "color": "yellow",
    "description": "huhuhu bis",
    "name": "task test updated 1196 application/xml",
    "blocked": false,
    "notes": null,
    "tags": []
}

<?xml version="1.0" encoding="UTF-8"?>
<task id="1224">
    <backlog id="31"/>
    <blocked>false</blocked>
    <color>yellow</color>
    <creationDate>2012-06-07 09:38:51.230 UTC</creationDate>
    <creator id="8"/>
    <description/>
    <doneDate/>
    <estimation>3.0</estimation>
    <inProgressDate>2012-06-07 09:40:12.298 UTC</inProgressDate>
    <initial>5.0</initial>
    <lastUpdated>2012-06-07 09:40:16.16 UTC</lastUpdated>
    <name>task 2 story : 344</name>
    <notes/>
    <tags/>
    <parentStory id="344"/>
    <participants/>
    <rank>3</rank>
    <responsible id="8"/>
    <state>1</state>
    <type/>
    <uid>309</uid>
</task>

Delete a task

DELETE http://:server/ws/p/:pkey/task/:id

Next Story API >>

Try it for free now
All you need for your Agile project management