IRPCClientScript.GetScriptApplicationsEx

View as Markdown

Vault API / standard read session idempotent

Lists the applications installed in the vault, optionally only one type or platform.

ServiceClient scripts and UI extension applications MFiles.IRPCClientScript
gRPC method/MFiles.IRPCClientScript/GetScriptApplicationsEx
HTTP (mf-http-grpc)POST /grpc/v1/get-script-applications-ex
RequestGetScriptApplicationsExRequest
ResponseGetScriptApplicationsExResponse
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: GetScriptApplicationsExRequest

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

FieldTypeDescription
filterExtApplicationTypeThe application type, or EXT_APPLICATION_TYPE_UNSPECIFIED for all types (disabled applications included).Values: EXT_APPLICATION_TYPE_UNSPECIFIED (0), EXT_APPLICATION_TYPE_CLIENT (1), EXT_APPLICATION_TYPE_SERVER (2).
platformExtApplicationPlatformThe client platform, or EXT_APPLICATION_PLATFORM_NONE for all.Values: EXT_APPLICATION_PLATFORM_NONE (0), EXT_APPLICATION_PLATFORM_DESKTOP (1), EXT_APPLICATION_PLATFORM_WEB (2), EXT_APPLICATION_PLATFORM_SHARE_POINT_ADD_ON (4), EXT_APPLICATION_PLATFORM_VNEXT (8), EXT_APPLICATION_PLATFORM_MWIDGET (16), EXT_APPLICATION_PLATFORM_ADMIN (32).

Response: GetScriptApplicationsExResponse

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

FieldTypeDescription
applications[]repeated ExtApplicationThe applications. See ExtApplication.
applications[].guidstringThe application identifier.
applications[].namestringThe application name.
applications[].versionstringThe application version (author set).
applications[].descriptionstringThe application name.
applications[].publisherstringThe application publisher.
applications[].is_enabledboolTrue if the application is enabled. Note: this is a user-specific value and is not stored with the application data. Relevant for client applications only.
applications[].is_optionalboolTrue if the application is optional (i.e. can be disabled). Relevant for client applications only.
applications[].requires_system_accessboolTrue if this application requires system access. Relevant for client applications only.
applications[].md5_checksumstringThe application checksum (hash value).
applications[].master_applicationstringThe guid for the master application. GUID_NULL if there is no master application.
applications[].typeExtApplicationTypeThe application type.Values: EXT_APPLICATION_TYPE_UNSPECIFIED (0), EXT_APPLICATION_TYPE_CLIENT (1), EXT_APPLICATION_TYPE_SERVER (2).
applications[].is_multi_server_compatibleboolIndicates if application has been designed to work in multi-server environment.
applications[].published_atgoogle.protobuf.TimestampPublishing date. Zero values if date has not been defined.
applications[].platformsint32The binary value of the application platfroms supported.
applications[].vault_app_dependencies[]repeated VaultApplicationDependencyVault application dependencies.
applications[].vault_app_dependencies[].guidstringThe application identifier.
applications[].vault_app_dependencies[].namestringThe name of the required vault application.
applications[].vault_app_dependencies[].versionstringThe minimum required application version.
applications[].vault_app_dependencies[].requiredboolTrue if the application is required to be at at least the minimum version.
applications[].is_signed_and_verifiedboolTrue if the application is signed and has been verified.
applications[].hot_swappableboolTrue if the application can be deployed without vault restart. Applicable for server-side vault applications only.