Lock¶

Required for: Online iOS Android

POST /wopi/files/(file_id)¶

The Lock operation locks a file for editing by the WOPI client application instance that requested the lock. To support editing files, WOPI clients require that the WOPI host support locking files. When locked, a file should not be writable by other applications.

If the file is currently unlocked, the host should lock the file and return 200 OK.

If the file is currently locked and the X-WOPI-Lock value matches the lock currently on the file, the host should treat the request as if it is a RefreshLock request. That is, the host should refresh the lock timer and return 200 OK.

In all other cases, the host must return a “lock mismatch” response (409 Conflict) and include an X-WOPI-Lock response header containing the value of the current lock on the file.

In the case where the file is locked by someone other than a WOPI client, hosts should still always include the current lock ID in the X-WOPI-Lock response header. However, if the current lock ID is not representable as a WOPI lock (for example, it is longer than the maximum lock length), the X-WOPI-Lock response header should be set to the empty string or omitted completely.

See Lock for more general information regarding locks.

Parameters

file_id (string) – A string that specifies a file ID of a file managed by host. This string must be URL safe.

Query Parameters

access_token (string) – An access token that the host will use to determine whether the request is authorized.

Request Headers

X-WOPI-Override – The string LOCK. Required.
X-WOPI-Lock – A string provided by the WOPI client that the host must use to identify the lock on the file. Required.

Response Headers

X-WOPI-Lock – A string value identifying the current lock on the file. This header must always be included when responding to the request with 409 Conflict. It should not be included when responding to the request with 200 OK.
X-WOPI-LockFailureReason – An optional string value indicating the cause of a lock failure. This header may be included when responding to the request with 409 Conflict. There is no standard for how this string is formatted, and it must only be used for logging purposes.
X-WOPI-LockedByOtherInterface –

Deprecated since version 2015-12-15: This header is deprecated and should be ignored by WOPI clients.
X-WOPI-ItemVersion – An optional string value indicating the version of the file. Its value should be the same as Version value in CheckFileInfo.

Status Codes

200 OK – Success
400 Bad Request – X-WOPI-Lock was not provided or was empty
401 Unauthorized – Invalid access token
404 Not Found – Resource not found/user unauthorized
409 Conflict – Lock mismatch/locked by another interface; an X-WOPI-Lock response header containing the value of the current lock on the file must always be included when using this response code
500 Internal Server Error – Server error
501 Not Implemented – Operation not supported