Skip to main content

Interface: ParamSelect

A parameter whose value is chosen from a finite list.

Extends​

Properties​

id​

id: string

Stable parameter identifier within the endpoint.

Inherited from​

ParamBase.id

label​

label: string

Human-readable form label.

Inherited from​

ParamBase.label

description?​

optional description?: string

Optional usage guidance displayed by clients.

Inherited from​

ParamBase.description

hidden?​

optional hidden?: boolean

Hides the input from the user while allowing clients to provide a value.

Inherited from​

ParamBase.hidden

required?​

optional required?: boolean

Whether callers must provide a value.

Inherited from​

ParamBase.required

role?​

optional role?: ServiceParameterRole

Lets the application map a parameter without relying on its ID.

Inherited from​

ParamBase.role

value?​

optional value?: string

Default or preselected value serialized as a string.

Inherited from​

ParamBase.value

type​

type: "select"

Discriminator for a selection parameter.

multiple?​

optional multiple?: boolean

Whether more than one option can be selected.

options​

options: object[]

Values and labels offered by the client.

label​

label: string

Human-readable option name.

value​

value: string

Value sent to the service.