IWorkspaceParametersService
Service for querying additional parameter data.
export interface IWorkspaceParametersService
Methods
Method | Description |
|---|---|
Create and save parameter for the provided parameter definition. | |
Delete parameter by reference. | |
Get parameter by reference. | |
Parameters query factory. | |
Applies a partial update to a parameter, including definition fields when provided. |
Method details
IWorkspaceParametersService.createParameter()method
Create and save parameter for the provided parameter definition.
createParameter(parameter: IParameterMetadataObjectDefinition): Promise<IParameterMetadataObject>;
Parameters
Parameter | Type | Description |
|---|---|---|
parameter | parameter definition |
Returns
Promise<IParameterMetadataObject>
promise of created parameter
IWorkspaceParametersService.deleteParameter()method
Delete parameter by reference.
deleteParameter(ref: ObjRef): Promise<void>;
Parameters
Parameter | Type | Description |
|---|---|---|
ref | ref of the parameter to delete |
Returns
Promise<void>
IWorkspaceParametersService.getParameter()method
Get parameter by reference.
getParameter(ref: ObjRef): Promise<IParameterMetadataObject>;
Parameters
Parameter | Type | Description |
|---|---|---|
ref | ref of the parameter to get |
Returns
Promise<IParameterMetadataObject>
promise of parameter
IWorkspaceParametersService.getParametersQuery()method
Parameters query factory.
getParametersQuery(): IParametersQuery;
Returns
parameters query
IWorkspaceParametersService.updateParameter()method
Applies a partial update to a parameter, including definition fields when provided.
updateParameter(updatedParameter: Partial<IParameterMetadataObjectDefinition> & IMetadataObjectIdentity): Promise<IParameterMetadataObject>;
Parameters
Parameter | Type | Description |
|---|---|---|
updatedParameter | Partial<IParameterMetadataObjectDefinition> & IMetadataObjectIdentity | update to apply |
Returns
Promise<IParameterMetadataObject>