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

# IDashboardCommand

- Package: [@gooddata/sdk-ui-dashboard](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/index.md)
- Kind: interface
- Source: https://github.com/gooddata/gooddata-ui-sdk/blob/rel/11.64/libs/sdk-ui-dashboard/src/model/commands/base.ts

Base type for all commands.

**Signature:**

```typescript
export interface IDashboardCommand 
```

## Remarks

Commands are dispatched using dispatcher obtained by useDashboardDispatcher(). All the dispatchers are 'contextual' - they target backend, workspace and dashboard in depending on the Dashboard component tree from which the dispatch is done.

## Properties

| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [correlationId?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.idashboardcommand/index.md#idashboardcommandcorrelationid) | `readonly` | string | _(Optional)_ Correlation ID can be provided when creating a command. |
| [meta?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.idashboardcommand/index.md#idashboardcommandmeta) | `readonly` | [CommandProcessingMeta](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.commandprocessingmeta/index.md) | _(Optional)_ Metadata related to processing of the command by the dashboard component. |
| [type](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.idashboardcommand/index.md#idashboardcommandtype) | `readonly` | [DashboardCommandType](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-dashboard/sdk-ui-dashboard.dashboardcommandtype/index.md) | Command type. Always starts with "GDC.DASH/CMD" |

## Property details

### IDashboardCommand.correlationId

Correlation ID can be provided when creating a command.

**Signature:**

```typescript
readonly correlationId?: string;
```

#### Remarks

All events emitted during the command processing will contain the same correlation ID.

If the correlation ID is not specified, a random string will be assigned.

### IDashboardCommand.meta

Metadata related to processing of the command by the dashboard component.

**Signature:**

```typescript
readonly meta?: CommandProcessingMeta;
```

#### Remarks

Note: this metadata is added by the dashboard component. It will be added dynamically to command right after its dispatch.

### IDashboardCommand.type

Command type. Always starts with "GDC.DASH/CMD"

**Signature:**

```typescript
readonly type: DashboardCommandType;
```