Skip to main content
Undo Checkout Document

Headers

SO-AppToken
string

The application token that identifies the partner app. Used when calling Online WebAPI from a server.

Path Parameters

documentId
integer<int32>
required

SuperOffice document ID

Query Parameters

allowedReturnTypes
string[]

List of return types that the client is prepared to handle, in case the document plugin needs to request additional processing.
Standard allowed return types include 'None', 'Message', 'SoProtocol', 'CustomGui', 'Other'.
An empty array implies that the client places no restriction on possible return action requests.

Response

OK

ExternalReference
string
VersionId
string
Success
boolean
Type
enum<string>
Available options:
None,
Message,
SoProtocol,
CustomGui,
Other,
URL
Value
string
AdditionalInfo
string