StellaOps.Workflow.Contracts
Workflow contracts: the definition, request and response types shared by workflow definitions, hosts and clients.
| Package | StellaOps.Workflow.Contracts |
| Component | Workflow |
| Licence | BUSL-1.1 (Workflow licence) |
| Package kind | Library |
| Target framework | net10.0 |
To add the package to a project, see Installing Stella Ops packages.
Namespaces
| Namespace | Types |
|---|---|
StellaOps.Workflow.Contracts | 162 |
StellaOps.Workflow.Contracts.Constants | 7 |
StellaOps.Workflow.Contracts namespace
| Type | Kind | Description |
|---|---|---|
StartWorkflowDeduplication | enum | How a start treats an instance of the same workflow that is already open. |
StartWorkflowRequest | record | Starts an instance of a registered workflow (POST /api/workflow/start). |
StartWorkflowResponse | record | The result of a start: the instance, the tasks it opened and its state. |
WorkflowActivateTaskStepDeclaration | record | Opens a declared human task; the instance waits until a user completes it ("$type": "activate-task"). |
WorkflowArrayExpressionDefinition | record | An array of expressions ("$type": "array"). |
WorkflowAssignBusinessReferenceStepDeclaration | record | Sets the business reference of the instance ("$type": "assign-business-reference"). |
WorkflowBinaryExpressionDefinition | record | A binary operation ("$type": "binary"). |
WorkflowBooleanExpressionDefinition | record | A Boolean literal ("$type": "boolean"). |
WorkflowBusinessReference | record | The business reference of a workflow instance: a key and its named parts, by which instances and tasks are found. |
WorkflowBusinessReferenceDeclaration | record | How a business reference is computed. |
WorkflowCancelRequest | record | Cancels an instance: raises an external signal for it, after starting a cleanup workflow when one is named and the cleanup policy allows it. |
WorkflowCancelResponse | record | The answer to a cancel request. |
WorkflowCanonicalDefinition | record | A canonical workflow definition: the portable, JSON form of a workflow that the engine imports, validates and runs. |
WorkflowCanonicalDefinitionSchema | class | The schema versions of canonical workflow definitions. |
WorkflowCanonicalIssueDto | record | A finding of the canonical definition validation. |
WorkflowCanonicalJsonSerializer | class | Reads and writes canonical definitions as JSON, byte-identical across platforms. |
WorkflowCanonicalSchemaGetResponse | record | The JSON schema of canonical workflow definitions. |
WorkflowCanonicalValidateRequest | record | Validates a canonical definition without importing it. |
WorkflowCanonicalValidateResponse | record | The outcome of a canonical definition validation. |
WorkflowCanonicalValidationIssue | record | A finding of the canonical definition validation. |
WorkflowCompleteStepDeclaration | record | Completes the instance ("$type": "complete"). |
WorkflowContinueWithWorkflowStepDeclaration | record | Starts another workflow as an independent instance and continues at once; its result is not returned ("$type": "continue-with-workflow"). |
WorkflowDecisionStepDeclaration | record | Branches on a condition ("$type": "decision"). |
WorkflowDefinitionActivateRequest | record | Makes a stored version the active version of its workflow. |
WorkflowDefinitionActivateResponse | record | The answer to an activation. |
WorkflowDefinitionByIdRequest | record | Reads one workflow definition: a code-registered workflow first, the definition store otherwise. |
WorkflowDefinitionByIdResponse | record | One workflow definition. |
WorkflowDefinitionDescriptor | record | A workflow definition: its name, version, roles and human tasks. |
WorkflowDefinitionExportMultiRequest | record | Exports a definition in a source format. |
WorkflowDefinitionExportMultiResponse | record | A definition exported in a source format. |
WorkflowDefinitionExportRequest | record | Exports a stored workflow definition. |
WorkflowDefinitionExportResponse | record | An exported workflow definition. |
WorkflowDefinitionGetRequest | record | Lists workflow definitions. |
WorkflowDefinitionGetResponse | record | A page of workflow definitions. |
WorkflowDefinitionImportMultiRequest | record | Imports a definition from a source format: it is converted to the canonical definition, then imported. |
WorkflowDefinitionImportMultiResponse | record | The answer to an import from a source format. |
WorkflowDefinitionImportRequest | record | Imports a canonical definition as a new version, which stays inactive until it is activated. |
WorkflowDefinitionImportResponse | record | The answer to a definition import. |
WorkflowDefinitionVersionSummary | record | One stored version of a workflow definition. |
WorkflowDefinitionVersionsGetRequest | record | Lists the stored versions of a workflow. |
WorkflowDefinitionVersionsGetResponse | record | The stored versions of a workflow. |
WorkflowDesignatedWorkflow | record | A workflow in the first-seen ledger, as first seen. |
WorkflowDesignatedWorkflowsGetResponse | record | The Designated Workflows of the installation as the first-seen ledger records them: every workflow ever registered in code or stored in the definition store, one entry per workflow, versions not counted. |
WorkflowDiagramEdge | record | A routed edge of a workflow diagram. |
WorkflowDiagramEdgeSection | record | A routed section of a diagram edge. |
WorkflowDiagramGetRequest | record | Lays out the diagram of a workflow definition, optionally with the progress of an instance. |
WorkflowDiagramGetResponse | record | A laid-out workflow diagram. |
WorkflowDiagramNode | record | A positioned node of a workflow diagram, with its progress when the diagram shows an instance. |
WorkflowDiagramPoint | record | A point of a diagram edge. |
WorkflowEndpointAddressDeclaration | record | An HTTP endpoint of a named service ("$type": "endpoint"): the host resolves the service name to a base address, and the call goes to WorkflowEndpointAddressDeclaration.Pathwith WorkflowEndpointAddressDeclaration.Method. |
WorkflowEndpointRequest | record | A call of an HTTP endpoint of a named service; the host’s endpoint transport delivers it. |
WorkflowEndpointResponse | record | The answer of an endpoint transport. |
WorkflowExecutionGraph | record | The scopes and steps of a workflow execution as a graph. |
WorkflowExecutionGraphEdge | record | An edge of an execution graph. |
WorkflowExecutionGraphNode | record | A node of an execution graph: a scope or a step. |
WorkflowExecutionListItem | record | One workflow execution of the console list. |
WorkflowExecutionListRequest | record | Lists workflow executions for the execution console, newest first. |
WorkflowExecutionListResponse | record | A page of workflow executions. |
WorkflowExecutionResourceRequest | record | Reads one resource of a workflow execution for the execution console. |
WorkflowExecutionResourceResponse | record | One resource of a workflow execution. |
WorkflowExecutionSnapshot | record | A task with the state of its workflow instance. |
WorkflowExecutionSvg | record | The execution graph drawn as SVG. |
WorkflowExpressionDefinition | record | An expression of a canonical definition. |
WorkflowExternalActivityStepDeclaration | record | Dispatches durable work through a deployment-owned, signed adapter registry. |
WorkflowExternalSignalStepDeclaration | record | Pauses the instance until a caller raises the signal for it ("$type": "external-signal"). |
WorkflowForkStepDeclaration | record | Runs its branches concurrently and continues when the last one has finished ("$type": "fork"). |
WorkflowFunctionArgumentDescriptor | record | An argument of an expression function. |
WorkflowFunctionCatalogGetResponse | record | The expression functions the engine provides. |
WorkflowFunctionDescriptor | record | An expression function of the function catalog. |
WorkflowFunctionExample | record | An example call of an expression function. |
WorkflowFunctionExpressionDefinition | record | A call of a function of the function catalog ("$type": "function"). |
WorkflowFunctionReturnDescriptor | record | The return value of an expression function. |
WorkflowGraphqlAddressDeclaration | record | A GraphQL query against a named target ("$type": "graphql"). |
WorkflowGraphqlRequest | record | A GraphQL query; the host’s GraphQL transport delivers it. |
WorkflowGraphqlResponse | record | The answer of the GraphQL transport. |
WorkflowGroupExpressionDefinition | record | A parenthesized expression ("$type": "group"). |
WorkflowHttpAddressDeclaration | record | A call of a named HTTP target ("$type": "http"). |
WorkflowHttpRequest | record | A call of a named HTTP target; the host’s HTTP transport delivers it. |
WorkflowHttpResponse | record | The answer of the HTTP transport. |
WorkflowInstanceGetRequest | record | Looks up one instance (GET /api/workflow/instances/{id}). |
WorkflowInstanceGetResponse | record | One instance with its state, tasks, task events and runtime state. |
WorkflowInstanceProjectionDetails | record | A workflow instance with its state, tasks and task events. |
WorkflowInstanceSummary | record | A workflow instance in a list or a lookup. |
WorkflowInstancesGetRequest | record | The filters, paging and sort of an instance list (GET /api/workflow/instances). |
WorkflowInstancesGetResponse | record | A page of instances and the total number that match the filters. |
WorkflowLicenceNotice | record | The licence notice the engine shows: “Licensed to” the licensee of the licence line whose entry covers the running version, or the message of the notice case. |
WorkflowLicenceStatus | record | The licence status of one licence evaluation: the status name, its factual message and the licence-status explanation that accompanies the messages. |
WorkflowMapStepDeclaration | record | Runs its body once per item of a collection, with bounded concurrency and a deterministic fan-in ("$type": "map"). |
WorkflowModuleInfo | record | A function module installed in the engine. |
WorkflowNamedExpressionDefinition | record | A named expression: an object property or a business reference part. |
WorkflowNullExpressionDefinition | record | The null value ("$type": "null"). |
WorkflowNumberExpressionDefinition | record | A number literal ("$type": "number"); arithmetic is decimal. |
WorkflowObjectExpressionDefinition | record | An object built from named expressions ("$type": "object"). |
WorkflowOpenBusinessKeySlot | class | Rules of the open-business-key slot (StartWorkflowDeduplication.OpenBusinessKey). |
WorkflowPathExpressionDefinition | record | Reads a value by path ("$type": "path"). |
WorkflowRabbitAddressDeclaration | record | A RabbitMQ exchange and routing key ("$type": "rabbit"). |
WorkflowRabbitCommandDeclaration | record | The command-style semantics of a rabbit call: the command name the peer dispatches on, how the message frames it, and whether the call waits for a correlated reply. |
WorkflowRabbitCommandFraming | enum | How a command-style rabbit message carries the command name and the payload. |
WorkflowRabbitRequest | record | A RabbitMQ call; the host’s RabbitMQ transport delivers it. |
WorkflowRabbitResponse | record | The answer of the RabbitMQ transport. |
WorkflowRenderEdgeView | record | An edge of a definition diagram. |
WorkflowRenderGraphGetRequest | record | Reads the render graph of a definition, for drawing it on the client. |
WorkflowRenderGraphGetResponse | record | The render graph of a definition. |
WorkflowRenderGraphView | record | The nodes and edges of a definition diagram. |
WorkflowRenderNodeView | record | A node of a definition diagram. |
WorkflowRenderPortView | record | A port of a diagram node. |
WorkflowRenderingRequest | record | Reads the stored rendering of a definition in one format. |
WorkflowRenderingResponse | record | The stored rendering of a definition in one format. |
WorkflowRepeatStepDeclaration | record | Runs its body while a condition holds, at most a number of times ("$type": "repeat"). |
WorkflowRequestContractDeclaration | record | The contract of a workflow start request. |
WorkflowRequiredModuleDeclaration | record | A function module a workflow needs. |
WorkflowRetentionRunRequest | record | Runs the instance retention once: marks stale instances and tasks, and purges those past their purge date. |
WorkflowRetentionRunResponse | record | The counts of a retention run. |
WorkflowRetryPolicyDeclaration | record | How failed map items are retried. |
WorkflowRuntimeStateSummary | record | The state a runtime provider keeps for an instance. |
WorkflowServiceMetadata | record | What a workflow service offers to tools. |
WorkflowServiceMetadataGetResponse | record | The metadata of the workflow service. |
WorkflowSetStateStepDeclaration | record | Sets a state value ("$type": "set-state"). |
WorkflowSignalDeadLetterMessage | record | A dead-lettered signal. |
WorkflowSignalDeadLetterReplayRequest | record | Puts a dead-lettered signal back on the signal queue. |
WorkflowSignalDeadLetterReplayResponse | record | The outcome of a dead letter replay. |
WorkflowSignalDeadLettersGetRequest | record | Lists the dead-lettered signals. |
WorkflowSignalDeadLettersGetResponse | record | A page of dead-lettered signals. |
WorkflowSignalPumpLastEvent | record | One signal pump event. |
WorkflowSignalPumpStats | record | The counts of the signal pump of this process since it started. |
WorkflowSignalPumpStatsGetResponse | record | The signal pump counts of this process. |
WorkflowSignalPumpStatsSignalType | record | The signal pump counts of one signal type. |
WorkflowSignalRaiseRequest | record | Raises a signal for a waiting instance (POST /api/workflow/signals/raise). |
WorkflowSignalRaiseResponse | record | The answer to a raised signal. |
WorkflowSortModel | record | Server-side sort request for list endpoints. |
WorkflowSourceFormatDiagnosticDto | record | A finding of a source format conversion. |
WorkflowStartDeclaration | record | What happens when a workflow instance starts. |
WorkflowStepDeclaration | record | A step of a canonical definition. |
WorkflowStepSequenceDeclaration | record | A sequence of steps. |
WorkflowStringExpressionDefinition | record | A string literal ("$type": "string"). |
WorkflowSubWorkflowStepDeclaration | record | Runs another workflow as a child and waits for it ("$type": "sub-workflow"). |
WorkflowSupportedFormatDescriptor | record | A source format of workflow definitions. |
WorkflowSupportedFormatsGetRequest | record | Lists the source formats the server converts. |
WorkflowSupportedFormatsGetResponse | record | The source formats the server converts. |
WorkflowTaskAssignRequest | record | Assigns a task to a user or to roles (POST /api/workflow/tasks/{id}/assign). |
WorkflowTaskAssignResponse | record | The result of a task assignment. |
WorkflowTaskCompleteRequest | record | Completes a task as the acting user (POST /api/workflow/tasks/{id}/complete). |
WorkflowTaskCompleteResponse | record | The result of a task completion. |
WorkflowTaskDeclaration | record | A human task a workflow declares, which an activate-task step opens. |
WorkflowTaskDescriptor | record | A human task a workflow definition declares. |
WorkflowTaskEventSummary | record | One event in the history of a task, for example its assignment or completion. |
WorkflowTaskGetRequest | record | Looks up one task (GET /api/workflow/tasks/{id}). |
WorkflowTaskGetResponse | record | One task. |
WorkflowTaskReleaseRequest | record | Releases an assigned task (POST /api/workflow/tasks/{id}/release). |
WorkflowTaskReleaseResponse | record | The result of a task release. |
WorkflowTaskSingleOpenSlot | class | Rules of the single-open task slot (WorkflowTaskDeclaration.SingleOpenSlot). |
WorkflowTaskSummary | record | A human task in a list, a lookup or the result of a start or a completion. |
WorkflowTasksGetRequest | record | The filters, paging and sort of a task list (GET /api/workflow/tasks). |
WorkflowTasksGetResponse | record | A page of tasks and the total number that match the filters. |
WorkflowTerminateForkStepDeclaration | record | Ends the fork whose branch reaches it (a BPMN terminate end event inside a parallel subprocess): tasks still open in the other branches are cancelled, their waits are dropped, and the flow continues after the fork. |
WorkflowTimelineResource | record | A page of the history events of a workflow execution. |
WorkflowTimerStepDeclaration | record | Pauses the instance for a delay; the host process can restart in between ("$type": "timer"). |
WorkflowTransportAddressDeclaration | record | The address of a transport call. |
WorkflowTransportCallStepDeclaration | record | Calls a service over a transport ("$type": "call-transport"). |
WorkflowTransportInvocationDeclaration | record | The address and payload of a transport call. |
WorkflowUnaryExpressionDefinition | record | A unary operation ("$type": "unary"). |
WorkflowWorkflowInvocationDeclaration | record | Which workflow a step starts, with what payload and business reference. |
StartWorkflowDeduplication enum
public enum StartWorkflowDeduplication
How a start treats an instance of the same workflow that is already open.
StartWorkflowRequest record
public sealed record StartWorkflowRequest
Starts an instance of a registered workflow (POST /api/workflow/start).
StartWorkflowRequest() constructor
public StartWorkflowRequest()
Creates an instance of StartWorkflowRequest.
BusinessReference property
public WorkflowBusinessReference? BusinessReference { get; init; }
The business reference of the new instance; overrides the business key of the start request.
Deduplication property
public StartWorkflowDeduplication Deduplication { get; init; }
Whether a start may reuse an open instance instead of creating one. Omitted from JSON when StartWorkflowDeduplication.None, so requests without it serialize as before.
Payload property
public IDictionary<string, object?> Payload { get; init; }
The start request, bound to the workflow’s start request type.
WorkflowName property
public required string WorkflowName { get; init; }
The registered workflow to start.
WorkflowVersion property
public string? WorkflowVersion { get; init; }
A registered version; the latest registered version when not set.
StartWorkflowResponse record
public sealed record StartWorkflowResponse
The result of a start: the instance, the tasks it opened and its state.
StartWorkflowResponse() constructor
public StartWorkflowResponse()
Creates an instance of StartWorkflowResponse.
BusinessReference property
public WorkflowBusinessReference? BusinessReference { get; init; }
The business reference of the instance: its key and parts.
Deduplicated property
public bool Deduplicated { get; init; }
True when the start returned an instance that was already open (StartWorkflowDeduplication.OpenBusinessKey); omitted from JSON when false.
NextTasks property
public IReadOnlyCollection<WorkflowTaskSummary> NextTasks { get; init; }
The tasks the start opened.
WorkflowInstanceId property
public required string WorkflowInstanceId { get; init; }
The identifier of the started instance, or of the open instance a deduplicated start returned.
WorkflowName property
public required string WorkflowName { get; init; }
The workflow name.
WorkflowState property
public IDictionary<string, object?> WorkflowState { get; init; }
The workflow state after the operation.
WorkflowVersion property
public required string WorkflowVersion { get; init; }
The workflow version the instance runs.
WorkflowActivateTaskStepDeclaration record
public sealed record WorkflowActivateTaskStepDeclaration : WorkflowStepDeclaration
Opens a declared human task; the instance waits until a user completes it ("$type": "activate-task").
WorkflowActivateTaskStepDeclaration() constructor
public WorkflowActivateTaskStepDeclaration()
Creates an instance of WorkflowActivateTaskStepDeclaration.
RuntimeRolesExpression property
public WorkflowExpressionDefinition? RuntimeRolesExpression { get; init; }
Roles computed from the state, which replace the task roles; when it yields no role, the task roles apply, or the workflow roles when the task has none.
TaskName property
public required string TaskName { get; init; }
The declared task to open.
TimeoutSeconds property
public int? TimeoutSeconds { get; init; }
Optional timeout for the human task in seconds. When null, no deadline is set — the task runs indefinitely until completed or purged by retention. When set, the task’s DeadlineUtc is computed as CreatedOnUtc + TimeoutSeconds.
WorkflowArrayExpressionDefinition record
public sealed record WorkflowArrayExpressionDefinition : WorkflowExpressionDefinition
An array of expressions ("$type": "array").
WorkflowArrayExpressionDefinition() constructor
public WorkflowArrayExpressionDefinition()
Creates an instance of WorkflowArrayExpressionDefinition.
Items property
public IReadOnlyCollection<WorkflowExpressionDefinition> Items { get; init; }
The items.
WorkflowAssignBusinessReferenceStepDeclaration record
public sealed record WorkflowAssignBusinessReferenceStepDeclaration : WorkflowStepDeclaration
Sets the business reference of the instance ("$type": "assign-business-reference").
WorkflowAssignBusinessReferenceStepDeclaration() constructor
public WorkflowAssignBusinessReferenceStepDeclaration()
Creates an instance of WorkflowAssignBusinessReferenceStepDeclaration.
BusinessReference property
public required WorkflowBusinessReferenceDeclaration BusinessReference { get; init; }
The new business reference.
WorkflowBinaryExpressionDefinition record
public sealed record WorkflowBinaryExpressionDefinition : WorkflowExpressionDefinition
A binary operation ("$type": "binary").
WorkflowBinaryExpressionDefinition() constructor
public WorkflowBinaryExpressionDefinition()
Creates an instance of WorkflowBinaryExpressionDefinition.
Left property
public required WorkflowExpressionDefinition Left { get; init; }
The left operand.
Operator property
public required string Operator { get; init; }
The operator: eq, ne, and, or, gt, gte, lt, lte, add, subtract, multiply or divide, case-sensitive. Arithmetic is decimal; division by zero fails the step.
Right property
public required WorkflowExpressionDefinition Right { get; init; }
The right operand.
WorkflowBooleanExpressionDefinition record
public sealed record WorkflowBooleanExpressionDefinition : WorkflowExpressionDefinition
A Boolean literal ("$type": "boolean").
WorkflowBooleanExpressionDefinition() constructor
public WorkflowBooleanExpressionDefinition()
Creates an instance of WorkflowBooleanExpressionDefinition.
Value property
public required bool Value { get; init; }
The value.
WorkflowBusinessReference record
public sealed record WorkflowBusinessReference
The business reference of a workflow instance: a key and its named parts, by which instances and tasks are found.
WorkflowBusinessReference() constructor
public WorkflowBusinessReference()
Creates an instance of WorkflowBusinessReference.
Key property
public string? Key { get; init; }
The reference key. When not set, the engine builds it from the parts, ordered by name (name=value|name=value). A key longer than 128 characters is shortened with a hash.
Parts property
public IDictionary<string, object?> Parts { get; init; }
The named parts of the reference; names compare ignoring case.
WorkflowBusinessReferenceDeclaration record
public sealed record WorkflowBusinessReferenceDeclaration
How a business reference is computed.
WorkflowBusinessReferenceDeclaration() constructor
public WorkflowBusinessReferenceDeclaration()
Creates an instance of WorkflowBusinessReferenceDeclaration.
KeyExpression property
public WorkflowExpressionDefinition? KeyExpression { get; init; }
The key; built from the parts when not set.
Parts property
public IReadOnlyCollection<WorkflowNamedExpressionDefinition> Parts { get; init; }
The named parts.
WorkflowCancelRequest record
public sealed record WorkflowCancelRequest
Cancels an instance: raises an external signal for it, after starting a cleanup workflow when one is named and the cleanup policy allows it.
WorkflowCancelRequest() constructor
public WorkflowCancelRequest()
Creates an instance of WorkflowCancelRequest.
CleanupPayload property
public IDictionary<string, object?> CleanupPayload { get; init; }
The start payload of the cleanup workflow.
CleanupWorkflowName property
public string? CleanupWorkflowName { get; init; }
The workflow to start for the cleanup, when the cleanup policy allows it; none when not set.
SignalName property
public string SignalName { get; init; }
The external signal the cancellation raises for the instance. The default is cancel.
WorkflowInstanceId property
public required string WorkflowInstanceId { get; init; }
The instance to cancel.
WorkflowCancelResponse record
public sealed record WorkflowCancelResponse
The answer to a cancel request.
WorkflowCancelResponse() constructor
public WorkflowCancelResponse()
Creates an instance of WorkflowCancelResponse.
Cancelled property
public required bool Cancelled { get; init; }
Whether the cancel signal was queued; false when the instance does not exist or is completed.
CleanupStarted property
public bool CleanupStarted { get; init; }
Whether the cleanup workflow started.
CleanupWorkflowInstanceId property
public string? CleanupWorkflowInstanceId { get; init; }
The cleanup workflow instance, when it started.
SignalId property
public string? SignalId { get; init; }
The cancel signal.
WorkflowInstanceId property
public required string WorkflowInstanceId { get; init; }
The instance.
WorkflowCanonicalDefinition record
public sealed record WorkflowCanonicalDefinition
A canonical workflow definition: the portable, JSON form of a workflow that the engine imports, validates and runs. WorkflowCanonicalJsonSerializerreads and writes it.
WorkflowCanonicalDefinition() constructor
public WorkflowCanonicalDefinition()
Creates an instance of WorkflowCanonicalDefinition.
BusinessReference property
public WorkflowBusinessReferenceDeclaration? BusinessReference { get; init; }
How the business reference of an instance is computed at start.
DisplayName property
public required string DisplayName { get; init; }
The display name.
RequiredCapabilities property
public IReadOnlyCollection<string> RequiredCapabilities { get; init; }
The capabilities the workflow declares it needs; none may be empty.
RequiredModules property
public IReadOnlyCollection<WorkflowRequiredModuleDeclaration> RequiredModules { get; init; }
The function modules the workflow needs.
SchemaVersion property
public string SchemaVersion { get; init; }
The schema version; WorkflowCanonicalDefinitionSchema.Version1by default.
Start property
public required WorkflowStartDeclaration Start { get; init; }
What happens when an instance starts.
StartRequest property
public WorkflowRequestContractDeclaration? StartRequest { get; init; }
The contract of the start request.
Tasks property
public IReadOnlyCollection<WorkflowTaskDeclaration> Tasks { get; init; }
The human tasks the workflow declares.
WorkflowName property
public required string WorkflowName { get; init; }
The workflow name.
WorkflowRoles property
public IReadOnlyCollection<string> WorkflowRoles { get; init; }
The roles of the workflow, which tasks use unless they declare their own.
WorkflowVersion property
public required string WorkflowVersion { get; init; }
The workflow version.
WorkflowCanonicalDefinitionSchema class
public static class WorkflowCanonicalDefinitionSchema
The schema versions of canonical workflow definitions.
Version1 constant
public const string Version1 = "stellaops.workflow.definition/v1"
The first schema version of canonical definitions.
WorkflowCanonicalIssueDto record
public sealed record WorkflowCanonicalIssueDto
A finding of the canonical definition validation.
WorkflowCanonicalIssueDto() constructor
public WorkflowCanonicalIssueDto()
Creates an instance of WorkflowCanonicalIssueDto.
Code property
public required string Code { get; init; }
The issue code.
Message property
public required string Message { get; init; }
The message.
Path property
public required string Path { get; init; }
The path of the definition element.
Severity property
public required string Severity { get; init; }
The severity, such as Error.
WorkflowCanonicalJsonSerializer class
public static class WorkflowCanonicalJsonSerializer
Reads and writes canonical definitions as JSON, byte-identical across platforms.
Options property
public static JsonSerializerOptions Options { get; }
The serializer options of canonical JSON: camel case, nulls omitted, indented, LF line ends.
Deserialize(string) method
public static WorkflowCanonicalDefinition Deserialize(string json)
Reads a definition from canonical JSON.
Parameters
json: The JSON.
Returns
The definition.
Exceptions
JsonException: The JSON is not a definition.
DeserializeFragment<TValue>(string) method
public static TValue DeserializeFragment<TValue>(string json)
Reads a part of a definition from canonical JSON.
Type parameters
TValue: The part type.
Parameters
json: The JSON.
Returns
The part.
Exceptions
JsonException: The JSON is not such a part.
Serialize(WorkflowCanonicalDefinition) method
public static string Serialize(WorkflowCanonicalDefinition definition)
Writes a definition as canonical JSON.
Parameters
definition: The definition.
Returns
The JSON.
SerializeFragment<TValue>(TValue) method
public static string SerializeFragment<TValue>(TValue value)
Writes a part of a definition as canonical JSON.
Type parameters
TValue: The part type.
Parameters
value: The part.
Returns
The JSON.
WorkflowCanonicalSchemaGetResponse record
public sealed record WorkflowCanonicalSchemaGetResponse
The JSON schema of canonical workflow definitions.
WorkflowCanonicalSchemaGetResponse() constructor
public WorkflowCanonicalSchemaGetResponse()
Creates an instance of WorkflowCanonicalSchemaGetResponse.
SchemaJson property
public required string SchemaJson { get; init; }
The JSON schema of canonical definitions.
SchemaVersion property
public required string SchemaVersion { get; init; }
The schema version.
WorkflowCanonicalValidateRequest record
public sealed record WorkflowCanonicalValidateRequest
Validates a canonical definition without importing it.
WorkflowCanonicalValidateRequest() constructor
public WorkflowCanonicalValidateRequest()
Creates an instance of WorkflowCanonicalValidateRequest.
CanonicalDefinitionJson property
public required string CanonicalDefinitionJson { get; init; }
The canonical definition, as JSON.
WorkflowCanonicalValidateResponse record
public sealed record WorkflowCanonicalValidateResponse
The outcome of a canonical definition validation.
WorkflowCanonicalValidateResponse() constructor
public WorkflowCanonicalValidateResponse()
Creates an instance of WorkflowCanonicalValidateResponse.
InstalledModules property
public IReadOnlyCollection<WorkflowModuleInfo> InstalledModules { get; init; }
The function modules installed in the engine.
IsValid property
public required bool IsValid { get; init; }
Whether the definition has no issue.
ModuleIssues property
public IReadOnlyCollection<WorkflowCanonicalValidationIssue> ModuleIssues { get; init; }
The findings about the modules the definition requires, checked against the installed ones.
SchemaIssues property
public IReadOnlyCollection<WorkflowCanonicalValidationIssue> SchemaIssues { get; init; }
The JSON schema findings.
SemanticIssues property
public IReadOnlyCollection<WorkflowCanonicalValidationIssue> SemanticIssues { get; init; }
The semantic findings.
WorkflowName property
public string? WorkflowName { get; init; }
The workflow name, when it could be read.
WorkflowVersion property
public string? WorkflowVersion { get; init; }
The workflow version, when it could be read.
WorkflowCanonicalValidationIssue record
public sealed record WorkflowCanonicalValidationIssue
A finding of the canonical definition validation.
WorkflowCanonicalValidationIssue() constructor
public WorkflowCanonicalValidationIssue()
Creates an instance of WorkflowCanonicalValidationIssue.
Code property
public required string Code { get; init; }
The issue code.
Message property
public required string Message { get; init; }
The message.
Path property
public required string Path { get; init; }
The path of the definition element.
WorkflowCompleteStepDeclaration record
public sealed record WorkflowCompleteStepDeclaration : WorkflowStepDeclaration
Completes the instance ("$type": "complete").
WorkflowCompleteStepDeclaration() constructor
public WorkflowCompleteStepDeclaration()
Creates an instance of WorkflowCompleteStepDeclaration.
WorkflowContinueWithWorkflowStepDeclaration record
public sealed record WorkflowContinueWithWorkflowStepDeclaration : WorkflowStepDeclaration
Starts another workflow as an independent instance and continues at once; its result is not returned ("$type": "continue-with-workflow").
WorkflowContinueWithWorkflowStepDeclaration() constructor
public WorkflowContinueWithWorkflowStepDeclaration()
Creates an instance of WorkflowContinueWithWorkflowStepDeclaration.
Invocation property
public required WorkflowWorkflowInvocationDeclaration Invocation { get; init; }
The workflow to start.
StepName property
public required string StepName { get; init; }
The step name, shown in diagrams.
WorkflowDecisionStepDeclaration record
public sealed record WorkflowDecisionStepDeclaration : WorkflowStepDeclaration
Branches on a condition ("$type": "decision").
WorkflowDecisionStepDeclaration() constructor
public WorkflowDecisionStepDeclaration()
Creates an instance of WorkflowDecisionStepDeclaration.
ConditionExpression property
public required WorkflowExpressionDefinition ConditionExpression { get; init; }
The condition.
DecisionName property
public required string DecisionName { get; init; }
The label of the decision in diagrams.
WhenElse property
public WorkflowStepSequenceDeclaration WhenElse { get; init; }
The steps to run otherwise.
WhenTrue property
public WorkflowStepSequenceDeclaration WhenTrue { get; init; }
The steps to run when the condition holds.
WorkflowDefinitionActivateRequest record
public sealed record WorkflowDefinitionActivateRequest
Makes a stored version the active version of its workflow.
WorkflowDefinitionActivateRequest() constructor
public WorkflowDefinitionActivateRequest()
Creates an instance of WorkflowDefinitionActivateRequest.
ActorId property
public string ActorId { get; init; }
Who activates, for the audit; the HTTP endpoint uses the caller and ignores this value.
AllowRollback property
public bool AllowRollback { get; init; }
Allows activating a lower version than the active one; it must be set for such a rollback, with WorkflowDefinitionActivateRequest.RollbackOfAuditId, and must not be set otherwise.
ExpectedActiveSha256 property
public string? ExpectedActiveSha256 { get; init; }
The content hash the caller expects the active version to have; checked with WorkflowDefinitionActivateRequest.ExpectedActiveVersion.
ExpectedActiveVersion property
public string? ExpectedActiveVersion { get; init; }
The version the caller expects to be active; it must match, and must not be set when no version is active, or the activation is refused with WORKFLOW_DEFINITION_ACTIVATION_FENCE_LOST.
ReasonCode property
public string ReasonCode { get; init; }
Why, for the audit; OPERATOR_ACTIVATION by default.
RollbackOfAuditId property
public string? RollbackOfAuditId { get; init; }
The audit record of the activation the rollback reverts; required for a rollback.
Version property
public required string Version { get; init; }
The version to activate.
WorkflowName property
public required string WorkflowName { get; init; }
The workflow name; the HTTP endpoint takes it from the route.
WorkflowDefinitionActivateResponse record
public sealed record WorkflowDefinitionActivateResponse
The answer to an activation.
WorkflowDefinitionActivateResponse() constructor
public WorkflowDefinitionActivateResponse()
Creates an instance of WorkflowDefinitionActivateResponse.
Activated property
public bool Activated { get; init; }
Whether the version was activated.
Version property
public required string Version { get; init; }
The activated version.
WorkflowName property
public required string WorkflowName { get; init; }
The workflow name.
WorkflowDefinitionByIdRequest record
public sealed record WorkflowDefinitionByIdRequest
Reads one workflow definition: a code-registered workflow first, the definition store otherwise.
WorkflowDefinitionByIdRequest() constructor
public WorkflowDefinitionByIdRequest()
Creates an instance of WorkflowDefinitionByIdRequest.
IncludeRendering property
public bool IncludeRendering { get; init; }
Include rendering assets (SVG, JSON, PNG) in the response.
Version property
public string? Version { get; init; }
Specific version. Null = active version.
WorkflowName property
public required string WorkflowName { get; init; }
Workflow name to retrieve.
WorkflowDefinitionByIdResponse record
public sealed record WorkflowDefinitionByIdResponse
One workflow definition.
WorkflowDefinitionByIdResponse() constructor
public WorkflowDefinitionByIdResponse()
Creates an instance of WorkflowDefinitionByIdResponse.
CanonicalDefinitionJson property
public required string CanonicalDefinitionJson { get; init; }
The canonical definition, as JSON.
ContentHash property
public string? ContentHash { get; init; }
The content hash, when the definition is stored.
DisplayName property
public string? DisplayName { get; init; }
The display name.
IsActive property
public bool IsActive { get; init; }
Whether the version is the active one.
RenderingJsonBase64 property
public string? RenderingJsonBase64 { get; init; }
The render graph JSON, base64-encoded; set when the request asked for the rendering and one is stored.
RenderingPngBase64 property
public string? RenderingPngBase64 { get; init; }
The PNG image, base64-encoded; set when the request asked for the rendering and one is stored.
RenderingSvgBase64 property
public string? RenderingSvgBase64 { get; init; }
The SVG diagram, base64-encoded; set when the request asked for the rendering and one is stored.
Source property
public string Source { get; init; }
“catalog” when compiled from a code-registered workflow, “store” when served from the persistent import store.
Version property
public required string Version { get; init; }
The version.
WorkflowName property
public required string WorkflowName { get; init; }
The workflow name.
WorkflowDefinitionDescriptor record
public sealed record WorkflowDefinitionDescriptor
A workflow definition: its name, version, roles and human tasks.
WorkflowDefinitionDescriptor() constructor
public WorkflowDefinitionDescriptor()
Creates an instance of WorkflowDefinitionDescriptor.
DisplayName property
public required string DisplayName { get; init; }
The display name.
Tasks property
public IReadOnlyCollection<WorkflowTaskDescriptor> Tasks { get; init; }
The human tasks.
WorkflowName property
public required string WorkflowName { get; init; }
The workflow name.
WorkflowRoles property
public IReadOnlyCollection<string> WorkflowRoles { get; init; }
The workflow roles.
WorkflowVersion property
public required string WorkflowVersion { get; init; }
The version.
WorkflowDefinitionExportMultiRequest record
public sealed record WorkflowDefinitionExportMultiRequest
Exports a definition in a source format.
WorkflowDefinitionExportMultiRequest() constructor
public WorkflowDefinitionExportMultiRequest()
Creates an instance of WorkflowDefinitionExportMultiRequest.
FormatId property
public required string FormatId { get; init; }
The target format, as the supported formats list it.
Version property
public string? Version { get; init; }
The version; the active one when not set.
WorkflowName property
public required string WorkflowName { get; init; }
The workflow name.
WorkflowDefinitionExportMultiResponse record
public sealed record WorkflowDefinitionExportMultiResponse
A definition exported in a source format.
WorkflowDefinitionExportMultiResponse() constructor
public WorkflowDefinitionExportMultiResponse()
Creates an instance of WorkflowDefinitionExportMultiResponse.
ContentBase64 property
public required string ContentBase64 { get; init; }
The content, base64-encoded.
ContentType property
public required string ContentType { get; init; }
The media type of the content.
FormatId property
public required string FormatId { get; init; }
The format.
SuggestedFileName property
public required string SuggestedFileName { get; init; }
A file name for the content.
Version property
public required string Version { get; init; }
The version.
WorkflowName property
public required string WorkflowName { get; init; }
The workflow name.
WorkflowDefinitionExportRequest record
public sealed record WorkflowDefinitionExportRequest
Exports a stored workflow definition.
WorkflowDefinitionExportRequest() constructor
public WorkflowDefinitionExportRequest()
Creates an instance of WorkflowDefinitionExportRequest.
IncludeRendering property
public bool IncludeRendering { get; init; }
Include rendering assets (SVG, JSON, PNG) in the response.
Version property
public string? Version { get; init; }
Specific version to export. Null = export the active version.
WorkflowName property
public required string WorkflowName { get; init; }
Workflow name to export.
WorkflowDefinitionExportResponse record
public sealed record WorkflowDefinitionExportResponse
An exported workflow definition.
WorkflowDefinitionExportResponse() constructor
public WorkflowDefinitionExportResponse()
Creates an instance of WorkflowDefinitionExportResponse.
CanonicalDefinitionJson property
public required string CanonicalDefinitionJson { get; init; }
The canonical definition, as JSON.
ContentHash property
public required string ContentHash { get; init; }
The content hash of the definition.
IsActive property
public bool IsActive { get; init; }
Whether the version is the active one.
RenderingJsonBase64 property
public string? RenderingJsonBase64 { get; init; }
The render graph JSON, base64-encoded; set when the request asked for the rendering and one is stored.
RenderingPngBase64 property
public string? RenderingPngBase64 { get; init; }
The PNG image, base64-encoded; set when the request asked for the rendering and one is stored.
RenderingSvgBase64 property
public string? RenderingSvgBase64 { get; init; }
The SVG diagram, base64-encoded; set when the request asked for the rendering and one is stored.
Version property
public required string Version { get; init; }
The exported version.
WorkflowName property
public required string WorkflowName { get; init; }
The workflow name.
WorkflowDefinitionGetRequest record
public sealed record WorkflowDefinitionGetRequest
Lists workflow definitions.
WorkflowDefinitionGetRequest() constructor
public WorkflowDefinitionGetRequest()
Creates an instance of WorkflowDefinitionGetRequest.
Filters property
public IReadOnlyCollection<object>? Filters { get; init; }
A client-side table filter collection that a request body may carry. The server ignores it and filters only by the named properties above; the property exists so that such a body is accepted.
Page property
public int Page { get; init; }
Pagination (1-based) alternative that matches the UI table payload convention. When both are > 0 the server derives Skip = (Page - 1) * PageSize and Take = PageSize, taking precedence over explicit Skip/Take.
PageSize property
public int PageSize { get; init; }
See WorkflowDefinitionGetRequest.Page.
Skip property
public int Skip { get; init; }
Pagination: rows to skip. 0 = start from beginning.
SortModel property
public WorkflowSortModel? SortModel { get; init; }
Optional sort. SortBy is whitelisted per-endpoint — for definitions the allowed values are “workflowName”, “workflowVersion”, “displayName”. Null sorts by a stable default.
Take property
public int Take { get; init; }
Pagination: max rows to return. 0 = return all.
WorkflowName property
public string? WorkflowName { get; init; }
A name filter: the name, or a part of it, ignoring case.
WorkflowNames property
public IReadOnlyCollection<string> WorkflowNames { get; init; }
Filter by multiple workflow names.
WorkflowVersion property
public string? WorkflowVersion { get; init; }
A version filter. With it, every matching version is returned; without it and without WorkflowDefinitionGetRequest.WorkflowNames, only the latest version of each workflow.
WorkflowDefinitionGetResponse record
public sealed record WorkflowDefinitionGetResponse
A page of workflow definitions.
WorkflowDefinitionGetResponse() constructor
public WorkflowDefinitionGetResponse()
Creates an instance of WorkflowDefinitionGetResponse.
Definitions property
public IReadOnlyCollection<WorkflowDefinitionDescriptor> Definitions { get; init; }
The definitions of the page.
TotalCount property
public int TotalCount { get; init; }
Total number of definitions matching the filter (pre-pagination).
WorkflowDefinitionImportMultiRequest record
public sealed record WorkflowDefinitionImportMultiRequest
Imports a definition from a source format: it is converted to the canonical definition, then imported.
WorkflowDefinitionImportMultiRequest() constructor
public WorkflowDefinitionImportMultiRequest()
Creates an instance of WorkflowDefinitionImportMultiRequest.
ContentBase64 property
public required string ContentBase64 { get; init; }
The source content, base64-encoded.
FormatId property
public required string FormatId { get; init; }
The source format, as the supported formats list it, such as canonical-yaml.
ImportedBy property
public string? ImportedBy { get; init; }
Who imports; the HTTP endpoint records the caller instead.
WorkflowDefinitionImportMultiResponse record
public sealed record WorkflowDefinitionImportMultiResponse
The answer to an import from a source format.
WorkflowDefinitionImportMultiResponse() constructor
public WorkflowDefinitionImportMultiResponse()
Creates an instance of WorkflowDefinitionImportMultiResponse.
CanonicalDefinitionJson property
public string? CanonicalDefinitionJson { get; init; }
The converted canonical definition, as JSON.
ContentHash property
public string? ContentHash { get; init; }
The content hash.
ConversionDiagnostics property
public IReadOnlyCollection<WorkflowSourceFormatDiagnosticDto> ConversionDiagnostics { get; init; }
The findings of the conversion.
IsActive property
public bool IsActive { get; init; }
Whether the version is the active one.
ValidationIssues property
public IReadOnlyCollection<WorkflowCanonicalIssueDto> ValidationIssues { get; init; }
The findings of the validation.
Version property
public string? Version { get; init; }
The version.
WasImported property
public bool WasImported { get; init; }
Whether a new version was stored; false when the content was already stored or the source was refused.
WasNewVersion property
public bool WasNewVersion { get; init; }
Whether the import stored a new version.
WorkflowName property
public string? WorkflowName { get; init; }
The workflow name.
WorkflowDefinitionImportRequest record
public sealed record WorkflowDefinitionImportRequest
Imports a canonical definition as a new version, which stays inactive until it is activated. Importing content already stored is a no-op; different content under a version that exists is refused with WORKFLOW_DEFINITION_VERSION_HASH_CONFLICT. The HTTP endpoint records the caller as WorkflowDefinitionImportRequest.ImportedBy.
WorkflowDefinitionImportRequest() constructor
public WorkflowDefinitionImportRequest()
Creates an instance of WorkflowDefinitionImportRequest.
CanonicalDefinitionJson property
public required string CanonicalDefinitionJson { get; init; }
Canonical definition JSON to import.
CompatibilitySha256 property
public string? CompatibilitySha256 { get; init; }
The compatibility SHA-256, as 64 hexadecimal digits; required for a managed definition, and stored as zeros when not set for another one.
ImportedBy property
public string? ImportedBy { get; init; }
User or system identifier performing the import.
ManagedCode property
public string? ManagedCode { get; init; }
The code of a managed definition.
Origin property
public string Origin { get; init; }
Where the definition comes from: OPERATOR_IMPORTED (the default) or MANAGED_EMBEDDED; any other value is refused. Content already stored under another origin or provenance is refused with WORKFLOW_DEFINITION_ORIGIN_COLLISION.
RenderingJsonBase64 property
public string? RenderingJsonBase64 { get; init; }
Optional render graph JSON (base64-encoded).
RenderingPngBase64 property
public string? RenderingPngBase64 { get; init; }
Optional PNG screenshot (base64-encoded).
RenderingSvgBase64 property
public string? RenderingSvgBase64 { get; init; }
Optional SVG diagram (base64-encoded).
SourceBuildSha256 property
public string? SourceBuildSha256 { get; init; }
The source build SHA-256, as 64 hexadecimal digits; required for a managed definition, and stored as zeros when not set for another one.
WorkflowDefinitionImportResponse record
public sealed record WorkflowDefinitionImportResponse
The answer to a definition import.
WorkflowDefinitionImportResponse() constructor
public WorkflowDefinitionImportResponse()
Creates an instance of WorkflowDefinitionImportResponse.
ContentHash property
public required string ContentHash { get; init; }
The content hash of the definition.
IsActive property
public bool IsActive { get; init; }
Whether this version is now the active version.
ValidationIssues property
public IReadOnlyCollection<WorkflowCanonicalValidationIssue> ValidationIssues { get; init; }
Validation issues found during import (empty if successful).
Version property
public required string Version { get; init; }
The version, as the definition declares it.
WasImported property
public bool WasImported { get; init; }
False if the content hash matched an existing version (no-op import).
WasNewVersion property
public bool WasNewVersion { get; init; }
True if this was the first import for this base version.
WorkflowName property
public required string WorkflowName { get; init; }
The workflow name.
WorkflowDefinitionVersionSummary record
public sealed record WorkflowDefinitionVersionSummary
One stored version of a workflow definition.
WorkflowDefinitionVersionSummary() constructor
public WorkflowDefinitionVersionSummary()
Creates an instance of WorkflowDefinitionVersionSummary.
ActivatedOnUtc property
public DateTime? ActivatedOnUtc { get; init; }
When the version was last activated, in UTC.
BaseVersion property
public required string BaseVersion { get; init; }
The version the definition declares.
BuildIteration property
public int BuildIteration { get; init; }
The build iteration within the base version; 0 for a version imported as declared.
CompatibilitySha256 property
public required string CompatibilitySha256 { get; init; }
The compatibility SHA-256; zeros when none was given.
ContentHash property
public required string ContentHash { get; init; }
The content hash.
CreatedOnUtc property
public DateTime CreatedOnUtc { get; init; }
When the version was stored, in UTC.
DisplayName property
public string? DisplayName { get; init; }
The display name of the definition.
ImportedBy property
public string? ImportedBy { get; init; }
Who imported the version.
IsActive property
public bool IsActive { get; init; }
Whether the version is the active one.
IsManaged property
public bool IsManaged { get; init; }
Whether the definition is managed (MANAGED_EMBEDDED).
ManagedCode property
public string? ManagedCode { get; init; }
The code of a managed definition.
Origin property
public required string Origin { get; init; }
Where the definition comes from: OPERATOR_IMPORTED or MANAGED_EMBEDDED.
SourceBuildSha256 property
public required string SourceBuildSha256 { get; init; }
The source build SHA-256; zeros when none was given.
Version property
public required string Version { get; init; }
The version.
WorkflowName property
public required string WorkflowName { get; init; }
The workflow name.
WorkflowDefinitionVersionsGetRequest record
public sealed record WorkflowDefinitionVersionsGetRequest
Lists the stored versions of a workflow.
WorkflowDefinitionVersionsGetRequest() constructor
public WorkflowDefinitionVersionsGetRequest()
Creates an instance of WorkflowDefinitionVersionsGetRequest.
WorkflowName property
public required string WorkflowName { get; init; }
The workflow name.
WorkflowDefinitionVersionsGetResponse record
public sealed record WorkflowDefinitionVersionsGetResponse
The stored versions of a workflow.
WorkflowDefinitionVersionsGetResponse() constructor
public WorkflowDefinitionVersionsGetResponse()
Creates an instance of WorkflowDefinitionVersionsGetResponse.
Versions property
public IReadOnlyCollection<WorkflowDefinitionVersionSummary> Versions { get; init; }
The versions.
WorkflowDesignatedWorkflow record
public sealed record WorkflowDesignatedWorkflow
A workflow in the first-seen ledger, as first seen.
WorkflowDesignatedWorkflow() constructor
public WorkflowDesignatedWorkflow()
Creates an instance of WorkflowDesignatedWorkflow.
FirstSeenOnUtc property
public required DateTimeOffset FirstSeenOnUtc { get; init; }
When the workflow was first seen (UTC).
FirstSeenSource property
public required string FirstSeenSource { get; init; }
Where the workflow was first seen: catalog, store or import.
WorkflowName property
public required string WorkflowName { get; init; }
The spelling of the workflow name at its first sighting.
WorkflowDesignatedWorkflowsGetResponse record
public sealed record WorkflowDesignatedWorkflowsGetResponse
The Designated Workflows of the installation as the first-seen ledger records them: every workflow ever registered in code or stored in the definition store, one entry per workflow, versions not counted. Read-only; the count is the ledger’s count, the one the licence monitor evaluates.
WorkflowDesignatedWorkflowsGetResponse() constructor
public WorkflowDesignatedWorkflowsGetResponse()
Creates an instance of WorkflowDesignatedWorkflowsGetResponse.
DesignatedWorkflows property
public required int DesignatedWorkflows { get; init; }
The number of distinct workflows the ledger records; equals the number of WorkflowDesignatedWorkflowsGetResponse.Workflows.
Ledger property
public required string Ledger { get; init; }
durable for the PostgreSQL and MongoDB ledgers; process-memory on a host without a workflow store, whose ledger holds only what the running process has seen.
Licence property
public WorkflowLicenceStatus? Licence { get; init; }
The licence status of the latest licence evaluation; null before the first evaluation of this process. Informational: nothing is refused.
Notice property
public WorkflowLicenceNotice? Notice { get; init; }
The licence notice of the latest licence evaluation; null before the first evaluation of this process (the licence monitor evaluates at startup and every hour).
Workflows property
public required IReadOnlyCollection<WorkflowDesignatedWorkflow> Workflows { get; init; }
The recorded workflows, ordered by their invariant upper-case name (ordinal).
WorkflowDiagramEdge record
public sealed record WorkflowDiagramEdge
A routed edge of a workflow diagram.
WorkflowDiagramEdge() constructor
public WorkflowDiagramEdge()
Creates an instance of WorkflowDiagramEdge.
Label property
public string? Label { get; init; }
The label.
Sections property
public IReadOnlyCollection<WorkflowDiagramEdgeSection> Sections { get; init; }
The routed sections.
SourceNodeId property
public required string SourceNodeId { get; init; }
The source node.
TargetNodeId property
public required string TargetNodeId { get; init; }
The target node.
WorkflowDiagramEdgeSection record
public sealed record WorkflowDiagramEdgeSection
A routed section of a diagram edge.
WorkflowDiagramEdgeSection() constructor
public WorkflowDiagramEdgeSection()
Creates an instance of WorkflowDiagramEdgeSection.
BendPoints property
public IReadOnlyCollection<WorkflowDiagramPoint> BendPoints { get; init; }
The bends between them.
EndPoint property
public required WorkflowDiagramPoint EndPoint { get; init; }
Where the section ends.
StartPoint property
public required WorkflowDiagramPoint StartPoint { get; init; }
Where the section starts.
WorkflowDiagramGetRequest record
public sealed record WorkflowDiagramGetRequest
Lays out the diagram of a workflow definition, optionally with the progress of an instance.
WorkflowDiagramGetRequest() constructor
public WorkflowDiagramGetRequest()
Creates an instance of WorkflowDiagramGetRequest.
LayoutEffort property
public string? LayoutEffort { get; init; }
The layout effort: Draft, Balanced or Best (the default), ignoring case.
LayoutOrderingIterations property
public int? LayoutOrderingIterations { get; init; }
The node ordering iterations of the layout.
LayoutPlacementIterations property
public int? LayoutPlacementIterations { get; init; }
The node placement iterations of the layout.
LayoutProvider property
public string? LayoutProvider { get; init; }
The layout provider; the configured one when not set.
WorkflowInstanceId property
public string? WorkflowInstanceId { get; init; }
An instance whose progress the diagram shows.
WorkflowName property
public required string WorkflowName { get; init; }
The workflow name.
WorkflowVersion property
public string? WorkflowVersion { get; init; }
The version; the latest when not set.
WorkflowDiagramGetResponse record
public sealed record WorkflowDiagramGetResponse
A laid-out workflow diagram.
WorkflowDiagramGetResponse() constructor
public WorkflowDiagramGetResponse()
Creates an instance of WorkflowDiagramGetResponse.
DisplayName property
public required string DisplayName { get; init; }
The display name.
Edges property
public IReadOnlyCollection<WorkflowDiagramEdge> Edges { get; init; }
The routed edges.
InstanceStatus property
public string? InstanceStatus { get; init; }
The status of that instance.
LayoutEffort property
public string? LayoutEffort { get; init; }
The layout effort used.
LayoutOrderingIterations property
public int? LayoutOrderingIterations { get; init; }
The ordering iterations used.
LayoutPlacementIterations property
public int? LayoutPlacementIterations { get; init; }
The placement iterations used.
LayoutProvider property
public string? LayoutProvider { get; init; }
The layout provider used.
Nodes property
public IReadOnlyCollection<WorkflowDiagramNode> Nodes { get; init; }
The positioned nodes.
RuntimeProvider property
public string? RuntimeProvider { get; init; }
The runtime provider of that instance.
RuntimeStatus property
public string? RuntimeStatus { get; init; }
The runtime status of that instance.
WorkflowInstanceId property
public string? WorkflowInstanceId { get; init; }
The instance shown, when the request named one.
WorkflowName property
public required string WorkflowName { get; init; }
The workflow name.
WorkflowVersion property
public required string WorkflowVersion { get; init; }
The version.
WorkflowDiagramNode record
public sealed record WorkflowDiagramNode
A positioned node of a workflow diagram, with its progress when the diagram shows an instance.
WorkflowDiagramNode() constructor
public WorkflowDiagramNode()
Creates an instance of WorkflowDiagramNode.
Assignee property
public string? Assignee { get; init; }
The assignee of that task.
EffectiveRoles property
public IReadOnlyCollection<string> EffectiveRoles { get; init; }
The roles of the active task of the node, after any runtime roles.
Height property
public double Height { get; init; }
The node height.
IconKey property
public string? IconKey { get; init; }
The icon of the node.
Id property
public required string Id { get; init; }
The node identifier.
Label property
public required string Label { get; init; }
The label.
NodeStatus property
public string? NodeStatus { get; init; }
The node status in the instance, when the request names one: the start node is Completed; the end node is Completed or Pending; a task node has the status of its open, assigned or stale task, or Pending before its first task; any other node is Completed once the instance is.
NodeType property
public required string NodeType { get; init; }
The node kind, such as Start, End, HumanTask, TransportCall or Decision.
Route property
public string? Route { get; init; }
The route of a human task node.
SemanticKey property
public string? SemanticKey { get; init; }
The name of what the node stands for, such as the task or step name.
SemanticType property
public string? SemanticType { get; init; }
What the node stands for, such as Task or Decision.
TaskRoles property
public IReadOnlyCollection<string> TaskRoles { get; init; }
The roles the task declares, for a human task node.
TaskType property
public string? TaskType { get; init; }
The task type of a human task node.
VisitCount property
public int VisitCount { get; init; }
How many tasks the node has created in the instance.
Width property
public double Width { get; init; }
The node width.
WorkflowRoles property
public IReadOnlyCollection<string> WorkflowRoles { get; init; }
The roles of the workflow.
WorkflowTaskId property
public string? WorkflowTaskId { get; init; }
The latest task of the node in the instance.
X property
public double X { get; init; }
The left edge of the node.
Y property
public double Y { get; init; }
The top edge of the node.
WorkflowDiagramPoint record
public sealed record WorkflowDiagramPoint
A point of a diagram edge.
WorkflowDiagramPoint() constructor
public WorkflowDiagramPoint()
Creates an instance of WorkflowDiagramPoint.
X property
public required double X { get; init; }
The horizontal position.
Y property
public required double Y { get; init; }
The vertical position.
WorkflowEndpointAddressDeclaration record
public sealed record WorkflowEndpointAddressDeclaration : WorkflowTransportAddressDeclaration
An HTTP endpoint of a named service ("$type": "endpoint"): the host resolves the service name to a base address, and the call goes to WorkflowEndpointAddressDeclaration.Pathwith WorkflowEndpointAddressDeclaration.Method.
WorkflowEndpointAddressDeclaration() constructor
public WorkflowEndpointAddressDeclaration()
Creates an instance of WorkflowEndpointAddressDeclaration.
Method property
public string Method { get; init; }
The HTTP method; POST by default.
Path property
public required string Path { get; init; }
The path.
ServiceName property
public required string ServiceName { get; init; }
The service.
WorkflowEndpointRequest record
public sealed record WorkflowEndpointRequest
A call of an HTTP endpoint of a named service; the host’s endpoint transport delivers it.
WorkflowEndpointRequest() constructor
public WorkflowEndpointRequest()
Creates an instance of WorkflowEndpointRequest.
Method property
public string Method { get; init; }
The HTTP method; POST by default.
Path property
public required string Path { get; init; }
The path, joined to the base address.
Payload property
public object? Payload { get; init; }
The body, sent as JSON; none when not set.
ServiceName property
public required string ServiceName { get; init; }
The service, resolved to a base address by the endpoint transport.
WorkflowEndpointResponse record
public sealed record WorkflowEndpointResponse
The answer of an endpoint transport.
WorkflowEndpointResponse() constructor
public WorkflowEndpointResponse()
Creates an instance of WorkflowEndpointResponse.
Error property
public string? Error { get; init; }
Why the call failed; not set when it succeeded.
Payload property
public object? Payload { get; init; }
The response body: read as JSON, or the text when it is not JSON.
StatusCode property
public long? StatusCode { get; init; }
The status the service answered with, when it answered; whenFailure branches read it.
Succeeded property
public required bool Succeeded { get; init; }
Whether the call succeeded.
WorkflowExecutionGraph record
public sealed record WorkflowExecutionGraph
The scopes and steps of a workflow execution as a graph.
Parameters
Nodes: The nodes.Edges: The edges.
WorkflowExecutionGraph(IReadOnlyList<WorkflowExecutionGraphNode>, IReadOnlyList<WorkflowExecutionGraphEdge>) constructor
public WorkflowExecutionGraph(IReadOnlyList<WorkflowExecutionGraphNode> Nodes, IReadOnlyList<WorkflowExecutionGraphEdge> Edges)
The scopes and steps of a workflow execution as a graph.
Parameters
Nodes: The nodes.Edges: The edges.
Edges property
public IReadOnlyList<WorkflowExecutionGraphEdge> Edges { get; init; }
The edges.
Nodes property
public IReadOnlyList<WorkflowExecutionGraphNode> Nodes { get; init; }
The nodes.
WorkflowExecutionGraphEdge record
public sealed record WorkflowExecutionGraphEdge
An edge of an execution graph.
Parameters
SourceId: The source node.TargetId: The target node.Kind:containsfrom a scope to what it contains, ornextfrom a step to the next one.
WorkflowExecutionGraphEdge(string, string, string) constructor
public WorkflowExecutionGraphEdge(string SourceId, string TargetId, string Kind)
An edge of an execution graph.
Parameters
SourceId: The source node.TargetId: The target node.Kind:containsfrom a scope to what it contains, ornextfrom a step to the next one.
Kind property
public string Kind { get; init; }
contains from a scope to what it contains, or next from a step to the next one.
SourceId property
public string SourceId { get; init; }
The source node.
TargetId property
public string TargetId { get; init; }
The target node.
WorkflowExecutionGraphNode record
public sealed record WorkflowExecutionGraphNode
A node of an execution graph: a scope or a step.
Parameters
Id: The scope or step execution.Kind:scopeorstep.Label: The scope code, or the step key; the TECHNICAL profile adds the operation.Status: The status.ParentId: The scope that contains the node.
WorkflowExecutionGraphNode(string, string, string, string, string) constructor
public WorkflowExecutionGraphNode(string Id, string Kind, string Label, string Status, string? ParentId)
A node of an execution graph: a scope or a step.
Parameters
Id: The scope or step execution.Kind:scopeorstep.Label: The scope code, or the step key; the TECHNICAL profile adds the operation.Status: The status.ParentId: The scope that contains the node.
Id property
public string Id { get; init; }
The scope or step execution.
Kind property
public string Kind { get; init; }
scope or step.
Label property
public string Label { get; init; }
The scope code, or the step key; the TECHNICAL profile adds the operation.
ParentId property
public string? ParentId { get; init; }
The scope that contains the node.
Status property
public string Status { get; init; }
The status.
WorkflowExecutionListItem record
public sealed record WorkflowExecutionListItem
One workflow execution of the console list.
WorkflowExecutionListItem() constructor
public WorkflowExecutionListItem()
Creates an instance of WorkflowExecutionListItem.
CompletedAtUtc property
public DateTime? CompletedAtUtc { get; init; }
When it completed, in UTC.
CreatedAtUtc property
public required DateTime CreatedAtUtc { get; init; }
When it started, in UTC.
DefinitionCode property
public required string DefinitionCode { get; init; }
The workflow name.
DefinitionVersion property
public required string DefinitionVersion { get; init; }
The workflow version.
Status property
public required string Status { get; init; }
The status.
WorkflowExecutionId property
public required string WorkflowExecutionId { get; init; }
The execution (workflow instance).
WorkflowExecutionListRequest record
public sealed record WorkflowExecutionListRequest
Lists workflow executions for the execution console, newest first.
WorkflowExecutionListRequest() constructor
public WorkflowExecutionListRequest()
Creates an instance of WorkflowExecutionListRequest.
Cursor property
public string? Cursor { get; init; }
The cursor of the next page, from the previous response; the first page when not set.
PageSize property
public int PageSize { get; init; }
The page size, from 1 to 50; 25 by default.
Profile property
public string Profile { get; init; }
The console profile: SAFE (the default) shows only the allowed state keys and step names; TECHNICAL shows more. Any other value is refused.
WorkflowExecutionListResponse record
public sealed record WorkflowExecutionListResponse
A page of workflow executions.
WorkflowExecutionListResponse() constructor
public WorkflowExecutionListResponse()
Creates an instance of WorkflowExecutionListResponse.
HasMoreCandidates property
public required bool HasMoreCandidates { get; init; }
Whether a next page exists.
Items property
public required IReadOnlyList<WorkflowExecutionListItem> Items { get; init; }
The executions of the page.
NextCursor property
public string? NextCursor { get; init; }
The cursor of the next page; not set on the last page.
WorkflowExecutionResourceRequest record
public sealed record WorkflowExecutionResourceRequest
Reads one resource of a workflow execution for the execution console.
WorkflowExecutionResourceRequest() constructor
public WorkflowExecutionResourceRequest()
Creates an instance of WorkflowExecutionResourceRequest.
AfterSequence property
public long AfterSequence { get; init; }
For the timeline: the history sequence after which events are returned.
MaxCount property
public int MaxCount { get; init; }
The most rows to return, from 1 to 1000; 100 by default.
Profile property
public string Profile { get; init; }
The console profile: SAFE (the default) shows only the allowed state keys and step names; TECHNICAL shows more. Any other value is refused.
WorkflowExecutionId property
public required string WorkflowExecutionId { get; init; }
The execution (workflow instance).
WorkflowExecutionResourceResponse record
public sealed record WorkflowExecutionResourceResponse
One resource of a workflow execution.
WorkflowExecutionResourceResponse() constructor
public WorkflowExecutionResourceResponse()
Creates an instance of WorkflowExecutionResourceResponse.
Authoritative property
public required bool Authoritative { get; init; }
Whether the resource was read from the durable store; this engine always reads it there.
Found property
public required bool Found { get; init; }
Whether the execution exists.
OverlayKind property
public string? OverlayKind { get; init; }
The kind of overlay the resource comes from; this engine sets none.
Profile property
public required string Profile { get; init; }
The profile the resource was read with.
Resource property
public object? Resource { get; init; }
The resource, when the execution exists.
WorkflowExecutionSnapshot record
public sealed record WorkflowExecutionSnapshot
A task with the state of its workflow instance.
WorkflowExecutionSnapshot() constructor
public WorkflowExecutionSnapshot()
Creates an instance of WorkflowExecutionSnapshot.
Task property
public required WorkflowTaskSummary Task { get; init; }
The task.
WorkflowState property
public IReadOnlyDictionary<string, JsonElement> WorkflowState { get; init; }
The state of its instance.
WorkflowExecutionSvg record
public sealed record WorkflowExecutionSvg
The execution graph drawn as SVG.
Parameters
ContentType: The media type of the SVG.Svg: The SVG markup.NodeCount: The nodes drawn.EdgeCount: The edges drawn.
WorkflowExecutionSvg(string, string, int, int) constructor
public WorkflowExecutionSvg(string ContentType, string Svg, int NodeCount, int EdgeCount)
The execution graph drawn as SVG.
Parameters
ContentType: The media type of the SVG.Svg: The SVG markup.NodeCount: The nodes drawn.EdgeCount: The edges drawn.
ContentType property
public string ContentType { get; init; }
The media type of the SVG.
EdgeCount property
public int EdgeCount { get; init; }
The edges drawn.
NodeCount property
public int NodeCount { get; init; }
The nodes drawn.
Svg property
public string Svg { get; init; }
The SVG markup.
WorkflowExpressionDefinition record
public abstract record WorkflowExpressionDefinition
An expression of a canonical definition. The $type property names the expression kind.
WorkflowExpressionDefinition() constructor
protected WorkflowExpressionDefinition()
Creates an instance of WorkflowExpressionDefinition.
WorkflowExternalActivityStepDeclaration record
public sealed record WorkflowExternalActivityStepDeclaration : WorkflowStepDeclaration
Dispatches durable work through a deployment-owned, signed adapter registry. Definitions deliberately cannot carry transport addresses or host command names.
WorkflowExternalActivityStepDeclaration() constructor
public WorkflowExternalActivityStepDeclaration()
Creates an instance of WorkflowExternalActivityStepDeclaration.
ContractVersion property
public required string ContractVersion { get; init; }
The contract version of the activity in the registry.
DeadlineSeconds property
public int? DeadlineSeconds { get; init; }
The deadline of the activity in seconds.
DestinationCode property
public required string DestinationCode { get; init; }
The destination of the activity in the registry.
OperationCode property
public required string OperationCode { get; init; }
The operation of the activity in the registry.
RequestExpression property
public required WorkflowExpressionDefinition RequestExpression { get; init; }
The request.
ResultKey property
public string? ResultKey { get; init; }
The key the result is kept under (result.<key>); not kept when not set.
StepName property
public required string StepName { get; init; }
The step name, shown in diagrams and in result.lastFailure.
WorkflowExternalSignalStepDeclaration record
public sealed record WorkflowExternalSignalStepDeclaration : WorkflowStepDeclaration
Pauses the instance until a caller raises the signal for it ("$type": "external-signal").
WorkflowExternalSignalStepDeclaration() constructor
public WorkflowExternalSignalStepDeclaration()
Creates an instance of WorkflowExternalSignalStepDeclaration.
ResultKey property
public string? ResultKey { get; init; }
The key the signal’s payload is kept under.
SignalNameExpression property
public required WorkflowExpressionDefinition SignalNameExpression { get; init; }
The signal name; not empty.
StepName property
public required string StepName { get; init; }
The step name, shown in diagrams.
WorkflowForkStepDeclaration record
public sealed record WorkflowForkStepDeclaration : WorkflowStepDeclaration
Runs its branches concurrently and continues when the last one has finished ("$type": "fork"). A terminate-fork step in a branch ends the fork early.
WorkflowForkStepDeclaration() constructor
public WorkflowForkStepDeclaration()
Creates an instance of WorkflowForkStepDeclaration.
Branches property
public IReadOnlyCollection<WorkflowStepSequenceDeclaration> Branches { get; init; }
The branches.
StepName property
public required string StepName { get; init; }
The step name, shown in diagrams.
WorkflowFunctionArgumentDescriptor record
public sealed record WorkflowFunctionArgumentDescriptor
An argument of an expression function.
WorkflowFunctionArgumentDescriptor() constructor
public WorkflowFunctionArgumentDescriptor()
Creates an instance of WorkflowFunctionArgumentDescriptor.
Description property
public required string Description { get; init; }
What the argument is.
Name property
public required string Name { get; init; }
The argument name.
Required property
public required bool Required { get; init; }
Whether the argument is required.
Type property
public required string Type { get; init; }
The argument type.
Variadic property
public bool Variadic { get; init; }
Whether the argument takes any number of values.
WorkflowFunctionCatalogGetResponse record
public sealed record WorkflowFunctionCatalogGetResponse
The expression functions the engine provides.
WorkflowFunctionCatalogGetResponse() constructor
public WorkflowFunctionCatalogGetResponse()
Creates an instance of WorkflowFunctionCatalogGetResponse.
Functions property
public IReadOnlyCollection<WorkflowFunctionDescriptor> Functions { get; init; }
The functions.
InstalledModules property
public IReadOnlyCollection<WorkflowModuleInfo> InstalledModules { get; init; }
The installed function modules.
WorkflowFunctionDescriptor record
public sealed record WorkflowFunctionDescriptor
An expression function of the function catalog.
WorkflowFunctionDescriptor() constructor
public WorkflowFunctionDescriptor()
Creates an instance of WorkflowFunctionDescriptor.
Aliases property
public IReadOnlyCollection<string> Aliases { get; init; }
Other names of the function.
Arguments property
public IReadOnlyCollection<WorkflowFunctionArgumentDescriptor> Arguments { get; init; }
The arguments.
Deterministic property
public bool Deterministic { get; init; }
Whether the function always returns the same result for the same arguments.
Examples property
public IReadOnlyCollection<WorkflowFunctionExample> Examples { get; init; }
Example calls.
FunctionName property
public required string FunctionName { get; init; }
The function name.
IntroducedInSchemaVersion property
public string IntroducedInSchemaVersion { get; init; }
The canonical schema version that introduced the function.
ModuleName property
public required string ModuleName { get; init; }
The module that provides the function.
ModuleVersion property
public required string ModuleVersion { get; init; }
The module version.
Return property
public WorkflowFunctionReturnDescriptor? Return { get; init; }
The return value.
Summary property
public required string Summary { get; init; }
What the function does.
WorkflowFunctionExample record
public sealed record WorkflowFunctionExample
An example call of an expression function.
WorkflowFunctionExample() constructor
public WorkflowFunctionExample()
Creates an instance of WorkflowFunctionExample.
Description property
public string? Description { get; init; }
What the example shows.
Expression property
public required string Expression { get; init; }
The example expression.
WorkflowFunctionExpressionDefinition record
public sealed record WorkflowFunctionExpressionDefinition : WorkflowExpressionDefinition
A call of a function of the function catalog ("$type": "function").
WorkflowFunctionExpressionDefinition() constructor
public WorkflowFunctionExpressionDefinition()
Creates an instance of WorkflowFunctionExpressionDefinition.
Arguments property
public IReadOnlyCollection<WorkflowExpressionDefinition> Arguments { get; init; }
The arguments.
FunctionName property
public required string FunctionName { get; init; }
The function name, as the function catalog lists it.
WorkflowFunctionReturnDescriptor record
public sealed record WorkflowFunctionReturnDescriptor
The return value of an expression function.
WorkflowFunctionReturnDescriptor() constructor
public WorkflowFunctionReturnDescriptor()
Creates an instance of WorkflowFunctionReturnDescriptor.
Description property
public required string Description { get; init; }
What the function returns.
Type property
public required string Type { get; init; }
The return type.
WorkflowGraphqlAddressDeclaration record
public sealed record WorkflowGraphqlAddressDeclaration : WorkflowTransportAddressDeclaration
A GraphQL query against a named target ("$type": "graphql").
WorkflowGraphqlAddressDeclaration() constructor
public WorkflowGraphqlAddressDeclaration()
Creates an instance of WorkflowGraphqlAddressDeclaration.
OperationName property
public string? OperationName { get; init; }
The operation to run, for a query document with several.
Query property
public required string Query { get; init; }
The GraphQL query.
Target property
public required string Target { get; init; }
The GraphQL target, as the transport configuration names it.
WorkflowGraphqlRequest record
public sealed record WorkflowGraphqlRequest
A GraphQL query; the host’s GraphQL transport delivers it.
WorkflowGraphqlRequest() constructor
public WorkflowGraphqlRequest()
Creates an instance of WorkflowGraphqlRequest.
OperationName property
public string? OperationName { get; init; }
The operation to run, for a query document with several.
Query property
public required string Query { get; init; }
The GraphQL query.
Target property
public required string Target { get; init; }
The GraphQL target, as the transport configuration names it.
Variables property
public IDictionary<string, object?> Variables { get; init; }
The query variables.
WorkflowGraphqlResponse record
public sealed record WorkflowGraphqlResponse
The answer of the GraphQL transport.
WorkflowGraphqlResponse() constructor
public WorkflowGraphqlResponse()
Creates an instance of WorkflowGraphqlResponse.
Error property
public string? Error { get; init; }
Why the query failed; not set when it succeeded.
JsonPayload property
public string? JsonPayload { get; init; }
The response body, as JSON text.
Succeeded property
public required bool Succeeded { get; init; }
Whether the query succeeded: a success status and no errors array.
WorkflowGroupExpressionDefinition record
public sealed record WorkflowGroupExpressionDefinition : WorkflowExpressionDefinition
A parenthesized expression ("$type": "group").
WorkflowGroupExpressionDefinition() constructor
public WorkflowGroupExpressionDefinition()
Creates an instance of WorkflowGroupExpressionDefinition.
Expression property
public required WorkflowExpressionDefinition Expression { get; init; }
The grouped expression.
WorkflowHttpAddressDeclaration record
public sealed record WorkflowHttpAddressDeclaration : WorkflowTransportAddressDeclaration
A call of a named HTTP target ("$type": "http").
WorkflowHttpAddressDeclaration() constructor
public WorkflowHttpAddressDeclaration()
Creates an instance of WorkflowHttpAddressDeclaration.
Method property
public string Method { get; init; }
The HTTP method; POST by default.
Path property
public required string Path { get; init; }
The path.
Target property
public required string Target { get; init; }
The HTTP target, as the transport configuration names it.
WorkflowHttpRequest record
public sealed record WorkflowHttpRequest
A call of a named HTTP target; the host’s HTTP transport delivers it.
WorkflowHttpRequest() constructor
public WorkflowHttpRequest()
Creates an instance of WorkflowHttpRequest.
Method property
public string Method { get; init; }
The HTTP method; POST by default.
Path property
public required string Path { get; init; }
The path, joined to the target address.
Payload property
public object? Payload { get; init; }
The body, sent as JSON; none when not set.
Target property
public required string Target { get; init; }
The HTTP target, as the transport configuration names it.
WorkflowHttpResponse record
public sealed record WorkflowHttpResponse
The answer of the HTTP transport.
WorkflowHttpResponse() constructor
public WorkflowHttpResponse()
Creates an instance of WorkflowHttpResponse.
Error property
public string? Error { get; init; }
Why the call failed; not set when it succeeded.
JsonPayload property
public string? JsonPayload { get; init; }
The response body, as JSON text.
StatusCode property
public int? StatusCode { get; init; }
The status the target answered with, when it answered.
Succeeded property
public required bool Succeeded { get; init; }
Whether the call succeeded.
WorkflowInstanceGetRequest record
public sealed record WorkflowInstanceGetRequest
Looks up one instance (GET /api/workflow/instances/{id}).
WorkflowInstanceGetRequest() constructor
public WorkflowInstanceGetRequest()
Creates an instance of WorkflowInstanceGetRequest.
ActorId property
public string? ActorId { get; init; }
The acting user. The HTTP endpoints set it from the authenticated caller.
ActorRoles property
public IReadOnlyCollection<string> ActorRoles { get; init; }
The roles of the acting user. The HTTP endpoints set them from the authenticated caller.
WorkflowInstanceId property
public required string WorkflowInstanceId { get; init; }
The workflow instance identifier.
WorkflowInstanceGetResponse record
public sealed record WorkflowInstanceGetResponse
One instance with its state, tasks, task events and runtime state.
WorkflowInstanceGetResponse() constructor
public WorkflowInstanceGetResponse()
Creates an instance of WorkflowInstanceGetResponse.
Instance property
public required WorkflowInstanceSummary Instance { get; init; }
The instance summary.
RuntimeState property
public WorkflowRuntimeStateSummary? RuntimeState { get; init; }
The state the runtime provider keeps for the instance.
TaskEvents property
public IReadOnlyCollection<WorkflowTaskEventSummary> TaskEvents { get; init; }
The task events of the instance.
Tasks property
public IReadOnlyCollection<WorkflowTaskSummary> Tasks { get; init; }
The tasks of the instance; their allowed actions are the caller’s.
WorkflowState property
public IDictionary<string, object?> WorkflowState { get; init; }
The current workflow state.
WorkflowInstanceProjectionDetails record
public sealed record WorkflowInstanceProjectionDetails
A workflow instance with its state, tasks and task events.
WorkflowInstanceProjectionDetails() constructor
public WorkflowInstanceProjectionDetails()
Creates an instance of WorkflowInstanceProjectionDetails.
Instance property
public required WorkflowInstanceSummary Instance { get; init; }
The instance.
TaskEvents property
public IReadOnlyCollection<WorkflowTaskEventSummary> TaskEvents { get; init; }
The events of its tasks.
Tasks property
public IReadOnlyCollection<WorkflowTaskSummary> Tasks { get; init; }
Its tasks.
WorkflowState property
public IDictionary<string, object?> WorkflowState { get; init; }
Its state.
WorkflowInstanceSummary record
public sealed record WorkflowInstanceSummary
A workflow instance in a list or a lookup.
WorkflowInstanceSummary() constructor
public WorkflowInstanceSummary()
Creates an instance of WorkflowInstanceSummary.
ActiveTask property
public WorkflowTaskSummary? ActiveTask { get; init; }
The first open (non-completed) task for this instance, if any.
BusinessReference property
public WorkflowBusinessReference? BusinessReference { get; init; }
The business reference of the instance: its key and parts.
CompletedOnUtc property
public DateTime? CompletedOnUtc { get; init; }
When the instance completed, in UTC; not set while it is open.
CreatedOnUtc property
public DateTime CreatedOnUtc { get; init; }
When the instance started, in UTC.
RuntimeInstanceId property
public string? RuntimeInstanceId { get; init; }
The identifier of the instance in its runtime provider.
RuntimeProvider property
public string? RuntimeProvider { get; init; }
The runtime provider that runs the instance.
RuntimeStatus property
public string? RuntimeStatus { get; init; }
The status the runtime provider reports.
Status property
public string Status { get; init; }
The instance status: Open, Completed or Stale.
WorkflowInstanceId property
public required string WorkflowInstanceId { get; init; }
The workflow instance identifier.
WorkflowName property
public required string WorkflowName { get; init; }
The workflow name.
WorkflowState property
public IDictionary<string, object?> WorkflowState { get; init; }
Current workflow state variables. Empty when not requested or unavailable.
WorkflowVersion property
public required string WorkflowVersion { get; init; }
The workflow version.
WorkflowInstancesGetRequest record
public sealed record WorkflowInstancesGetRequest
The filters, paging and sort of an instance list (GET /api/workflow/instances).
WorkflowInstancesGetRequest() constructor
public WorkflowInstancesGetRequest()
Creates an instance of WorkflowInstancesGetRequest.
BusinessReferenceKey property
public string? BusinessReferenceKey { get; init; }
Lists only instances with this business key.
BusinessReferenceParts property
public IDictionary<string, object?> BusinessReferenceParts { get; init; }
Lists only instances whose business reference has these parts.
Filters property
public IReadOnlyCollection<object>? Filters { get; init; }
A client-side table filter collection that a request body may carry. The server ignores it and filters only by the named properties above; the property exists so that such a body is accepted.
IncludeDetails property
public bool IncludeDetails { get; init; }
When true, populate ActiveTask and WorkflowState on each instance summary.
Page property
public int Page { get; init; }
Pagination (1-based) alternative that matches the UI table payload convention. When both are > 0 the server derives Skip = (Page - 1) * PageSize and Take = PageSize, taking precedence over explicit Skip/Take.
PageSize property
public int PageSize { get; init; }
See WorkflowInstancesGetRequest.Page.
Skip property
public int Skip { get; init; }
Pagination: rows to skip. 0 = start from beginning.
SortModel property
public WorkflowSortModel? SortModel { get; init; }
Optional sort. SortBy is whitelisted per-endpoint — for instances the allowed values are “workflowInstanceId”, “workflowName”, “workflowVersion”, “status”, “createdOnUtc”, “completedOnUtc”, “businessReferenceKey”. Null sorts by createdOnUtc desc by default.
Status property
public string? Status { get; init; }
Lists only instances with this status: Open, Completed or Stale.
Take property
public int Take { get; init; }
Pagination: max rows to return. 0 = use server default cap.
WorkflowInstanceId property
public string? WorkflowInstanceId { get; init; }
Filter by a single workflow instance ID.
WorkflowInstanceIds property
public IReadOnlyCollection<string> WorkflowInstanceIds { get; init; }
Filter by multiple workflow instance IDs.
WorkflowName property
public string? WorkflowName { get; init; }
Lists only instances of this workflow.
WorkflowVersion property
public string? WorkflowVersion { get; init; }
Lists only instances of this version.
WorkflowInstancesGetResponse record
public sealed record WorkflowInstancesGetResponse
A page of instances and the total number that match the filters.
WorkflowInstancesGetResponse() constructor
public WorkflowInstancesGetResponse()
Creates an instance of WorkflowInstancesGetResponse.
Instances property
public IReadOnlyCollection<WorkflowInstanceSummary> Instances { get; init; }
The instances of the requested page.
TotalCount property
public int TotalCount { get; init; }
Total number of rows matching the filter (pre-pagination).
WorkflowLicenceNotice record
public sealed record WorkflowLicenceNotice
The licence notice the engine shows: “Licensed to” the licensee of the licence line whose entry covers the running version, or the message of the notice case. The fields of the notice of the Router’s licence health output, with the permission, version scope and effective date of an embedded line.
WorkflowLicenceNotice() constructor
public WorkflowLicenceNotice()
Creates an instance of WorkflowLicenceNotice.
Case property
public required string Case { get; init; }
licensed-to, no-licence-file, no-file-loaded, records-not-assessed or no-covering-record.
CoversVersionsPublishedBefore property
public string? CoversVersionsPublishedBefore { get; init; }
The release-date scope of the deciding standard-capacity entry (yyyy-MM-dd); for the no-covering-record case, the latest cutoff of the loaded entries; otherwise null.
EffectiveDate property
public string? EffectiveDate { get; init; }
The effective date of a deciding embedded line (yyyy-MM-dd); otherwise null.
LicenceFilesNotInForce property
public required int LicenceFilesNotInForce { get; init; }
The licence files that were read and are not in force.
LicensedCapacity property
public int? LicensedCapacity { get; init; }
The capacity of the deciding entry, in Designated Workflows; null unless licensed-to, and null for an embedded line, which records unlimited capacity.
Licensee property
public string? Licensee { get; init; }
The licensee display name of the deciding licence line; null unless WorkflowLicenceNotice.Caseis licensed-to.
Permission property
public string? Permission { get; init; }
The permission of the deciding line, standard-capacity or embedded; null unless licensed-to. For an embedded line the notice describes the recorded permission and does not certify that the use is within it.
RecordsInForce property
public required int RecordsInForce { get; init; }
The licence records (serials) in force.
Text property
public required string Text { get; init; }
The one-line notice, as the log line writes it (fields separated by |).
VersionScope property
public string? VersionScope { get; init; }
The version scope of a deciding embedded line, delivered-without-cutoff; otherwise null.
WorkflowLicenceStatus record
public sealed record WorkflowLicenceStatus
The licence status of one licence evaluation: the status name, its factual message and the licence-status explanation that accompanies the messages. The status describes the licence records the local reader can see; it refuses nothing and is not a compliance determination.
WorkflowLicenceStatus() constructor
public WorkflowLicenceStatus()
Creates an instance of WorkflowLicenceStatus.
Explanation property
public required string Explanation { get; init; }
The licence-status explanation that accompanies the messages.
Message property
public required string Message { get; init; }
The factual message of the status.
Status property
public required string Status { get; init; }
within-free-limit, above-notice-level, record-matches, count-exceeds-recorded-capacity, embedded-scope-not-established, development-build, no-matching-record or count-unavailable.
Warns property
public required bool Warns { get; init; }
true for a status the engine logs as a warning at startup and hourly (every status but within-free-limit and record-matches).
WorkflowMapStepDeclaration record
public sealed record WorkflowMapStepDeclaration : WorkflowStepDeclaration
Runs its body once per item of a collection, with bounded concurrency and a deterministic fan-in ("$type": "map"). A map needs the durable stores and services.
WorkflowMapStepDeclaration() constructor
public WorkflowMapStepDeclaration()
Creates an instance of WorkflowMapStepDeclaration.
Body property
public WorkflowStepSequenceDeclaration Body { get; init; }
The steps that run for each item.
CollectionExpression property
public required WorkflowExpressionDefinition CollectionExpression { get; init; }
The collection to map over.
DeadlineSeconds property
public int? DeadlineSeconds { get; init; }
The deadline of the map in seconds.
FailurePolicy property
public string FailurePolicy { get; init; }
What a failed item does: FAIL_FAST (the default), COLLECT_PARTIAL or ROUTE_MANUAL.
FanInPolicy property
public string FanInPolicy { get; init; }
When the map completes: ALL_SUCCEEDED (the default), COLLECT_ALL or MIN_SUCCEEDED.
GlobalActivityClass property
public string? GlobalActivityClass { get; init; }
A class of activities whose concurrency is limited across all maps.
ItemKeyExpression property
public required WorkflowExpressionDefinition ItemKeyExpression { get; init; }
The key of an item, evaluated with the item in the state.
ItemResultExpression property
public required WorkflowExpressionDefinition ItemResultExpression { get; init; }
The result of an item, evaluated after its body.
ItemStateKey property
public required string ItemStateKey { get; init; }
The state key that holds the current item.
MaxAggregateStateBytes property
public required int MaxAggregateStateBytes { get; init; }
The size limit of the collected results, in bytes.
MaxConcurrency property
public required int MaxConcurrency { get; init; }
The items in flight at once; at most WorkflowMapStepDeclaration.MaxItemsand WorkflowRuntime:MaxMapConcurrency.
MaxItems property
public required int MaxItems { get; init; }
The items allowed in the collection; at most WorkflowRuntime:MaxMapItems.
MinimumSucceeded property
public int? MinimumSucceeded { get; init; }
The items that must succeed under MIN_SUCCEEDED.
ResultKey property
public string? ResultKey { get; init; }
The key the collected results are kept under.
RetryPolicy property
public WorkflowRetryPolicyDeclaration RetryPolicy { get; init; }
The retry policy of an item.
StepName property
public required string StepName { get; init; }
The step name, shown in diagrams.
WorkflowModuleInfo record
public sealed record WorkflowModuleInfo
A function module installed in the engine.
WorkflowModuleInfo() constructor
public WorkflowModuleInfo()
Creates an instance of WorkflowModuleInfo.
ModuleName property
public required string ModuleName { get; init; }
The module name.
Version property
public required string Version { get; init; }
The module version.
WorkflowNamedExpressionDefinition record
public sealed record WorkflowNamedExpressionDefinition
A named expression: an object property or a business reference part.
WorkflowNamedExpressionDefinition() constructor
public WorkflowNamedExpressionDefinition()
Creates an instance of WorkflowNamedExpressionDefinition.
Expression property
public required WorkflowExpressionDefinition Expression { get; init; }
The expression.
Name property
public required string Name { get; init; }
The name.
WorkflowNullExpressionDefinition record
public sealed record WorkflowNullExpressionDefinition : WorkflowExpressionDefinition
The null value ("$type": "null").
WorkflowNullExpressionDefinition() constructor
public WorkflowNullExpressionDefinition()
Creates an instance of WorkflowNullExpressionDefinition.
WorkflowNumberExpressionDefinition record
public sealed record WorkflowNumberExpressionDefinition : WorkflowExpressionDefinition
A number literal ("$type": "number"); arithmetic is decimal.
WorkflowNumberExpressionDefinition() constructor
public WorkflowNumberExpressionDefinition()
Creates an instance of WorkflowNumberExpressionDefinition.
Value property
public required string Value { get; init; }
The number, as invariant decimal text.
WorkflowObjectExpressionDefinition record
public sealed record WorkflowObjectExpressionDefinition : WorkflowExpressionDefinition
An object built from named expressions ("$type": "object").
WorkflowObjectExpressionDefinition() constructor
public WorkflowObjectExpressionDefinition()
Creates an instance of WorkflowObjectExpressionDefinition.
Properties property
public IReadOnlyCollection<WorkflowNamedExpressionDefinition> Properties { get; init; }
The properties.
WorkflowOpenBusinessKeySlot class
public static class WorkflowOpenBusinessKeySlot
Rules of the open-business-key slot (StartWorkflowDeduplication.OpenBusinessKey).
AlreadyOpenCode constant
public const string AlreadyOpenCode = "WORKFLOW_BUSINESS_KEY_ALREADY_OPEN"
Safe code of a start the store refused because another start of the same workflow and business key holds the slot, when the store could not return that instance itself.
Marker constant
public const string Marker = "OpenBusinessKey"
The stored marker of an instance started with StartWorkflowDeduplication.OpenBusinessKey.
OpenStatus constant
public const string OpenStatus = "Open"
The instance status that holds the slot.
WorkflowPathExpressionDefinition record
public sealed record WorkflowPathExpressionDefinition : WorkflowExpressionDefinition
Reads a value by path ("$type": "path").
WorkflowPathExpressionDefinition() constructor
public WorkflowPathExpressionDefinition()
Creates an instance of WorkflowPathExpressionDefinition.
Path property
public required string Path { get; init; }
The dotted path. Its root is start (the start request), state, payload (the payload being handled), result (the kept step results) or businessReference; another root reads null.
WorkflowRabbitAddressDeclaration record
public sealed record WorkflowRabbitAddressDeclaration : WorkflowTransportAddressDeclaration
A RabbitMQ exchange and routing key ("$type": "rabbit").
WorkflowRabbitAddressDeclaration() constructor
public WorkflowRabbitAddressDeclaration()
Creates an instance of WorkflowRabbitAddressDeclaration.
Command property
public WorkflowRabbitCommandDeclaration? Command { get; init; }
Command-style request and response semantics, for a peer that dispatches on a command name and answers on a reply queue. Absent for a plain publish.
Exchange property
public required string Exchange { get; init; }
The exchange.
RoutingKey property
public required string RoutingKey { get; init; }
The routing key.
WorkflowRabbitCommandDeclaration record
public sealed record WorkflowRabbitCommandDeclaration
The command-style semantics of a rabbit call: the command name the peer dispatches on, how the message frames it, and whether the call waits for a correlated reply. Header and field names, the reply queue and the timeout are transport configuration, not part of a definition.
WorkflowRabbitCommandDeclaration() constructor
public WorkflowRabbitCommandDeclaration()
Creates an instance of WorkflowRabbitCommandDeclaration.
ExpectReply property
public bool ExpectReply { get; init; }
Whether the call waits for the correlated reply; true by default.
Framing property
public WorkflowRabbitCommandFraming Framing { get; init; }
How the message carries the command name; WorkflowRabbitCommandFraming.Envelopeby default.
Name property
public required string Name { get; init; }
The command name the peer dispatches on.
WorkflowRabbitCommandFraming enum
public enum WorkflowRabbitCommandFraming
How a command-style rabbit message carries the command name and the payload.
| Value | Description |
|---|---|
Envelope = 0 | The body is an envelope that holds the command name and the payload. |
Header = 1 | The body is the bare payload; the command name travels in a message header. |
WorkflowRabbitRequest record
public sealed record WorkflowRabbitRequest
A RabbitMQ call; the host’s RabbitMQ transport delivers it.
WorkflowRabbitRequest() constructor
public WorkflowRabbitRequest()
Creates an instance of WorkflowRabbitRequest.
Command property
public WorkflowRabbitCommandDeclaration? Command { get; init; }
The command-style semantics of the call, when the address declares them.
Exchange property
public required string Exchange { get; init; }
The exchange to publish to.
Payload property
public object? Payload { get; init; }
The message body.
RoutingKey property
public required string RoutingKey { get; init; }
The routing key.
WorkflowRabbitResponse record
public sealed record WorkflowRabbitResponse
The answer of the RabbitMQ transport.
WorkflowRabbitResponse() constructor
public WorkflowRabbitResponse()
Creates an instance of WorkflowRabbitResponse.
Error property
public string? Error { get; init; }
Why the call failed; not set when it succeeded.
Payload property
public object? Payload { get; init; }
The reply body of a command that expects a reply.
Succeeded property
public required bool Succeeded { get; init; }
Whether the call succeeded.
WorkflowRenderEdgeView record
public sealed record WorkflowRenderEdgeView
An edge of a definition diagram.
WorkflowRenderEdgeView() constructor
public WorkflowRenderEdgeView()
Creates an instance of WorkflowRenderEdgeView.
Id property
public required string Id { get; init; }
The edge identifier.
Kind property
public string? Kind { get; init; }
The edge kind.
Label property
public string? Label { get; init; }
The label.
SourceNodeId property
public required string SourceNodeId { get; init; }
The source node.
SourcePortId property
public string? SourcePortId { get; init; }
The source port, when the edge leaves a port.
TargetNodeId property
public required string TargetNodeId { get; init; }
The target node.
TargetPortId property
public string? TargetPortId { get; init; }
The target port, when the edge enters a port.
WorkflowRenderGraphGetRequest record
public sealed record WorkflowRenderGraphGetRequest
Reads the render graph of a definition, for drawing it on the client.
WorkflowRenderGraphGetRequest() constructor
public WorkflowRenderGraphGetRequest()
Creates an instance of WorkflowRenderGraphGetRequest.
IncludeSvg property
public bool IncludeSvg { get; init; }
When true, also emits a server-rendered SVG (via StellaOps ElkSharp layout + SVG renderer).
Version property
public string? Version { get; init; }
The version; when not set, the code-registered definition, or else the active stored version.
WorkflowName property
public required string WorkflowName { get; init; }
The workflow name.
WorkflowRenderGraphGetResponse record
public sealed record WorkflowRenderGraphGetResponse
The render graph of a definition.
WorkflowRenderGraphGetResponse() constructor
public WorkflowRenderGraphGetResponse()
Creates an instance of WorkflowRenderGraphGetResponse.
Graph property
public required WorkflowRenderGraphView Graph { get; init; }
The render graph.
Source property
public string Source { get; init; }
“catalog” when compiled from a code-registered workflow, “store” when compiled from the persistent import store.
Svg property
public string? Svg { get; init; }
Server-rendered SVG when the request asked for IncludeSvg = true. Null otherwise.
SvgLayoutProvider property
public string? SvgLayoutProvider { get; init; }
Layout provider that produced the SVG (e.g. “ElkSharp”). Null when Svg is null.
Version property
public required string Version { get; init; }
The version.
WorkflowName property
public required string WorkflowName { get; init; }
The workflow name.
WorkflowRenderGraphView record
public sealed record WorkflowRenderGraphView
The nodes and edges of a definition diagram.
WorkflowRenderGraphView() constructor
public WorkflowRenderGraphView()
Creates an instance of WorkflowRenderGraphView.
Edges property
public required IReadOnlyCollection<WorkflowRenderEdgeView> Edges { get; init; }
The edges.
Id property
public required string Id { get; init; }
The graph identifier.
Nodes property
public required IReadOnlyCollection<WorkflowRenderNodeView> Nodes { get; init; }
The nodes.
WorkflowRenderNodeView record
public sealed record WorkflowRenderNodeView
A node of a definition diagram.
WorkflowRenderNodeView() constructor
public WorkflowRenderNodeView()
Creates an instance of WorkflowRenderNodeView.
Height property
public double Height { get; init; }
The node height.
IconKey property
public string? IconKey { get; init; }
The icon of the node, such as task or decision.
Id property
public required string Id { get; init; }
The node identifier.
Kind property
public required string Kind { get; init; }
The node kind, such as Start, End, HumanTask, TransportCall or Decision.
Label property
public required string Label { get; init; }
The label.
ParentNodeId property
public string? ParentNodeId { get; init; }
The node that contains this one, when it is nested.
Ports property
public IReadOnlyCollection<WorkflowRenderPortView> Ports { get; init; }
The ports of the node.
Route property
public string? Route { get; init; }
The route of a human task node.
SemanticKey property
public string? SemanticKey { get; init; }
The name of what the node stands for, such as the task or step name.
SemanticType property
public string? SemanticType { get; init; }
What the node stands for, such as Task or Decision.
TaskType property
public string? TaskType { get; init; }
The task type of a human task node.
Width property
public double Width { get; init; }
The node width.
WorkflowRenderPortView record
public sealed record WorkflowRenderPortView
A port of a diagram node.
WorkflowRenderPortView() constructor
public WorkflowRenderPortView()
Creates an instance of WorkflowRenderPortView.
Height property
public double Height { get; init; }
The port height.
Id property
public required string Id { get; init; }
The port identifier.
Side property
public string? Side { get; init; }
The side of the node the port is on.
Width property
public double Width { get; init; }
The port width.
WorkflowRenderingRequest record
public sealed record WorkflowRenderingRequest
Reads the stored rendering of a definition in one format.
WorkflowRenderingRequest() constructor
public WorkflowRenderingRequest()
Creates an instance of WorkflowRenderingRequest.
Format property
public string Format { get; init; }
Output format: “svg”, “png”, or “json” (render graph).
Version property
public string? Version { get; init; }
Specific version. Null = active version.
WorkflowName property
public required string WorkflowName { get; init; }
Workflow name to render.
WorkflowRenderingResponse record
public sealed record WorkflowRenderingResponse
The stored rendering of a definition in one format.
WorkflowRenderingResponse() constructor
public WorkflowRenderingResponse()
Creates an instance of WorkflowRenderingResponse.
ContentBase64 property
public string? ContentBase64 { get; init; }
Rendered content as base64.
ContentType property
public string? ContentType { get; init; }
MIME type: image/svg+xml, image/png, or application/json.
Format property
public required string Format { get; init; }
The format: svg, png or json.
Version property
public required string Version { get; init; }
The version.
WorkflowName property
public required string WorkflowName { get; init; }
The workflow name.
WorkflowRepeatStepDeclaration record
public sealed record WorkflowRepeatStepDeclaration : WorkflowStepDeclaration
Runs its body while a condition holds, at most a number of times ("$type": "repeat").
WorkflowRepeatStepDeclaration() constructor
public WorkflowRepeatStepDeclaration()
Creates an instance of WorkflowRepeatStepDeclaration.
Body property
public WorkflowStepSequenceDeclaration Body { get; init; }
The steps of one iteration.
ContinueWhileExpression property
public WorkflowExpressionDefinition? ContinueWhileExpression { get; init; }
The condition to run another iteration, evaluated before each one.
IterationStateKey property
public string? IterationStateKey { get; init; }
The state key that holds the iteration number; not kept when not set.
MaxIterationsExpression property
public required WorkflowExpressionDefinition MaxIterationsExpression { get; init; }
The maximum number of iterations.
StepName property
public required string StepName { get; init; }
The step name, shown in diagrams.
WorkflowRequestContractDeclaration record
public sealed record WorkflowRequestContractDeclaration
The contract of a workflow start request.
WorkflowRequestContractDeclaration() constructor
public WorkflowRequestContractDeclaration()
Creates an instance of WorkflowRequestContractDeclaration.
AllowAdditionalProperties property
public bool AllowAdditionalProperties { get; init; }
Whether the start request may carry properties the schema does not declare; true by default.
ContractName property
public string? ContractName { get; init; }
CLR type name of the start request. Retained for backward compatibility but not used for canonical portability — use WorkflowRequestContractDeclaration.Schemainstead.
Schema property
public IDictionary<string, object?>? Schema { get; init; }
JSON Schema describing the start request shape. This is the portable, CLR-independent contract definition for the workflow’s input.
SchemaReference property
public string? SchemaReference { get; init; }
A reference to the schema, as an alternative to WorkflowRequestContractDeclaration.Schema.
WorkflowRequiredModuleDeclaration record
public sealed record WorkflowRequiredModuleDeclaration
A function module a workflow needs.
WorkflowRequiredModuleDeclaration() constructor
public WorkflowRequiredModuleDeclaration()
Creates an instance of WorkflowRequiredModuleDeclaration.
ModuleName property
public required string ModuleName { get; init; }
The module name.
Optional property
public bool Optional { get; init; }
Whether the workflow can be imported without the module. A missing required module refuses the import.
VersionExpression property
public string VersionExpression { get; init; }
The versions accepted, such as >=1.0.0 (the default).
WorkflowRetentionRunRequest record
public sealed record WorkflowRetentionRunRequest
Runs the instance retention once: marks stale instances and tasks, and purges those past their purge date.
WorkflowRetentionRunRequest() constructor
public WorkflowRetentionRunRequest()
Creates an instance of WorkflowRetentionRunRequest.
CompletedOlderThanDays property
public int? CompletedOlderThanDays { get; init; }
Optional. When set, purges completed/cancelled instances whose CompletedOnUtc is older than this many days — bypasses the pre-computed PurgeAfterUtc on the projection.
ReferenceUtc property
public DateTime? ReferenceUtc { get; init; }
The time the retention dates are compared with, in UTC; now when not set.
RunningOlderThanDays property
public int? RunningOlderThanDays { get; init; }
Optional. When set, marks running (Open) instances whose CreatedOnUtc is older than this many days as stale AND purges them (along with any already-stale rows of the same age) — bypasses the pre-computed StaleAfterUtc / PurgeAfterUtc on the projection.
WorkflowRetentionRunResponse record
public sealed record WorkflowRetentionRunResponse
The counts of a retention run.
WorkflowRetentionRunResponse() constructor
public WorkflowRetentionRunResponse()
Creates an instance of WorkflowRetentionRunResponse.
ExecutedOnUtc property
public required DateTime ExecutedOnUtc { get; init; }
The reference time of the run, in UTC.
PurgedInstances property
public required int PurgedInstances { get; init; }
The instances purged.
PurgedRuntimeStates property
public required int PurgedRuntimeStates { get; init; }
The runtime states purged.
PurgedTaskEvents property
public required int PurgedTaskEvents { get; init; }
The task events purged.
PurgedTasks property
public required int PurgedTasks { get; init; }
The tasks purged.
StaleInstancesMarked property
public required int StaleInstancesMarked { get; init; }
The instances marked stale.
StaleTasksMarked property
public required int StaleTasksMarked { get; init; }
The tasks marked stale.
WorkflowRetryPolicyDeclaration record
public sealed record WorkflowRetryPolicyDeclaration
How failed map items are retried.
WorkflowRetryPolicyDeclaration() constructor
public WorkflowRetryPolicyDeclaration()
Creates an instance of WorkflowRetryPolicyDeclaration.
AttemptTimeoutSeconds property
public int? AttemptTimeoutSeconds { get; init; }
The timeout of one attempt, in seconds.
BackoffKind property
public string BackoffKind { get; init; }
How the delay grows: FIXED (the default), EXPONENTIAL or PROVIDER_HINT.
InitialDelaySeconds property
public int InitialDelaySeconds { get; init; }
The first delay, in seconds.
JitterPercent property
public int JitterPercent { get; init; }
How much the delay varies, in percent.
MaxSemanticAttempts property
public int MaxSemanticAttempts { get; init; }
The attempts allowed, the first included; 1 (no retry) by default.
MaximumDelaySeconds property
public int MaximumDelaySeconds { get; init; }
The delay cap, in seconds; none when 0.
MaximumProviderHintSeconds property
public int MaximumProviderHintSeconds { get; init; }
The cap of a provider-requested delay, in seconds; positive for PROVIDER_HINT.
RetryableCategories property
public IReadOnlyCollection<string> RetryableCategories { get; init; }
The failure categories that are retried.
ReuseBinding property
public bool ReuseBinding { get; init; }
Whether a retry keeps the binding of the previous attempt; true by default.
WorkflowRuntimeStateSummary record
public sealed record WorkflowRuntimeStateSummary
The state a runtime provider keeps for an instance.
WorkflowRuntimeStateSummary() constructor
public WorkflowRuntimeStateSummary()
Creates an instance of WorkflowRuntimeStateSummary.
BusinessReference property
public WorkflowBusinessReference? BusinessReference { get; init; }
The business reference of the instance: its key and parts.
CompletedOnUtc property
public DateTime? CompletedOnUtc { get; init; }
When the instance completed, in UTC.
CreatedOnUtc property
public DateTime CreatedOnUtc { get; init; }
When the runtime state was created, in UTC.
LastUpdatedOnUtc property
public DateTime LastUpdatedOnUtc { get; init; }
When the runtime state last changed, in UTC.
PurgeAfterUtc property
public DateTime? PurgeAfterUtc { get; init; }
When the retention job purges the completed instance, in UTC.
RuntimeInstanceId property
public required string RuntimeInstanceId { get; init; }
The identifier of the instance in its runtime provider.
RuntimeProvider property
public required string RuntimeProvider { get; init; }
The runtime provider that runs the instance.
RuntimeStatus property
public required string RuntimeStatus { get; init; }
The status the runtime provider reports.
StaleAfterUtc property
public DateTime? StaleAfterUtc { get; init; }
When the retention job marks the open instance stale, in UTC.
State property
public IDictionary<string, object?> State { get; init; }
The provider’s state of the instance.
WorkflowServiceMetadata record
public sealed record WorkflowServiceMetadata
What a workflow service offers to tools.
WorkflowServiceMetadata() constructor
public WorkflowServiceMetadata()
Creates an instance of WorkflowServiceMetadata.
DiagramProvider property
public required string DiagramProvider { get; init; }
The diagram layout provider, such as ElkSharp.
ServiceName property
public required string ServiceName { get; init; }
The service name.
SupportsCanonicalImportValidation property
public bool SupportsCanonicalImportValidation { get; init; }
Whether the service validates canonical definitions before an import.
SupportsCanonicalSchemaInspection property
public bool SupportsCanonicalSchemaInspection { get; init; }
Whether the service serves the canonical definition schema.
SupportsDefinitionInspection property
public required bool SupportsDefinitionInspection { get; init; }
Whether the service serves definitions for inspection.
SupportsInstanceInspection property
public required bool SupportsInstanceInspection { get; init; }
Whether the service serves instances for inspection.
WorkflowServiceMetadataGetResponse record
public sealed record WorkflowServiceMetadataGetResponse
The metadata of the workflow service.
WorkflowServiceMetadataGetResponse() constructor
public WorkflowServiceMetadataGetResponse()
Creates an instance of WorkflowServiceMetadataGetResponse.
Metadata property
public required WorkflowServiceMetadata Metadata { get; init; }
The service metadata.
WorkflowSetStateStepDeclaration record
public sealed record WorkflowSetStateStepDeclaration : WorkflowStepDeclaration
Sets a state value ("$type": "set-state").
WorkflowSetStateStepDeclaration() constructor
public WorkflowSetStateStepDeclaration()
Creates an instance of WorkflowSetStateStepDeclaration.
OnlyIfPresent property
public bool OnlyIfPresent { get; init; }
Whether to set the value only when it is set: not null and not an empty or white-space string.
StateKey property
public required string StateKey { get; init; }
The state key.
ValueExpression property
public required WorkflowExpressionDefinition ValueExpression { get; init; }
The value.
WorkflowSignalDeadLetterMessage record
public sealed record WorkflowSignalDeadLetterMessage
A dead-lettered signal.
WorkflowSignalDeadLetterMessage() constructor
public WorkflowSignalDeadLetterMessage()
Creates an instance of WorkflowSignalDeadLetterMessage.
Correlation property
public string? Correlation { get; init; }
The correlation of the queue message: the signal id.
DeliveryCount property
public int DeliveryCount { get; init; }
How many times the signal was delivered before it was dead-lettered.
DueAtUtc property
public DateTime? DueAtUtc { get; init; }
When the signal was due, in UTC.
EnqueuedOnUtc property
public DateTime? EnqueuedOnUtc { get; init; }
When the message was queued, in UTC.
ExpectedVersion property
public long? ExpectedVersion { get; init; }
The runtime-state version the signal was raised against.
IsEnvelopeReadable property
public bool IsEnvelopeReadable { get; init; }
Whether the signal envelope could be read.
OccurredAtUtc property
public DateTime? OccurredAtUtc { get; init; }
When the signal was raised, in UTC.
Payload property
public IReadOnlyDictionary<string, JsonElement> Payload { get; init; }
The signal payload.
RawPayloadBase64 property
public string? RawPayloadBase64 { get; init; }
The raw message, base64-encoded, when the request asked for it.
ReadError property
public string? ReadError { get; init; }
Why the envelope could not be read.
RuntimeProvider property
public string? RuntimeProvider { get; init; }
The runtime provider of the instance.
SignalId property
public string? SignalId { get; init; }
The signal.
SignalType property
public string? SignalType { get; init; }
The signal type.
WaitingToken property
public string? WaitingToken { get; init; }
The wait the signal resumes, when it targets one.
WorkflowInstanceId property
public string? WorkflowInstanceId { get; init; }
The instance the signal is for.
WorkflowSignalDeadLetterReplayRequest record
public sealed record WorkflowSignalDeadLetterReplayRequest
Puts a dead-lettered signal back on the signal queue.
WorkflowSignalDeadLetterReplayRequest() constructor
public WorkflowSignalDeadLetterReplayRequest()
Creates an instance of WorkflowSignalDeadLetterReplayRequest.
SignalId property
public required string SignalId { get; init; }
The dead-lettered signal.
WorkflowSignalDeadLetterReplayResponse record
public sealed record WorkflowSignalDeadLetterReplayResponse
The outcome of a dead letter replay.
WorkflowSignalDeadLetterReplayResponse() constructor
public WorkflowSignalDeadLetterReplayResponse()
Creates an instance of WorkflowSignalDeadLetterReplayResponse.
Replayed property
public bool Replayed { get; init; }
Whether the signal was put back; false when no such dead letter exists.
SignalId property
public required string SignalId { get; init; }
The signal.
SignalType property
public string? SignalType { get; init; }
The signal type.
WasEnvelopeReadable property
public bool WasEnvelopeReadable { get; init; }
Whether the signal envelope could be read.
WorkflowInstanceId property
public string? WorkflowInstanceId { get; init; }
The instance the signal is for.
WorkflowSignalDeadLettersGetRequest record
public sealed record WorkflowSignalDeadLettersGetRequest
Lists the dead-lettered signals.
WorkflowSignalDeadLettersGetRequest() constructor
public WorkflowSignalDeadLettersGetRequest()
Creates an instance of WorkflowSignalDeadLettersGetRequest.
Filters property
public IReadOnlyCollection<object>? Filters { get; init; }
A client-side table filter collection that a request body may carry. The server ignores it and filters only by SignalId, WorkflowInstanceId and SignalType above; the property exists so that such a body is accepted.
IncludeRawPayload property
public bool IncludeRawPayload { get; init; }
Whether to return the raw message, base64-encoded.
MaxMessages property
public int MaxMessages { get; init; }
Hard safety cap on how many messages the underlying driver is allowed to materialise before paging is applied. Clamped to 500. Kept separate from WorkflowSignalDeadLettersGetRequest.Takeso a slow driver is never asked for an unbounded result set.
Page property
public int Page { get; init; }
Pagination (1-based) alternative that matches the UI table payload convention. When both are > 0 the server derives Skip = (Page - 1) * PageSize and Take = PageSize, taking precedence over explicit Skip/Take.
PageSize property
public int PageSize { get; init; }
See WorkflowSignalDeadLettersGetRequest.Page.
SignalId property
public string? SignalId { get; init; }
A signal filter.
SignalType property
public string? SignalType { get; init; }
A signal type filter.
Skip property
public int Skip { get; init; }
Pagination: rows to skip. 0 = start from beginning.
SortModel property
public WorkflowSortModel? SortModel { get; init; }
Optional sort. SortBy is whitelisted — allowed values are “signalId”, “workflowInstanceId”, “signalType”, “enqueuedOnUtc”, “deliveryCount”. Null sorts by enqueuedOnUtc desc.
Take property
public int Take { get; init; }
Pagination: max rows to return. 0 = use WorkflowSignalDeadLettersGetRequest.MaxMessagesas the effective cap.
WorkflowInstanceId property
public string? WorkflowInstanceId { get; init; }
An instance filter.
WorkflowSignalDeadLettersGetResponse record
public sealed record WorkflowSignalDeadLettersGetResponse
A page of dead-lettered signals.
WorkflowSignalDeadLettersGetResponse() constructor
public WorkflowSignalDeadLettersGetResponse()
Creates an instance of WorkflowSignalDeadLettersGetResponse.
Messages property
public IReadOnlyCollection<WorkflowSignalDeadLetterMessage> Messages { get; init; }
The dead letters of the page.
TotalCount property
public int TotalCount { get; init; }
Total number of rows matching the filter (pre-pagination).
WorkflowSignalPumpLastEvent record
public sealed record WorkflowSignalPumpLastEvent
One signal pump event.
WorkflowSignalPumpLastEvent() constructor
public WorkflowSignalPumpLastEvent()
Creates an instance of WorkflowSignalPumpLastEvent.
ConsumerName property
public required string ConsumerName { get; init; }
The consumer.
DeliveryCount property
public int DeliveryCount { get; init; }
The delivery attempt.
DurationMs property
public long DurationMs { get; init; }
How long the delivery took, in milliseconds.
Message property
public string? Message { get; init; }
The error message, for a failure or a dead letter.
OccurredOnUtc property
public DateTime OccurredOnUtc { get; init; }
When it happened, in UTC.
SignalId property
public string? SignalId { get; init; }
The signal.
SignalType property
public string? SignalType { get; init; }
The signal type.
WorkflowInstanceId property
public string? WorkflowInstanceId { get; init; }
The instance.
WorkflowSignalPumpStats record
public sealed record WorkflowSignalPumpStats
The counts of the signal pump of this process since it started.
WorkflowSignalPumpStats() constructor
public WorkflowSignalPumpStats()
Creates an instance of WorkflowSignalPumpStats.
ConcurrencySkipCount property
public long ConcurrencySkipCount { get; init; }
The deliveries put back because the instance kept changing under them.
DeadLetterCount property
public required long DeadLetterCount { get; init; }
The signals dead-lettered.
EmptyPollCount property
public required long EmptyPollCount { get; init; }
The polls that found no signal.
FailureCount property
public required long FailureCount { get; init; }
The failed deliveries.
LastActivityOnUtc property
public DateTime? LastActivityOnUtc { get; init; }
When the pump last did anything, in UTC.
LastDeadLetter property
public WorkflowSignalPumpLastEvent? LastDeadLetter { get; init; }
The last dead-lettered signal.
LastDeadLetterOnUtc property
public DateTime? LastDeadLetterOnUtc { get; init; }
When a signal was last dead-lettered, in UTC.
LastFailure property
public WorkflowSignalPumpLastEvent? LastFailure { get; init; }
The last failed delivery.
LastFailureOnUtc property
public DateTime? LastFailureOnUtc { get; init; }
When a delivery last failed, in UTC.
LastSuccess property
public WorkflowSignalPumpLastEvent? LastSuccess { get; init; }
The last processed signal.
LastSuccessOnUtc property
public DateTime? LastSuccessOnUtc { get; init; }
When a signal was last processed, in UTC.
ProcessedCount property
public required long ProcessedCount { get; init; }
The signals processed.
SignalsByType property
public IReadOnlyCollection<WorkflowSignalPumpStatsSignalType> SignalsByType { get; init; }
The counts by signal type.
StartedOnUtc property
public required DateTime StartedOnUtc { get; init; }
When the counting started, in UTC.
WorkflowSignalPumpStatsGetResponse record
public sealed record WorkflowSignalPumpStatsGetResponse
The signal pump counts of this process.
WorkflowSignalPumpStatsGetResponse() constructor
public WorkflowSignalPumpStatsGetResponse()
Creates an instance of WorkflowSignalPumpStatsGetResponse.
Stats property
public required WorkflowSignalPumpStats Stats { get; init; }
The signal pump counts.
WorkflowSignalPumpStatsSignalType record
public sealed record WorkflowSignalPumpStatsSignalType
The signal pump counts of one signal type.
WorkflowSignalPumpStatsSignalType() constructor
public WorkflowSignalPumpStatsSignalType()
Creates an instance of WorkflowSignalPumpStatsSignalType.
ConcurrencySkipCount property
public long ConcurrencySkipCount { get; init; }
The deliveries put back because the instance kept changing under them.
DeadLetterCount property
public required long DeadLetterCount { get; init; }
The signals dead-lettered.
FailureCount property
public required long FailureCount { get; init; }
The failed deliveries.
ProcessedCount property
public required long ProcessedCount { get; init; }
The signals processed.
SignalType property
public required string SignalType { get; init; }
The signal type.
WorkflowSignalRaiseRequest record
public sealed record WorkflowSignalRaiseRequest
Raises a signal for a waiting instance (POST /api/workflow/signals/raise).
WorkflowSignalRaiseRequest() constructor
public WorkflowSignalRaiseRequest()
Creates an instance of WorkflowSignalRaiseRequest.
Payload property
public IDictionary<string, object?> Payload { get; init; }
The signal’s payload; the waiting step keeps it under its result key.
SignalName property
public string? SignalName { get; init; }
The signal name the instance waits for; without it, the signal goes to the instance’s first wait for an external signal.
WaitingToken property
public string? WaitingToken { get; init; }
The token of a specific wait.
WorkflowInstanceId property
public required string WorkflowInstanceId { get; init; }
The waiting instance.
WorkflowSignalRaiseResponse record
public sealed record WorkflowSignalRaiseResponse
The answer to a raised signal.
WorkflowSignalRaiseResponse() constructor
public WorkflowSignalRaiseResponse()
Creates an instance of WorkflowSignalRaiseResponse.
Queued property
public required bool Queued { get; init; }
Whether the signal was queued.
SignalId property
public required string SignalId { get; init; }
The queued signal.
WorkflowInstanceId property
public required string WorkflowInstanceId { get; init; }
The instance.
WorkflowSortModel record
public sealed record WorkflowSortModel
Server-side sort request for list endpoints. WorkflowSortModel.Propis matched against a per-endpoint whitelist on the server; unknown values are rejected with a validation error rather than silently ignored, so typos and client/server drift surface early.
WorkflowSortModel() constructor
public WorkflowSortModel()
Creates an instance of WorkflowSortModel.
Direction property
public string Direction { get; init; }
“asc” or “desc”. Defaults to ascending.
Prop property
public required string Prop { get; init; }
Whitelisted column identifier (e.g. “createdOnUtc”, “workflowName”).
WorkflowSourceFormatDiagnosticDto record
public sealed record WorkflowSourceFormatDiagnosticDto
A finding of a source format conversion.
WorkflowSourceFormatDiagnosticDto() constructor
public WorkflowSourceFormatDiagnosticDto()
Creates an instance of WorkflowSourceFormatDiagnosticDto.
Code property
public required string Code { get; init; }
The diagnostic code.
Location property
public string? Location { get; init; }
Where in the source, when known.
Message property
public required string Message { get; init; }
The message.
Severity property
public required string Severity { get; init; }
The severity, such as Error.
WorkflowStartDeclaration record
public sealed record WorkflowStartDeclaration
What happens when a workflow instance starts.
WorkflowStartDeclaration() constructor
public WorkflowStartDeclaration()
Creates an instance of WorkflowStartDeclaration.
InitialSequence property
public WorkflowStepSequenceDeclaration InitialSequence { get; init; }
The first steps of an instance.
InitialTaskName property
public string? InitialTaskName { get; init; }
A task to open when an instance starts.
InitializeStateExpression property
public required WorkflowExpressionDefinition InitializeStateExpression { get; init; }
The initial state: an object expression; start.* paths read the start request.
WorkflowStepDeclaration record
public abstract record WorkflowStepDeclaration
A step of a canonical definition. The $type property names the step kind.
WorkflowStepDeclaration() constructor
protected WorkflowStepDeclaration()
Creates an instance of WorkflowStepDeclaration.
WorkflowStepSequenceDeclaration record
public sealed record WorkflowStepSequenceDeclaration
A sequence of steps.
WorkflowStepSequenceDeclaration() constructor
public WorkflowStepSequenceDeclaration()
Creates an instance of WorkflowStepSequenceDeclaration.
Steps property
public IReadOnlyCollection<WorkflowStepDeclaration> Steps { get; init; }
The steps, run in order.
WorkflowStringExpressionDefinition record
public sealed record WorkflowStringExpressionDefinition : WorkflowExpressionDefinition
A string literal ("$type": "string").
WorkflowStringExpressionDefinition() constructor
public WorkflowStringExpressionDefinition()
Creates an instance of WorkflowStringExpressionDefinition.
Value property
public required string Value { get; init; }
The value.
WorkflowSubWorkflowStepDeclaration record
public sealed record WorkflowSubWorkflowStepDeclaration : WorkflowStepDeclaration
Runs another workflow as a child and waits for it ("$type": "sub-workflow").
WorkflowSubWorkflowStepDeclaration() constructor
public WorkflowSubWorkflowStepDeclaration()
Creates an instance of WorkflowSubWorkflowStepDeclaration.
Invocation property
public required WorkflowWorkflowInvocationDeclaration Invocation { get; init; }
The child workflow to run.
ResultKey property
public string? ResultKey { get; init; }
The key the child’s result is kept under.
StepName property
public required string StepName { get; init; }
The step name, shown in diagrams and in result.lastFailure.
WhenFailure property
public WorkflowStepSequenceDeclaration? WhenFailure { get; init; }
Optional branch run when the child workflow fails or ends in a status other than completed; it reads the failure as result.lastFailure. An empty branch ignores the failure and continues; a missing one leaves it unhandled. Declared last and omitted when null, so definitions without it are unchanged.
WorkflowSupportedFormatDescriptor record
public sealed record WorkflowSupportedFormatDescriptor
A source format of workflow definitions.
WorkflowSupportedFormatDescriptor() constructor
public WorkflowSupportedFormatDescriptor()
Creates an instance of WorkflowSupportedFormatDescriptor.
ContentType property
public required string ContentType { get; init; }
The media type.
DisplayName property
public required string DisplayName { get; init; }
The display name.
FileExtension property
public required string FileExtension { get; init; }
The file extension.
FormatId property
public required string FormatId { get; init; }
The format id, such as canonical-json, canonical-yaml or canonical-bundle.
IsBinary property
public bool IsBinary { get; init; }
Whether the content is binary.
SupportsExport property
public bool SupportsExport { get; init; }
Whether definitions can be exported to the format.
SupportsImport property
public bool SupportsImport { get; init; }
Whether definitions can be imported from the format.
WorkflowSupportedFormatsGetRequest record
public sealed record WorkflowSupportedFormatsGetRequest
Lists the source formats the server converts.
WorkflowSupportedFormatsGetRequest() constructor
public WorkflowSupportedFormatsGetRequest()
Creates an instance of WorkflowSupportedFormatsGetRequest.
WorkflowSupportedFormatsGetResponse record
public sealed record WorkflowSupportedFormatsGetResponse
The source formats the server converts.
WorkflowSupportedFormatsGetResponse() constructor
public WorkflowSupportedFormatsGetResponse()
Creates an instance of WorkflowSupportedFormatsGetResponse.
Formats property
public required IReadOnlyCollection<WorkflowSupportedFormatDescriptor> Formats { get; init; }
The formats.
WorkflowTaskAssignRequest record
public sealed record WorkflowTaskAssignRequest
Assigns a task to a user or to roles (POST /api/workflow/tasks/{id}/assign). Assigning to another user or to roles needs an administrator role.
WorkflowTaskAssignRequest() constructor
public WorkflowTaskAssignRequest()
Creates an instance of WorkflowTaskAssignRequest.
ActorId property
public required string ActorId { get; init; }
The acting user. The HTTP endpoints set it from the authenticated caller.
ActorRoles property
public IReadOnlyCollection<string> ActorRoles { get; init; }
The roles of the acting user. The HTTP endpoints set them from the authenticated caller.
TargetRoles property
public IReadOnlyCollection<string> TargetRoles { get; init; }
Roles to assign the task to instead of a user.
TargetUserId property
public string? TargetUserId { get; init; }
The user to assign the task to; the acting user when not set.
WorkflowTaskId property
public required string WorkflowTaskId { get; init; }
The task identifier.
WorkflowTaskAssignResponse record
public sealed record WorkflowTaskAssignResponse
The result of a task assignment.
WorkflowTaskAssignResponse() constructor
public WorkflowTaskAssignResponse()
Creates an instance of WorkflowTaskAssignResponse.
Assignee property
public required string? Assignee { get; init; }
The assigned user, when the task is assigned to a user.
EffectiveRoles property
public IReadOnlyCollection<string> EffectiveRoles { get; init; }
The roles that may work the task after the assignment.
RuntimeRoles property
public IReadOnlyCollection<string> RuntimeRoles { get; init; }
The task’s runtime roles after the assignment.
Status property
public required string Status { get; init; }
The task status after the assignment.
WorkflowTaskId property
public required string WorkflowTaskId { get; init; }
The task identifier.
WorkflowTaskCompleteRequest record
public sealed record WorkflowTaskCompleteRequest
Completes a task as the acting user (POST /api/workflow/tasks/{id}/complete).
WorkflowTaskCompleteRequest() constructor
public WorkflowTaskCompleteRequest()
Creates an instance of WorkflowTaskCompleteRequest.
ActorId property
public required string ActorId { get; init; }
The acting user. The HTTP endpoints set it from the authenticated caller.
ActorRoles property
public IReadOnlyCollection<string> ActorRoles { get; init; }
The roles of the acting user. The HTTP endpoints set them from the authenticated caller.
Payload property
public IDictionary<string, object?> Payload { get; init; }
The answer to the task; the task’s completion steps read it as payload.*.
WorkflowTaskId property
public required string WorkflowTaskId { get; init; }
The task identifier.
WorkflowTaskCompleteResponse record
public sealed record WorkflowTaskCompleteResponse
The result of a task completion.
WorkflowTaskCompleteResponse() constructor
public WorkflowTaskCompleteResponse()
Creates an instance of WorkflowTaskCompleteResponse.
Completed property
public required bool Completed { get; init; }
Whether the task was completed.
NextTasks property
public IReadOnlyCollection<WorkflowTaskSummary> NextTasks { get; init; }
The tasks the completion opened.
WorkflowInstanceId property
public string? WorkflowInstanceId { get; init; }
The instance the task belongs to.
WorkflowState property
public IDictionary<string, object?> WorkflowState { get; init; }
The workflow state after the operation.
WorkflowTaskId property
public required string WorkflowTaskId { get; init; }
The task identifier.
WorkflowTaskDeclaration record
public sealed record WorkflowTaskDeclaration
A human task a workflow declares, which an activate-task step opens.
WorkflowTaskDeclaration() constructor
public WorkflowTaskDeclaration()
Creates an instance of WorkflowTaskDeclaration.
OnComplete property
public WorkflowStepSequenceDeclaration OnComplete { get; init; }
The steps that run when a user completes the task.
OnTimeout property
public WorkflowStepSequenceDeclaration? OnTimeout { get; init; }
Runs when the task is still open at its timeout: the engine closes the task as expired and continues with this sequence instead of WorkflowTaskDeclaration.OnComplete(a BPMN interrupting timer). Requires WorkflowTaskDeclaration.TimeoutSeconds.
PayloadExpression property
public required WorkflowExpressionDefinition PayloadExpression { get; init; }
The payload the task carries to its client.
RouteExpression property
public required WorkflowExpressionDefinition RouteExpression { get; init; }
The route of the task.
SingleOpenSlot property
public string? SingleOpenSlot { get; init; }
Optional single-open slot: while a task of the same execution that holds this slot is open or assigned, the projection store refuses to open another one (WorkflowTaskSingleOpenSlot.AlreadyOpenCode). Declared after WorkflowTaskDeclaration.OnTimeoutand omitted when null, so definitions without it are unchanged.
TaskName property
public required string TaskName { get; init; }
The task name.
TaskRoles property
public IReadOnlyCollection<string> TaskRoles { get; init; }
The roles that may work the task; the workflow roles when empty.
TaskType property
public required string TaskType { get; init; }
The task type: the form a client shows.
TimeoutSeconds property
public int? TimeoutSeconds { get; init; }
Optional timeout for the human task in seconds, counted from its activation. Without WorkflowTaskDeclaration.OnTimeoutit only sets the task’s deadline.
WorkflowTaskDescriptor record
public sealed record WorkflowTaskDescriptor
A human task a workflow definition declares.
WorkflowTaskDescriptor() constructor
public WorkflowTaskDescriptor()
Creates an instance of WorkflowTaskDescriptor.
Route property
public required string Route { get; init; }
The route of the task.
TaskName property
public required string TaskName { get; init; }
The task name.
TaskRoles property
public IReadOnlyCollection<string> TaskRoles { get; init; }
The roles that may work on the task.
TaskType property
public required string TaskType { get; init; }
The task type: the form a client shows.
WorkflowTaskEventSummary record
public sealed record WorkflowTaskEventSummary
One event in the history of a task, for example its assignment or completion.
WorkflowTaskEventSummary() constructor
public WorkflowTaskEventSummary()
Creates an instance of WorkflowTaskEventSummary.
ActorId property
public string? ActorId { get; init; }
The user who caused the event, when one did.
CreatedOnUtc property
public DateTime CreatedOnUtc { get; init; }
When the event happened, in UTC.
EventType property
public required string EventType { get; init; }
What happened to the task.
Payload property
public IDictionary<string, object?> Payload { get; init; }
The data of the event.
TaskName property
public string? TaskName { get; init; }
The task name.
WorkflowTaskId property
public required string WorkflowTaskId { get; init; }
The task identifier.
WorkflowTaskGetRequest record
public sealed record WorkflowTaskGetRequest
Looks up one task (GET /api/workflow/tasks/{id}).
WorkflowTaskGetRequest() constructor
public WorkflowTaskGetRequest()
Creates an instance of WorkflowTaskGetRequest.
ActorId property
public string? ActorId { get; init; }
The acting user. The HTTP endpoints set it from the authenticated caller.
ActorRoles property
public IReadOnlyCollection<string> ActorRoles { get; init; }
The roles of the acting user. The HTTP endpoints set them from the authenticated caller.
WorkflowTaskId property
public required string WorkflowTaskId { get; init; }
The task identifier.
WorkflowTaskGetResponse record
public sealed record WorkflowTaskGetResponse
One task.
WorkflowTaskGetResponse() constructor
public WorkflowTaskGetResponse()
Creates an instance of WorkflowTaskGetResponse.
Task property
public required WorkflowTaskSummary Task { get; init; }
The task summary.
WorkflowTaskReleaseRequest record
public sealed record WorkflowTaskReleaseRequest
Releases an assigned task (POST /api/workflow/tasks/{id}/release). Only the assignee or an administrator may release a task.
WorkflowTaskReleaseRequest() constructor
public WorkflowTaskReleaseRequest()
Creates an instance of WorkflowTaskReleaseRequest.
ActorId property
public required string ActorId { get; init; }
The acting user. The HTTP endpoints set it from the authenticated caller.
ActorRoles property
public IReadOnlyCollection<string> ActorRoles { get; init; }
The roles of the acting user. The HTTP endpoints set them from the authenticated caller.
WorkflowTaskId property
public required string WorkflowTaskId { get; init; }
The task identifier.
WorkflowTaskReleaseResponse record
public sealed record WorkflowTaskReleaseResponse
The result of a task release.
WorkflowTaskReleaseResponse() constructor
public WorkflowTaskReleaseResponse()
Creates an instance of WorkflowTaskReleaseResponse.
Released property
public required bool Released { get; init; }
Whether the task was released.
WorkflowTaskId property
public required string WorkflowTaskId { get; init; }
The task identifier.
WorkflowTaskSingleOpenSlot class
public static class WorkflowTaskSingleOpenSlot
Rules of the single-open task slot (WorkflowTaskDeclaration.SingleOpenSlot).
AlreadyOpenCode constant
public const string AlreadyOpenCode = "WORKFLOW_TASK_SLOT_ALREADY_OPEN"
Safe code of a refused task: another task of the execution already holds the slot.
MaxLength constant
public const int MaxLength = 64
The maximum length of a slot.
IsValid(string) method
public static bool IsValid(string? slot)
A slot is an identifier: a letter, then letters, digits, ‘_’, ‘-’ or ‘.’, at most WorkflowTaskSingleOpenSlot.MaxLengthcharacters.
WorkflowTaskSummary record
public sealed record WorkflowTaskSummary
A human task in a list, a lookup or the result of a start or a completion.
WorkflowTaskSummary() constructor
public WorkflowTaskSummary()
Creates an instance of WorkflowTaskSummary.
AllowedActions property
public IReadOnlyCollection<string> AllowedActions { get; init; }
The actions the caller may take on the task.
Assignee property
public string? Assignee { get; init; }
The user the task is assigned to; not set while it is unassigned.
BusinessReference property
public WorkflowBusinessReference? BusinessReference { get; init; }
The business reference of the instance: its key and parts.
CompletedOnUtc property
public DateTime? CompletedOnUtc { get; init; }
When the task was completed, in UTC.
CreatedOnUtc property
public DateTime CreatedOnUtc { get; init; }
When the task was opened, in UTC.
DeadlineUtc property
public DateTime? DeadlineUtc { get; init; }
The deadline by which the task should be completed. Computed as CreatedOnUtc + TimeoutSeconds from the task declaration. Null means no deadline — the task runs indefinitely until completed or purged by retention.
EffectiveRoles property
public IReadOnlyCollection<string> EffectiveRoles { get; init; }
The roles that may work the task.
Payload property
public IDictionary<string, object?> Payload { get; init; }
The data the task shows.
PurgeAfterUtc property
public DateTime? PurgeAfterUtc { get; init; }
When the retention job purges the task, in UTC.
Route property
public required string Route { get; init; }
The route of the task.
RuntimeRoles property
public IReadOnlyCollection<string> RuntimeRoles { get; init; }
The roles computed when the task was opened; they replace the task roles.
StaleAfterUtc property
public DateTime? StaleAfterUtc { get; init; }
When the retention job marks the open task stale, in UTC.
Status property
public string Status { get; init; }
The task status: Open, Assigned, Completed, Expired, Cancelled or Stale.
TaskName property
public required string TaskName { get; init; }
The task name, as declared in the workflow.
TaskRoles property
public IReadOnlyCollection<string> TaskRoles { get; init; }
The roles the task declares; they replace the workflow roles.
TaskType property
public required string TaskType { get; init; }
The task type: the form a client shows.
WorkflowInstanceId property
public required string WorkflowInstanceId { get; init; }
The instance the task belongs to.
WorkflowName property
public required string WorkflowName { get; init; }
The workflow name.
WorkflowRoles property
public IReadOnlyCollection<string> WorkflowRoles { get; init; }
The roles of the workflow.
WorkflowTaskId property
public required string WorkflowTaskId { get; init; }
The task identifier.
WorkflowVersion property
public required string WorkflowVersion { get; init; }
The workflow version.
WorkflowTasksGetRequest record
public sealed record WorkflowTasksGetRequest
The filters, paging and sort of a task list (GET /api/workflow/tasks).
WorkflowTasksGetRequest() constructor
public WorkflowTasksGetRequest()
Creates an instance of WorkflowTasksGetRequest.
ActorId property
public string? ActorId { get; init; }
The acting user. The HTTP endpoints set it from the authenticated caller. The allowed actions are computed for this user; the filters decide which tasks are listed.
ActorRoles property
public IReadOnlyCollection<string> ActorRoles { get; init; }
The roles of the acting user. The HTTP endpoints set them from the authenticated caller.
Assignee property
public string? Assignee { get; init; }
Lists only tasks assigned to this user.
BusinessReferenceKey property
public string? BusinessReferenceKey { get; init; }
Lists only tasks with this business key.
BusinessReferenceParts property
public IDictionary<string, object?> BusinessReferenceParts { get; init; }
Lists only tasks whose business reference has these parts.
CandidateRoles property
public IReadOnlyCollection<string> CandidateRoles { get; init; }
Lists only tasks whose effective roles include one of these roles, ignoring case.
Filters property
public IReadOnlyCollection<object>? Filters { get; init; }
A client-side table filter collection that a request body may carry. The server ignores it and filters only by the named properties above; the property exists so that such a body is accepted.
Page property
public int Page { get; init; }
Pagination (1-based) alternative that matches the UI table payload convention. When both are > 0 the server derives Skip = (Page - 1) * PageSize and Take = PageSize, taking precedence over explicit Skip/Take.
PageSize property
public int PageSize { get; init; }
See WorkflowTasksGetRequest.Page.
Skip property
public int Skip { get; init; }
Pagination: rows to skip. 0 = start from beginning.
SortModel property
public WorkflowSortModel? SortModel { get; init; }
Optional sort. SortBy is whitelisted per-endpoint — for tasks the allowed values are “workflowTaskId”, “taskName”, “workflowName”, “workflowVersion”, “status”, “assignee”, “createdOnUtc”, “completedOnUtc”, “deadlineUtc”. Null sorts by createdOnUtc desc by default.
Status property
public string? Status { get; init; }
Lists only tasks with this status.
Take property
public int Take { get; init; }
Pagination: max rows to return. 0 = use server default cap.
WorkflowInstanceId property
public string? WorkflowInstanceId { get; init; }
Lists only tasks of this instance.
WorkflowName property
public string? WorkflowName { get; init; }
Lists only tasks of this workflow.
WorkflowVersion property
public string? WorkflowVersion { get; init; }
Lists only tasks of this version.
WorkflowTasksGetResponse record
public sealed record WorkflowTasksGetResponse
A page of tasks and the total number that match the filters.
WorkflowTasksGetResponse() constructor
public WorkflowTasksGetResponse()
Creates an instance of WorkflowTasksGetResponse.
Tasks property
public IReadOnlyCollection<WorkflowTaskSummary> Tasks { get; init; }
The tasks of the requested page.
TotalCount property
public int TotalCount { get; init; }
Total number of rows matching the filter (pre-pagination).
WorkflowTerminateForkStepDeclaration record
public sealed record WorkflowTerminateForkStepDeclaration : WorkflowStepDeclaration
Ends the fork whose branch reaches it (a BPMN terminate end event inside a parallel subprocess): tasks still open in the other branches are cancelled, their waits are dropped, and the flow continues after the fork.
WorkflowTerminateForkStepDeclaration() constructor
public WorkflowTerminateForkStepDeclaration()
Creates an instance of WorkflowTerminateForkStepDeclaration.
WorkflowTimelineResource record
public sealed record WorkflowTimelineResource
A page of the history events of a workflow execution.
Parameters
Disposition:OK, orCURSOR_COMPACTEDwhen the events after the requested sequence were compacted away; the page is then empty.HistoryFloorSequence: The first history sequence still kept.SnapshotSequence: The last history sequence when the page was read.Events: The events.
WorkflowTimelineResource(string, long, long, IReadOnlyList<object>) constructor
public WorkflowTimelineResource(string Disposition, long HistoryFloorSequence, long SnapshotSequence, IReadOnlyList<object> Events)
A page of the history events of a workflow execution.
Parameters
Disposition:OK, orCURSOR_COMPACTEDwhen the events after the requested sequence were compacted away; the page is then empty.HistoryFloorSequence: The first history sequence still kept.SnapshotSequence: The last history sequence when the page was read.Events: The events.
Disposition property
public string Disposition { get; init; }
OK, or CURSOR_COMPACTED when the events after the requested sequence were compacted away; the page is then empty.
Events property
public IReadOnlyList<object> Events { get; init; }
The events.
HistoryFloorSequence property
public long HistoryFloorSequence { get; init; }
The first history sequence still kept.
SnapshotSequence property
public long SnapshotSequence { get; init; }
The last history sequence when the page was read.
WorkflowTimerStepDeclaration record
public sealed record WorkflowTimerStepDeclaration : WorkflowStepDeclaration
Pauses the instance for a delay; the host process can restart in between ("$type": "timer").
WorkflowTimerStepDeclaration() constructor
public WorkflowTimerStepDeclaration()
Creates an instance of WorkflowTimerStepDeclaration.
DelayExpression property
public required WorkflowExpressionDefinition DelayExpression { get; init; }
The delay: a number of milliseconds, a string of digits (also milliseconds), or a time-span string in the invariant c format such as 00:01:00; a negative delay is zero.
StepName property
public required string StepName { get; init; }
The step name, shown in diagrams.
WorkflowTransportAddressDeclaration record
public abstract record WorkflowTransportAddressDeclaration
The address of a transport call. The canonical kinds are exactly endpoint, rabbit, graphql and http.
WorkflowTransportAddressDeclaration() constructor
protected WorkflowTransportAddressDeclaration()
Creates an instance of WorkflowTransportAddressDeclaration.
Alias property
public string? Alias { get; init; }
A name for the address, shown in diagrams.
WorkflowTransportCallStepDeclaration record
public sealed record WorkflowTransportCallStepDeclaration : WorkflowStepDeclaration
Calls a service over a transport ("$type": "call-transport").
WorkflowTransportCallStepDeclaration() constructor
public WorkflowTransportCallStepDeclaration()
Creates an instance of WorkflowTransportCallStepDeclaration.
Invocation property
public required WorkflowTransportInvocationDeclaration Invocation { get; init; }
The address and payload of the call.
ResultKey property
public string? ResultKey { get; init; }
The key the response is kept under.
StepName property
public required string StepName { get; init; }
The step name, shown in diagrams and in result.lastFailure.
TimeoutSeconds property
public int? TimeoutSeconds { get; init; }
Optional per-step timeout in seconds. Overrides the transport-level default. When null, the default timeout (1 hour) is used.
WhenFailure property
public WorkflowStepSequenceDeclaration? WhenFailure { get; init; }
The steps to run when the call fails.
WhenTimeout property
public WorkflowStepSequenceDeclaration? WhenTimeout { get; init; }
The steps to run when the call times out.
WorkflowTransportInvocationDeclaration record
public sealed record WorkflowTransportInvocationDeclaration
The address and payload of a transport call.
WorkflowTransportInvocationDeclaration() constructor
public WorkflowTransportInvocationDeclaration()
Creates an instance of WorkflowTransportInvocationDeclaration.
Address property
public required WorkflowTransportAddressDeclaration Address { get; init; }
The address.
PayloadExpression property
public WorkflowExpressionDefinition? PayloadExpression { get; init; }
The payload; none when not set.
WorkflowUnaryExpressionDefinition record
public sealed record WorkflowUnaryExpressionDefinition : WorkflowExpressionDefinition
A unary operation ("$type": "unary").
WorkflowUnaryExpressionDefinition() constructor
public WorkflowUnaryExpressionDefinition()
Creates an instance of WorkflowUnaryExpressionDefinition.
Operand property
public required WorkflowExpressionDefinition Operand { get; init; }
The operand.
Operator property
public required string Operator { get; init; }
The operator: not, the only unary operator; names are case-sensitive.
WorkflowWorkflowInvocationDeclaration record
public sealed record WorkflowWorkflowInvocationDeclaration
Which workflow a step starts, with what payload and business reference.
WorkflowWorkflowInvocationDeclaration() constructor
public WorkflowWorkflowInvocationDeclaration()
Creates an instance of WorkflowWorkflowInvocationDeclaration.
BusinessReference property
public WorkflowBusinessReferenceDeclaration? BusinessReference { get; init; }
The business reference of the new instance; none when not set.
PayloadExpression property
public WorkflowExpressionDefinition? PayloadExpression { get; init; }
The start payload; none when not set.
WorkflowNameExpression property
public required WorkflowExpressionDefinition WorkflowNameExpression { get; init; }
The workflow to run.
WorkflowVersionExpression property
public WorkflowExpressionDefinition? WorkflowVersionExpression { get; init; }
Its version; the latest when not set.
StellaOps.Workflow.Contracts.Constants namespace
| Type | Kind | Description |
|---|---|---|
ConstantsClass | class | The string values of the map, retention, outbox and retry settings and states. |
ConstantsClass.DurableOutboxStates | class | Delivery state of a durable outbox message: appended READY, marked PUBLISHED once sent. |
ConstantsClass.MapItemStates | class | The states of a map item. |
ConstantsClass.MapPolicies | class | The fan-in and failure policies of a map step. |
ConstantsClass.MapStates | class | The states of a map execution. |
ConstantsClass.RetentionPolicies | class | Per-instance retention: STANDARD follows the stale/purge schedule; HOLD_ALL keeps history and rows. |
ConstantsClass.RetryBackoffKinds | class | How the delay between retries grows. |
ConstantsClass class
public static class ConstantsClass
The string values of the map, retention, outbox and retry settings and states.
ConstantsClass.DurableOutboxStates class
public static class DurableOutboxStates
Delivery state of a durable outbox message: appended READY, marked PUBLISHED once sent.
Published constant
public const string Published = "PUBLISHED"
Sent.
Ready constant
public const string Ready = "READY"
Appended, not yet sent.
ConstantsClass.MapItemStates class
public static class MapItemStates
The states of a map item.
Claimed constant
public const string Claimed = "CLAIMED"
Claimed by a worker and running.
Failed constant
public const string Failed = "FAILED"
Failed.
Partial constant
public const string Partial = "PARTIAL"
Completed partially; counts as succeeded for the fan-in.
Ready constant
public const string Ready = "READY"
Not started.
Skipped constant
public const string Skipped = "SKIPPED"
Not started before the map stopped; counts as succeeded for the fan-in.
Succeeded constant
public const string Succeeded = "SUCCEEDED"
Succeeded.
ConstantsClass.MapPolicies class
public static class MapPolicies
The fan-in and failure policies of a map step.
AllSucceeded constant
public const string AllSucceeded = "ALL_SUCCEEDED"
Fan-in: the map completes when every item succeeded.
CollectAll constant
public const string CollectAll = "COLLECT_ALL"
Fan-in: the map completes when every item finished, whatever the outcome.
CollectPartial constant
public const string CollectPartial = "COLLECT_PARTIAL"
Failure: the map waits for every item, then applies its fan-in policy.
FailFast constant
public const string FailFast = "FAIL_FAST"
Failure: the first failed item fails the map.
MinimumSucceeded constant
public const string MinimumSucceeded = "MIN_SUCCEEDED"
Fan-in: the map completes when at least the minimum number of items succeeded.
RouteManual constant
public const string RouteManual = "ROUTE_MANUAL"
Failure: when every item finished and one failed, the map waits for manual handling (ConstantsClass.MapStates.Manual).
ConstantsClass.MapStates class
public static class MapStates
The states of a map execution.
Canceled constant
public const string Canceled = "CANCELED"
The map was canceled.
Completed constant
public const string Completed = "COMPLETED"
The map completed.
Failed constant
public const string Failed = "FAILED"
The map failed.
Manual constant
public const string Manual = "MANUAL"
The map waits for manual handling of its failed items.
Ready constant
public const string Ready = "READY"
Created; no item has started.
Running constant
public const string Running = "RUNNING"
Items are running.
ConstantsClass.RetentionPolicies class
public static class RetentionPolicies
Per-instance retention: STANDARD follows the stale/purge schedule; HOLD_ALL keeps history and rows.
HoldAll constant
public const string HoldAll = "HOLD_ALL"
Keeps the history and rows.
Standard constant
public const string Standard = "STANDARD"
Follows the stale and purge schedule.
ConstantsClass.RetryBackoffKinds class
public static class RetryBackoffKinds
How the delay between retries grows. Every kind is capped by the maximum delay, when one is set, and varied by the jitter.
Exponential constant
public const string Exponential = "EXPONENTIAL"
The delay starts at the initial delay and doubles with each retry.
Fixed constant
public const string Fixed = "FIXED"
Every retry waits the initial delay.
ProviderHint constant
public const string ProviderHint = "PROVIDER_HINT"
The delay the provider asks for, such as a retry-after value, capped by the provider-hint bound; the initial delay when the provider gives none.
