Instance¶

Specifies an instance of a workflow process in the system. Each workflow instance is created for a process and has an initiator work item. Every instance has a unique ID and a sequentially incrementing instance number.

Capabilities¶

Properties¶

• Instance.Case: Gets the related case on which the instance was started.
• Instance.End: Gets the end date of the instance. Returns null if the instance is not completed.
• Instance.Initiator: Gets the initiator identity of the instance.
• Instance.ParentWorkItem: Gets the parent work item.

Context¶

• Instance.Culture: Gets or sets the culture of the instance.
• Instance.Id: Gets the globally unique identifier of the instance.
• Instance.InitiatorWorkItem: Gets the initiator work item.
• Instance.Number: Gets the unique instance number.
• Instance.ProcessId: Gets the ID of the process on which the instance was created.

Lifecycle¶

• Instance.EnhancedSecurity: Gets or sets the enhanced security mode for the instance.
• Instance.Start: Gets the start date of the instance.
• Instance.State: Gets the state of the instance.
• Instance.Terminate: Terminates the instance.

Configuration and Tags¶

• Instance.Priority: Gets or sets the priority of the instance.
• Instance.Tags: Gets or sets the attached tags as a string array.
• Instance.TestMode: Gets a boolean value indicating whether the instance is in test mode.
• Instance.AddTag: Adds a new tag to the instance.
• Instance.RemoveTag: Removes a tag from instance tags.