The Instance Entity


Common Methods

These are the most commonly used methods of an Instance.

NameReturn TypeDescription
getIdstringThe unique ID of the Instance
getWorkflowIdstringThe unique ID of the Workflow the Instance was started from
getNamestringThe descriptive name of the Instance
getTeamNamestringThe team name of the Instance
getDescriptionstringA description of the Instance
getCategorystringA descriptive grouping for your Instance
getOwnerstringThe owner of the Instance
getFieldsarrayThe fields containing the data for the Instance
getStatusstringrunning, completed or cancelled
getStartDateDateTimeThe date and time the Instance was started
getEndDateDateTimeThe date and time the Instance was ended
getStepsarrayThe steps of the Instance

Permission and Visibility methods

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

getFieldVisibilitystringThe default visiblity level of fields for the Instance
public, internal, confidential or highlyConfidential
getVisibilitystringThe visbility level of the Instance
open or restricted
getVisibleToUsersarrayThe 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 methods

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

getInstanceIdstringRead-only alias for id.
getCreatedBystringThe email address of the user who started the Instance
ownerstringThe email address of the user who is the primary admin
for the Instance.


Instance($id = null, $workflowId = null, $name = null, $teamName = null, $description = null, $category = null, $owner = null, $createdBy = null, $steps = null, $fields = null, $status = null, $startDate = null, $endDate = null, $fieldVisibility = null, $visibility = null, $visibleToUsers = null)

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.