The Instance Entity
Catalytic\SDK\Entities\Instance
Common Methods
These are the most commonly used methods of an Instance
.
Name | Return Type | Description |
---|---|---|
getId | string | The unique ID of the Instance |
getWorkflowId | string | The unique ID of the Workflow the Instance was started from |
getName | string | The descriptive name of the Instance |
getTeamName | string | The team name of the Instance |
getDescription | string | A description of the Instance |
getCategory | string | A descriptive grouping for your Instance |
getOwner | string | The owner of the Instance |
getFields | array | The fields containing the data for the Instance |
getStatus | string | running , completed or cancelled |
getStartDate | DateTime | The date and time the Instance was started |
getEndDate | DateTime | The date and time the Instance was ended |
getSteps | array | The steps of the Instance |
Permission and Visibility methods
These are the methods that determine how users can find, or update an Instance
.
Name | Type | Description |
---|---|---|
getFieldVisibility | string | The default visiblity level of fields for the Instancepublic , internal , confidential or highlyConfidential |
getVisibility | string | The visbility level of the Instanceopen or restricted |
getVisibleToUsers | array | 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 methods
These are less commonly used properties, or properties that are often used only with specific interfaces.
Name | Type | Description |
---|---|---|
getInstanceId | string | Read-only alias for id . |
getCreatedBy | 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($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
.
Updated over 2 years ago