IRPCClientScript.UploadScriptApplicationFileBlockEx

View as Markdown

Vault API / standard write session idempotent

Uploads an application package block by block and, with the last block, installs the application.

ServiceClient scripts and UI extension applications MFiles.IRPCClientScript
gRPC method/MFiles.IRPCClientScript/UploadScriptApplicationFileBlockEx
HTTP (mf-http-grpc)POST /grpc/v1/upload-script-application-file-block-ex
RequestUploadScriptApplicationFileBlockExRequest
ResponseUploadScriptApplicationFileBlockExResponse
Book and levelVault API, standard
Kindwrite
SessionRequired: the session ID from LogIn in the mfiles-session-id-bin metadata.
Idempotentyes
Returns metadata structure versionno
Streamingnone (unary)

Remarks

Request: UploadScriptApplicationFileBlockExRequest

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

FieldTypeDescription
upload_idint320 in the first call; then the upload_idret it returned.
total_size_in_bytesint64The size of the whole package.
offsetint64The position of this block. Use multiples of 4096 bytes for all blocks but the last.
databytesThe bytes of this block.
readyboolTrue on the last block, to install the uploaded package.

Response: UploadScriptApplicationFileBlockExResponse

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

FieldTypeDescription
upload_idretint32The ID of the upload, for the next blocks.
outdated_vault_apps[]repeated VaultApplicationDependencyAfter the last block, the dependencies whose installed version is too old. Empty otherwise.
outdated_vault_apps[].guidstringThe application identifier.
outdated_vault_apps[].namestringThe name of the required vault application.
outdated_vault_apps[].versionstringThe minimum required application version.
outdated_vault_apps[].requiredboolTrue if the application is required to be at at least the minimum version.