Class WorkflowApiCoreOptions

OptimaJet.Workflow.Api.Options.WorkflowApiCoreOptions

Represents the basic settings of the Workflow Engine Web API.

Namespace: OptimaJet.Workflow.Api.Options

public record WorkflowApiCoreOptions : IEquatable<WorkflowApiCoreOptions>

Inheritance

Object

Implemented Interfaces

System.IEquatable{OptimaJet.Workflow.Api.Options.WorkflowApiCoreOptions}

Properties

Name

Type

BasePath #

String

The root path to the Workflow Engine Web API endpoints. If an empty string is specified, the endpoints will be accessible via the root path of your application.

LicenseKey #

String

The Workflow Engine license key with the Workflow Engine API option enabled. If the key is not provided, the API will not start. Request a key from our sales team at sales@optimajet.com

DefaultTenantId #

String

The default workflow tenant ID to use when no tenant is specified in the request. If default tenant is null, requests without a tenant specified will be rejected.

ProtectedGlobalParameterTypes #

HashSet<String>

Global Parameter types that cannot be accessed through generic Global Parameters Data API endpoints. Host applications can add, remove, or replace values in this set. By default, it reserves types specified in WorkflowApiConstants.DefaultProtectedGlobalParameterTypes.