alert-plugin-type-property

alert-plugin-type-property

Describes Notification Plugin field metadata

JSON Example

{
    "key": "string",
    "dataType": "string",
    "enum-values": [
        "string"
    ],
    "description": "string",
    "length": 0,
    "required": false,
    "displayOrder": 0,
    "defaultValue": "string",
    "isDeprecated": false,
    "acceptableServiceCredentialTypes": [
        "string"
    ]
}

string

key

Required

Unique identifier or name for the Plugin Property

string

dataType

Optional

Datatype for the property value

Possible values are : UNSPECIFIED, STRING, BOOLEAN, PASSWORD, INTEGER, ENUM,

array of string

enum-values

Optional

Possible values if the data type is an enum

string

description

Optional

A description of the property

integer As int32 As int32

length

Optional

Optional, the supported length for the property value

boolean

required

Required

True if this field is required for the configuration

integer As int32 As int32

displayOrder

Optional

Display order in the UI

string

defaultValue

Optional

Optional default value for the property

boolean

isDeprecated

Optional

Is Property deprecated

array of string

acceptableServiceCredentialTypes

Optional

Acceptable service credential types for plugin type

Property Of

alert-plugin-type