Difference between revisions of "StoryBoard/RestAPI"

Revision as of 11:21, 27 November 2013

Storyboard REST API should be considered as the only instrument to communicate with Storyboard.

Most of read operations are accessible without any authorization.
User should be authorized to perform non-administrative actions. (create a Story, change a Task status, etc.)
User should be authorized and have special privileges to perform administrative actions. (create a Project in a Project Group, change Task Priority, etc.)
Only a super-priviledged Users can perform Storyboard management actions. (create a Project Group, grant other privileges, etc.)

HTTP Method	URL	Description	Required Permissions
GET	/project_groups	Returns a list of all existing Project Groups.	none
GET	/project_groups/(group_name)	Returns a Project Group by it's name.	none
POST	/project_groups	Creates a new Project Group.	Authorized, StoryboardAdmin
PUT	/project_groups/(group_name)	Updates a Project Group named (group_name) with new properties.	Authorized, StoryboardAdmin
DELETE	/project_groups/(group_name)	Deletes a Project Group named (group_name)	Authorized, StoryboardAdmin

@@ Line 1: / Line 1: @@
+== Basic Concepts ==
+Storyboard REST API should be considered as the only instrument to communicate with Storyboard.
+* Most of read operations are accessible without any authorization.
+* User should be authorized to perform non-administrative actions. (create a Story, change a Task status, etc.)
+* User should be authorized and have special privileges to perform administrative actions. (create a Project in a Project Group, change Task Priority, etc.)
+* Only a super-priviledged Users can perform Storyboard management actions. (create a Project Group, grant other privileges, etc.)
 == Project Group Operations ==
 {| class="wikitable"