The Instance Entity


Common Properties

These are the most commonly used properties of an Instance.

idstringThe unique ID of the Instance
workflowIdstringThe 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
fieldsFields[]The fields containing the data for the Instance
stepsInstanceStep[]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 visibility level of fields for this Workflow
public, internal, confidential or highlyConfidential
visibilityInstanceVisibilityThe visbility level of the Instance
open or restricted
visibleToUsersstring[]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_).
createdBystringThe email address of the user who started the Instance
ownerstringThe email address of the user who is the primary admin
for the Instance.