Overview
Configuration is provided for establishing connections with JotForm service. The configuration is used in the REST Connection Manager.
Setup
Press 
icon to get more information about the connection parameters.
Obtain data
Use REST Source component to get data from service resource.
Insert data
Use REST Destination component to insert data into service resource.
Demonstration
Quick Start
In this task, we will show you step-by-step how to create a connection to Jotform REST API using COZYROC's REST Connection Manager.
Step 1. Run "Visual Studio" under "Administrator account". Right click on Connection managers Tab and Select New Connection. In Add SSIS Connection Manager scroll down and select Connection managers for REST Connection and click Add.
Step 2. From drop-down menu Configuration select Jotform. Provide your APKIKey in the grid below for the APIKey parameter.
Step 3. Click "Test Connection" to test your connection.
Congratulations! You have now established a connection to your Jotform instance.
In this guide, we will show how to read data from the Jotform service resource using the COZYROC REST Source component.
Step 1. Select an existing "Data Flow task" or create a new "Data Flow Task".
Step 2. Open "SSIS Toolbox" and drag and drop COZYROC "REST Source" component.
Step 3. Double click on the "REST Source" component and select Jotform connection from the combo. Select from available Jotform resources listed in the second combo below.
Optionally you can include extra parameters in the grid below if needed.
Step 4. Click on the "Columns tab" and select Jotform resource columns you want to read.
Step 5. Click Preview to make sure all necessary resource columns are included.
Bravo! You have now learned how to read data from Jotform service.
In this guide, we will show how to write data to the Jotform service resource using the COZYROC REST Destination component.
Step 1. Select an existing "Data Flow task" or create a new "Data Flow Task".
Step 2. Open the "SSIS Toolbox" and drag and drop COZYROC "REST Destination" component.
Step 3. Double click on the "REST Destination" component and select Jotform connection from the combo. Also, select resource action and Jotform resource you want to work on.
Step 4. Click on the "Mapping" tab and map the input columns for the process you are configuring.
If you want to provide input for other resource composite objects, change the input above and map the columns.
Done. You have now learned how to write data into the Jotform resource.
Configuration
Base URL address: https://api.jotform.com.
- APIKey
-
The authentication uses a parameters-based authentication.
The authentication has the following user-defined parameters:
- APIKey: Required. Specify API key.
The following request parameters will be automatically processed during the authentication process:
-
APIKEY:
{{=connection.user.APIKey}}
Documentation: https://api.jotform.com/docs/#authentication.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/user.
The result is extracted from:{{=[response.content]}}.Documentation: https://api.jotform.com/docs/#user.
- username
Template: ShortText.
- name
Template: ShortText.
Template: ShortText.
- website
Template: ShortText.
- time_zone
Template: ShortText.
- account_type
Template: ShortText.
- status
Template: ShortText.
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
- industry
Template: ShortText.
- securityAnswer
Template: ShortText.
- company
Template: ShortText.
- securityQuestion
Template: ShortText.
- webhooks
Template: ShortText.
- doNotClone
Template: ShortText.
- folderLayout
Template: ShortText.
- language
Template: ShortText.
- avatarUrl
Template: ShortText.
- usage
The value is gathered from
/user/usageaddress. The gathered value is processed with{{=response.content}}expression. Field components:- Contains the following components: submissions, ssl_submissions, payments, uploads.
- subusers
The value is gathered from
/user/subusersaddress. The gathered value is processed with{{=response.content}}expression. Field components:- An array.
- Contains the following components: owner, status, email, username, created_at, permissions.
- folders
The value is gathered from
/user/foldersaddress. The gathered value is processed with{{=[_.extend(response.content, { forms: _.values(response.content.forms) })]}}expression. Field components:-
Uses template:
FolderT. - Contains the following components: .
-
Uses template:
- reports
The value is gathered from
/user/reportsaddress. The gathered value is processed with{{=response.content}}expression. Field components:- An array.
- Contains the following components: id, form_id, title, created_at, updated_at, fields, list_type, form_url, form_title, form_count, status, last_submission, url, isProtected, properties, share, content.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/user/history.
The result is extracted from:{{=response.content}}.
- form_id
A key field. Template: Id.
- type
Template: ShortText.
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
- username
Template: ShortText.
- formTitle
Template: ShortText.
- formStatus
Template: ShortText.
- form_title
Template: ShortText.
- ip
Data type: DT_I4
- timestamp
Template: UnixTime. A read-only field.
Based on resource template Base.
- [Create] action
-
Endpoint URL address:
/user/register.
- username
Template: ShortText.
- password
Template: ShortText.
Template: ShortText.
Based on resource template Base.
- [Create] action
-
Endpoint URL address:
/user/login.
- username
Template: ShortText.
- password
Template: ShortText.
- appName
Template: ShortText.
- access
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/user/forms.
The result is extracted from:{{=response.content}}.Documentation: https://api.jotform.com/docs/#user-forms.
- [Read single] action
-
Endpoint URL address:
/form/{{=parameters.form_id}}.
The result is extracted from:{{=[response.content]}}.The action has the following user-defined parameters:
- form_id: Required. Specify the form id.
Documentation: https://api.jotform.com/docs/#form-id.
- [Read folder] action
-
Endpoint URL address:
/folder/{{=parameters.folder_id}}.
The result is extracted from:{{=_.values(response.content.forms)}}.Documentation: https://api.jotform.com/docs/#folder-id.
- [Create] action
-
Endpoint URL address:
/form.The following request parameters will be automatically processed:
-
application/json:
{{=item}}
Documentation: https://api.jotform.com/docs/#put-forms.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/form/{{=item.id}}.Documentation: https://api.jotform.com/docs/#put-forms.
- id
A key field. Template: Id.
- username
Template: ShortText.
- title
Template: ShortText.
- height
Template: ShortText.
- url
Template: ShortText.
- status
Template: ShortText.
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
- new
Data type: DT_I4
- count
Data type: DT_I4
- questions
Field components:
- An array.
- Contains the following components: type, text, order, name.
- emails
Field components:
- An array.
- Contains the following components: type, name, from, to, subject, html.
- files
The value is gathered from
/form/{{=item.id}}/filesaddress. The gathered value is processed with{{=response.content}}expression. Field components:- An array.
- Contains the following components: form_id, submission_id, name, type, size, username, url, date.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/form/{{=parameters.form_id}}/questions.
The result is extracted from:{{=_.values(response.content)}}.The action has the following user-defined parameters:
- form_id: Required. Specify the form id.
Documentation: https://api.jotform.com/docs/#form-id.
- [Read single] action
-
Endpoint URL address:
/form/{{=parameters.form_id}}/question/{{=parameters.question_id}}.
The result is extracted from:{{=[response.content]}}.The action has the following user-defined parameters:
- form_id: Required. Specify the form id.
- question_id: Required. Specify the question id.
Documentation: https://api.jotform.com/docs/#form-id.
- [Create] action
-
Endpoint URL address:
/form/{{=item.form_id}}/questions.The following request parameters will be automatically processed:
-
item:
{{=JotForm.getPayload(item, 'question')}}
Documentation: https://api.jotform.com/docs/#put-forms.
-
item:
- [Update] action
-
Endpoint URL address:
/form/{{=item.form_id}}/question/{{=item.qid}}.
The action uses POST method.The following request parameters will be automatically processed:
-
item:
{{=JotForm.getPayload(item, 'question')}}
Documentation: https://api.jotform.com/docs/#post-form-id-question-id.
-
item:
- [Delete] action
-
Endpoint URL address:
/form/{{=item.form_id}}/question/{{=item.qid}}.Documentation: https://api.jotform.com/docs/#put-forms.
- form_id
A key field. Template: Id.
- type
Template: ShortText.
- text
Template: ShortText.
- order
Data type: DT_I4
- name
Template: ShortText.
- validation
Template: ShortText.
- required
Template: ShortText.
- readonly
Template: ShortText.
- size
Data type: DT_I4
- labelAlign
Template: ShortText.
- hint
Template: ShortText.
- qid
A key field. Template: ShortText.
- properties
The gathered value is processed with
{{=_.map(item, function(v, k) { return { name: k, value: v }; })}}expression. Field components:- An array.
-
Uses template:
PropertyT.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/form/{{=parameters.form_id}}/properties.
The result is extracted from:{{=[response.content]}}.The action has the following user-defined parameters:
- form_id: Required. Specify the form id.
Documentation: https://api.jotform.com/docs/#form-id-properties.
- [Read single] action
-
Endpoint URL address:
/form/{{=parameters.form_id}}/properties/{{=parameters.property_key}}.
The result is extracted from:{{=[response.content]}}.The action has the following user-defined parameters:
- form_id: Required. Specify the form id.
- property_key: Required. Specify the property key.
Documentation: https://api.jotform.com/docs/#form-id.
- [Update] action
-
Endpoint URL address:
/form/{{=item.id}}/properties.The action has the following user-defined parameters:
- form_id: Required. Specify the form id.
The following request parameters will be automatically processed:
-
item:
{{=JotForm.getPayload(item, 'properties')}}
Documentation: https://api.jotform.com/docs/#post-form-id-properties.
- id
A key field. Template: Id.
- fontsize
Data type: DT_I4
- options
Template: LongText. A composite field.
- hideMailEmptyFields
Template: ShortText.
- limitSubmission
Data type: DT_I4
- messageOfLimitedForm
Data type: DT_WSTR
- sendpostdata
Template: ShortText.
- activeRedirect
Template: ShortText.
- expireDate
Template: DateTime.
- alignment
Template: ShortText.
- font
Template: ShortText.
- fontcolor
Template: ShortText.
- formWidth
Data type: DT_I4
- highlightLine
Template: ShortText.
- labelWidth
Data type: DT_I4
- lineSpacing
Data type: DT_I4
- styles
Data type: DT_WSTR
- pagetitle
Template: ShortText.
- thanktext
Data type: DT_NTEXT
- unique
Template: ShortText.
- uniqueField
Template: ShortText.
- background
Template: ShortText.
- secure
Template: ShortText.
- expiredDate
Template: Date.
- injectCSS
Data type: DT_NTEXT
- thankurl
Data type: DT_NTEXT
- disabled
Template: ShortText.
- properties
The gathered value is processed with
{{=_.map(item, function(v, k) { return { name: k, value: v }; })}}expression. Field components:- An array.
-
Uses template:
PropertyT.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/form/{{=parameters.form_id}}/reports.
The result is extracted from:{{=response.content}}.The action has the following user-defined parameters:
- form_id: Required. Specify the form id.
Documentation: https://api.jotform.com/docs/#form-id-reports.
- [Create] action
-
Endpoint URL address:
/form/{{=item.id}}/reports.Documentation: https://api.jotform.com/docs/#post-form-id-reports.
- id
A key field. Template: Id.
- title
Template: ShortText.
- fields
Template: ShortText.
- list_type
Template: ShortText.
- status
Template: ShortText.
- url
Template: ShortText.
- isProtected
Data type: DT_BOOL
- settings
Template: ShortText.
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/form/{{=parameters.form_id}}/webhooks.
The result is extracted from:{{=[response.content]}}.The action has the following user-defined parameters:
- form_id: Required. Specify the form id.
Documentation: https://api.jotform.com/docs/#form-id-webhooks.
- [Create] action
-
Endpoint URL address:
/form/{{=item.form_id}}/webhooks.Documentation: https://api.jotform.com/docs/#post-form-id-webhooks.
- [Delete] action
-
Endpoint URL address:
/form/{{=item.form_id}}/webhooks/{{=item.webhook_id}}.Documentation: https://api.jotform.com/docs/#post-form-id-webhooks.
- form_id
A key field. Template: Id.
- webhook_id
A key field. Template: Id.
- webhookURL
Template: ShortText.
- content
A read-only field. The gathered value is processed with
{{=_.map(response.content, function(v, k) { return { id: k, value: v }; })}}expression. Field components:- An array.
- Contains the following components: id, value.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/form/{{=parameters.form_id}}/submissions.
The result is extracted from:{{=JotForm.getSubmissionData(response.content)}}.The action has the following user-defined parameters:
- form_id: Required. Specify the form id.
Documentation: https://api.jotform.com/docs/#form-id-submissions.
- [Create] action
-
Endpoint URL address:
/form/{{=parameters.form_id}}/submissions.The action has the following user-defined parameters:
- form_id: Required. Specify the form id.
Documentation: https://api.jotform.com/docs/#post-form-id-submissions.
- [Update] action
-
Endpoint URL address:
/submission/{{=item.id}}.The action has the following user-defined parameters:
- form_id: Required. Specify the form id.
Documentation: https://api.jotform.com/docs/#post-submission-id.
- [Delete] action
-
Endpoint URL address:
/submission/{{=item.id}}.Documentation: https://api.jotform.com/docs/#delete-submission-id.
- id
A key field. Template: Id.
- form_id
A key field. Template: Id.
- ip
Template: ShortText. A read-only field.
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
- new
Template: ShortText.
- status
Template: ShortText. A read-only field.
- title
Template: ShortText. A read-only field.
- notes
Template: ShortText. A read-only field.
- flag
Data type: DT_I4
- [External]
-
The external fields URL address:
{{=parameters.get('form_id') && '/form/' + parameters.form_id + '/questions'}}. The external fields list is extracted from:{{=typeof response !== 'undefined' && _.values(response.content)}}.- {{=external.name}}
Template: {{=JotForm.getFieldTemplate(external.type)}}. Before setting, the value is processed with
{{=JotForm.getSetExtValue(field, value)}}expression.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/system/plan/{{=parameters.plan_name}}.
The result is extracted from:{{=[response.content]}}.The action has the following user-defined parameters:
- plan_name: Required. Specify the plan name.
Documentation: https://api.jotform.com/docs/#system-plan-planName.
- name
Template: ShortText.
- currency
Template: ShortText.
- limits
Field components:
- Contains the following components: submissions, overSubmissions, sslSubmissions, payments, uploads, tickets, subusers, api-daily-limit, views, formCount, hipaaCompliance, emails.
- prices
Field components:
- Contains the following components: monthly, yearly, biyearly.
- plimusIDs
Field components:
- Contains the following components: monthly, yearly, biyearly.
- fastSpringURLs
Field components:
-
Uses template:
ShortText. - Contains the following components: monthly, yearly, biyearly.
-
Uses template:
- [Read] action
-
The result is paginated.The following request parameters will be automatically processed:
-
offset:
{{=parameters.iterator}} -
limit:
{{=parameters.batchSize}} -
_includeUserParameters:
{{=parameters}}
-
offset:
- [Create] action
-
The action uses POST method.The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}} -
item:
{{=item}}
-
_includeUserParameters:
- [Update] action
-
The action uses PUT method.The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}} -
item:
{{=item}}
-
_includeUserParameters:
- [Delete] action
-
The action uses DELETE method.
- ShortText
Data type: DT_WSTR ( length 255 )
- LongText
Data type: DT_WSTR ( length 1000 )
- DateTime
Data type: DT_DBTIMESTAMP
- Date
Data type: DT_DBDATE
- UnixTime
Data type: DT_DBTIMESTAMP The gathered value is processed with
{{=value && new Date(value * 1000).toUTCString()}}expression.- Int
Data type: DT_I4
- Image
Data type: DT_IMAGE
- Id
Data type: DT_I8
- FullNameT
Field components:
-
Uses template:
ShortText. - Contains the following components: first, last.
-
Uses template:
- ControlMatrixT
Field components:
-
Uses template:
ShortText. - Contains the following components: Friendliness, Knowledge, Quickness, Service Quality, Cleanliness, Responsiveness.
-
Uses template:
- ControlTimeT
Field components:
-
Uses template:
ShortText. - Contains the following components: timeInput, hourSelect, minuteSelect, ampm.
-
Uses template:
- ControlPhoneT
Field components:
-
Uses template:
ShortText. - Contains the following components: full.
-
Uses template:
- ControlAddressT
Field components:
-
Uses template:
ShortText. - Contains the following components: addr_line1, addr_line2, city, state, postal.
-
Uses template:
- ControlAppointmentT
Field components:
-
Uses template:
DateTime. - Contains the following components: date, duration, timezone.
-
Uses template:
- ControlDatetimeT
Field components:
- Contains the following components: month, day, year.
- PaymentT
Field components:
-
Uses template:
ShortText. - Contains the following components: 0, 1, paymentArray.
-
Uses template:
- InlineT
Field components:
-
Uses template:
ShortText. - Contains the following components: shorttext-1, shorttext-2.
-
Uses template:
- FolderT
Field components:
-
Uses template:
ShortText. - Contains the following components: id, path, owner, name, parent, color, forms, subfolders.
-
Uses template:
- PropertyT
Field components:
-
Uses template:
ShortText. - Contains the following components: name, value, complex.
-
Uses template:
What's New
- New: Introduced connection.
COZYROC SSIS+ Components Suite is free for testing in your development environment.
A licensed version can be deployed on-premises, on Azure-SSIS IR and on COZYROC Cloud.