Steps
List all steps
GET /v1/workshops/:workshop_id/steps
Response
[
{
"id": "5007d396eb7abf319a000047",
"position": 0,
"name": "Step",
"instructions": "Hello world",
"prefs": {
"allow_add_idea": true,
"allow_add_cluster": true,
"allow_edit": "all",
"allow_delete": "all",
"allow_items": true,
"allow_vote_on_ideas": true,
"allow_vote_on_clusters": true,
"allow_display_votes": true,
"allow_rate": true,
"allow_display_ratings": true,
"allow_comment": true,
"allow_attachment": true
},
"view": {
"card": null,
"card_sub_view": "content",
"sort": "position",
"sort_reverse": false,
"sort_criterium_id": null,
"show": "cards",
"show_clusters": "all",
"show_cluster_ids": [
],
"card_status": "active",
"card_author": "all"
}
}
]
Create a new step
POST /v1/workshops/:workshop_id/steps
Parameters
| Name |
Type |
Description |
| name |
string |
Required the name of the step |
| instructions |
string |
the instructions |
| position |
integer |
the position of the step in the sequence |
| prefs.allow_add_idea |
boolean |
allow to add ideas |
| prefs.allow_add_cluster |
boolean |
allow to add clusters |
| prefs.allow_edit |
string |
allow to edit cards (none, their or all) |
| prefs.allow_delete |
string |
allow to delete cards (none, their or all) |
| prefs.allow_items |
boolean |
allow to add items |
| prefs.allow_vote_on_ideas |
boolean |
allow to vote on ideas |
| prefs.allow_vote_on_clusters |
boolean |
allow to vote on clusters |
| prefs.allow_display_votes |
boolean |
allow to view the result of votes |
| prefs.allow_rate |
boolean |
allow to rate |
| prefs.allow_display_ratings |
boolean |
allow to view the result of the ratings |
| prefs.allow_comment |
boolean |
allow to comment |
| prefs.allow_attachment |
boolean |
allow to attach files |
| view.card |
string |
the card id showed to participants |
| view.sort |
string |
default sort of cards (position, random, score, criterium_average) |
| view.sort_criterium_id |
string |
id of criterion to take when sorting by criterium_average |
| view.sort_reverse |
boolean |
reverse the sort choosed |
| view.show |
string |
default view of cards (cards, bars or bubbles) |
| view.show_clusters |
string |
show clusters (all, none or multi) |
| view.show_cluster_ids |
array |
ids of the cluster to show when show_clusters is multi |
| view.card_status |
string |
default card status filter (all, active or aside) |
| view.card_author |
string |
default card author filter (all, active or other) |
| view.card_sub_view |
string |
sub view showed when a card is showed (content, votes, ratings-overall or ratings-user) |
Example
{
"instructions": "Be creative"
}
Response
{
"id": "5007d396eb7abf319a000047",
"position": 0,
"name": "Step",
"instructions": "Be creative",
"prefs": {
"allow_add_idea": true,
"allow_add_cluster": true,
"allow_edit": "all",
"allow_delete": "all",
"allow_items": true,
"allow_vote_on_ideas": true,
"allow_vote_on_clusters": true,
"allow_display_votes": true,
"allow_rate": true,
"allow_display_ratings": true,
"allow_comment": true,
"allow_attachment": true
},
"view": {
"card": null,
"card_sub_view": "content",
"sort": "position",
"sort_reverse": false,
"sort_criterium_id": null,
"show": "cards",
"show_clusters": "all",
"show_cluster_ids": [
],
"card_status": "active",
"card_author": "all"
}
}
Show a step
GET /v1/workshops/:workshop_id/steps/:id
Response
{
"id": "5007d396eb7abf319a000047",
"position": 0,
"name": "Step",
"instructions": "Hello world",
"prefs": {
"allow_add_idea": true,
"allow_add_cluster": true,
"allow_edit": "all",
"allow_delete": "all",
"allow_items": true,
"allow_vote_on_ideas": true,
"allow_vote_on_clusters": true,
"allow_display_votes": true,
"allow_rate": true,
"allow_display_ratings": true,
"allow_comment": true,
"allow_attachment": true
},
"view": {
"card": null,
"card_sub_view": "content",
"sort": "position",
"sort_reverse": false,
"sort_criterium_id": null,
"show": "cards",
"show_clusters": "all",
"show_cluster_ids": [
],
"card_status": "active",
"card_author": "all"
}
}
Update a step
PUT /v1/workshops/:workshop_id/steps/:id
Parameters
| Name |
Type |
Description |
| name |
string |
Required the name of the step |
| instructions |
string |
the instructions |
| position |
integer |
the position of the step in the sequence |
| prefs.allow_add_idea |
boolean |
allow to add ideas |
| prefs.allow_add_cluster |
boolean |
allow to add clusters |
| prefs.allow_edit |
string |
allow to edit cards (none, their or all) |
| prefs.allow_delete |
string |
allow to delete cards (none, their or all) |
| prefs.allow_items |
boolean |
allow to add items |
| prefs.allow_vote_on_ideas |
boolean |
allow to vote on ideas |
| prefs.allow_vote_on_clusters |
boolean |
allow to vote on clusters |
| prefs.allow_display_votes |
boolean |
allow to view the result of votes |
| prefs.allow_rate |
boolean |
allow to rate |
| prefs.allow_display_ratings |
boolean |
allow to view the result of the ratings |
| prefs.allow_comment |
boolean |
allow to comment |
| prefs.allow_attachment |
boolean |
allow to attach files |
| view.card |
string |
the card id showed to participants |
| view.sort |
string |
default sort of cards (position, random, score, criterium_average) |
| view.sort_criterium_id |
string |
id of criterion to take when sorting by criterium_average |
| view.sort_reverse |
boolean |
reverse the sort choosed |
| view.show |
string |
default view of cards (cards, bars or bubbles) |
| view.show_clusters |
string |
show clusters (all, none or multi) |
| view.show_cluster_ids |
array |
ids of the cluster to show when show_clusters is multi |
| view.card_status |
string |
default card status filter (all, active or aside) |
| view.card_author |
string |
default card author filter (all, active or other) |
| view.card_sub_view |
string |
sub view showed when a card is showed (content, votes, ratings-overall or ratings-user) |
Example
{
"instructions": "Be creative"
}
Response
Delete a step
DELETE /v1/workshops/:workshop_id/steps/:id
Response