1. Types
  2. vapi
  3. std

vapi std: localization param

This structure holds a single message parameter and formatting settings for it. The structure has fields for string, long, double, date time and nested messages. Only one will be used depending on the type of data sent. For date, double and long it is possible to set additional formatting details. This structure was added in vSphere API 7.0.0.0.

Representation:

{
    "dt" : "2015-01-01T22:13:05.651Z",
    "s" : "string",
    "d" : 1.5,
    "precision" : 1,
    "format" : "SHORT_DATE",
    "i" : 1,
    "l" : {
        "id" : "string",
        "params" : {
            "<string>" : {
                "dt" : "2015-01-01T22:13:05.651Z",
                "s" : "string",
                "d" : 1.5,
                "precision" : 1,
                "format" : "SHORT_DATE",
                "i" : 1,
                "l" : {
                    "id" : "string",
                    "params" : {}
                }
            }
        }
    }
}
{
    "dt" : "2015-01-01T22:13:05.651Z",
    "s" : "string",
    "d" : 1.5,
    "precision" : 1,
    "format" : "SHORT_DATE",
    "i" : 1,
    "l" : {
        "id" : "string",
        "params" : [
            {
                "value" : {
                    "dt" : "2015-01-01T22:13:05.651Z",
                    "s" : "string",
                    "d" : 1.5,
                    "precision" : 1,
                    "format" : "SHORT_DATE",
                    "i" : 1,
                    "l" : {
                        "id" : "string",
                        "params" : [
                            {
                                "key" : "string"
                            }
                        ]
                    }
                },
                "key" : "string"
            }
        ]
    }
}

Attributes:

Name Type Description
Required
-.l.id string Unique identifier of the localizable string or message template.

This identifier is typically used to retrieve a locale-specific string or message template from a message catalog.

. This attribute was added in vSphere API 7.0.0.0.
-.l.params.* localization_param
Optional
-.s string String value associated with the parameter. This attribute was added in vSphere API 7.0.0.0.

Optional. this field will be set when string value is used.
-.dt date_time Date and time value associated with the parameter. Use the format field to specify date and time display style. This attribute was added in vSphere API 7.0.0.0.

Optional. this field will be set when date and time value is used.
-.i long long value associated with the parameter. This attribute was added in vSphere API 7.0.0.0.

Optional. this field will be set when long value is used.
-.d double The double value associated with the parameter. The number of displayed fractional digits is changed via precision field. This attribute was added in vSphere API 7.0.0.0.

Optional. this field will be set when double value is used.
-.l nested_localizable_message Nested localizable value associated with the parameter. This is useful construct to convert to human readable localized form enumerated type and boolean values. It can also be used for proper handling of pluralization and gender forms in localization. Recursive nested_localizable_message instances can be used for localizing short lists of items. This attribute was added in vSphere API 7.0.0.0.

Optional. this field will be set when nested localization message value is used.
-.l.params object Named Arguments to be substituted into the message template. This attribute was added in vSphere API 7.0.0.0.

Optional. services will not populate this field when there are no parameters to be substituted.

-.l.params.*.s string String value associated with the parameter. This attribute was added in vSphere API 7.0.0.0.

Optional. this field will be set when string value is used.
-.format string Format associated with the date and time value in dt field. The enumeration value SHORT_DATETIME will be used as default. This attribute was added in vSphere API 7.0.0.0.

Optional. this may not be set if enumeration value SHORT_DATETIME default format is appropriate.

-.precision long Number of fractional digits to include in formatted double value. This attribute was added in vSphere API 7.0.0.0.

Optional. this will be set when exact precision is required for rendering double numbers.