> Documentation index: https://www.gooddata.ai/docs/gooddata-ui/llms.txt lists every page of these docs as Markdown.

# IAutomationParameter

- Package: [@gooddata/sdk-ui-dashboard](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/index.md)
- Kind: interface
- Stability: beta
- Source: https://github.com/gooddata/gooddata-ui-sdk/blob/rel/11.64/libs/sdk-ui-dashboard/src/presentation/automations/shared/automationFilters/automationParameters.ts

> **Beta API.** Mostly stable, but details may change in a minor release, outside SemVer. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

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.

**Signature:**

```typescript
export interface IAutomationParameter 
```

## Properties

| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [definition](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.iautomationparameter/index.md#iautomationparameterdefinition) |  | [IParameterDefinition](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iparameterdefinition/index.md) | **_(BETA)_** Resolved definition of the parameter; determines which editing control the chip renders. |
| [mode](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.iautomationparameter/index.md#iautomationparametermode) |  | [DashboardParameterMode](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.dashboardparametermode/index.md) | **_(BETA)_** Dashboard-level mode of the parameter, controlling whether its chip is editable in the dialog. |
| [ref](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.iautomationparameter/index.md#iautomationparameterref) |  | [IdentifierRef](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.identifierref/index.md) | **_(BETA)_** Reference to the workspace parameter this row represents. |
| [title](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.iautomationparameter/index.md#iautomationparametertitle) |  | 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. |
| [value](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.iautomationparameter/index.md#iautomationparametervalue) |  | [ParameterValue](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.parametervalue/index.md) | **_(BETA)_** The current effective value — the value a headless run of the automation will capture. |

## Property details

### IAutomationParameter.definition

> **Beta API.** Mostly stable, but details may change in a minor release, outside SemVer. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Resolved definition of the parameter; determines which editing control the chip renders.

**Signature:**

```typescript
definition: IParameterDefinition;
```

### IAutomationParameter.mode

> **Beta API.** Mostly stable, but details may change in a minor release, outside SemVer. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Dashboard-level mode of the parameter, controlling whether its chip is editable in the dialog.

**Signature:**

```typescript
mode: DashboardParameterMode;
```

### IAutomationParameter.ref

> **Beta API.** Mostly stable, but details may change in a minor release, outside SemVer. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Reference to the workspace parameter this row represents.

**Signature:**

```typescript
ref: IdentifierRef;
```

### IAutomationParameter.title

> **Beta API.** Mostly stable, but details may change in a minor release, outside SemVer. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Title shown on the parameter chip: the dashboard-level label when the dashboard defines one, otherwise the workspace parameter's title, otherwise the identifier.

**Signature:**

```typescript
title: string;
```

### IAutomationParameter.value

> **Beta API.** Mostly stable, but details may change in a minor release, outside SemVer. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

The current effective value — the value a headless run of the automation will capture.

**Signature:**

```typescript
value: ParameterValue;
```