Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents
maxLevel3
typeflat

...

OperationDescription

getForm

Retrieves a specific form.

getFormSubmissions

Retrieves submissions for a specific form.

cloneFormClones an existing form.

Operation details

This section provides further details on the operations related to forms.

...

Code Block
languagexml
titlegetForm
<jotform.getForm>
	<formId>{$ctx:formId}</formId>
</jotform.getForm>
Properties
  • formId: The ID of the form.
  
Anchor
request
request
Sample request

...

Code Block
languagexml
titleSample Request for getForm
{
	"apiUrl" : "https://api.jotform.com",
    "apiKey" : "f71e12ef09ef7941b8b19b80e5173d26",
	"formId" : "51661468375463"
}

...

Code Block
languagexml
titlegetFormSubmissions
<jotform.getFormSubmissions>
    <limit>{$ctx:limit}</limit>
    <orderBy>{$ctx:orderBy}</orderBy>
    <formId>{$ctx:formId}</formId>
    <offset>{$ctx:offset}</offset>
	<filter>{$ctx:filter}</filter>
</jotform.getFormSubmissions>
Properties
  • limit: The number of results in each result set for submission data.
  • orderBy: The order value in which the results are ordered.
  • formId: The ID of the form which needs to be retrieved.
  • offset: The page value of each result set for submission data.
  • filter: The query results to fetch a specific submissions range.
  
Anchor
request
request
Sample request

...

Code Block
languagexml
titleSample Request for getFormSubmissions
{
 	"apiUrl" : "https://api.jotform.com",			
    "apiKey" : "f71e12ef09ef7941b8b19b80e5173d26",
	"formId" : "51661468375463",
  	"offset" : "0",
    "limit" :  "2",
	"orderBy" : "id"			
}
Info
titleNote

There are optional parameters available. For more information on the usage of these parameters please check the API document. 

Related JotForm documentation

http://api.jotform.com/docs/#form-id-submissions

Anchor
cloneForm
cloneForm
Cloning a form

The cloneForm operation clones an existing form.

Code Block
languagexml
titlecloneForm
<jotform.cloneForm>
	<formId>{$ctx:formId}</formId>
</jotform.cloneForm>
Properties
  • formId: The ID of the form that it is cloned from.
  
Anchor
request
request
Sample request

Following is a sample REST/JSON request that can be handled by the cloneForm operation.

Code Block
languagexml
titleSample Request for cloneForm
{
	"apiUrl" : "https://api.jotform.com",
    "filterapiKey" : "f71e12ef09ef7941b8b19b80e5173d26",
	"orderByformId" : "id51651915860458"			
}
Related JotForm documentation

http://api.jotform.com/docs/#form#post-form-id-submissionsclone

Anchor
sampleconfiguration
sampleconfiguration
Sample configuration

...