ScrollVersion API
Is there a REST API or a public component I can use to get all configured versions of a space?
-
Hi,
Thanks for contacting us.It would be great if you could further describe your use case and what you want to achieve using REST - e.g. you can publish a version using REST already: https://help.k15t.com/scroll-versions/latest/how-can-i-publish-a-version-with-the-rest-api-111903754.html
Regarding a public REST API functionality, we already have an improvement in our JIRA system (see https://k15t.jira.com/browse/VSN-1811), however there are currently no short-term plans to implement this feature.
Please sign up at https://k15t.jira.com/secure/Signup!default.jspa to watch, comment on or vote for this issue. You'll then get a notification for every status update on the issue.Best,
Nils -
Hi Nils,
thank you for your response.
My use case is an external system which should show all available versions for a specific space with quick links.
Though I would prefer an already available REST service to retrieve the versions, it would be equally convenient for me to import a public component (of Scroll Versions addon) and write the REST service myself.
Is this possible?
Regards
-
Hi,
thanks for the further details.
With those quicklinks, do you want to link to the home page of each version? Please note, that those versions are only available for the users that are defined as Reviewers, Authors or Doc-Admins in that space.To retrieve all versions you can use the following REST call: <confluence-base-url>/rest/scroll-versions/1.0/versions/<spaceKey>
This will return the version details of all versions defined for the spacekey you entered, e.g.
[{"id":"0A4346FB0154C66140738D6F30B6E6DE","name":"5.9-OD1","description":null,"releaseDate":null,"precedingVersionId":null,"archived":false,"color":"#8eb021","runtimeAccessible":false},{"id":"0A4346FB0154C6647C62810470586461","name":"5.9-OD2","description":null,"releaseDate":null,"precedingVersionId":"0A4346FB0154C66140738D6F30B6E6DE","archived":false,"color":"#999999","runtimeAccessible":false}]I hope that helps.
Best,
Nils -
Hi Nils,
great, thank you. This will definitely help!
The generated quicklinks will link to multiple resources:
- the home page of each version
- and some other platforms which follow the same version names as the Confluence space. But Confluence is in the lead here and I needed a way to know what version names are available.
I was hoping for something public, because I can't be sure, that the user has already logged in. But I guess, I will find a way to work around that.
Regards
-
Hi,
Unfortunately we currently do not have a public API (see https://k15t.jira.com/browse/VSN-1811).
If you want to have multiple public versions and allow your readers to switch between those versions, you could have a look at Scroll Viewport.
Scroll Viewport allows you to style your Confluence content to your companies style and have dropdowns available for your readers to switch between versions.A couple of examples can be found here:
- https://help.k15t.com/scroll-versions
- https://docops.ca.com/ca-api-developer-portal/3-5
- https://confluence.atlassian.com/doc/get-started-777010817.html
Would that help?
Best,
Nils -
Hi,
ScrollViewport is no solution for us. We need to know available versions in an external system. We have a couple of tools/services which need to work with the same version number.
I hoped, I could provide a custom made service via an addon, which provides all available version numbers for those external systems.
Regards
Please sign in to leave a comment.
Comments
7 comments