Era.Common.NetworkMessage.ConsoleApi.Common.RpcGetServerInfoResponse

Description

Returns information about current server installation.

Properties

Name JsonSchemaType Description
agentUuid reference to Era.Common.DataDefinition.Common.Uuid UUID of the managing ESMC Agent if present.
databaseHostname string Database hostname.
databaseName string Database name.
databaseUser string Database user name.
databaseVersion string Database version.
hasMSPLocation boolean Location with MSP type is present.
installationLocale string Installation language of the ESMC Server, 4-letter code, e.g. en_US.
licenseExpirationDate reference to Era.Common.DataDefinition.Common.UTCTime Expiration date of the license, the server is using.
licensePublicID string Public ID of the license, the server is using.
loadedModules array of references to Era.Common.NetworkMessage.ConsoleApi.Common.RpcGetServerInfoResponse_LoadedModules List of modules currently loaded in the ESMC Server.
productCompatibilityVersion string Version of the ESMC Server, used for compatibility checks. In general, there may be 1 productCompatibilityVersion for multiple productVersion.
productName string Product name of the ESMC Server.
productVersion string Version of the ESMC Server.
publicProductVersion string public Version of the ESMCC Server.
serverUuid reference to Era.Common.DataDefinition.Common.Uuid UUID of the ESMC Server.
uiFeatures array of references to Era.Common.NetworkMessage.ConsoleApi.Common.RpcGetServerInfoResponse_UiFeature UI features which are enabled by default

Dual message (request/response)

Era.Common.NetworkMessage.ConsoleApi.Common.RpcGetServerInfoRequest

Referenced in messages

No references.

JsonSchema

{
    "title": "Era.Common.NetworkMessage.ConsoleApi.Common.RpcGetServerInfoResponse",
    "type": "object",
    "$schema": "http://json-schema.org/draft-04/schema#",
    "additionalProperties": false,
    "required": [
        "Era.Common.NetworkMessage.ConsoleApi.Common.RpcGetServerInfoResponse"
    ],
    "properties": {
        "Era.Common.NetworkMessage.ConsoleApi.Common.RpcGetServerInfoResponse": {
            "$ref": "#/definitions/RpcGetServerInfoResponse"
        }
    },
    "definitions": {
        "RpcGetServerInfoResponse": {
            "additionalProperties": false,
            "required": [
                "serverUuid"
            ],
            "type": "object",
            "properties": {
                "agentUuid": {
                    "$ref": "Era.Common.DataDefinition.Common.Uuid#/definitions/Uuid"
                },
                "databaseHostname": {
                    "type": "string"
                },
                "databaseName": {
                    "type": "string"
                },
                "databaseUser": {
                    "type": "string"
                },
                "databaseVersion": {
                    "type": "string"
                },
                "hasMSPLocation": {
                    "type": "boolean"
                },
                "installationLocale": {
                    "type": "string"
                },
                "licenseExpirationDate": {
                    "$ref": "Era.Common.DataDefinition.Common.UTCTime#/definitions/UTCTime"
                },
                "licensePublicID": {
                    "type": "string"
                },
                "loadedModules": {
                    "type": "array",
                    "items": [
                        {
                            "$ref": "Era.Common.NetworkMessage.ConsoleApi.Common.RpcGetServerInfoResponse_LoadedModules#/definitions/RpcGetServerInfoResponse_LoadedModules"
                        }
                    ]
                },
                "productCompatibilityVersion": {
                    "type": "string"
                },
                "productName": {
                    "type": "string"
                },
                "productVersion": {
                    "type": "string"
                },
                "publicProductVersion": {
                    "type": "string"
                },
                "serverUuid": {
                    "$ref": "Era.Common.DataDefinition.Common.Uuid#/definitions/Uuid"
                },
                "uiFeatures": {
                    "type": "array",
                    "items": [
                        {
                            "$ref": "Era.Common.NetworkMessage.ConsoleApi.Common.RpcGetServerInfoResponse_UiFeature#/definitions/RpcGetServerInfoResponse_UiFeature"
                        }
                    ]
                }
            }
        }
    }
}