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

# IOrganizationAutomationService

- 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/organization/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 organization-wide automations for centralized automation management. It allows managing automations across all workspaces within the organization.

**Signature:**

```typescript
export interface IOrganizationAutomationService 
```

## Methods

| Method | Description |
| --- | --- |
| [deleteAutomation(id, workspaceId)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iorganizationautomationservice/index.md#iorganizationautomationservicedeleteautomation) | **_(ALPHA)_** Delete automation from any workspace within the organization |
| [deleteAutomations(automations)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iorganizationautomationservice/index.md#iorganizationautomationservicedeleteautomations) | **_(ALPHA)_** Delete multiple automations across workspaces for centralized management Deletes multiple automations identified by their IDs from any workspace within the organization. |
| [getAutomationsQuery(options)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iorganizationautomationservice/index.md#iorganizationautomationservicegetautomationsquery) | **_(ALPHA)_** List automations across the organization for centralized management |
| [pauseAutomation(id, workspaceId)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iorganizationautomationservice/index.md#iorganizationautomationservicepauseautomation) | **_(ALPHA)_** Pause automation from any workspace within the organization |
| [pauseAutomations(automations)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iorganizationautomationservice/index.md#iorganizationautomationservicepauseautomations) | **_(ALPHA)_** Pause multiple automations across workspaces for centralized management Pauses multiple automations identified by their IDs from any workspace within the organization. |
| [resumeAutomation(id, workspaceId)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iorganizationautomationservice/index.md#iorganizationautomationserviceresumeautomation) | **_(ALPHA)_** Resume automation from any workspace within the organization |
| [resumeAutomations(automations)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iorganizationautomationservice/index.md#iorganizationautomationserviceresumeautomations) | **_(ALPHA)_** Resume multiple automations across workspaces for centralized management Resumes multiple automations identified by their IDs from any workspace within the organization. |
| [unsubscribeAutomation(id, workspaceId)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iorganizationautomationservice/index.md#iorganizationautomationserviceunsubscribeautomation) | **_(ALPHA)_** Unsubscribe from automation from any workspace within the organization |
| [unsubscribeAutomations(automations)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iorganizationautomationservice/index.md#iorganizationautomationserviceunsubscribeautomations) | **_(ALPHA)_** Unsubscribe from multiple automations across workspaces for centralized management Unsubscribes from multiple automations identified by their IDs from any workspace within the organization. |

## Method details

### IOrganizationAutomationService.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 from any workspace within the organization

**Signature:**

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

#### Parameters

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

**Returns:**

Promise&lt;void&gt;

Promise resolved when the automation is deleted.

### IOrganizationAutomationService.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 multiple automations across workspaces for centralized management

Deletes multiple automations identified by their IDs from any workspace within the organization.

**Signature:**

```typescript
deleteAutomations(automations: Array<{
        id: string;
        workspaceId: string;
    }>): Promise<void>;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| automations | Array&lt;{ id: string; workspaceId: string; }&gt; |  |

**Returns:**

Promise&lt;void&gt;

Promise resolved when the automations are deleted.

### IOrganizationAutomationService.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 across the organization for centralized management

**Signature:**

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

#### 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:**

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

methods for querying organization automations

### IOrganizationAutomationService.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 from any workspace within the organization

**Signature:**

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

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| id | string | id of the automation |
| workspaceId | string | id of the workspace containing the automation |

**Returns:**

Promise&lt;void&gt;

Promise resolved when the automation is paused.

### IOrganizationAutomationService.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 multiple automations across workspaces for centralized management

Pauses multiple automations identified by their IDs from any workspace within the organization.

**Signature:**

```typescript
pauseAutomations(automations: Array<{
        id: string;
        workspaceId: string;
    }>): Promise<void>;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| automations | Array&lt;{ id: string; workspaceId: string; }&gt; |  |

**Returns:**

Promise&lt;void&gt;

Promise resolved when the automations are paused.

### IOrganizationAutomationService.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 from any workspace within the organization

**Signature:**

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

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| id | string | id of the automation |
| workspaceId | string | id of the workspace containing the automation |

**Returns:**

Promise&lt;void&gt;

Promise resolved when the automation is resumed.

### IOrganizationAutomationService.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 multiple automations across workspaces for centralized management

Resumes multiple automations identified by their IDs from any workspace within the organization.

**Signature:**

```typescript
resumeAutomations(automations: Array<{
        id: string;
        workspaceId: string;
    }>): Promise<void>;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| automations | Array&lt;{ id: string; workspaceId: string; }&gt; |  |

**Returns:**

Promise&lt;void&gt;

Promise resolved when the automations are resumed.

### IOrganizationAutomationService.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 from automation from any workspace within the organization

**Signature:**

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

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| id | string | id of the automation |
| workspaceId | string | id of the workspace containing the automation |

**Returns:**

Promise&lt;void&gt;

Promise resolved when unsubscribed from the automation.

### IOrganizationAutomationService.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 multiple automations across workspaces for centralized management

Unsubscribes from multiple automations identified by their IDs from any workspace within the organization.

**Signature:**

```typescript
unsubscribeAutomations(automations: Array<{
        id: string;
        workspaceId: string;
    }>): Promise<void>;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| automations | Array&lt;{ id: string; workspaceId: string; }&gt; | Array of automation objects with id and workspaceId |

**Returns:**

Promise&lt;void&gt;

Promise resolved when unsubscribed from the automations.