The Instance Entity


Common Properties

These are the most commonly used properties of an Instance.

NameReturn TypeDescription
getIdUUIDThe unique ID of the Instance
getWorkflowIdUUIDThe unique ID of the Workflow the Instance was started from
getNameStringThe descriptive name of the Instance
getDescriptionStringA description of the Instance
getCategoryStringA descriptive grouping for your Instance
getStatusStringRunning, Completed or Cancelled
getStartDateOffsetDateTimeThe timestamp that the Instance was started
getEndDateOffsetDateTimeThe timestamp that the Instance was ended
getFieldsList<Field>The fields containing the data for the Instance
getStepsList<InstanceStep>The steps of the Instance

Permission and Visibility Properties

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

NameReturn TypeDescription
getFieldVisibilityFieldVisibilityThe default visiblity level of fields for the Instance
Public, Internal, Confidential or HighlyConfidential
getVisibilityInstanceVisibilityThe visbility level of the Instance
Open or Restricted
getVisibleToUsersList<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.

getIinstanceIdUUIDRead-only alias for Id.
getReferenceNameStringRead-only alias for Id, represented as a string
getCreatedByStringThe email address of the user who started the Instance
getOwnerStringThe email address of the user who is the primary admin
for the Instance.


Instance(UUID id, UUID workflowId, String name, String teamName, String description, String category, String owner, String createdBy, List<InstanceStep> steps, List<Field> fields, String status, OffsetDateTime startDate, OffsetDateTime endDate, FieldVisibility fieldVisibility, InstanceVisibility instanceVisibility, List<String> visibleToUsers)

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.start.