/
[PATCH] /unlock

[PATCH] /unlock

/api/dms/objects/{objectId}/contents/native/unlock

Description

To unlock (undo checkout) a certain document.
If the document is locked by another user and the current user is no super user a DmsObject result list is returned in which the system field "system:versionSeriesLockedBy" contains the userId of the user who has currently locked (checked out) the document.

Request
Method

PATCH

Response
Format

  • On success: HTTP/204 No Content

  • If the document is locked by another user: HTTP/409 Conflict

  • If the document is not locked or it is a register or folder: HTTP/400 Bad Request

Minimum Version

3.2.2

Request
Example

/api/dms/objects/2563/contents/native/unlock

Result
Example
if the unlock was not possible

{ "objects": [{ "properties": { "system:objectId": { "value": "4400" }, "system:objectTypeId": { "value": "262144" }, "system:versionSeriesLockedBy": { "value": "3911" } } }], "numItems": 1, "hasMoreItems": false, "totalNumItems": 1 }