WOPI REST API
WOPI REST API defines a set of operations that enable a client to access and change files stored on a server.
Filez Docs Platform uses the following WOPI operations:
- CheckFileInfo - Returns information about file properties, access permissions, and editor settings.
- GetFile - Retrieves a file.
- Lock - Locks a file for editing.
- Unlock - Unlocks a file to allow editing.
- PutFile - Updates the file content.
Possible error codes and their description
| Error code | Description |
|---|---|
| 200 OK | Success |
| 400 Bad Request | X-WOPI-Lock is not provided or empty / specified name is illegal |
| 401 Unauthorized | Invalid access token |
| 404 Not Found | Resource not found / user unauthorized |
| 409 Conflict | Lock mismatch / locked by another interface. When using this response code, the X-WOPI-Lock response header containing the current lock value must always be included |
| 412 Precondition Failed | File is larger than X-WOPI-MaxExpectedSize |
| 413 Request Entity Too Large | File is too large; maximum file size is host-specific |
| 500 Internal Server Error | Server error |
| 501 Not Implemented | Operation not supported |