Web API
- N 278 total items
- C 237 classes
- I 19 interfaces
- E 22 enums
- S 0 structs
- M 63 methods
- P 824 properties
OptimaJet.Workflow.Api
Classes
This class contains extensions for configuring Workflow Engine Api services and connecting ASP.NET middleware.
Class containing various public constants for working with the Workflow Engine API.
A basic implementation of IWorkflowTenant.
Interfaces
Interface for data provider used in DATA API.
Interface for provider abstract factory used to create data provider and workflow provider implementations.
Interface for a registry that manages and provides access to different providers factories
Fluent builder for hierarchical operation rules inside an already selected operations list policy.
Service for building Workflow Engine API permission claims.
Fluent builder for Workflow Engine API permissions values.
Configures each workflow runtime created by the Workflow API.
Defines a workflow tenant in a Workflow Engine Web API. In a single-tenant setup registered as a single instance with WorkflowApiConstants.SingleTenantId as its only id.
Factory interface for creating IWorkflowTenant instances.
Registry of runtime workflow tenants.
Controls the host-owned lifecycle of the workflow tenant registry.
Immutable point-in-time workflow tenant snapshot.
Enums
Controls whether the tenant lifecycle is managed by the tenant registry or by the external owner.
OptimaJet.Workflow.Api.Configuration
Classes
An immutable operation identity with a library-owned handler.
Interfaces
Registers callbacks for one operation in one application.
Provides the current HTTP request to operation callbacks.
Provides the complete logical input to operation callbacks.
A library-owned group of immutable operation selections.
Configures operations for one service provider after all module defaults have been loaded.
OptimaJet.Workflow.Api.Exceptions
Classes
An exception thrown when there is an attempt to set a system process parameter.
An exception thrown when duplicate workflow tenant IDs are found.
An exception thrown when HttpContext is not available.
An exception thrown when the workflow tenant configuration is incorrect.
An exception thrown when a permissions claim is invalid.
An exception thrown when a permissions value is invalid.
An exception thrown when a tenant id has an invalid format.
An exception thrown when the license does not support the Workflow Engine API.
Exception thrown when an operation group cannot be found.
An exception thrown when an permission target permission is not found.
An exception thrown when a process parameter cannot be deserialized to the target type.
An exception thrown when duplicate provider factory persistence provider IDs are found.
An exception thrown when a provider factory is not found.
An exception thrown when a tenant snapshot is obsolete and cannot be used.
An exception thrown when a required service is not found.
An exception thrown when there is an error in the Workflow Designer API.
An exception thrown when workflow tenant ID is not provided in the HTTP request and no default tenant is configured.
An exception thrown when a workflow tenant is not found.
OptimaJet.Workflow.Api.Models
Classes
Approval Model.
Bulk Create Instance Request.
Bulk Delete Instance Request.
Bulk Execute Command Request.
Bulk Get Available Commands Request.
Bulk Get Process Instance Request.
Bulk Get Process Instances Tree Request.
Bulk Is Process Exists Request.
Bulk Task Result.
Bulk Update Scheme If Obsolete Request.
Check All Subprocesses Completed Request.
Check All Subprocesses Completed Response.
Combines the scheme code from the route with the bound request body.
Identifies a scheme by its code from the route.
Command Execution Result.
Command Parameter.
Create Collection Response.
Create Instance Params Item.
Create Instance Request.
Create Instance Response.
Create Response.
Delete All Subprocesses Request.
Delete All Subprocesses Response.
Delete Collection Response.
Delete Instance Request.
Delete Instance Response.
Delete Response.
Error.
Exception Model.
Execute Command Request.
Execute Command Response.
A field comparison or a logical combination of nested filters.
Get Available Commands Request.
Get Available Commands Response.
Get Available States To Set By Scheme Code Request.
Get Available States To Set By Scheme Code Response.
Get Available States To Set Request.
Get Available States To Set Response.
Get Collection Response.
Get Current Activity Name Request.
Get Current Activity Name Response.
Get Current State Name Request.
Get Current State Name Result.
Get Current State Request.
Get Current State Response.
Get Initial Commands Request.
Get Initial Commands Response.
Get Initial State Request.
Get Initial State Response.
Get Localized Command Name By Scheme Id Request.
Get Localized Command Name By Scheme Id Response.
Get Localized Command Name Request.
Get Localized Command Name Response.
Get Localized State Name By Scheme Code Request.
Get Localized State Name By Scheme Code Response.
Get Localized State Name By Scheme Id Request.
Get Localized State Name By Scheme Id Response.
Get Localized State Name Request.
Get Localized State Name Response.
Get Process History Count Request.
Get Process History Count Response.
Get Process History Request.
Get Process History Response.
Get Process Instance Request.
Get Process Instance Response.
Get Process Instances Tree Request.
Get Process Instances Tree Response.
Get Process Parameter Request.
Get Process Parameter Response.
Get Process Status Request.
Get Process Status Response.
Get Process Status String Response.
Get Scheme Codes Request.
Get Scheme Codes Response.
Combines global parameter route keys with the bound request body.
Global Parameter Create Request.
Global Parameter Create Request With Type Name.
Global Parameter Model.
Identifies a global parameter by its type and name from the route.
Global Parameter Update Request.
Contains the resource ID bound from the route.
Inbox Entry Model.
Is Process Exists Request.
Is Process Exists Response.
Log Debug If Logger Exists Request.
Log Debug If Logger Exists Response.
Log Debug Request.
Log Debug Response.
Log Error If Logger Exists Request.
Log Error If Logger Exists Response.
Log Error Request.
Log Error Response.
Log Info If Logger Exists Request.
Log Info If Logger Exists Response.
Log Info Request.
Log Info Response.
Paging.
Parameter Create Request.
Parameter Create Request With Name.
Parameter Definition With Value.
Parameter Model.
Parameter Update Request.
Pre Execute From Current Activity Request.
Pre Execute From Current Activity Response.
Pre Execute From Initial Activity Request.
Pre Execute From Initial Activity Response.
Pre Execute Request.
Pre Execute Response.
Pre Execution Activity.
Pre Execution Transition.
Combines the process ID from the route with the bound request body.
Combines a process ID with query filters, sorting and pagination.
Combines a process ID with the collection items to create.
Combines a process ID with filters selecting collection items to delete.
Process History Item.
Identifies the process whose status is requested.
Identifies a process and the identity associated with an inbox entry.
Process Instance.
Process Instances Tree.
Identifies an item in a process-scoped collection.
Process Model.
Combines process and item route keys with the bound request body.
Identifies a named item belonging to a process.
Process Parameter.
Process Update Request.
Search, filtering, sorting and pagination for a collection operation.
Readiness Response.
Resume Request.
Resume Result.
Rpc Get Process Scheme Request.
Rpc Get Process Scheme Response.
Runtime Cold Start Request.
Runtime Cold Start Response.
Runtime Get Status Request.
Runtime Get Status Response.
Runtime Model.
Runtime Shut Down Request.
Runtime Shut Down Response.
Runtime Start Request.
Runtime Start Response.
Scheme.
Scheme Create Request.
Scheme Create Request With Code.
Scheme Model.
Scheme Update Request.
Action Reference.
Activity.
Activity Timeout.
Actor.
Annotation.
Code Action.
Code Action Parameter.
Command.
Comment.
Condition.
Designer.
Dropdown Value.
Exceptions Handler.
Parameter.
Parameter Reference.
Restriction.
Timer.
Transition.
Translation.
Trigger.
Set Activity With Execution Request.
Set Activity With Execution Response.
Set Activity Without Execution Request.
Set Activity Without Execution Response.
Set Process New Status Request.
Set Process New Status Response.
Set Process Parameter Request.
Set Process Parameter Response.
Set Scheme Is Obsolete Request.
Set Scheme Is Obsolete Response.
Set State With Execution Request.
Set State With Execution Response.
Set State Without Execution Request.
Set State Without Execution Response.
A collection sorting rule identifying a field and its direction.
Status Model.
Tenant Readiness Response.
Tenant Status.
Timer Create Request.
Timer Create Request With Name.
Timer Model.
Timer Update Request.
Transition Model.
Update Response.
Update Scheme If Obsolete Request.
Update Scheme If Obsolete Response.
Workflow Command.
Represent a state of a process for use in an application
Interfaces
The shared success payload contract for enum and string representations of a process status.
Enums
Approval Field.
Bulk Task State.
Database Status.
Direction.
Error Code.
Filter Type.
Global Parameter Field.
Inbox Entry Field.
Parameter Field.
Parameter Purpose.
Parameter Purpose Without System.
Process Field.
Process Status.
Process Status Available To Set.
Runtime Field.
Runtime Running Status.
Scheme Field.
Status Field.
Timer Field.
Transition Classifier.
Transition Field.
OptimaJet.Workflow.Api.Operations.DataGlobalParameters
Classes
Data Global Parameters Group operation selection. Instances are provided by the library.
OptimaJet.Workflow.Api.Operations
Classes
Data Group operation selection. Instances are provided by the library.
Rpc Group operation selection. Instances are provided by the library.
Search Group operation selection. Instances are provided by the library.
Workflow Api operation selection. Instances are provided by the library.
OptimaJet.Workflow.Api.Operations.DataProcesses
Classes
Data Processes Group operation selection. Instances are provided by the library.
OptimaJet.Workflow.Api.Operations.DataProcessesApprovals
Classes
Data Processes Approvals Group operation selection. Instances are provided by the library.
OptimaJet.Workflow.Api.Operations.DataProcessesInboxEntries
Classes
Data Processes Inbox Entries Group operation selection. Instances are provided by the library.
OptimaJet.Workflow.Api.Operations.DataProcessesParameters
Classes
Data Processes Parameters Group operation selection. Instances are provided by the library.
OptimaJet.Workflow.Api.Operations.DataProcessesTimers
Classes
Data Processes Timers Group operation selection. Instances are provided by the library.
OptimaJet.Workflow.Api.Operations.DataProcessesTransitions
Classes
Data Processes Transitions Group operation selection. Instances are provided by the library.
OptimaJet.Workflow.Api.Operations.DataRuntimes
Classes
Data Runtimes Group operation selection. Instances are provided by the library.
OptimaJet.Workflow.Api.Operations.DataSchemes
Classes
Data Schemes Group operation selection. Instances are provided by the library.
OptimaJet.Workflow.Api.Operations.DataStatuses
Classes
Data Statuses Group operation selection. Instances are provided by the library.
OptimaJet.Workflow.Api.Operations.Designer
Classes
Designer Group operation selection. Instances are provided by the library.
OptimaJet.Workflow.Api.Options
Classes
Represents configuration options for creating a data provider.
Represents the basic settings of the Workflow Engine Web API.
Represents the settings for authentication and authorization of your Workflow Engine Web API.
Represents the settings for creating a Workflow Engine IWorkflowProvider.
Contains configuration options for the Workflow Engine WorkflowRuntime.
Represents the settings for creating IWorkflowTenant implementation.