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

# IWorkspaceAutomationService

- Package: [@gooddata/sdk-backend-spi](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/index.md)
- Kind: interface
- Stability: alpha
- Source: https://github.com/gooddata/gooddata-ui-sdk/blob/rel/11.64/libs/sdk-backend-spi/src/workspace/automations/index.ts

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

This service provides access to workspace automations.

**Signature:**

```typescript
export interface IWorkspaceAutomationService 
```

## Methods

| Method | Description |
| --- | --- |
| [createAutomation(automation, options, widgetExecution, overrides)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspaceautomationservice/index.md#iworkspaceautomationservicecreateautomation) | **_(ALPHA)_** Create new automation |
| [deleteAutomation(id)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspaceautomationservice/index.md#iworkspaceautomationservicedeleteautomation) | **_(ALPHA)_** Delete automation |
| [deleteAutomations(ids)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspaceautomationservice/index.md#iworkspaceautomationservicedeleteautomations) | **_(ALPHA)_** Delete automations Deletes multiple automations identified by their IDs. |
| [getAutomation(id, options)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspaceautomationservice/index.md#iworkspaceautomationservicegetautomation) | **_(ALPHA)_** Get atuomation by id |
| [getAutomations(options)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspaceautomationservice/index.md#iworkspaceautomationservicegetautomations) | **_(ALPHA)_** Get all automations |
| [getAutomationsQuery(options)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspaceautomationservice/index.md#iworkspaceautomationservicegetautomationsquery) | **_(ALPHA)_** List automations |
| [pauseAutomation(id)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspaceautomationservice/index.md#iworkspaceautomationservicepauseautomation) | **_(ALPHA)_** Pause automation |
| [pauseAutomations(ids)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspaceautomationservice/index.md#iworkspaceautomationservicepauseautomations) | **_(ALPHA)_** Pause automations Pauses multiple automations identified by their IDs. |
| [resumeAutomation(id)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspaceautomationservice/index.md#iworkspaceautomationserviceresumeautomation) | **_(ALPHA)_** Resume automation |
| [resumeAutomations(ids)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspaceautomationservice/index.md#iworkspaceautomationserviceresumeautomations) | **_(ALPHA)_** Resume automations Resumes multiple automations identified by their IDs. |
| [triggerAutomation(id)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspaceautomationservice/index.md#iworkspaceautomationservicetriggerautomation) | **_(ALPHA)_** Trigger existing automation Triggers the existing automation to execute immediately. |
| [unsubscribeAutomation(id)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspaceautomationservice/index.md#iworkspaceautomationserviceunsubscribeautomation) | **_(ALPHA)_** Unsubscribe automation |
| [unsubscribeAutomations(ids)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspaceautomationservice/index.md#iworkspaceautomationserviceunsubscribeautomations) | **_(ALPHA)_** Unsubscribe from automations Unsubscribes current user from multiple automations identified by their IDs. If no IDs are provided, the backend may unsubscribe from all automations in the workspace. |
| [updateAutomation(automation, options, widgetExecution, overrides)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspaceautomationservice/index.md#iworkspaceautomationserviceupdateautomation) | **_(ALPHA)_** Update existing automation |

## Method details

### IWorkspaceAutomationService.createAutomation()

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Create new automation

**Signature:**

```typescript
createAutomation(automation: IAutomationMetadataObjectDefinition, options?: IGetAutomationOptions, widgetExecution?: IExecutionDefinition, overrides?: IRawExportCustomOverrides): Promise<IAutomationMetadataObject>;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| automation | [IAutomationMetadataObjectDefinition](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iautomationmetadataobjectdefinition/index.md) | definition of the automation |
| options | [IGetAutomationOptions](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.igetautomationoptions/index.md) | _(Optional)_ specify additional options |
| widgetExecution | [IExecutionDefinition](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iexecutiondefinition/index.md) | _(Optional)_ execution definition for widget exports |
| overrides | [IRawExportCustomOverrides](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.irawexportcustomoverrides/index.md) | _(Optional)_ custom overrides for widget exports |

**Returns:**

Promise&lt;[IAutomationMetadataObject](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iautomationmetadataobject/index.md)&gt;

Promise resolved with created automation.

### IWorkspaceAutomationService.deleteAutomation()

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Delete automation

**Signature:**

```typescript
deleteAutomation(id: string): Promise<void>;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| id | string | id of the automation |

**Returns:**

Promise&lt;void&gt;

Promise resolved when the automation is deleted.

### IWorkspaceAutomationService.deleteAutomations()

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Delete automations

Deletes multiple automations identified by their IDs.

**Signature:**

```typescript
deleteAutomations(ids: string[]): Promise<void>;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| ids | string[] | IDs of the automations to delete |

**Returns:**

Promise&lt;void&gt;

Promise resolved when the automations are deleted.

### IWorkspaceAutomationService.getAutomation()

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Get atuomation by id

**Signature:**

```typescript
getAutomation(id: string, options?: IGetAutomationOptions): Promise<IAutomationMetadataObject>;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| id | string | id of the automation |
| options | [IGetAutomationOptions](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.igetautomationoptions/index.md) | _(Optional)_ specify additional options |

**Returns:**

Promise&lt;[IAutomationMetadataObject](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iautomationmetadataobject/index.md)&gt;

Promise resolved with automation definition

### IWorkspaceAutomationService.getAutomations()

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Get all automations

**Signature:**

```typescript
getAutomations(options?: IGetAutomationsOptions): Promise<IAutomationMetadataObject[]>;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| options | [IGetAutomationsOptions](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.igetautomationsoptions/index.md) | _(Optional)_ specify additional options |

**Returns:**

Promise&lt;[IAutomationMetadataObject](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iautomationmetadataobject/index.md)[]&gt;

Promise resolved with array of automations.

#### Exceptions

In case of error.

### IWorkspaceAutomationService.getAutomationsQuery()

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

List automations

**Signature:**

```typescript
getAutomationsQuery(options?: IGetAutomationsQueryOptions): IAutomationsQuery;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| options | [IGetAutomationsQueryOptions](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.igetautomationsqueryoptions/index.md) | _(Optional)_ specify additional options |

**Returns:**

[IAutomationsQuery](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iautomationsquery/index.md)

methods for querying automations

### IWorkspaceAutomationService.pauseAutomation()

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Pause automation

**Signature:**

```typescript
pauseAutomation(id: string): Promise<void>;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| id | string | id of the automation |

**Returns:**

Promise&lt;void&gt;

Promise resolved when the automation is paused.

### IWorkspaceAutomationService.pauseAutomations()

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Pause automations

Pauses multiple automations identified by their IDs.

**Signature:**

```typescript
pauseAutomations(ids: string[]): Promise<void>;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| ids | string[] | IDs of the automations to pause |

**Returns:**

Promise&lt;void&gt;

Promise resolved when the automations are paused.

### IWorkspaceAutomationService.resumeAutomation()

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Resume automation

**Signature:**

```typescript
resumeAutomation(id: string): Promise<void>;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| id | string | id of the automation |

**Returns:**

Promise&lt;void&gt;

Promise resolved when the automation is resumed.

### IWorkspaceAutomationService.resumeAutomations()

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Resume automations

Resumes multiple automations identified by their IDs.

**Signature:**

```typescript
resumeAutomations(ids: string[]): Promise<void>;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| ids | string[] | IDs of the automations to resume |

**Returns:**

Promise&lt;void&gt;

Promise resolved when the automations are resumed.

### IWorkspaceAutomationService.triggerAutomation()

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Trigger existing automation

Triggers the existing automation to execute immediately.

**Signature:**

```typescript
triggerAutomation(id: string): Promise<void>;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| id | string | id of the automation |

**Returns:**

Promise&lt;void&gt;

Promise resolved when the automation is triggered.

### IWorkspaceAutomationService.unsubscribeAutomation()

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Unsubscribe automation

**Signature:**

```typescript
unsubscribeAutomation(id: string): Promise<void>;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| id | string | id of the automation |

**Returns:**

Promise&lt;void&gt;

Promise resolved when the automation is unsubscribed.

### IWorkspaceAutomationService.unsubscribeAutomations()

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Unsubscribe from automations

Unsubscribes current user from multiple automations identified by their IDs. If no IDs are provided, the backend may unsubscribe from all automations in the workspace.

**Signature:**

```typescript
unsubscribeAutomations(ids: string[]): Promise<void>;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| ids | string[] | IDs of the automations to unsubscribe from |

**Returns:**

Promise&lt;void&gt;

Promise resolved when the user is unsubscribed.

### IWorkspaceAutomationService.updateAutomation()

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Update existing automation

**Signature:**

```typescript
updateAutomation(automation: IAutomationMetadataObject, options?: IGetAutomationOptions, widgetExecution?: IExecutionDefinition, overrides?: IRawExportCustomOverrides): Promise<IAutomationMetadataObject>;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| automation | [IAutomationMetadataObject](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iautomationmetadataobject/index.md) | definition of the automation |
| options | [IGetAutomationOptions](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.igetautomationoptions/index.md) | _(Optional)_ specify additional options |
| widgetExecution | [IExecutionDefinition](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iexecutiondefinition/index.md) | _(Optional)_ execution definition for widget exports |
| overrides | [IRawExportCustomOverrides](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.irawexportcustomoverrides/index.md) | _(Optional)_ custom overrides for widget exports |

**Returns:**

Promise&lt;[IAutomationMetadataObject](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iautomationmetadataobject/index.md)&gt;

Promise resolved when the automation is updated.