IRPCObjectOperations.DownloadFileWithDownloadKey
Vault API / core write session or assertion
Not available over native gRPC: the server answers "Not implemented.". Used by the M-Files HTTP gateway.
| Service | Objects, versions, properties and files MFiles.IRPCObjectOperations |
|---|---|
| gRPC method | /MFiles.IRPCObjectOperations/DownloadFileWithDownloadKey |
| HTTP (mf-http-grpc) | POST /grpc/v1/download-file-with-download-key |
| Request | DownloadFileWithDownloadKeyRequest |
| Response | DownloadFileWithDownloadKeyResponse |
| Book and level | Vault API, core |
| Kind | write |
| Session | Required: a session (mfiles-session-id-bin metadata) or a session assertion (x-mf-session-assertion metadata). |
| Idempotent | no |
| Returns metadata structure version | no |
| Streaming | none (unary) |
Request: DownloadFileWithDownloadKeyRequest
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 |
|---|---|---|
download_key | StringValue | Contains identifier that will be used to locate the file. |
download_key.value | string | String. |
format | FileFormat | Specifies the file format to download.Values: FILE_FORMAT_NATIVE (0), FILE_FORMAT_PDF (1), FILE_FORMAT_DISPLAY_ONLY_PDF (2), FILE_FORMAT_PLAIN_TEXT (3), FILE_FORMAT_MARKDOWN (4). |
content_disposition_inline | bool | True if the content is expected to be displayed inline in the browser. |
need_checksum | bool | True if the caller wants to receive the checksum of the file. Will be returned in the response headers. |
Response: DownloadFileWithDownloadKeyResponse
No fields.
Related methods
- DownloadFile -- Not available over native gRPC: the server answers "Not implemented.". Used by the M-Files HTTP gateway.