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

# IWorkspaceExportDefinitionsService

- Package: [@gooddata/sdk-backend-spi](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/index.md)
- Kind: interface
- Stability: alpha
- Deprecated
- Source: https://github.com/gooddata/gooddata-ui-sdk/blob/rel/11.64/libs/sdk-backend-spi/src/workspace/exportDefinitions/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).
> 

> Warning: This API is now obsolete.
> 
> Not supported for write anymore
> 

Service to query, update or delete exportDefinitions, and other methods related to exportDefinitions. Check IExportDefinitionMetadataObject for more details.

**Signature:**

```typescript
export interface IWorkspaceExportDefinitionsService 
```

## Methods

| Method | Description |
| --- | --- |
| [createExportDefinition(exportDefinition)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspaceexportdefinitionsservice/index.md#iworkspaceexportdefinitionsservicecreateexportdefinition) | **_(ALPHA)_** Create and save exportDefinition for the provided exportDefinition |
| [deleteExportDefinition(ref)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspaceexportdefinitionsservice/index.md#iworkspaceexportdefinitionsservicedeleteexportdefinition) | **_(ALPHA)_** Delete exportDefinition with the given reference |
| [getExportDefinition(ref, options)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspaceexportdefinitionsservice/index.md#iworkspaceexportdefinitionsservicegetexportdefinition) | **_(ALPHA)_** Request exportDefinition for the given reference |
| [getExportDefinitions(options)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspaceexportdefinitionsservice/index.md#iworkspaceexportdefinitionsservicegetexportdefinitions) | **_(ALPHA)_** Queries workspace exportDefinitions, using various criteria and paging settings. |
| [getExportDefinitionsQuery()](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspaceexportdefinitionsservice/index.md#iworkspaceexportdefinitionsservicegetexportdefinitionsquery) | **_(ALPHA)_** List exportDefinitions |
| [updateExportDefinition(ref, exportDefinition)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspaceexportdefinitionsservice/index.md#iworkspaceexportdefinitionsserviceupdateexportdefinition) | **_(ALPHA)_** Update provided exportDefinition |

## Method details

### IWorkspaceExportDefinitionsService.createExportDefinition()

> **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 and save exportDefinition for the provided exportDefinition

**Signature:**

```typescript
createExportDefinition(exportDefinition: IExportDefinitionMetadataObjectDefinition): Promise<IExportDefinitionMetadataObject>;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| exportDefinition | [IExportDefinitionMetadataObjectDefinition](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iexportdefinitionmetadataobjectdefinition/index.md) | exportDefinition to create |

**Returns:**

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

promise of created exportDefinition

### IWorkspaceExportDefinitionsService.deleteExportDefinition()

> **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 exportDefinition with the given reference

**Signature:**

```typescript
deleteExportDefinition(ref: ObjRef): Promise<void>;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| ref | [ObjRef](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.objref/index.md) | ref of the exportDefinition to delete |

**Returns:**

Promise&lt;void&gt;

promise of undefined

### IWorkspaceExportDefinitionsService.getExportDefinition()

> **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).
> 

Request exportDefinition for the given reference

**Signature:**

```typescript
getExportDefinition(ref: ObjRef, options?: IGetExportDefinitionOptions): Promise<IExportDefinitionMetadataObject>;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| ref | [ObjRef](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.objref/index.md) | exportDefinition reference |
| options | [IGetExportDefinitionOptions](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.igetexportdefinitionoptions/index.md) | _(Optional)_ specify additional options |

**Returns:**

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

promise of exportDefinition

### IWorkspaceExportDefinitionsService.getExportDefinitions()

> **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).
> 

Queries workspace exportDefinitions, using various criteria and paging settings.

**Signature:**

```typescript
getExportDefinitions(options?: IExportDefinitionsQueryOptions): Promise<IExportDefinitionsQueryResult>;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| options | [IExportDefinitionsQueryOptions](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iexportdefinitionsqueryoptions/index.md) | _(Optional)_ query options; if not specified defaults to no sorting, no filtering and 50 items per page |

**Returns:**

Promise&lt;[IExportDefinitionsQueryResult](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iexportdefinitionsqueryresult/index.md)&gt;

paged results, empty page with zero total count if there are no exportDefinitions stored in the workspace

### IWorkspaceExportDefinitionsService.getExportDefinitionsQuery()

> **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 exportDefinitions

**Signature:**

```typescript
getExportDefinitionsQuery(): IExportDefinitionsQuery;
```
**Returns:**

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

methods for querying exportDefinitions

### IWorkspaceExportDefinitionsService.updateExportDefinition()

> **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 provided exportDefinition

**Signature:**

```typescript
updateExportDefinition(ref: ObjRef, exportDefinition: IExportDefinitionMetadataObjectDefinition): Promise<IExportDefinitionMetadataObject>;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| ref | [ObjRef](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.objref/index.md) | ref of the exportDefinition to update |
| exportDefinition | [IExportDefinitionMetadataObjectDefinition](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iexportdefinitionmetadataobjectdefinition/index.md) | exportDefinition to update |

**Returns:**

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

promise of updated exportDefinition