PUT api/2.0/files/file/{fileId}/lock This function requires authentication

Description

Locks a file with the ID specified in the request.

Parameters
Name Description Type Example
fileId
sent in url
File ID number 1234
LockFile
sent in body
Specifies whether to lock a file or not System.Boolea
Example
PUT api/2.0/files/file/1234/lock
Host: yourportal.onlyoffice.com
Content-Type: application/json
Accept: application/json
Returns

Locked file information

Example Response

application/json

{
  "status": 0,
  "response": {
    "FolderId": 1234,
    "Version": 1234,
    "VersionGroup": 1234,
    "ContentLength": "some text",
    "Mute": true,
    "ViewUrl": "some text",
    "WebUrl": "some text",
    "FileExst": "some text",
    "Comment": "some text",
    "ThumbnailUrl": "some text",
    "LockedBy": "some text",
    "DenyDownload": true,
    "DenySharing": true
  }
}

text/xml

<result>
  <status>0</status>
  <response>
    <FolderId>1234</FolderId>
    <Version>1234</Version>
    <VersionGroup>1234</VersionGroup>
    <ContentLength>some text</ContentLength>
    <Mute>True</Mute>
    <ViewUrl>some text</ViewUrl>
    <WebUrl>some text</WebUrl>
    <FileExst>some text</FileExst>
    <Comment>some text</Comment>
    <ThumbnailUrl>some text</ThumbnailUrl>
    <LockedBy>some text</LockedBy>
    <DenyDownload>True</DenyDownload>
    <DenySharing>True</DenySharing>
  </response>
</result>