The Instance Entity



Common Properties

These are the most commonly used properties of an Instance.

IdGuidThe unique ID of the Instance
WorkflowIdGuidThe unique ID of the Workflow the Instance was started from
NamestringThe descriptive name of the Instance
DescriptionstringA description of the Instance
CategorystringA descriptive grouping for your Instance
StatusInstanceStatusRunning, Completed or Cancelled
FieldsFieldsCollectionThe fields containing the data for the Instance
The steps of the Instance

Permission and Visibility Properties

These are the properties that determine how users can find, or update an Instance.

FieldVisibilityFieldVisibilityThe default visiblity level of fields for the Instance
Public, Internal, Confidential or HighlyConfidential
VisibilityInstanceVisibilityThe visbility level of the Instance
Open or Restricted
VisibleToUsersList<string>The users or groups who who may view this Instance
Users will be represented by their Email,
groups by their group name (starting with g_).

Other Properties

These are less commonly used properties, or properties that are often used only with specific interfaces.

InstanceIdGuidRead-only alias for Id.
ReferenceNamestringRead-only alias for Id, represented as a string. Used when
an Instance is added to an ReferenceableCollection<T>
CreatedBystringThe email address of the user who started the Instance
OwnerstringThe email address of the user who is the primary admin
for the Instance.



Creates a new instance of the Instance class. Note that this does not create a new, running Instance on the platform. For that, you must instead call Instances.StartInstance.