Other Actions
In addition to creating and querying instances of a form, there are multiple actions applied to the use of forms that provide additional value and help optimize the workflow.
Let's take a look at some of them below.
Get Form Instance State
Returns the state of a form instance, i.e., whether it is in draft or confirmed state. It includes the following parameters:
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:
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:
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.
This action is configured with the following parameters:
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:
formInstanceId
In
Text
ID of the form instance
force
In
Flag
Forces the deletion of an instance
Get Attachments / Download Attachment
These actions are closely related, as the first allows listing all attachments in the fields of a specific instance, and the second allows downloading all files from the obtained list.
Let's look at the properties of the Get Attachments action:
formInstanceId
In
Text
ID of the form instance
stageIndex
In
Number
Stage from which the attachments are obtained
Attachments
Out
Collection
List of URLs to download the files
On the other hand, the Download Attachment action includes the following parameters:
AttachmentURL
In
Text
URL from which to download the file
Path
In
Number
Path where the downloaded file will be saved
Upload FormInstance Resource / Delete FormInstance Resource
These actions allow, respectively, adding and deleting a resource from a form instance. The type of resources managed this way are not included in the form design but are added as external links with downloadable material:
The properties to define for uploading a new resource are:
formInstanceId
In
Text
URL from which to download the file
Path
In
Number
Path where the file will be attached
To delete it, however, the following must be set:
formInstanceId
In
Text
URL from which to download the file
ResourceName
In
Text
Name of the resource whose attachment is to be deleted
Last updated
