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

# IExportDefinitionsQuery

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

Service to query exportDefinitions.

**Signature:**

```typescript
export interface IExportDefinitionsQuery 
```

## Methods

| Method | Description |
| --- | --- |
| [query()](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iexportdefinitionsquery/index.md#iexportdefinitionsqueryquery) | **_(ALPHA)_** Starts the query. |
| [withFilter(filter)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iexportdefinitionsquery/index.md#iexportdefinitionsquerywithfilter) | **_(ALPHA)_** Sets filter for the query. |
| [withPage(page)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iexportdefinitionsquery/index.md#iexportdefinitionsquerywithpage) | **_(ALPHA)_** Sets starting page for the query. Backend WILL return no data if the page is greater than total number of pages. Default page: 0 |
| [withSize(size)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iexportdefinitionsquery/index.md#iexportdefinitionsquerywithsize) | **_(ALPHA)_** Sets number of exportDefinitions to return per page. Default size: 50 |
| [withSorting(sort)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iexportdefinitionsquery/index.md#iexportdefinitionsquerywithsorting) | **_(ALPHA)_** Sets sorting for the query. |

## Method details

### IExportDefinitionsQuery.query()

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

Starts the query.

**Signature:**

```typescript
query(): Promise<IExportDefinitionsQueryResult>;
```
**Returns:**

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

promise of the first page of the results

### IExportDefinitionsQuery.withFilter()

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

Sets filter for the query.

**Signature:**

```typescript
withFilter(filter: {
        title?: string;
    }): IExportDefinitionsQuery;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| filter | { title?: string; } | filter to apply |

**Returns:**

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

exportDefinitions query

### IExportDefinitionsQuery.withPage()

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

Sets starting page for the query. Backend WILL return no data if the page is greater than total number of pages. Default page: 0

**Signature:**

```typescript
withPage(page: number): IExportDefinitionsQuery;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| page | number | zero indexed, must be non-negative |

**Returns:**

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

exportDefinitions query

### IExportDefinitionsQuery.withSize()

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

Sets number of exportDefinitions to return per page. Default size: 50

**Signature:**

```typescript
withSize(size: number): IExportDefinitionsQuery;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| size | number | desired max number of exportDefinitions per page must be a positive number |

**Returns:**

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

exportDefinitions query

### IExportDefinitionsQuery.withSorting()

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

Sets sorting for the query.

**Signature:**

```typescript
withSorting(sort: ExportDefinitionQuerySort[]): IExportDefinitionsQuery;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| sort | [ExportDefinitionQuerySort](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.exportdefinitionquerysort/index.md)[] | Sorting criteria in the format: property,(asc\|desc). Default sort order is ascending. Multiple sort criteria are supported. |

**Returns:**

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

exportDefinitions query