ProfileParameterMetadata

ProfileParameterMetadata
ProfileParameterMetadata

The ProfileParameterMetadata data object represents the metadata information for expressions, policy options, and host-specific configuration data.

AllOf
This class requires all of the following:
JSON Example
{
    "_typeName": "string",
    "id": {
        "_typeName": "string",
        "label": "string",
        "summary": "string",
        "key": "string",
        "messageCatalogKeyPrefix": "string",
        "messageArg": [
            {
                "_typeName": "string",
                "key": "string",
                "value": {
                    "_typeName": "string"
                }
            }
        ]
    },
    "type": "string",
    "optional": false,
    "defaultValue": {
        "_typeName": "string"
    },
    "hidden": false,
    "securitySensitive": false,
    "readOnly": false,
    "parameterRelations": [
        {
            "_typeName": "string",
            "relationTypes": [
                "string"
            ],
            "values": [
                {
                    "_typeName": "string"
                }
            ],
            "path": {
                "_typeName": "string",
                "profilePath": "string",
                "policyId": "string",
                "parameterId": "string",
                "policyOptionId": "string"
            },
            "minCount": 0,
            "maxCount": 0
        }
    ]
}
id
Required

Identifier for the parameter.

string
type
Required

Type of the parameter.

boolean
optional
Required

Whether the parameter is optional.

defaultValue
Optional

The base of all data types. Not to be used directly on the wire.

boolean
hidden
Optional

Whether the parameter will not be displayed in UI.

boolean
securitySensitive
Optional

Whether the parameter is security sensitive.

boolean
readOnly
Optional

Indicates that the parameter value is read-only.

parameterRelations
Optional

Relations with other profile or parameters.