Stage-Linked Actions
As we saw earlier, workflows are traversed through a series of steps consisting of different forms that must be completed in an orderly manner. Let's take a closer look at the actions associated with configuring their functionality:
Create Stage
Allows you to create a Stage using the following parameters:
formInstanceId
In
Text
ID of the form instance
initialValues
In
Text
JSON object of initial values to load into the Stage
notificationMessage
In
Text
Message sent to users using Teams when the Stage is assigned
userOrGroupAssigned
In
Text
User or group assigned to this instance, defined through a user's email or a Connect group ID
state
In
Text
Collection containing all previous data of the form instance
Get Stage Response
Returns the response of a Stage from a form instance.
formInstanceId
In
Text
ID of the form instance
index
In
Number
Stage from which attachments are obtained
formDefinitionID
Out
Text
ID of the template to which the instance belongs
formInstanceId
Out
Text
ID of the form instance, as it will be included in the final output
id
Out
Text
ID of the Stage
lastSaved
Out
Text
Date and time of the last save of the Stage
values
Out
Collection
Values entered in the Stage
state
Out
Text
State of the Stage in the form instance
stageName
Out
Text
Name of the Stage
Response
Out
Collection
Collection containing all the above data
Update Stage
Allows you to update a pre-existing Stage of a form instance with the following parameters:
formInstanceId
In
Text
ID of the form instance
initialValues
In
Text
JSON object of initial values to load into the Stage
notificationMessage
In
Text
Message sent to users using Teams when the Stage is assigned
userOrGroupAssigned
In
Text
User or group assigned to this instance, defined through a user's email or a Connect group ID
index
In
Number
Stage to be updated
resetValues
In
Flag
Discards previously entered values
Last updated