RefreshLock

POST /wopi/files/(file_id)

Refreshes the lock on a file by resetting its automatic expiration timer to 30 minutes. This lock will expire automatically after 30 minutes unless it is changed by the Unlock or another RefreshLock operations.

This operation works as follows:

  1. The WOPI host checks if a file is currently locked or not.
  2. If the file is unlocked, or if the file is currently locked and the X-WOPI-Lock value does not match the lock currently on the file, the host must return 409 Conflict (“lock mismatch”) and include the X-WOPI-Lock response header containing the value of the current lock on the file. In the case where the file is unlocked, the host must set X-WOPI-Lock to the empty string.
  3. In the case where the file is locked by a third-party client, hosts should still always include the current lock ID in the X-WOPI-Lock response header.

Parameters

NameDescriptionType
file_idThe file ID that must be URL safe.string

Query parameters

NameDescriptionType
access_tokenAn access token that the host will use to determine whether the request is authorized.string

Request headers

NameDescriptionTypePresence
X-WOPI-OverrideThe requested operation from the WOPI server (REFRESH_LOCK).stringrequired
X-WOPI-LockThe lock ID that the host must use to identify the lock on the file.stringrequired

Response headers

NameDescriptionTypePresence
X-WOPI-LockThe lock ID 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.stringoptional
X-WOPI-LockFailureReasonThe cause of the lock failure. This header may be included when responding to the request with 409 Conflict. It must only be used for logging purposes.stringoptional