Embedded Files
Overview
Overview
The forms APIs are provided as a series of webservice endpoints that can be used to programmatically manage forms of different types. This includes, creation, update and deletion.
Authentication
Authentication
All endpoints require 2 parameters for authentication:
API_KEY
API_USER_KEY
Refer to the section: API Keys for details on how to obtain these.
deleteForm
deleteForm
What it does
What it does
Deletes any forms given in the array of ID maps. There is no way to recover a form once it is deleted.
Inputs:
Inputs:
Outputs:
Outputs:
getForm
getForm
What it does
What it does
Gets a list of forms for the given IDs
Inputs:
Inputs:
Outputs:
Outputs:
STATUS - returns either OK or ERROR
RESPONSE - Contains an array of Form objects with their properties
saveForm
saveForm
What it does
What it does
Takes the array of form objects and saves any updates to the forms.
Inputs:
Inputs:
Outputs:
Outputs:
STATUS - returns either OK or ERROR
RESPONSE - Contains the map of original to updated IDs for the forms saved.
getFormDefinition
getFormDefinition
What it does
What it does
Gets the Form Definition object for a given ID.
Inputs:
Inputs:
Outputs:
Outputs:
STATUS - returns either OK or ERROR
RESPONSE - Contains the Form Definition object and all of its properties.
getFieldAttachments
getFieldAttachments
What it does
What it does
Gets any documents that are attached to the given form.
Inputs:
Inputs:
Outputs:
Outputs:
STATUS - returns either OK or ERROR
ATTACHMENTS - Contains an array of attachment objects.
getFieldTable
getFieldTable
What it does
What it does
Gets the configuration and contents of a Form Table form field.
Inputs:
Inputs:
Outputs:
Outputs:
STATUS - returns either OK or ERROR
CONFIG - Contains an array of maps of configuration options for the columns of the table.
ROWS - Contains an array of maps of data that is already attached to the table.
Google Sites
Report abuse