RefreshLock
POST /wopi/files/(file_id)
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's modified by a subsequent WOPI operation, such as Unlock and RefreshLock operations.
This operation works as follows:
- The WOPI host checks if a file is currently locked or not.
- 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.
- 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
| Name | Type | Description |
|---|---|---|
| file_id | string | The file ID that must be URL safe. |
Query parameters
| Name | Type | Description |
|---|---|---|
| access_token | string | An access token that the host will use to determine whether the request is authorized. |
Request headers
| Name | Type | Presence | Description |
|---|---|---|---|
| X-WOPI-Override | string | required | The requested operation from the WOPI server (REFRESH_LOCK). |
| X-WOPI-Lock | string | required | The lock ID that the host must use to identify the lock on the file. |
Response headers
| Name | Type | Presence | Description |
|---|---|---|---|
| X-WOPI-Lock | string | optional | The 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. |
| X-WOPI-LockFailureReason | string | optional | The 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. |