Era.Common.DataDefinition.Common.Label

Description

Structure to store localized label.
If this structure is retrieved from server, it should have [type] STR_LITERAL and contain localized string in [literal].
The [res_id] typically contains server-side resource ID assciated with this [literal].

Properties

Name	JsonSchemaType	Description
literal	string	Localized text of this label.
res_id	integer	Server-side resource ID assciated with this label.
type	enum of Era.Common.DataDefinition.Common.Label_Type	Type of the label.

Dual message (request/response)

No dual message.

Referenced in messages

Era.Common.DataDefinition.Common.BulkOperationResult
Era.Common.DataDefinition.FilterAdvisor.ResultSet_AttributeFamilyResultSet
Era.Common.DataDefinition.Licenses.SeatRemovalResult
Era.Common.DataDefinition.Reports.Report_Rendering_Chart
Era.Common.DataDefinition.Reports.Report_Rendering_Chart_Series
Era.Common.DataDefinition.Reports.Report_Rendering_Table_Column
Era.Common.DataDefinition.Symbol.SymbolDefinition
Era.Common.DataDefinition.Symbol.SymbolDefinition_PredefinedConstant
Era.Common.DataDefinition.Task.ESS.ServerOnDemandScan_ScanTarget
Era.Common.NetworkMessage.ConsoleApi.Symbols.RpcGetAllEnumTypesLabelsResponse_IdLabelPair
Era.Common.NetworkMessage.ConsoleApi.Symbols.RpcGetAllSymbolsCategoriesLabelsResponse_Id32LabelPair
Era.Common.NetworkMessage.ConsoleApi.Symbols.RpcGetAllSymbolsCategoriesLabelsResponse_Id64LabelPair
Era.Common.NetworkMessage.ConsoleApi.Symbols.RpcGetLogIDsForEventLogTriggerResponse_IdLabelPair
Era.Common.NetworkMessage.ConsoleApi.Symbols.RpcGetStateTriggerDetailsResponse_IdLabelPair

JsonSchema

{
    "title": "Era.Common.DataDefinition.Common.Label",
    "type": "object",
    "$schema": "http://json-schema.org/draft-04/schema#",
    "additionalProperties": false,
    "required": [
        "Era.Common.DataDefinition.Common.Label"
    ],
    "properties": {
        "Era.Common.DataDefinition.Common.Label": {
            "$ref": "#/definitions/Label"
        }
    },
    "definitions": {
        "Label": {
            "additionalProperties": false,
            "required": [
                "type"
            ],
            "type": "object",
            "properties": {
                "literal": {
                    "type": "string"
                },
                "res_id": {
                    "type": "integer"
                },
                "type": {
                    "enum": [
                        0,
                        1
                    ]
                }
            }
        }
    }
}