Export (0) Print
Expand All

3.3.5.1.3 Lock

Office

Take 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 "LOCK".

X-WOPI-Lock

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

A string.

The response message for this operation contains the following HTTP headers if the status code is 200.

Response header

Usage

Value

X-WOPI-OldLock

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

A string.

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

Show:
© 2014 Microsoft