RefreshLockΒΆ

Required for: Online iOS Android
POST /wopi/files/(file_id)ΒΆ

The RefreshLock operation refreshes the lock on a file by resetting its automatic expiration timer to 30 minutes. The refreshed lock must expire automatically after 30 minutes unless it is modified by a subsequent WOPI operation, such as Unlock or RefreshLock.

WOPI clients will usually make a Lock request to lock a file prior to calling this operation. The WOPI client will pass the lock ID established by that previous Lock operation in the X-WOPI-Lock request header.

If the file is currently locked and the X-WOPI-Lock value does not match the lock currently on the file, or if the file is unlocked, 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 unlocked, the host must set X-WOPI-Lock to the empty string.

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 REFRESH_LOCK. Required.
  • X-WOPI-Lock – A string provided by the WOPI client that the host must use to identify the existing 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.

Status Codes:

See also

Standard WOPI request and response headers
In addition to the request/response headers listed here, this operation may also use the Standard WOPI request and response headers.