IRPCClientScript.GetVaultApplicationLicenseStatus

View as Markdown

Vault API / standard read session idempotent

Gets the license status of a vault application, or checks a license before installing it.

ServiceClient scripts and UI extension applications MFiles.IRPCClientScript
gRPC method/MFiles.IRPCClientScript/GetVaultApplicationLicenseStatus
HTTP (mf-http-grpc)POST /grpc/v1/get-vault-application-license-status
RequestGetVaultApplicationLicenseStatusRequest
ResponseGetVaultApplicationLicenseStatusResponse
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: GetVaultApplicationLicenseStatusRequest

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

FieldTypeDescription
application_guidstringThe GUID of the application.
use_new_licenseboolTrue to evaluate new_license instead of the installed license.
new_licensestringThe license to evaluate when use_new_license is true.
return_detailsboolTrue to get a description of the status in details.

Response: GetVaultApplicationLicenseStatusResponse

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

FieldTypeDescription
statusApplicationLicenseStatusThe license status of the application.Values: APPLICATION_LICENSE_STATUS_UNKNOWN (0), APPLICATION_LICENSE_STATUS_NOT_NEEDED (1), APPLICATION_LICENSE_STATUS_NOT_INSTALLED (2), APPLICATION_LICENSE_STATUS_INSTALLED (3), APPLICATION_LICENSE_STATUS_VALID (4), APPLICATION_LICENSE_STATUS_INVALID (5), APPLICATION_LICENSE_STATUS_FORMAT_ERROR (6), APPLICATION_LICENSE_STATUS_TRIAL (7), APPLICATION_LICENSE_STATUS_GRACE_PERIOD (8).
detailsstringWith return_details, a description of the status.