IRPCClientScript.GetScriptApplicationsEx
Vault API / standard read session idempotent
Lists the applications installed in the vault, optionally only one type or platform.
| Service | Client scripts and UI extension applications MFiles.IRPCClientScript |
|---|---|
| gRPC method | /MFiles.IRPCClientScript/GetScriptApplicationsEx |
| HTTP (mf-http-grpc) | POST /grpc/v1/get-script-applications-ex |
| Request | GetScriptApplicationsExRequest |
| Response | GetScriptApplicationsExResponse |
| Book and level | Vault API, standard |
| Kind | read |
| Session | Required: the session ID from LogIn in the mfiles-session-id-bin metadata. |
| Idempotent | yes |
| Returns metadata structure version | no |
| Streaming | none (unary) |
Remarks
- With
filterEXT_APPLICATION_TYPE_CLIENTany vault session can call it. Other filters need the vault rightread_all_metadata_structure; otherwise "Access denied.". - With
filterEXT_APPLICATION_TYPE_UNSPECIFIEDall applications are returned, disabled ones included. With a type filter only enabled applications are returned; UI extension applications whose vault application is disabled are left out as well. platformreturns the applications whoseplatformsinclude it.EXT_APPLICATION_PLATFORM_NONEandEXT_APPLICATION_PLATFORM_ADMINdo not filter.
Request: GetScriptApplicationsExRequest
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 |
|---|---|---|
filter | ExtApplicationType | The 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). |
platform | ExtApplicationPlatform | The 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.
| Field | Type | Description |
|---|---|---|
applications[] | repeated ExtApplication | The applications. See ExtApplication. |
applications[].guid | string | The application identifier. |
applications[].name | string | The application name. |
applications[].version | string | The application version (author set). |
applications[].description | string | The application name. |
applications[].publisher | string | The application publisher. |
applications[].is_enabled | bool | True 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_optional | bool | True if the application is optional (i.e. can be disabled). Relevant for client applications only. |
applications[].requires_system_access | bool | True if this application requires system access. Relevant for client applications only. |
applications[].md5_checksum | string | The application checksum (hash value). |
applications[].master_application | string | The guid for the master application. GUID_NULL if there is no master application. |
applications[].type | ExtApplicationType | The application type.Values: EXT_APPLICATION_TYPE_UNSPECIFIED (0), EXT_APPLICATION_TYPE_CLIENT (1), EXT_APPLICATION_TYPE_SERVER (2). |
applications[].is_multi_server_compatible | bool | Indicates if application has been designed to work in multi-server environment. |
applications[].published_at | google.protobuf.Timestamp | Publishing date. Zero values if date has not been defined. |
applications[].platforms | int32 | The binary value of the application platfroms supported. |
applications[].vault_app_dependencies[] | repeated VaultApplicationDependency | Vault application dependencies. |
applications[].vault_app_dependencies[].guid | string | The application identifier. |
applications[].vault_app_dependencies[].name | string | The name of the required vault application. |
applications[].vault_app_dependencies[].version | string | The minimum required application version. |
applications[].vault_app_dependencies[].required | bool | True if the application is required to be at at least the minimum version. |
applications[].is_signed_and_verified | bool | True if the application is signed and has been verified. |
applications[].hot_swappable | bool | True if the application can be deployed without vault restart. Applicable for server-side vault applications only. |