IRPCObjectOperations.GetFileDownloadUrl
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/GetFileDownloadUrl |
| HTTP (mf-http-grpc) | POST /grpc/v1/get-file-download-url |
| Request | GetFileDownloadUrlRequest |
| Response | GetFileDownloadUrlResponse |
| 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: GetFileDownloadUrlRequest
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 |
|---|---|---|
obj_ver | ObjVer | Object version. |
obj_ver.obj_id | ObjID | The object. |
obj_ver.obj_id.type | int32 | The object type ID, for example 0 for documents. In a lookup value, the value list ID (for a lookup to objects, the object type ID). |
obj_ver.obj_id.item_id | ItemID | The ID of the object within its type, in item_id.internal_id. |
obj_ver.version | ObjVerVersion | The version. Usually OBJ_VER_VERSION_TYPE_SPECIFIC with internal_version. |
obj_ver.version.type | ObjVerVersionType | What internal_version means. OBJ_VER_VERSION_TYPE_SPECIFIC for a version number.Values: OBJ_VER_VERSION_TYPE_UNINITIALIZED (0), OBJ_VER_VERSION_TYPE_LATEST (1), OBJ_VER_VERSION_TYPE_ANY (2), OBJ_VER_VERSION_TYPE_ALL (3), OBJ_VER_VERSION_TYPE_SPECIFIC (4), OBJ_VER_VERSION_TYPE_VALUE_LIST_ITEM (6), OBJ_VER_VERSION_TYPE_OBJECT_LEVEL_REFERENCE (7). |
obj_ver.version.internal_version | int32 | The version number, starting from 1, when type is OBJ_VER_VERSION_TYPE_SPECIFIC. The server returns -1 with OBJ_VER_VERSION_TYPE_LATEST. |
obj_ver.version.external_repository_version | string | Used only for objects in external repositories. Leave empty. |
obj_ver.version.external_repository_sort_key | int64 | Used only for objects in external repositories. Leave 0. |
file_id | FileID | File ID. |
file_id.type | FileIDType | FILE_IDTYPE_SPECIFIC for one file.Values: FILE_IDTYPE_UNINITIALIZED (0), FILE_IDTYPE_ALL (1), FILE_IDTYPE_ANY (2), FILE_IDTYPE_SPECIFIC (3). |
file_id.internal_id | int32 | The file ID. |
file_id.external_repository_id | string | Used only for files in external repositories. Leave empty. |
additional_data[] | repeated NamedValue | An optional key-value pairs for additional data from the caller. Can be empty. |
additional_data[].key | string | The name of the value. |
additional_data[].value | TypedValue | The value as a serialized bytearray. |
additional_data[].value.is_null_value | bool | True if the value is empty. data is then unset. |
additional_data[].value.type | Datatype | The data type of the value. |
additional_data[].value.data | TypedValueUnion | The value, in the member that matches type. Unset for an empty value. |
Response: GetFileDownloadUrlResponse
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 |
|---|---|---|
url | string | URL that can be used to download the file. |
Related methods
- GetFileDownloadUrl2 -- Not available over native gRPC: the server answers "Not implemented.". Used by the M-Files HTTP gateway.