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

# IWorkspaceCatalogFactoryOptions

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

Configuration options for querying catalog items

**Signature:**

```typescript
export interface IWorkspaceCatalogFactoryOptions 
```

## Properties

| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [dataset?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspacecatalogfactoryoptions/index.md#iworkspacecatalogfactoryoptionsdataset) |  | [ObjRef](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.objref/index.md) | _(Optional)_ Get catalog items from a specific dataset |
| [excludeTags](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspacecatalogfactoryoptions/index.md#iworkspacecatalogfactoryoptionsexcludetags) |  | [ObjRef](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.objref/index.md)[] | Get catalog items that don't have reference to specific tags Use this to obtain catalog items that are not included in specific group(s). |
| [includeDateGranularities?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspacecatalogfactoryoptions/index.md#iworkspacecatalogfactoryoptionsincludedategranularities) |  | string[] | _(Optional)_ Optional list of additional date dataset granularities that must be added by backend to the ones returned by default. Default: undefined |
| [includeTags](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspacecatalogfactoryoptions/index.md#iworkspacecatalogfactoryoptionsincludetags) |  | [ObjRef](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.objref/index.md)[] | Get catalog items that have reference to specific tags. This is commonly used to obtain catalog items from specific group(s). |
| [loadGroups?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspacecatalogfactoryoptions/index.md#iworkspacecatalogfactoryoptionsloadgroups) |  | boolean | _(Optional)_ Should catalog fetch groups? Default: true |
| [loadPermissions?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspacecatalogfactoryoptions/index.md#iworkspacecatalogfactoryoptionsloadpermissions) |  | boolean | _(Optional)_ Should catalog ask the backend for object-level permissions of the loaded items? Only measures carry them at the moment. Default: false |
| [pageSize?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspacecatalogfactoryoptions/index.md#iworkspacecatalogfactoryoptionspagesize) |  | number | _(Optional)_ Page size of items to load. Default: 250 |
| [production?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspacecatalogfactoryoptions/index.md#iworkspacecatalogfactoryoptionsproduction) |  | boolean | _(Optional)_ When true, get only production ready catalog items. When false, get only non-production ready catalog items. Otherwise, return both. Default: undefined |
| [search?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspacecatalogfactoryoptions/index.md#iworkspacecatalogfactoryoptionssearch) |  | string | _(Optional)_ Search for catalog items by title or identifier. |
| [types](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspacecatalogfactoryoptions/index.md#iworkspacecatalogfactoryoptionstypes) |  | [CatalogItemType](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.catalogitemtype/index.md)[] | Get catalog items of specific types (attribute, measure, fact, dateDataset, attributeHierarchy or computedAttribute) Default: [DefaultWorkspaceCatalogTypes](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.defaultworkspacecatalogtypes/index.md) |

## Property details

### IWorkspaceCatalogFactoryOptions.dataset

Get catalog items from a specific dataset

**Signature:**

```typescript
dataset?: ObjRef;
```

### IWorkspaceCatalogFactoryOptions.excludeTags

Get catalog items that don't have reference to specific tags Use this to obtain catalog items that are not included in specific group(s).

**Signature:**

```typescript
excludeTags: ObjRef[];
```

### IWorkspaceCatalogFactoryOptions.includeDateGranularities

Optional list of additional date dataset granularities that must be added by backend to the ones returned by default. Default: undefined

**Signature:**

```typescript
includeDateGranularities?: string[];
```

### IWorkspaceCatalogFactoryOptions.includeTags

Get catalog items that have reference to specific tags. This is commonly used to obtain catalog items from specific group(s).

**Signature:**

```typescript
includeTags: ObjRef[];
```

### IWorkspaceCatalogFactoryOptions.loadGroups

Should catalog fetch groups? Default: true

**Signature:**

```typescript
loadGroups?: boolean;
```

### IWorkspaceCatalogFactoryOptions.loadPermissions

Should catalog ask the backend for object-level permissions of the loaded items? Only measures carry them at the moment. Default: false

**Signature:**

```typescript
loadPermissions?: boolean;
```

### IWorkspaceCatalogFactoryOptions.pageSize

Page size of items to load. Default: 250

**Signature:**

```typescript
pageSize?: number;
```

### IWorkspaceCatalogFactoryOptions.production

When true, get only production ready catalog items. When false, get only non-production ready catalog items. Otherwise, return both. Default: undefined

**Signature:**

```typescript
production?: boolean;
```

### IWorkspaceCatalogFactoryOptions.search

Search for catalog items by title or identifier.

**Signature:**

```typescript
search?: string;
```

### IWorkspaceCatalogFactoryOptions.types

Get catalog items of specific types (attribute, measure, fact, dateDataset, attributeHierarchy or computedAttribute) Default: [DefaultWorkspaceCatalogTypes](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.defaultworkspacecatalogtypes/index.md)

**Signature:**

```typescript
types: CatalogItemType[];
```