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

# IReferencesService

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

**Signature:**

```typescript
export interface IReferencesService 
```

## Methods

| Method | Description |
| --- | --- |
| [getAllReferences()](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.ireferencesservice/index.md#ireferencesservicegetallreferences) | **_(ALPHA)_** Returns the references between all objects of the workspace. |
| [getReferences(root, opts)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.ireferencesservice/index.md#ireferencesservicegetreferences) | **_(ALPHA)_** |

## Method details

### IReferencesService.getAllReferences()

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

Returns the references between all objects of the workspace.

**Signature:**

```typescript
getAllReferences(): Promise<IReferencesResult>;
```
**Returns:**

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

#### Remarks

Each edge goes from the object that uses another object to the object that it uses. The result has no root nodes.

### IReferencesService.getReferences()

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

**Signature:**

```typescript
getReferences(root: IdentifierRef | IdentifierRef[], opts?: IReferencesOption): Promise<IReferencesResult>;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| root | [IdentifierRef](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.identifierref/index.md) \| [IdentifierRef](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.identifierref/index.md)[] |  |
| opts | [IReferencesOption](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.ireferencesoption/index.md) | _(Optional)_ |

**Returns:**

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