POSTFOS,ALL/ExecuteOnSubmitEvents
Arguments
- forminstanceidCharacter
REQUIRED - The form instance id of the form for which you want to fire onSubmit events.
- actionIdCharacter
The id(s) of the action you want to fire. Blank for all actions. Can be a comma delimited list of action ids. Action Id's can be found in the onSubmit events JSON definition.
Returns
- resultJSON Object
Returns an object with these properties:
- errorboolean
true if there was an error.
- errorTextstring
An error message if an error occurred.
- requiredVariablesArray
An array listing one or more required variables that were missing from the request if the request fails.
Description
Fire the onSubmit events (all of the events, or just specified events) for a form instance.
Headers
- Name
- Description
- apikey
REQUIRED - A TransForm API key with the appropriate scopes to access the endpoint. The API Key must have either the EOS or ALL scopes.
Example Request
curl -L -X POST 'https://transform.alphasoftware.com/transformAPIVersion1.a5svc/ExecuteOnSubmitEvents' \
-H 'apiKey: YOUR_API_KEY' \
-H 'Content-Type: application/json' \
--data-raw '{
"forminstanceid":"YOUR_INSTANCE_ID",
"actionId":""
}'Example Responses
Request succeeded:
{
"error": false,
"errorText": ""
}Request failed (form instance id was not specified):
{
"error": true,
"errorText": "Required variables not specified.",
"requiredVariables": [
"forminstanceid"
]
}