IRPCClientScript.DownloadScriptApplicationFile_Begin

View as Markdown

Vault API / standard read session idempotent

Starts downloading the package (ZIP file) of an application and returns its first block.

ServiceClient scripts and UI extension applications MFiles.IRPCClientScript
gRPC method/MFiles.IRPCClientScript/DownloadScriptApplicationFile_Begin
HTTP (mf-http-grpc)POST /grpc/v1/download-script-application-file_-begin
RequestDownloadScriptApplicationFile_BeginRequest
ResponseDownloadScriptApplicationFile_BeginResponse
Book and levelVault API, standard
Kindread
SessionRequired: the session ID from LogIn in the mfiles-session-id-bin metadata.
Idempotentyes
Returns metadata structure versionno
Streamingnone (unary)

Remarks

Request: DownloadScriptApplicationFile_BeginRequest

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

FieldTypeDescription
script_applicationstringThe GUID of the application.
block_sizeuint32The number of bytes to return in data, at most 4 MiB.

Response: DownloadScriptApplicationFile_BeginResponse

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

FieldTypeDescription
download_idint32The ID of the download, for the next blocks.
file_sizeint64The size of the package in bytes.
databytesThe first block of the package.