Obsolete iceScrum documention (R6#14+) This documentation applies only to old iceScrum R6. For new iceScrum v7, click here.
Contents
Actor API
When retrieving actors, most attributes names and values are self-explanatory. Here is the correspondance between those that aren’t:
– instances: 0: 1, 1: 2-5, 3: 6-10, 4: 11-100, 5: 500+
– expertnessLevel: 0: low, 1: medium, 2: high
– useFrequency: 0: hour, 1: day, 2: week, 3: month, 4: quarter
Get all actors
1 |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 | [ { "uid": 1, "id": 80, "creationDate": "2012-06-01T14:18:58Z", "stories": [ {"id": 1819}, {"id": 1703}, {"id": 1719}, {"id": 1815}, {"id": 1711} ], "useFrequency": 2, "description": "Un ScrumMaster", "name": "ScrumMaster", "lastUpdated": "2012-06-01T14:18:58Z", "expertnessLevel": 1, "satisfactionCriteria": "", "notes": null, "tags": [], "instances": 0 }, { "uid": 4, "id": 83, "creationDate": "2012-06-01T14:18:58Z", "stories": [ {"id": 1747}, {"id": 1702}, {"id": 1727}, {"id": 1697}, {"id": 1812} ], "useFrequency": 2, "description": "Un Team member", "name": "Team member", "lastUpdated": "2012-06-01T14:18:58Z", "expertnessLevel": 1, "satisfactionCriteria": "", "notes": null, "tags": [], "instances": 0 }, { "uid": 5, "id": 84, "creationDate": "2012-06-01T14:18:58Z", "stories": [], "useFrequency": 2, "description": "Un visitor", "name": "visitor", "lastUpdated": "2012-06-01T14:18:58Z", "expertnessLevel": 1, "satisfactionCriteria": "", "notes": null, "tags": [], "instances": 0 }] |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 | <?xml version="1.0" encoding="UTF-8"?><list> <actor id="80"> <creationDate>2012-06-01 14:18:58.0 UTC</creationDate> <description>Un ScrumMaster</description> <expertnessLevel>1</expertnessLevel> <instances>0</instances> <lastUpdated>2012-06-01 14:18:58.0 UTC</lastUpdated> <name>ScrumMaster</name> <notes/> <tags/> <satisfactionCriteria/> <stories> <story id="1819"/> <story id="1719"/> <story id="1703"/> <story id="1815"/> <story id="1711"/> </stories> <uid>1</uid> <useFrequency>2</useFrequency> </actor> <actor id="83"> <creationDate>2012-06-01 14:18:58.0 UTC</creationDate> <description>Un Team member</description> <expertnessLevel>1</expertnessLevel> <instances>0</instances> <lastUpdated>2012-06-01 14:18:58.0 UTC</lastUpdated> <name>Team member</name> <notes/> <tags/> <satisfactionCriteria/> <stories> <story id="1747"/> <story id="1702"/> <story id="1727"/> <story id="1697"/> <story id="1812"/> </stories> <uid>4</uid> <useFrequency>2</useFrequency> </actor> <actor id="84"> <creationDate>2012-06-01 14:18:58.0 UTC</creationDate> <description>Un visitor</description> <expertnessLevel>1</expertnessLevel> <instances>0</instances> <lastUpdated>2012-06-01 14:18:58.0 UTC</lastUpdated> <name>visitor</name> <notes/> <tags/> <satisfactionCriteria/> <stories/> <uid>5</uid> <useFrequency>2</useFrequency> </actor></list> |
Get an actor
1 |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 | { "uid": 1, "id": 1, "creationDate": "2012-06-06T15:53:36Z", "stories": [ {"id": 9}, {"id": 133}, {"id": 13}, {"id": 57}, {"id": 69} ], "useFrequency": 2, "description": "Un ScrumMaster", "name": "ScrumMaster", "lastUpdated": "2012-06-06T15:53:36Z", "expertnessLevel": 1, "satisfactionCriteria": "", "notes": null, "tags": [], "instances": 0} |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 | <?xml version="1.0" encoding="UTF-8"?><actor id="1"> <creationDate>2012-06-06 15:53:36.861 UTC</creationDate> <description>Un ScrumMaster</description> <expertnessLevel>1</expertnessLevel> <instances>0</instances> <lastUpdated>2012-06-06 15:53:36.920 UTC</lastUpdated> <name>ScrumMaster</name> <notes/> <tags/> <satisfactionCriteria/> <stories> <story id="9"/> <story id="133"/> <story id="13"/> <story id="57"/> <story id="69"/> </stories> <uid>1</uid> <useFrequency>2</useFrequency></actor> |
Create an actor
1 |
Input
- actor.name
- Required
- actor.description
- Optional
- actor.notes
- Optional - You can use the textile markup
- actor.satisfactionCriteria
- Optional
- actor.instances
- Optional integer - 0: 1, 1: 2-5, 3: 6-10, 4: 11-100, 5: 500+
- actor.expertnessLevel
- Optional integer - 0: low, 1: medium, 2: high
- actor.useFrequency
- Optional integer - 0: hour, 1: day, 2: week, 3: month, 4: quarter
- actor.tags
- Optional - Use commas for multiple tags
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 | { "uid": 6, "id": 85, "creationDate": "2012-06-01T14:21:07Z", "stories": null, "useFrequency": 2, "description": "testing create a new actor", "name": "test application/json", "lastUpdated": "2012-06-01T14:21:07Z", "expertnessLevel": 1, "satisfactionCriteria": "", "notes": null, "tags": [], "instances": 0} |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 | <?xml version="1.0" encoding="UTF-8"?><actor id="86"> <creationDate>2012-06-01 14:21:08.369 UTC</creationDate> <description>testing create a new actor</description> <expertnessLevel>1</expertnessLevel> <instances>0</instances> <lastUpdated>2012-06-01 14:21:08.422 UTC</lastUpdated> <name>test application/xml</name> <notes/> <tags/> <satisfactionCriteria/> <stories/> <uid>7</uid> <useFrequency>2</useFrequency></actor> |
Update an actor
1 |
Input
- actor.name
- Optional
- actor.description
- Optional
- actor.notes
- Optional - You can use the textile markup
- actor.satisfactionCriteria
- Optional
- actor.instances
- Optional integer - 0: 1, 1: 2-5, 3: 6-10, 4: 11-100, 5: 500+
- actor.expertnessLevel
- Optional integer - 0: low, 1: medium, 2: high
- actor.useFrequency
- Optional integer - 0: hour, 1: day, 2: week, 3: month, 4: quarter
- actor.tags
- Optional - Requires the manageTags parameter, use commas for multiple tags
- manageTags
- Optional boolean - Required if you want to update tags
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 | { "uid": 2, "id": 81, "creationDate": "2012-06-01T14:18:58Z", "stories": [ {"id": 1764}, {"id": 1700}, {"id": 1689}, {"id": 1784}, {"id": 1716} ], "useFrequency": 2, "description": "testing update existing actor", "name": "Update application/json", "lastUpdated": "2012-06-01T14:21:09Z", "expertnessLevel": 1, "satisfactionCriteria": "", "notes": null, "tags": [], "instances": 0} |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 | <?xml version="1.0" encoding="UTF-8"?><actor id="80"> <creationDate>2012-06-01 14:18:58.0 UTC</creationDate> <description>testing update existing actor</description> <expertnessLevel>1</expertnessLevel> <instances>0</instances> <lastUpdated>2012-06-01 14:21:10.231 UTC</lastUpdated> <name>Update application/xml</name> <notes/> <tags/> <satisfactionCriteria/> <stories> <story id="1819"/> <story id="1719"/> <story id="1703"/> <story id="1815"/> <story id="1711"/> </stories> <uid>1</uid> <useFrequency>2</useFrequency></actor> |
Delete an actor
1 |
