The Instance Step Entity

InstanceStep

Common Properties

These are the most commonly used properties of an InstanceStep.

NameTypeDescription
idstringThe unique ID of the Instance Step
instanceIdstringThe ID of the Instance the Step belongs to
workflowIdstringThe ID of the Workflow the Step's Instance was started from
namestringThe descriptive name of the Step
descriptionstringA description of the Step, or instructions to be carried out during the Step
assignedTostringThe email of the user or group that the Step is assigned to, if any.

Methods

🚧

Methods not yet implemented

setInput

setInput(name: string, value: any): CompleteStepRequest;

This method supports setting inputs in a chaining style and then passing those to an catalytic.instances.completeInstanceStep() call to complete the InstanceStep with the specified inputs.