Skip to main content

Interface: ParamBase

Fields shared by every service endpoint parameter.

Extended by​

Properties​

id​

id: string

Stable parameter identifier within the endpoint.

label​

label: string

Human-readable form label.

description?​

optional description?: string

Optional usage guidance displayed by clients.

hidden?​

optional hidden?: boolean

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

required?​

optional required?: boolean

Whether callers must provide a value.

role?​

optional role?: ServiceParameterRole

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

value?​

optional value?: string

Default or preselected value serialized as a string.