PbmExtendedElementDescription

PbmExtendedElementDescription
PbmExtendedElementDescription

This structure may be used only with operations rendered under /pbm.

AllOf
This class requires all of the following:
JSON Example
{
    "_typeName": "string",
    "label": "string",
    "summary": "string",
    "key": "string",
    "messageCatalogKeyPrefix": "string",
    "messageArg": [
        {
            "_typeName": "string",
            "key": "string",
            "value": {
                "_typeName": "string"
            }
        }
    ]
}
string
label
Required

Display label.

string
summary
Required

Summary description.

string
key
Required

Enumeration or literal ID being described.

string
messageCatalogKeyPrefix
Required

Key to the localized message string in the catalog.

If the localized string contains parameters, values to the parameters will be provided in #messageArg. E.g: If the message in the catalog is "IP address is {address}", value for "address" will be provided by #messageArg. Both summary and label in ElementDescription will have a corresponding entry in the message catalog with the keys <messageCatalogKeyPrefix>.summary and <messageCatalogKeyPrefix>.label respectively. ElementDescription.summary and ElementDescription.label will contain the strings in server locale.

messageArg
Optional

Provides named arguments that can be used to localize the message in the catalog.