×

You're using an outdated browser

For a better experience, keep your browser up to date. Check here for the latest version.

Manual

Scroll Translations administration via REST API

Nils Bier

Nils Bier Last update: Jul 20, 2017

You can use the REST API to retrieve (and edit) multiple settings on how Scroll Translations is configured in a space.

REST functionality is not officially supported

The REST API functionality described on this page is not officially supported, and may change in the future.

Retrieve information on Scroll Translations configuration in a space

You can get space information about enabled/disabled Scroll Translation modules by sending a GET request to the following URL:

Resource
http://<host>:<port>/rest/scroll-versions/latest/config/<space-key>
HTTP MethodGET
HTTP HeaderAuthorization via Basic Auth

This request returns a JSON document containing all relevant information:

{
  "enableVersionManagement":true,
  "enableTheme":true,
  "enableWorkflow":false,
  "enableTranslation":false,
  "enableVariants":false,
  "enablePermalinks":true,
  "reviewers":[],
  "authors":[],
  "docadmins":["confluence-administrators"],
  "translators":[]
}

Modify Scroll Translations configuration in a space

Scroll Translations modules can be enabled/disabled and permissions can be set by sending a POST request to the following URL:

Resource
http://<host>:<port>/rest/scroll-versions/latest/config/<space-key>
HTTP Method

POST

HTTP Header

Authorization via Basic-Auth

Content-Type

application/json

JSON Document
{
  "enableVersionManagement":true,
  "enableTheme":true,
  "enableWorkflow":false,
  "enableTranslation":false,
  "enableVariants":false,
  "enablePermalinks":true,
  "reviewers":["doc-reviewers"],
  "authors":["doc-authors"],
  "docadmins":["confluence-administrators"],
  "translators":[]
}
2xlatest
We use cookies to create a secure and effective browsing experience for our website visitors and to understand how you use our site (i.e. Google Analytics). For more information: click here.
Ok