POST Document/{id}/Lock

• 2 minutes to read
 • 2 minutes to read 
POST /api/v1/Document/{documentId}/Lock

Check out a document for editing by the current user.

Path Part Type Description
documentId int32 SuperOffice document ID Required

Query String Parameters

Parameter Name Type Description
allowedReturnTypes array List of return types that the client is prepared to handle, in case the document plugin needs to request additional processing.<br/>Standard allowed return types include 'None', 'Message', 'SoProtocol', 'CustomGui', 'Other'.<br/>An empty array implies that the client places no restriction on possible return action requests. 
POST /api/v1/Document/{documentId}/Lock?allowedReturnTypes=Message

Request Headers

Parameter Name Description
Authorization Supports 'Basic', 'SoTicket' and 'Bearer' schemes, depending on installation type.
X-XSRF-TOKEN If not using Authorization header, you must provide XSRF value from cookie or hidden input field
Accept Content-type(s) you would like the response in: application/json, text/json, application/xml, text/xml, application/json-patch+json, application/merge-patch+json
Accept-Language Convert string references and multi-language values into a specified language (iso2) code.
SO-Language Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value.
SO-Culture Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set.
SO-TimeZone Specify the timezone code that you would like date/time responses converted to.
SO-AppToken The application token that identifies the partner app. Used when calling Online WebAPI from a server.

Response:

OK

Response Description
200 OK

Response body: TimeZoneData

Property Name Type Description
ExternalReference string
VersionId string
Success bool
Type string
Value string
AdditionalInfo string

Sample request

POST /api/v1/Document/{documentId}/Lock
Authorization: Basic dGplMDpUamUw
Accept: application/json; charset=utf-8
Accept-Language: *

Sample response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "ExternalReference": "quo",
  "VersionId": "aut",
  "Success": true,
  "Type": "CustomGui",
  "Value": "soluta",
  "AdditionalInfo": "consequatur"
}