Era.Common.NetworkMessage.ConsoleApi.Symbols.RpcGetResidLabelsRequest

Description

Requests symbol ID and query usage definition, which can be used to get the list of labels for all possible values of symbol symbol_id. symbol_id can be a symbol of type ST_RESOURCE_ID. Used to render filters in report templates, to allow the user to select from the values.

Properties

Name JsonSchemaType Description
symbol_id integer

Dual message (request/response)

Era.Common.NetworkMessage.ConsoleApi.Symbols.RpcGetResidLabelsResponse

Referenced in messages

No references.

JsonSchema

{
    "title": "Era.Common.NetworkMessage.ConsoleApi.Symbols.RpcGetResidLabelsRequest",
    "type": "object",
    "$schema": "http://json-schema.org/draft-04/schema#",
    "additionalProperties": false,
    "required": [
        "Era.Common.NetworkMessage.ConsoleApi.Symbols.RpcGetResidLabelsRequest"
    ],
    "properties": {
        "Era.Common.NetworkMessage.ConsoleApi.Symbols.RpcGetResidLabelsRequest": {
            "$ref": "#/definitions/RpcGetResidLabelsRequest"
        }
    },
    "definitions": {
        "RpcGetResidLabelsRequest": {
            "additionalProperties": false,
            "required": [
                "symbol_id"
            ],
            "type": "object",
            "properties": {
                "symbol_id": {
                    "type": "integer"
                }
            }
        }
    }
}