# Class ProcessInstanceTenantGlobalParameterExtensions

OptimaJet.Workflow.Core.Model.ProcessInstanceTenantGlobalParameterExtensions

Provides an extension method for creating a [TenantGlobalParameterApi](https://api.workflowengine.io/core/OptimaJet.Workflow.Core.Persistence/TenantGlobalParameterApi/) whose operations are scoped by [ProcessInstance.TenantId](https://api.workflowengine.io/core/OptimaJet.Workflow.Core.Model/ProcessInstance/).

Namespace: [OptimaJet.Workflow.Core.Model](https://api.workflowengine.io/core/OptimaJet.Workflow.Core.Model/)

```csharp
public static class ProcessInstanceTenantGlobalParameterExtensions
```

## Methods

`public static TenantGlobalParameterApi GetTenantGlobalParameterApi(this ProcessInstance processInstance)` 

Creates a [TenantGlobalParameterApi](https://api.workflowengine.io/core/OptimaJet.Workflow.Core.Persistence/TenantGlobalParameterApi/) scoped to the tenant identified by [ProcessInstance.TenantId](https://api.workflowengine.io/core/OptimaJet.Workflow.Core.Model/ProcessInstance/) on `processInstance`.

### Parameters

| Name | Type | Description |
| --- | --- | --- |
| `processInstance` | `ProcessInstance` | The [ProcessInstance](https://api.workflowengine.io/core/OptimaJet.Workflow.Core.Model/ProcessInstance/) whose [ProcessInstance.TenantId](https://api.workflowengine.io/core/OptimaJet.Workflow.Core.Model/ProcessInstance/) defines the global parameter scope. |

### Returns

| Type | Description |
| --- | --- |
| `TenantGlobalParameterApi` | A new [TenantGlobalParameterApi](https://api.workflowengine.io/core/OptimaJet.Workflow.Core.Persistence/TenantGlobalParameterApi/) for the tenant scope identified by [ProcessInstance.TenantId](https://api.workflowengine.io/core/OptimaJet.Workflow.Core.Model/ProcessInstance/) on `processInstance`. |

### Exceptions

| Type | Description |
| --- | --- |
| `ArgumentNullException` | `processInstance` is [null](https://learn.microsoft.com/dotnet/csharp/language-reference/keywords/null). |

### Remarks

If the [ProcessInstance.TenantId](https://api.workflowengine.io/core/OptimaJet.Workflow.Core.Model/ProcessInstance/) of `processInstance` is [null](https://learn.microsoft.com/dotnet/csharp/language-reference/keywords/null), empty, or contains only white-space characters, the returned [TenantGlobalParameterApi](https://api.workflowengine.io/core/OptimaJet.Workflow.Core.Persistence/TenantGlobalParameterApi/) uses the shared global parameter scope.

[Previous ProcessInstance](https://api.workflowengine.io/core/OptimaJet.Workflow.Core.Model/ProcessInstance/) [Next RestrictionDefinition](https://api.workflowengine.io/core/OptimaJet.Workflow.Core.Model/RestrictionDefinition/)