3.3.5.1.22 Unlock

Release a lock for editing a file.

HTTP Verb: POST

URI: HTTP://server/<...>/wopi*/files/<id>?access_token=<token>

The request message for this operation contains the following HTTP headers.

Request header

Usage

Value

X-WOPI-Override

A string specifying the requested operation from the WOPI server. Required.

The string "UNLOCK".

X-WOPI-Lock

A string provided by the WOPI client that the WOPI server MUST use to identify the lock on the file. Required.

The string provided by the WOPI client through Lock (see section 3.3.5.1.14).

The response message for this operation can contain the following HTTP headers.

Response header

Usage

Value

X-WOPI-Lock

A string provided by the WOPI client that the WOPI server uses to identify the lock on the file. This header SHOULD be included when responding with the 409 status code if no lock or a different shared lock exists on the file. This header SHOULD NOT be included when responding with the 200 status code.

A string.

X-WOPI-LockedByOtherInterface

A string indicating that the file is currently locked by another client. This header SHOULD be included when responding with the 409 status code if the file is locked by another client.

The string "true".

The response message for this operation can result in the following status codes.

Status code

Description

200

Success

401

Token is invalid

404

File unknown/User unauthorized

409

Lock mismatch/locked by another interface;

500

Server error

501

Unsupported