The Instance Entity

Instance

Catalytic.SDK.Entities.Instance

Common Properties

These are the most commonly used properties of an Instance.

Name	Type	Description
`Id`	`Guid`	The unique ID of the Instance
`WorkflowId`	`Guid`	The unique ID of the Workflow the Instance was started from
`Name`	`string`	The descriptive name of the Instance
`Description`	`string`	A description of the Instance
`Category`	`string`	A descriptive grouping for your Instance
`Status`	`InstanceStatus`	`Running`, `Completed` or `Cancelled`
`Fields`	`FieldsCollection`	The fields containing the data for the Instance
`Steps`	`ReferenceableCollection` `<InstanceStep>`	The steps of the Instance

Permission and Visibility Properties

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

Name	Type	Description
`FieldVisibility`	`FieldVisibility`	The default visiblity level of fields for the Instance `Public`, `Internal`, `Confidential` or `HighlyConfidential`
`Visibility`	`InstanceVisibility`	The visbility level of the Instance `Open` or `Restricted`
`VisibleToUsers`	`List<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.

Name	Type	Description
`InstanceId`	`Guid`	Read-only alias for `Id`.
`ReferenceName`	`string`	Read-only alias for `Id`, represented as a `string`. Used when an `Instance` is added to an `ReferenceableCollection<T>`
`CreatedBy`	`string`	The email address of the user who started the Instance
`Owner`	`string`	The email address of the user who is the primary admin for the Instance.

Constructors

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.

Updated about 4 years ago