PutFile

POST /wopi/files/(file_id)/contents

Updates a file’s binary contents for the HTTP://server/<...>/wopi*/files/<id>/contents operation.

This operation works as follows:

The WOPI host checks if a file is currently locked or not.
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.
If the file is unlocked, the host must check the current size of the file. If it is 0 bytes, the PutFile request should be considered valid and should proceed. If it is any value other than 0 bytes, or is missing altogether, the host should respond with 409 Conflict.
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.

Name	Type	Description
access_token	string	An access token that the host will use to determine whether the request is authorized.

Name	Type	Presence	Description
X-WOPI-Override	string	required	The requested operation from the WOPI server (PUT).
X-WOPI-Lock	string	optional	The lock ID that the host must use to identify the lock on the file.
X-WOPI-Editors	string	optional	All the users who contributed changes to the document in this PutFile request (UserId values delimited by commas).
X-LOOL-WOPI-IsModifiedByUser	string	optional	Indicates whether the user has modified the document before the save ("true"), or if they just pressed the Save button without any modification ("false").
X-LOOL-WOPI-IsAutosave	string	optional	Indicates whether the PutFile is triggered by autosave ("true") or by explicit user operation (Save button or menu entry) ("false").
X-LOOL-WOPI-IsExitSave	string	optional	Indicates whether an automatic save will be triggered when the document gets cleaned up from memory (e.g. when all users disconnect) ("true") or not ("false").

The request body must be the full binary contents of the file.

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.
X-WOPI-ItemVersion	string	optional	The file version.