IAutomationParameter
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
A workspace parameter resolved for display and editing inside an automation (alert/schedule) dialog. The value is the current effective value the headless run will capture; definition picks which control renders.
export interface IAutomationParameter
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
(BETA) Resolved definition of the parameter; determines which editing control the chip renders. | |||
(BETA) Dashboard-level mode of the parameter, controlling whether its chip is editable in the dialog. | |||
(BETA) Reference to the workspace parameter this row represents. | |||
string | (BETA) Title shown on the parameter chip: the dashboard-level label when the dashboard defines one, otherwise the workspace parameter’s title, otherwise the identifier. | ||
(BETA) The current effective value — the value a headless run of the automation will capture. |
Property details
IAutomationParameter.definitionpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Resolved definition of the parameter; determines which editing control the chip renders.
definition: IParameterDefinition;
IAutomationParameter.modepropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Dashboard-level mode of the parameter, controlling whether its chip is editable in the dialog.
mode: DashboardParameterMode;
IAutomationParameter.refpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Reference to the workspace parameter this row represents.
ref: IdentifierRef;
IAutomationParameter.titlepropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Title shown on the parameter chip: the dashboard-level label when the dashboard defines one, otherwise the workspace parameter’s title, otherwise the identifier.
title: string;
IAutomationParameter.valuepropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
The current effective value — the value a headless run of the automation will capture.
value: ParameterValue;