Skip to content

[Feature Request]: Creating goals/columns/stories on a storyboard via the REST API should return data of created items #705

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
heinezen opened this issue Apr 6, 2025 · 3 comments
Assignees
Labels
enhancement New feature or request Storyboard

Comments

@heinezen
Copy link

heinezen commented Apr 6, 2025

Description

I'm currently writing a script to automatically create storyboards from my own datasets and fill them with custom information using the REST API. When it comes to creating just the storyboard, that works just fine via the /users/{userId}/storyboards path. However, filling the storyboard with items (goals, columns, stories) is currently very tedious, since the API for creating those is still very bare bones. In particular, the HTTP response for creating these items doesn't return any data.

An example for a problem I ran into was:

  • I create a new goal for the storyboard using the /storyboards/{storyboardId}/goals endpoint.
  • Now I want to create a column for my new goal, but /storyboards/{storyboardId}/columns requires me to specify the ID of the goal that the column is added to.
  • I have no way of knowing the ID of the goal I just created, since the response to endpoint /storyboards/{storyboardId}/goals contains a data object that is just empty.

I could search for the new goal's ID by requesting the storyboard info with GET /storyboards/{storyboardId}, but this is not a very nice or efficient way to do this IMO.

Describe the solution you'd like

Best case would be to return the JSON definition of the item that was just created. So for a new storyboard goal, I would like to see the JSON data model that is also part of the response in GET /storyboards/{storyboardId}.

Describe alternatives you've considered

If the solution above is not feasible, I would expect that the creation of a new storyboard item returns at least the ID of the created resource, so that it can be used in further requests.

@heinezen heinezen added the enhancement New feature or request label Apr 6, 2025
@StevenWeathers
Copy link
Owner

This is possible though a bit more involved to fix, I will try to work on it this week if I can find the time.

@heinezen
Copy link
Author

heinezen commented Apr 6, 2025

@StevenWeathers Thanks a lot, and no pressure :)

@hnorkowski
Copy link

That would be a very nice feature!

@StevenWeathers StevenWeathers self-assigned this May 23, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request Storyboard
Projects
None yet
Development

No branches or pull requests

3 participants