openStagedDocumentEditor

Get URL to edit document

Returns document editor url.

Path Params
string
required

The documentId of the document to be edited.

Query Params
string
enum

The action to start with. Default initial action is PREVIEW

Allowed:
string

The user of the new session.
It is not required, that this user is a valid user name of the client. However: Such a user may have granted only the role "I_EVERYONE" unless XNSG is configured to use e.g. an LDAP server and the user can be found in the LDAP server with some roles granted to the user.
No password is required because other servers which contact over the business facade will be trusted to have checked the users access rights. This enables a kind of "single sign on" between different e.g. XNSG servers.

string

The two letter ISO code of the language of the new session. Currently "de" and "en" are supported.

boolean

If set to 'true', the generated URI is returned in the 'Location' header of a SEE OTHER (303) response.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

303

Redirected to a URI generated in call response

Language
Credentials
Response
Click Try It! to start a request and see the response here!