transform

GETALL,RDA/GetFormInstancesArrayForAllForms

IN THIS PAGE

Arguments

personCharacter

userId of the TransForm user. If blank form instances for all users are returned

paginatedLogical

true/false - indicates if the results should be paginated.

pageSizeNumeric

number of records per page

pageNumberNumeric

page number for which data is returned

modeCharacter

detailed/summary - determines if meta data and form data or just form instanceId and date created are returned

getRecordCountLogical

if true, count of number of records is returned

timestampCharacter

timestamp when record was last updated. Format is yyyy-mm-dd 0h:0m:0s

fieldlistCharacter

a list of the top level form fields that you want to return data from. if blank then data for all form fields are returned.

resolveMediaFieldsLogical

determine if coded data for media fields is resolved to the actual URL on Amazon S3.

returnMediaFileListLogical

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

Returns

resultJSON Object

Returns an object with these properties:

errorboolean

true if there was an error

errorTextstring
hightimestring

date of the last update to any record in the array (format yyyy-mm-dd 0h:0m:0s)

recordCount

number of records (1 if not paginated and getRecordCount is false)

pageCount

number of pages of data (1 if not paginated)

resultarray
formid
forminstanceid
created

date when the form instance was created

timestamp

date when the form instance was last updated

Description

Get information (meta data and form data) for all form instances in the account associated with the API token.

CURL 

CURL --insecure -H "apikey:Your_api_key" -H "accept: application/json"  "https://transform.alphasoftware.com/transformAPIVersion1.a5svc/GetFormInstancesArrayForAllForms?person=value_of_person&paginated=value_of_paginated&pagesize=value_of_pagesize&pageNumber=value_of_pageNumber&mode=value_of_mode&getrecordcount=value_of_getrecordcount&timestamp=value_of_timestamp&fieldList=value_of_fieldList&resolveMediaFields=value_of_resolveMediaFields&returnMediaFileList=value_of_returnMediaFileList"

Node 

var https = require('https');
var options = {
  protocol: "https:",
  hostname: "transform.alphasoftware.com",
  path: "/transformAPIVersion1.a5svc/GetFormInstancesArrayForAllForms?person=value%5fof%5fperson&paginated=value%5fof%5fpaginated&pagesize=value%5fof%5fpagesize&pageNumber=value%5fof%5fpageNumber&mode=value%5fof%5fmode&getrecordcount=value%5fof%5fgetrecordcount&timestamp=value%5fof%5ftimestamp&fieldList=value%5fof%5ffieldList&resolveMediaFields=value%5fof%5fresolveMediaFields&returnMediaFileList=value%5fof%5freturnMediaFileList",
  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 = "/GetFormInstancesArrayForAllForms?person=value%5fof%5fperson&paginated=value%5fof%5fpaginated&pagesize=value%5fof%5fpagesize&pageNumber=value%5fof%5fpageNumber&mode=value%5fof%5fmode&getrecordcount=value%5fof%5fgetrecordcount&timestamp=value%5fof%5ftimestamp&fieldList=value%5fof%5ffieldList&resolveMediaFields=value%5fof%5fresolveMediaFields&returnMediaFileList=value%5fof%5freturnMediaFileList"
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