IRPCClientScript.GetScriptApplication
Vault API / standard write session
Gets one application by its GUID.
| Service | Client scripts and UI extension applications MFiles.IRPCClientScript |
|---|---|
| gRPC method | /MFiles.IRPCClientScript/GetScriptApplication |
| HTTP (mf-http-grpc) | POST /grpc/v1/get-script-application |
| Request | GetScriptApplicationRequest |
| Response | GetScriptApplicationResponse |
| Book and level | Vault API, standard |
| Kind | write |
| Session | Required: the session ID from LogIn in the mfiles-session-id-bin metadata. |
| Idempotent | no |
| Returns metadata structure version | no |
| Streaming | none (unary) |
Remarks
- An unknown GUID fails with "Not found. (Vault application not found. (ID: ...))".
Request: GetScriptApplicationRequest
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 |
|---|---|---|
script_application | string | The GUID of the application. |
Response: GetScriptApplicationResponse
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 |
|---|---|---|
application | ExtApplication | The application. See ExtApplication. |
application.guid | string | The application identifier. |
application.name | string | The application name. |
application.version | string | The application version (author set). |
application.description | string | The application name. |
application.publisher | string | The application publisher. |
application.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. |
application.is_optional | bool | True if the application is optional (i.e. can be disabled). Relevant for client applications only. |
application.requires_system_access | bool | True if this application requires system access. Relevant for client applications only. |
application.md5_checksum | string | The application checksum (hash value). |
application.master_application | string | The guid for the master application. GUID_NULL if there is no master application. |
application.type | ExtApplicationType | The application type.Values: EXT_APPLICATION_TYPE_UNSPECIFIED (0), EXT_APPLICATION_TYPE_CLIENT (1), EXT_APPLICATION_TYPE_SERVER (2). |
application.is_multi_server_compatible | bool | Indicates if application has been designed to work in multi-server environment. |
application.published_at | google.protobuf.Timestamp | Publishing date. Zero values if date has not been defined. |
application.platforms | int32 | The binary value of the application platfroms supported. |
application.vault_app_dependencies[] | repeated VaultApplicationDependency | Vault application dependencies. |
application.vault_app_dependencies[].guid | string | The application identifier. |
application.vault_app_dependencies[].name | string | The name of the required vault application. |
application.vault_app_dependencies[].version | string | The minimum required application version. |
application.vault_app_dependencies[].required | bool | True if the application is required to be at at least the minimum version. |
application.is_signed_and_verified | bool | True if the application is signed and has been verified. |
application.hot_swappable | bool | True if the application can be deployed without vault restart. Applicable for server-side vault applications only. |
Related methods
- GetScriptApplicationServerEnable -- Tells whether an application is enabled in the vault.