The Instance Step Entity

catalytic.sdk.entities.InstanceStep

Common Methods

These are the most commonly used methods of an InstanceStep.

Name	Type	Description
`getId`	`UUID`	The unique ID of the Instance Step
`getInstanceId`	`UUID`	The ID of the Instance Step belongs to
`getWorkflowId`	`UUID`	The ID of the Workflow the Step's Instance was started from
`getName`	`String`	The descriptive name of the Step
`getTeamName`	`String`	The name of the team in which this Instance Step belongs to
`getPosition`	`String`	The position of the Instance Step within the Workflow
`getDescription`	`String`	A description of the Step, or instructions to be carried out during the Step
`getStatus`	`String`	The status of the Instance Step
`getAssignedTo`	`String`	The email of the user or group that the Step is assigned to, if any.
`getStartDate`	`OffsetDateTime`	The timestamp that the Instance Step was started
`getEndDate`	`OffsetDateTime`	The timestamp that the Instance Step was ended
`getOutputFields`	`List<`Field`>`	The list of output Fields from this Instance Step

Constructors

InstanceStep()
InstanceStep(UUID id, UUID instanceId, UUID workflowId, String name, String teamName, Integer position, String description, String status, String assignedTo, OffsetDateTime startDate, OffsetDateTime endDate, List<Field> outputFields)

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.

Updated almost 4 years ago