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

# IWorkspaceParametersService

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

Service for querying additional parameter data.

**Signature:**

```typescript
export interface IWorkspaceParametersService 
```

## Methods

| Method | Description |
| --- | --- |
| [createParameter(parameter)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspaceparametersservice/index.md#iworkspaceparametersservicecreateparameter) | Create and save parameter for the provided parameter definition. |
| [deleteParameter(ref)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspaceparametersservice/index.md#iworkspaceparametersservicedeleteparameter) | Delete parameter by reference. |
| [getParameter(ref)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspaceparametersservice/index.md#iworkspaceparametersservicegetparameter) | Get parameter by reference. |
| [getParametersQuery()](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspaceparametersservice/index.md#iworkspaceparametersservicegetparametersquery) | Parameters query factory. |
| [updateParameter(updatedParameter)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.iworkspaceparametersservice/index.md#iworkspaceparametersserviceupdateparameter) | Applies a partial update to a parameter, including definition fields when provided. |

## Method details

### IWorkspaceParametersService.createParameter()

Create and save parameter for the provided parameter definition.

**Signature:**

```typescript
createParameter(parameter: IParameterMetadataObjectDefinition): Promise<IParameterMetadataObject>;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| parameter | [IParameterMetadataObjectDefinition](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iparametermetadataobjectdefinition/index.md) | parameter definition |

**Returns:**

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

promise of created parameter

### IWorkspaceParametersService.deleteParameter()

Delete parameter by reference.

**Signature:**

```typescript
deleteParameter(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 parameter to delete |

**Returns:**

Promise&lt;void&gt;

### IWorkspaceParametersService.getParameter()

Get parameter by reference.

**Signature:**

```typescript
getParameter(ref: ObjRef): Promise<IParameterMetadataObject>;
```

#### 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 parameter to get |

**Returns:**

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

promise of parameter

### IWorkspaceParametersService.getParametersQuery()

Parameters query factory.

**Signature:**

```typescript
getParametersQuery(): IParametersQuery;
```
**Returns:**

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

parameters query

### IWorkspaceParametersService.updateParameter()

Applies a partial update to a parameter, including definition fields when provided.

**Signature:**

```typescript
updateParameter(updatedParameter: Partial<IParameterMetadataObjectDefinition> & IMetadataObjectIdentity): Promise<IParameterMetadataObject>;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| updatedParameter | Partial&lt;[IParameterMetadataObjectDefinition](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iparametermetadataobjectdefinition/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;[IParameterMetadataObject](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.iparametermetadataobject/index.md)&gt;