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

# IWorkspaceAttributesService

- 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/attributes/index.ts

Service for querying additional attributes and attribute display forms data, and their elements.

**Signature:**

```typescript
export interface IWorkspaceAttributesService 
```

## Remarks

If you want to query attributes themselves, use catalog [IWorkspaceCatalogFactory](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspacecatalogfactory/index.md)

## Methods

| Method | Description |
| --- | --- |
| [elements()](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspaceattributesservice/index.md#iworkspaceattributesserviceelements) | Returns service that can be used to query attribute elements for attributes defined in this workspace. |
| [getAttribute(ref, opts)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspaceattributesservice/index.md#iworkspaceattributesservicegetattribute) | Gets metadata of the attribute. |
| [getAttributeByDisplayForm(ref)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspaceattributesservice/index.md#iworkspaceattributesservicegetattributebydisplayform) | Gets metadata of the attribute for particular display form reference. |
| [getAttributeDatasetMeta(ref)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspaceattributesservice/index.md#iworkspaceattributesservicegetattributedatasetmeta) | Get information about the given attribute's dataset |
| [getAttributeDisplayForm(ref)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspaceattributesservice/index.md#iworkspaceattributesservicegetattributedisplayform) | Gets the attribute display form with the provided identifier. |
| [getAttributeDisplayForms(refs)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspaceattributesservice/index.md#iworkspaceattributesservicegetattributedisplayforms) | Gets the list of metadata of attribute display form with the provided list of uris or identifiers. (list of object refs). |
| [getAttributes(refs)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspaceattributesservice/index.md#iworkspaceattributesservicegetattributes) | Gets the list of metadata of attribute with the provided list of uris. (list of object refs) |
| [getAttributesQuery()](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspaceattributesservice/index.md#iworkspaceattributesservicegetattributesquery) | Attributes query factory. |
| [getAttributesWithReferences(displayFormRefs)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspaceattributesservice/index.md#iworkspaceattributesservicegetattributeswithreferences) | Get attributes with their related objects, by their respective display forms. |
| [getCommonAttributes(attributeRefs)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspaceattributesservice/index.md#iworkspaceattributesservicegetcommonattributes) | Request list of attributes that are "center of star" for the input attributes in the data model. |
| [getCommonAttributesBatch(attributesRefsBatch)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspaceattributesservice/index.md#iworkspaceattributesservicegetcommonattributesbatch) | Request the "center of star" for multiple series of attributes. |
| [getConnectedAttributesByDisplayForm(ref, options)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspaceattributesservice/index.md#iworkspaceattributesservicegetconnectedattributesbydisplayform) | Request list of attributes that have a connection with specified display form in the data model. |
| [updateAttributeDisplayFormMeta(updatedDisplayForm)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspaceattributesservice/index.md#iworkspaceattributesserviceupdateattributedisplayformmeta) | Updates metadata of an attribute display form (label). |
| [updateAttributeMeta(updatedAttribute)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspaceattributesservice/index.md#iworkspaceattributesserviceupdateattributemeta) | Updates metadata of the attribute. |

## Method details

### IWorkspaceAttributesService.elements()

Returns service that can be used to query attribute elements for attributes defined in this workspace.

**Signature:**

```typescript
elements(): IElementsQueryFactory;
```
**Returns:**

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

#### Remarks

For instance if workspace has data set Employee with attribute Name, then this service can be used to retrieve names of all employees.

### IWorkspaceAttributesService.getAttribute()

Gets metadata of the attribute.

**Signature:**

```typescript
getAttribute(ref: ObjRef, opts?: {
        include?: ["dataset"];
    }): Promise<IAttributeMetadataObject>;
```

#### 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 attribute to retrieve |
| opts | { include?: ["dataset"]; } | _(Optional)_ options to include additional data |

**Returns:**

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

promise of attribute metadata object

### IWorkspaceAttributesService.getAttributeByDisplayForm()

Gets metadata of the attribute for particular display form reference.

**Signature:**

```typescript
getAttributeByDisplayForm(ref: ObjRef): Promise<IAttributeMetadataObject>;
```

#### 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 display form to retrieve attribute for |

**Returns:**

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

promise of attribute metadata object

### IWorkspaceAttributesService.getAttributeDatasetMeta()

Get information about the given attribute's dataset

**Signature:**

```typescript
getAttributeDatasetMeta(ref: ObjRef): Promise<IMetadataObject>;
```

#### 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 attribute |

**Returns:**

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

promise of metadata object

### IWorkspaceAttributesService.getAttributeDisplayForm()

Gets the attribute display form with the provided identifier.

**Signature:**

```typescript
getAttributeDisplayForm(ref: ObjRef): Promise<IAttributeDisplayFormMetadataObject>;
```

#### 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 attribute display form to retrieve |

**Returns:**

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

promise of attribute display form metadata object

### IWorkspaceAttributesService.getAttributeDisplayForms()

Gets the list of metadata of attribute display form with the provided list of uris or identifiers. (list of object refs).

**Signature:**

```typescript
getAttributeDisplayForms(refs: ObjRef[]): Promise<IAttributeDisplayFormMetadataObject[]>;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| refs | [ObjRef](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.objref/index.md)[] | list of refs of the attribute display form to retrieve. |

**Returns:**

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

promise of list of attribute display form metadata object.

#### Remarks

If a display form referenced by any of the refs does not exist, then the call must not fail and instead return only those display forms that exist.

### IWorkspaceAttributesService.getAttributes()

Gets the list of metadata of attribute with the provided list of uris. (list of object refs)

**Signature:**

```typescript
getAttributes(refs: ObjRef[]): Promise<IAttributeMetadataObject[]>;
```

#### Parameters

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

**Returns:**

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

promise of list of attribute metadata object.

#### Remarks

If a display form referenced by any of the refs does not exist, then the call must not fail and instead return only those display forms that exist.

### IWorkspaceAttributesService.getAttributesQuery()

Attributes query factory.

**Signature:**

```typescript
getAttributesQuery(): IAttributesQuery;
```
**Returns:**

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

attributes query

### IWorkspaceAttributesService.getAttributesWithReferences()

Get attributes with their related objects, by their respective display forms.

**Signature:**

```typescript
getAttributesWithReferences(displayFormRefs: ObjRef[]): Promise<IAttributeWithReferences[]>;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| displayFormRefs | [ObjRef](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.objref/index.md)[] |  |

**Returns:**

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

promise of attributes with their related objects

### IWorkspaceAttributesService.getCommonAttributes()

Request list of attributes that are "center of star" for the input attributes in the data model.

**Signature:**

```typescript
getCommonAttributes(attributeRefs: ObjRef[]): Promise<ObjRef[]>;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| attributeRefs | [ObjRef](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.objref/index.md)[] | input list of attribute references |

**Returns:**

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

promise returning list of attribute references. It can be one of the input attributes or another attribute(s) that connects the input attributes in the data model.

### IWorkspaceAttributesService.getCommonAttributesBatch()

Request the "center of star" for multiple series of attributes.

**Signature:**

```typescript
getCommonAttributesBatch(attributesRefsBatch: ObjRef[][]): Promise<ObjRef[][]>;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| attributesRefsBatch | [ObjRef](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.objref/index.md)[][] | input batch of list of attribute references |

**Returns:**

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

promise returning batch of attribute references.

### IWorkspaceAttributesService.getConnectedAttributesByDisplayForm()

Request list of attributes that have a connection with specified display form in the data model.

**Signature:**

```typescript
getConnectedAttributesByDisplayForm(ref: ObjRef, options?: IConnectedAttributesOptions): Promise<ObjRef[]>;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| ref | [ObjRef](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.objref/index.md) | attribute display form reference whose connections we need to find |
| options | [IConnectedAttributesOptions](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iconnectedattributesoptions/index.md) | _(Optional)_ options influencing which objects count as connected |

**Returns:**

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

promise of array of connected attribute references

### IWorkspaceAttributesService.updateAttributeDisplayFormMeta()

Updates metadata of an attribute display form (label).

**Signature:**

```typescript
updateAttributeDisplayFormMeta(updatedDisplayForm: IUpdateMetadataObjectMetaPayload): Promise<IAttributeDisplayFormMetadataObject>;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| updatedDisplayForm | [IUpdateMetadataObjectMetaPayload](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iupdatemetadataobjectmetapayload/index.md) | update to apply |

**Returns:**

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

### IWorkspaceAttributesService.updateAttributeMeta()

Updates metadata of the attribute.

**Signature:**

```typescript
updateAttributeMeta(updatedAttribute: Partial<IMetadataObjectBase> & IMetadataObjectIdentity): Promise<IAttributeMetadataObject>;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| updatedAttribute | Partial&lt;[IMetadataObjectBase](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.imetadataobjectbase/index.md)&gt; &amp; [IMetadataObjectIdentity](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.imetadataobjectidentity/index.md) | update to apply |

**Returns:**

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