IRPCWOPIOperationsPublic.WOPIUploadFile
Server integration API / specialized internal: not for applications write no session
Uploads a block of the new content of the file of a WOPI editing or co-authoring session.
| Service | WOPI operations (anonymous) MFiles.IRPCWOPIOperationsPublic |
|---|---|
| gRPC method | /MFiles.IRPCWOPIOperationsPublic/WOPIUploadFile |
| HTTP (mf-http-grpc) | POST /grpc/v1/wopiupload-file |
| Request | WOPIUploadFileRequest |
| Response | WOPIUploadFileResponse |
| Book and level | Server integration API, specialized |
| Kind | write |
| Session | Not needed: the call can be made before logging in. |
| Idempotent | no |
| Returns metadata structure version | no |
| Streaming | none (unary) |
Remarks
For M-Files components only. The M-Files WOPI service calls it when Office for the web saves the file. Applications should not call it.
- Works only with a token whose link is for editing or co-authoring; others fail with "The parameter is incorrect.". The token's user needs read and edit access to the object.
- The first call has
upload_id0 andoffset0 and returns the upload ID; later calls pass it. Complete the upload with WOPIUploadFileCommit. A failed call deletes the upload.
Request: WOPIUploadFileRequest
Nested message fields are expanded to depth 3; follow a type link for deeper levels and for the type's own page.
| Field | Type | Description |
|---|---|---|
wopi_user_session_key | string | The WOPI user session token. |
upload_id | int32 | 0 to start a new upload, otherwise the ID returned by the first call. |
total_size_in_bytes | int64 | The total size of the file in bytes. Used only when offset is 0. |
offset | int64 | The position of data in the file. Use multiples of 4096 bytes. |
data | bytes | The block. Use multiples of 4096 bytes, except for the last block. |
Response: WOPIUploadFileResponse
Nested message fields are expanded to depth 3; follow a type link for deeper levels and for the type's own page.
| Field | Type | Description |
|---|---|---|
upload_id | int32 | Receives the identifier of this upload operation. |
Related methods
- WOPIUploadFileCommit -- Stores an upload made with WOPIUploadFile as the new content of the file of the WOPI session.