GETALL/GetFormDataForFormInstanceId/{formInstanceId}

Arguments

formInstanceIdCharacter

Id of the form instance

modeCharacter

"Detailed or "Summary" - determines if form meta data and data or just form meta data are returned.

Detailed

returns both meta data and form data

Summary

returns only the form meta data

resolveMediaFieldsLogical

Determine if coded data for media fields is resolved to the actual URL on Amazon S3. If "true", media field values are resolved to the actual URL for the media field. If "false", media fields values are the coded values actually stored in the TransForm database.

injectFormMetaDataIntoDataLogical

Specifies if form meta data (i.e. name of user filling in form, form status, etc.) should be injected into the formdata return by the method.

returnMediaFileListLogical

Specify if an array of media files should be returned - only honored if 'resolveMediaFields' is not true.

getFormDefinitionLogical

Specify if the form definition should also be returned

Returns

resultJSON Object

Returns an object with these properties:

errorboolean

true if there was an error

errorTextstring

The error message. Will be blank if no error occurred.

resultarray

Contains the information for the form instance.

Description

Get information about a particular formInstanceId

CURL

CURL --insecure -H "apikey:Your_api_key" -H "accept: application/json" "https://transform.alphasoftware.com/transformAPIVersion1.a5svc/GetFormDataForFormInstanceId/value_of_forminstanceid?mode=value_of_mode&resolveMediaFields=value_of_resolveMediaFields&injectFormMetaDataIntoData=value_of_injectFormMetaDataIntoData&returnMediaFileList=value_of_returnMediaFileList&getFormDefinition=value_of_getFormDefinition"

Node

var https = require('https');
var options = {
  protocol: "https:",
  hostname: "transform.alphasoftware.com",
  path: "/transformAPIVersion1.a5svc/GetFormDataForFormInstanceId/value_of_forminstanceid?mode=value%5fof%5fmode&resolveMediaFields=value%5fof%5fresolveMediaFields&injectFormMetaDataIntoData=value%5fof%5finjectFormMetaDataIntoData&returnMediaFileList=value%5fof%5freturnMediaFileList&getFormDefinition=value%5fof%5fgetFormDefinition",
  headers: {apikey: "Your_api_key"}
};

https.get(options, (resp) => {
  let data = '';
  resp.on('data', (chunk) => {data += chunk;});
  resp.on('end', () => {console.log(data);});
}).on("error", (err) => {console.log("Error: " + err.message);});

Xbasic

dim apikey as c = "Your_api_key"
dim postdata as c 
dim url as c = "/GetFormDataForFormInstanceId/value_of_forminstanceid?mode=value%5fof%5fmode&resolveMediaFields=value%5fof%5fresolveMediaFields&injectFormMetaDataIntoData=value%5fof%5finjectFormMetaDataIntoData&returnMediaFileList=value%5fof%5freturnMediaFileList&getFormDefinition=value%5fof%5fgetFormDefinition"
dim pr as p
pr = a5dialogHelper_transformAPIQuery(url,postdata,apikey)
if pr.error = .f. then
	dim result as c 
	result = pr.result
else
	dim errorText as c 
	errorText = pr.errorText
end if