/
[PATCH] /lock

[PATCH] /lock

Owned by Team Dodo

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

Description

To lock (checkout) a certain document for editting.
If the document is already locked a DmsObject result list is returned in which the system field "system:versionSeriesLockedBy" contains the userId of the user who has currently locked the document.

Request
Method

PATCH

Response
Format

  • On success: HTTP/204 No Content

  • If it is already locked: HTTP/409 Conflict plus the DmsObject with the information who has locked (checked out) it.

  • If the object is a register or folder: HTTP/400 Bad Request because only document objets can be locked.

Minimum Version

3.2.2

Request
Example

/api/dms/objects/2563/contents/native/lock

Result
Example
if the object is already locked

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

 

Related content