IRPCSharedLinksPublic.GetSharedLinkInfo

View as Markdown

Vault API / standard write no session

Gets the name, extension and size of the file that a shared link points to, without logging in.

ServiceShared links (anonymous access) MFiles.IRPCSharedLinksPublic
gRPC method/MFiles.IRPCSharedLinksPublic/GetSharedLinkInfo
HTTP (mf-http-grpc)POST /grpc/v1/get-shared-link-info
RequestGetSharedLinkInfoRequest
ResponseGetSharedLinkInfoResponse
Book and levelVault API, standard
Kindwrite
SessionNot needed: the call can be made before logging in.
Idempotentno
Returns metadata structure versionno
Streamingnone (unary)

Remarks

Request: GetSharedLinkInfoRequest

Nested message fields are expanded to depth 3; follow a type link for deeper levels and for the type's own page.

FieldTypeDescription
vaultstringThe vault GUID, for example {7BBEA0BC-40D8-4BCB-A67D-8A3ACFBDB575}.
access_keystringThe access key of the shared link.
additional_data[]repeated NamedValueOptional named values: RECIPIENT_EMAIL, RECIPIENT_ACCESSCODE and ACCESS_SESSION for links shared with named visitors, and CLIENT_IP for the event log.
additional_data[].keystringThe name of the value.
additional_data[].valueTypedValueThe value as a serialized bytearray.
additional_data[].value.is_null_valueboolTrue if the value is empty. data is then unset.
additional_data[].value.typeDatatypeThe data type of the value.
additional_data[].value.dataTypedValueUnionThe value, in the member that matches type. Unset for an empty value.

Response: GetSharedLinkInfoResponse

Nested message fields are expanded to depth 3; follow a type link for deeper levels and for the type's own page.

FieldTypeDescription
resultSharedFileInfoThe file's title, extension, size and change time.
result.titlestringThe title of the file.
result.extensionstringFile extension, not including the dot (e.g. "doc").
result.logical_sizeint64The logical size of the file in bytes.
result.change_timegoogle.protobuf.TimestampThe time in UTC the file was last written to or its attributes were changed.