Instance-Linked Actions

Below, we will delve into a series of actions that allow us to understand the state of a form instance, the token assigned to it, the response values obtained, among other aspects.

Get Form Instance State

Returns the state of a form instance, indicating whether it is in draft or confirmed status. It includes the following parameters:

Parameters	Direction	Data Type	Description
formInstanceId	In	Text	ID of the form instance
state	Out	Text	State of the form instance
lastSaved	Out	Text	Date and time of the last save
Response	Out	Collection	Collection containing all the above data of the form instance

Get Form Instance Response

Includes the properties of Get Form Instance State but also allows collecting the data entered in a form instance, displaying them as values. Its properties are as follows:

Parameters	Direction	Data Type	Description
formInstanceId	In	Text	ID of the form instance
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
lastSaved	Out	Text	Date and time of the last save
state	Out	Text	State of the form instance
values	Out	Collection	Values entered in the form instance
Response	Out	Collection	Collection containing all the above data of the form instance

Get Form Instance Token

Allows generating a new public token for a form instance (e.g., because it has expired) by defining the following parameters:

Parameters	Direction	Data Type	Description
formInstanceId	In	Text	ID of the form instance
expiresAt	In	Date and Time	Expiration date of the token
formInstanceId	Out	Text	ID of the form instance, as it will be included in the final output
sharedFormToken	Out	Text	Token that allows viewing and modifying the generated instance
URL	Out	Text	Accessible URL formed by the base URL and the token
Response	Out	Collection	Collection containing all the above data of the form instance

Set Form Instance Process Info

Allows users of the portal or the Teams application to review the status of the forms they have submitted, which is reflected in the "Process Status" and "Completed" columns.

Form status visualization in the Portal

This action is configured with the following parameters:

Parameters	Direction	Data Type	Description
formInstanceId	In	Text	ID of the form instance
status	In	Text	Processing status of the instance to be displayed to the user
endState	In	Text	Final processing status, with options "OK" or "Error"
completionMessage	In	Text	Message specifying the conditions under which the instance was completed

Delete Form Instance

Allows deleting a form instance. Its main properties are:

Parameters	Direction	Data Type	Description
formInstanceId	In	Text	ID of the form instance
force	In	Flag	Forces the deletion of an instance