Release API – iceScrum

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

Contents

Release API

When retrieving releases, 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 all releases

GET http://:server/ws/p/:pkey/release
[
    {
        "id": 24,
        "startDate": "2012-06-06T00:00:00Z",
        "releaseVelocity": 0,
        "vision": "",
        "parentProduct": {"id": 23},
        "orderNumber": 1,
        "name": "dummy relesase",
        "state": 2,
        "lastUpdated": "2012-06-06T15:55:57Z",
        "endDate": "2012-10-04T00:00:00Z",
        "sprints": [
            {"id": 26},
            {"id": 27},
            {"id": 28},
            {"id": 29},
            {"id": 30},
            {"id": 31},
            {"id": 32},
            {"id": 33}
        ],
        "goal": "test Goal"
    },
    {
        "id": 25,
        "startDate": "2012-10-05T00:00:00Z",
        "releaseVelocity": 0,
        "vision": "",
        "parentProduct": {"id": 23},
        "orderNumber": 2,
        "name": "dummy relesase 2",
        "state": 1,
        "lastUpdated": "2012-06-06T15:55:33Z",
        "endDate": "2013-02-02T00:00:00Z",
        "sprints": [],
        "goal": "test Goal 2"
    }
]

<?xml version="1.0" encoding="UTF-8"?>
<set>
    <release id="24">
        <endDate>2012-10-04 00:00:00.0 UTC</endDate>
        <goal>test Goal</goal>
        <lastUpdated>2012-06-06 15:55:57.108 UTC</lastUpdated>
        <name>dummy relesase</name>
        <orderNumber>1</orderNumber>
        <parentProduct id="23"/>
        <releaseVelocity>0.0</releaseVelocity>
        <sprints>
            <sprint id="26"/>
            <sprint id="27"/>
            <sprint id="28"/>
            <sprint id="29"/>
            <sprint id="30"/>
            <sprint id="31"/>
            <sprint id="32"/>
            <sprint id="33"/>
        </sprints>
        <startDate>2012-06-06 00:00:00.0 UTC</startDate>
        <state>2</state>
        <vision/>
    </release>
    <release id="25">
        <endDate>2013-02-02 00:00:00.0 UTC</endDate>
        <goal>test Goal 2</goal>
        <lastUpdated>2012-06-06 15:55:33.97 UTC</lastUpdated>
        <name>dummy relesase 2</name>
        <orderNumber>2</orderNumber>
        <parentProduct id="23"/>
        <releaseVelocity>0.0</releaseVelocity>
        <sprints/>
        <startDate>2012-10-05 00:00:00.0 UTC</startDate>
        <state>1</state>
        <vision/>
    </release>
</set>

Get a release

GET http://:server/ws/p/:pkey/release/:id
{
    "id": 24,
    "startDate": "2012-06-06T00:00:00Z",
    "releaseVelocity": 0,
    "vision": "",
    "parentProduct": {"id": 23},
    "orderNumber": 1,
    "name": "dummy relesase",
    "state": 2,
    "lastUpdated": "2012-06-06T15:55:57Z",
    "endDate": "2012-10-04T00:00:00Z",
    "sprints": [
        {"id": 26},
        {"id": 27},
        {"id": 28},
        {"id": 29},
        {"id": 30},
        {"id": 31},
        {"id": 32},
        {"id": 33}
    ],
    "goal": "test Goal"
}

<?xml version="1.0" encoding="UTF-8"?>
<release id="24">
    <endDate>2012-10-04 00:00:00.0 UTC</endDate>
    <goal>test Goal</goal>
    <lastUpdated>2012-06-06 15:55:57.108 UTC</lastUpdated>
    <name>dummy relesase</name>
    <orderNumber>1</orderNumber>
    <parentProduct id="23"/>
    <releaseVelocity>0.0</releaseVelocity>
    <sprints>
        <sprint id="26"/>
        <sprint id="27"/>
        <sprint id="28"/>
        <sprint id="29"/>
        <sprint id="30"/>
        <sprint id="31"/>
        <sprint id="32"/>
        <sprint id="33"/>
    </sprints>
    <startDate>2012-06-06 00:00:00.0 UTC</startDate>
    <state>2</state>
    <vision/>
</release>

Create a release

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

Input


release.name
Required

release.goal
Optional

release.startDate
Required - The format depends on the user's locale, eg. for an American user it will be MM/dd/yyyy and for a French one dd/MM/yyyy

release.endDate
Required - The format depends on the user's locale, eg. for an American user it will be MM/dd/yyyy and for a French one dd/MM/yyyy

{
    "id": 34,
    "startDate": "2013-02-03T00:00:00Z",
    "releaseVelocity": 0,
    "vision": "",
    "parentProduct": {"id": 23},
    "orderNumber": 3,
    "name": "test application/json",
    "state": 1,
    "lastUpdated": "2012-06-06T15:56:01Z",
    "endDate": "2013-04-03T00:00:00Z",
    "sprints": null,
    "goal": "testing create a new release"
}

<?xml version="1.0" encoding="UTF-8"?>
<release id="35">
    <endDate>2013-06-02 00:00:00.0 UTC</endDate>
    <goal>testing create a new release</goal>
    <lastUpdated>2012-06-06 15:56:02.430 UTC</lastUpdated>
    <name>test application/xml</name>
    <orderNumber>4</orderNumber>
    <parentProduct id="23"/>
    <releaseVelocity>0.0</releaseVelocity>
    <sprints/>
    <startDate>2013-04-04 00:00:00.0 UTC</startDate>
    <state>1</state>
    <vision/>
</release>

Update a release

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

Input


release.name
Optional

release.goal
Optional

release.startDate
Optional - The format depends on the user's locale, eg. for an American user it will be MM/dd/yyyy and for a French one dd/MM/yyyy

release.endDate
Optional - The format depends on the user's locale, eg. for an American user it will be MM/dd/yyyy and for a French one dd/MM/yyyy

{
    "id": 34,
    "startDate": "2013-02-03T00:00:00Z",
    "releaseVelocity": 0,
    "vision": "",
    "parentProduct": {"id": 23},
    "orderNumber": 3,
    "name": "Update application/json 2",
    "state": 1,
    "lastUpdated": "2012-06-06T15:56:05Z",
    "endDate": "2013-04-03T00:00:00Z",
    "sprints": [],
    "goal": "testing update existing release"
}

<?xml version="1.0" encoding="UTF-8"?>
<release id="35">
    <endDate>2013-06-02 00:00:00.0 UTC</endDate>
    <goal>testing update existing release</goal>
    <lastUpdated>2012-06-06 15:56:05.740 UTC</lastUpdated>
    <name>Update application/xml 2</name>
    <orderNumber>4</orderNumber>
    <parentProduct id="23"/>
    <releaseVelocity>0.0</releaseVelocity>
    <sprints/>
    <startDate>2013-04-04 00:00:00.0 UTC</startDate>
    <state>1</state>
    <vision/>
</release>

Activate a release

POST http://:server/ws/p/:pkey/release/:id/activate
{
    "id": 25,
    "startDate": "2012-10-05T00:00:00Z",
    "releaseVelocity": 0,
    "vision": "",
    "parentProduct": {"id": 23},
    "orderNumber": 2,
    "name": "dummy relesase 2",
    "state": 2,
    "lastUpdated": "2012-06-06T15:56:08Z",
    "endDate": "2013-02-02T00:00:00Z",
    "sprints": [],
    "goal": "test Goal 2"
}

<?xml version="1.0" encoding="UTF-8"?>
<release id="25">
    <endDate>2013-02-02 00:00:00.0 UTC</endDate>
    <goal>test Goal 2</goal>
    <lastUpdated>2012-06-06 15:56:09.200 UTC</lastUpdated>
    <name>dummy relesase 2</name>
    <orderNumber>2</orderNumber>
    <parentProduct id="23"/>
    <releaseVelocity>0.0</releaseVelocity>
    <sprints/>
    <startDate>2012-10-05 00:00:00.0 UTC</startDate>
    <state>2</state>
    <vision/>
</release>

Close a release

POST http://:server/ws/p/:pkey/release/:id/close
{
    "id": 24,
    "startDate": "2012-06-06T00:00:00Z",
    "releaseVelocity": 25,
    "vision": "",
    "parentProduct": {"id": 23},
    "orderNumber": 1,
    "name": "dummy relesase",
    "state": 3,
    "lastUpdated": "2012-06-06T15:56:07Z",
    "endDate": "2012-09-25T00:00:00Z",
    "sprints": [
        {"id": 26},
        {"id": 27},
        {"id": 28},
        {"id": 29},
        {"id": 30},
        {"id": 31},
        {"id": 32},
        {"id": 33}
    ],
    "goal": "test Goal"
}

<?xml version="1.0" encoding="UTF-8"?>
<release id="24">
    <endDate>2012-09-25 00:00:00.0 UTC</endDate>
    <goal>test Goal</goal>
    <lastUpdated>2012-06-06 15:56:08.233 UTC</lastUpdated>
    <name>dummy relesase</name>
    <orderNumber>1</orderNumber>
    <parentProduct id="23"/>
    <releaseVelocity>25.0</releaseVelocity>
    <sprints>
        <sprint id="26"/>
        <sprint id="27"/>
        <sprint id="28"/>
        <sprint id="29"/>
        <sprint id="30"/>
        <sprint id="31"/>
        <sprint id="32"/>
        <sprint id="33"/>
    </sprints>
    <startDate>2012-06-06 00:00:00.0 UTC</startDate>
    <state>3</state>
    <vision/>
</release>

Delete a release

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

Previous << Sprint API
Next Feature API >>

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