The Instance Step Entity

Catalytic\SDK\Entities\InstanceStep

Common Methods

These are the most commonly used methods of an InstanceStep.

NameTypeDescription
getIdstringThe unique ID of the Instance Step
getInstanceIdstringThe unique ID of the Instance this step is associated with
getWorkflowIdstringThe ID of the Workflow the Step's Instance was started from
getNamestringThe descriptive name of the Step
getTeamNamestringThe team name this step is associated with
getPositionstringThe position of this step within the Instance
getDescriptionstringA description of the Step, or instructions to be carried out during the Step
getAssignedTostringThe email of the user or group that the Step is assigned to, if any.
getStartDateDateTimeThe date and time the Instance Step was started
getEndDateDateTimeThe 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.