TransForm API Reference

Description

A web API for interacting with TransForm from web applications.

Discussion

In order to use the TransForm API in your application, a TransForm API key is required. You can generate a TransForm API key in TransForm Central. See Get TransForm API Key to learn how.

Name
Description
AddUserToTransFormAccount API Method

Add users to a TransForm account. The account is the account associated with the API key.

ChangeAccountDisplayName API Method

Change the display name for a TransForm account. The account is the account associated with the API key.

ChangeFormInstanceData API Method

Edit data in an existing form instance specified by the formInstanceId.

ChangeFormInstanceMetaData API Method

Change meta data (e.g. status, person) for an form instance specified by a formInstanceId.

ChangeUserDisplayName API Method

Change the display name for a user's TransForm account.

ChangeUserOrderInAccount API Method

Change the order in which users are assigned to a TransForm account. The account is the account associated with the API key.

CreateFormCommandsFromSampleJSON API Method

Takes sample JSON data and returns the form definition commands to create a TransForm form that matches the schema of the sample JSON data. Once you have the form definition commands, you can use the CreateNewFormDefinition method to create a new TransForm form definition.

CreateNewFormDefinition API Method

Creates a new TransForm form definition in the account associated with the API key. You can either supply a complete form definition, or just the form definition commands. The form definition commands define the fields on the form. The complete form definition includes the form definition commands, and also defines meta data for the form such as icon, text color, etc. To see an example of the JSON for a complete form definition use the GetFormDefinitionForFormId method.

CreateNewFormInstance API Method

Create a new form instance. The form type is specified by the formId. The account is the account associated with the API key.

CreateNewUserAccount API Method

Create a new TransForm User account. The user is automatically added to the TransForm account associated with the API key.

DeleteFormDefinition API Method

Deletes a form definition from a TransForm account. The account is the account associated with the API key.

DeleteFormInstance API Method

Delete a form instance.

DeleteTransFormAccount API Method

SUPER USER ONLY. Delete a TransForm account account.

DeleteUserAccount API Method

SUPER USER ONLY. Delete a user's account.

DeleteUserRolesInAccount API Method

Delete user roles from a TransForm account. The account is the account associated with the API key.

DuplicateFormDefinition API Method

Duplicates a TransForm form definition in the account associated with the API key.

GetAccountLicenses API Method

Get a list of the license keys registered for a TransForm account.

GetAccountStatus API Method

Get the status of a TransForm account

GetAPIKey API Method

Generates an API key. The generated API key is associated with the same account as the API key that was used to call this method.

GetAPIScopeCodes API Method

Get a list of API scopes. API scopes are specified when an API key is created. The API scopes define what API methods a particular API key allows.

GetFieldsInForm API Method

Get a list of the fields in a TransForm form definition. The form must exist in the account associated with the API key.

GetFormDataArrayForFormId API Method

Get form data for all form instances of the specified formId. You can specify a hightime and only records edited after the specified hightime are returned.

GetFormDataForFormInstanceId API Method

Get information about a specific form instance.

GetFormDefinitionCommandsForFormId API Method

Get the commands for a TransForm form. The commands define the fields in the form. The commands are a JSON array of form commands.

GetFormDefinitionForFormId API Method

Get a form definition. Data includes the form commands which define the form structure.

GetFormInstancesArrayForAllForms API Method

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

GetFormInstancesArrayForFormId API Method

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

GetFormLookupList API Method

Get the list of choices for a List field in a Form definition.

GetFormMediaFieldNamesForFormId API Method

Get a list of the media fields in a form definition.

GetListOfFormDefinitionsForAccount API Method

Gets a list of the form definitions for an account.

GetTransFormAccountsForUser API Method

SUPER USER ONLY. Get a list of TransForm account in which the user is a member.

GetUserRolesInAccount API Method

Get a list of roles that a user has in a TransForm account. The account is the account associated with the API key.

GetUsersInTransformAccount API Method

Get a list of users in a TransForm account. The account is the account associated with the API key.

InviteUsers API Method

Invite people to create their own TransForm user accounts. When any of the invitees accept their invitation they are automatically added to the TransForm account associated with the API key.

RemoveUserFromTransFormAccount API Method

Remove users from a TransForm account. The account is the account associated with the API key.

RevokeAPIKey API Method

Revoke an API key.

SetAccountLicenses API Method

Set the license keys for a TransForm account.

SetFormLookupList API Method

Set the list of choices for a List field in a Form definition.

SetUserRolesInAccount API Method

Set user roles in a TransForm account. The account is the account associated with the API key.

UpdateFormDefinitionCommandsForFormId API Method

Updates form definition commands in a TransForm form definition. The form definition commands define the structure of the TransForm form.

UpdateFormDefinitionForFormId API Method

Updates a TransForm form definition. Only properties specified in the Form Definition JSON are updated. If a form property is not specified in the input JSON object, the form property is not updated. For example, you may want to update only the form icon. Therefore the formDefinition input parameter (a JSON string) will only define the icon property.