Feature API – iceScrum

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

Contents

Feature API

When retrieving features, 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: 0: functional, 1: architectural

Get all features

GET http://:server/ws/p/:pkey/feature
[
    {
        "uid": 1,
        "id": 53,
        "creationDate": "2012-06-01T15:29:36Z",
        "rank": 1,
        "stories": [
            {"id": 2107},
            {"id": 2127},
            {"id": 2147},
            {"id": 2167},
            {"id": 2119}
        ],
        "color": "blue",
        "description": "Une feature",
        "name": "La feature",
        "value": 1,
        "lastUpdated": "2012-06-01T15:29:36Z",
        "type": 0,
        "notes": null,
        "tags": []
    },
    {
        "uid": 2,
        "id": 54,
        "creationDate": "2012-06-01T15:29:36Z",
        "rank": 2,
        "stories": [
            {"id": 2112},
            {"id": 2117},
            {"id": 2132}
        ],
        "color": "pink",
        "description": "Une feature",
        "name": "La feature 2",
        "value": 1,
        "lastUpdated": "2012-06-01T15:29:36Z",
        "type": 0,
        "notes": null,
        "tags": []
    },
    {
        "uid": 3,
        "id": 55,
        "creationDate": "2012-06-01T15:29:36Z",
        "rank": 3,
        "stories": [
            {"id": 2122},
            {"id": 2137},
            {"id": 2152},
            {"id": 2182},
            {"id": 2128}
        ],
        "color": "orange",
        "description": "Une feature",
        "name": "La feature 3",
        "value": 1,
        "lastUpdated": "2012-06-01T15:29:36Z",
        "type": 0,
        "notes": null,
        "tags": []
    }
]

<?xml version="1.0" encoding="UTF-8"?>
<list>
    <feature id="53">
        <color>blue</color>
        <creationDate>2012-06-01 15:29:36.0 UTC</creationDate>
        <description>Une feature</description>
        <lastUpdated>2012-06-01 15:29:36.0 UTC</lastUpdated>
        <name>La feature</name>
        <notes/>
        <tags/>
        <rank>1</rank>
        <stories>
            <story id="2107"/>
            <story id="2127"/>
            <story id="2147"/>
            <story id="2167"/>
            <story id="2119"/>
        </stories>
        <type>0</type>
        <uid>1</uid>
        <value>1</value>
    </feature>
    <feature id="54">
        <color>pink</color>
        <creationDate>2012-06-01 15:29:36.0 UTC</creationDate>
        <description>Une feature</description>
        <lastUpdated>2012-06-01 15:29:36.0 UTC</lastUpdated>
        <name>La feature 2</name>
        <notes/>
        <tags/>
        <rank>2</rank>
        <stories>
            <story id="2112"/>
            <story id="2117"/>
            <story id="2132"/>
        </stories>
        <type>0</type>
        <uid>2</uid>
        <value>1</value>
    </feature>
    <feature id="55">
        <color>orange</color>
        <creationDate>2012-06-01 15:29:36.0 UTC</creationDate>
        <description>Une feature</description>
        <lastUpdated>2012-06-01 15:29:36.0 UTC</lastUpdated>
        <name>La feature 3</name>
        <notes/>
        <tags/>
        <rank>3</rank>
        <stories>
            <story id="2122"/>
            <story id="2137"/>
            <story id="2152"/>
            <story id="2182"/>
        </stories>
        <type>0</type>
        <uid>3</uid>
        <value>1</value>
    </feature>
</list>

Get a feature

GET http://:server/ws/p/:pkey/feature/:id
{
    "uid": 1,
    "id": 53,
    "creationDate": "2012-06-01T15:29:36Z",
    "rank": 1,
    "stories": [
        {"id": 2107},
        {"id": 2127}
    ],
    "color": "blue",
    "description": "Une feature",
    "name": "La feature",
    "value": 1,
    "lastUpdated": "2012-06-01T15:29:36Z",
    "type": 0,
    "notes": null,
    "tags": []
}

<?xml version="1.0" encoding="UTF-8"?>
<feature id="53">
    <color>blue</color>
    <creationDate>2012-06-01 15:29:36.0 UTC</creationDate>
    <description>Une feature</description>
    <lastUpdated>2012-06-01 15:29:36.0 UTC</lastUpdated>
    <name>La feature</name>
    <notes/>
    <tags/>
    <rank>1</rank>
    <stories>
        <story id="2107"/>
        <story id="2127"/>
    </stories>
    <type>0</type>
    <uid>1</uid>
    <value>1</value>
</feature>

Create a feature

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

Input


feature.name
Required

feature.description
Optional

feature.notes
Optional - You can use the textile markup

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

feature.type
Optional integer - 0: functional, 1: architectural

feature.value
Optional integer

feature.tags
Optional - Use commas for multiple tags

{
    "uid": 4,
    "id": 56,
    "creationDate": "2012-06-01T15:31:46Z",
    "rank": 4,
    "stories": null,
    "color": "blue",
    "description": "testing create a new feature",
    "name": "test application/json",
    "value": null,
    "lastUpdated": "2012-06-01T15:31:46Z",
    "type": 0,
    "notes": null,
    "tags": []
}

<?xml version="1.0" encoding="UTF-8"?>
<feature id="57">
    <color>blue</color>
    <creationDate>2012-06-01 15:31:47.394 UTC</creationDate>
    <description>testing create a new feature</description>
    <lastUpdated>2012-06-01 15:31:47.453 UTC</lastUpdated>
    <name>test application/xml</name>
    <notes/>
    <tags/>
    <rank>5</rank>
    <stories/>
    <type>0</type>
    <uid>5</uid>
    <value/>
</feature>

Update a feature

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

Input


feature.name
Optional

feature.description
Optional

feature.notes
Optional - You can use the textile markup

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

feature.type
Optional integer - 0: functional, 1: architectural

feature.value
Optional integer

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

manageTags
Optional boolean - Required if you want to update tags

{
    "uid": 1,
    "id": 53,
    "creationDate": "2012-06-01T15:29:36Z",
    "rank": 1,
    "stories": [
        {"id": 2107},
        {"id": 2127},
        {"id": 2227}
    ],
    "color": "blue",
    "description": "testing update existing feature",
    "name": "Update application/json",
    "value": 1,
    "lastUpdated": "2012-06-01T15:31:48Z",
    "type": 0,
    "notes": null,
    "tags": []
}

<?xml version="1.0" encoding="UTF-8"?>
<feature id="54">
    <color>pink</color>
    <creationDate>2012-06-01 15:29:36.0 UTC</creationDate>
    <description>testing update existing feature</description>
    <lastUpdated>2012-06-01 15:31:50.420 UTC</lastUpdated>
    <name>Update application/xml</name>
    <notes/>
    <tags/>
    <rank>2</rank>
    <stories>
        <story id="2112"/>
        <story id="2117"/>
        <story id="2217"/>
    </stories>
    <type>0</type>
    <uid>2</uid>
    <value>1</value>
</feature>

Copy a feature to the backlog

POST http://:server/ws/p/:pkey/feature/:id/copyFeatureToBacklog
{
    "uid": 0,
    "inProgressDate": null,
    "executionFrequency": 1,
    "state": 2,
    "actor": null,
    "type": 0,
    "textAs": null,
    "textTo": null,
    "creator": {"id": 5},
    "id": 281,
    "doneDate": null,
    "rank": 61,
    "description": "testing create a new feature",
    "name": "test application/json",
    "feature": {"id": 7},
    "acceptanceTests": null,
    "acceptedDate": "2012-06-06T15:55:19Z",
    "effort": null,
    "lastUpdated": "2012-06-06T15:55:19Z",
    "tasks": null,
    "textICan": null,
    "parentSprint": null,
    "estimatedDate": null,
    "creationDate": "2012-06-06T15:55:19Z",
    "plannedDate": null,
    "suggestedDate": "2012-06-06T15:55:19Z",
    "notes": null,
    "tags": []
}

<?xml version="1.0" encoding="UTF-8"?>
<story id="282">
    <acceptanceTests/>
    <acceptedDate>2012-06-06 15:55:19.525 UTC</acceptedDate>
    <actor/>
    <creationDate>2012-06-06 15:55:19.530 UTC</creationDate>
    <creator id="5"/>
    <description>testing create a new feature</description>
    <doneDate/>
    <effort/>
    <estimatedDate/>
    <executionFrequency>1</executionFrequency>
    <feature id="8"/>
    <inProgressDate/>
    <lastUpdated>2012-06-06 15:55:19.538 UTC</lastUpdated>
    <name>test application/xml</name>
    <notes/>
    <tags/>
    <parentSprint/>
    <plannedDate/>
    <rank>62</rank>
    <state>2</state>
    <suggestedDate>2012-06-06 15:55:19.525 UTC</suggestedDate>
    <tasks/>
    <textAs/>
    <textICan/>
    <textTo/>
    <type>0</type>
    <uid>0</uid>
</story>

Delete a feature

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

Previous << Release API
Next Finder API >>

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