DEL Document/{id}/Lock

• 1 minute to read
 • 1 minute to read 
DELETE /api/v1/Document/{documentId}/Lock

Undo (abandon) a checkout

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. 
DELETE /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
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

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

Sample response

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

{
  "ExternalReference": "sint",
  "VersionId": "ut",
  "Success": false,
  "Type": "CustomGui",
  "Value": "necessitatibus",
  "AdditionalInfo": "aut"
}