The Instance Step Entity

Catalytic\SDK\Entities\InstanceStep

Common Methods

These are the most commonly used methods of an InstanceStep.

Name	Type	Description
`getId`	`string`	The unique ID of the Instance Step
`getInstanceId`	`string`	The unique ID of the Instance this step is associated with
`getWorkflowId`	`string`	The ID of the Workflow the Step's Instance was started from
`getName`	`string`	The descriptive name of the Step
`getTeamName`	`string`	The team name this step is associated with
`getPosition`	`string`	The position of this step within the Instance
`getDescription`	`string`	A description of the Step, or instructions to be carried out during the Step
`getAssignedTo`	`string`	The email of the user or group that the Step is assigned to, if any.
`getStartDate`	`DateTime`	The date and time the Instance Step was started
`getEndDate`	`DateTime`	The date and time the Instance Step was ended

Constructors

InstanceStep($id = null, $instanceId = null, $workflowId = null, $name = null, $teamName = null, $position = null, $description = null, $status = null, $assignedTo = null, $startDate = null, $endDate = null, $outputFields = null)

Creates a new instance of the InstanceStep class. Note that this does not create a new step within an Instance on the platform. That is not yet supported in the SDK.

This method supports setting inputs in a chaining style and then passing those to a catalytic->instances()->completeStep() call to complete the task with the specified inputs.