Skip to main content

WorkflowInstance Properties

An object defining properties for the WorkflowInstance class.

Reasons

Stores a dictionary of reasons associated with the workflow instance, often used for capturing feedback or notes at different workflow stages.

Type: Dictionary<string, string>

See Also

  • //todo

AgentMode

Gets a value indicating whether the workflow instance is in agent mode.

Type: bool


ParentProcessId

Gets or sets the parent process identifier for the workflow instance, if applicable.

Type: long?


ProjectName

Gets the name of the project associated with the workflow instance.

Type: string


DocumentParameters

Gets the document parameters for the workflow instance.

Type: Dictionary<string, object>


Version

Gets or sets the version of the workflow instance. Default value is "latest".

Type: string


FlowSecretKey

Gets the secret key for the workflow flow.

Type: string

See Also

  • SecretKeys todo

ProcessRequestObjectName

Gets or sets the name of the process request object for the workflow instance.

Type: string


Variables

Gets the variables associated with the workflow instance.

Type: Variables


RequestId

Gets the request identifier for the workflow instance, if applicable.

Type: long?


StartingEvent

Gets or sets the starting event for the workflow instance.

Type: Event


DocumentOptions

Gets the list of document options for the workflow instance.

Type: List<StartParametersDocumentOption>


Documents

Gets the documents associated with the workflow instance.

Type: Documents


DeploymentUrl

Gets the deployment URL for the workflow instance.

Type: string


Events

Gets the events associated with the workflow instance.

Type: Events


ProcessId

Gets the process identifier for the workflow instance.

Type: long


FlowName

Gets the name of the flow associated with the workflow instance.

Type: string