Overview
Configuration is provided for establishing connections with Formstack 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.
Quick Start
In this task, we will show you step-by-step how to create a connection to Formstack REST API using COZYROC's REST Connection Manager.
Congratulations! You have now established a connection to your Formstack instance.
In this guide, we will show how to read data from the Formstack service resource using the COZYROC REST Source component.
In this guide, we will show how to write data to the Formstack service resource using the COZYROC REST Destination component.
Configuration
Base URL address: https://www.formstack.com/api/v2
.
- OAuth 2
-
The authentication uses an authorized token. The token will be refreshed with the following expression:
{{=Date.now() + (response.expires_in - 300) * 1000}}
.The following request parameters will be automatically processed during the authentication process:
-
Authorization:
Bearer {{=token.Access}}
Documentation: https://developers.formstack.com/reference#authorization.
-
Authorization:
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/form.json
.
The result is extracted from:{{=response.forms}}
.Documentation: https://developers.formstack.com/reference#form-get.
- [Read Single] action
-
Endpoint URL address:
/form/{{=parameters.id}}.json
.The action has the following user-defined parameters:
- id: Required. Specify the form id.
Documentation: https://developers.formstack.com/reference#form-id-get.
- [Read Basic] action
-
Endpoint URL address:
/form/{{=parameters.id}}/basic.json
.The action has the following user-defined parameters:
- id: Required. Specify the form id.
Documentation: https://developers.formstack.com/reference#form-id-get.
- [Create] action
-
Endpoint URL address:
/form.json
.Documentation: https://developers.formstack.com/reference#form-post.
- [Update] action
-
Endpoint URL address:
/form/{{=item.id}}.json
.Documentation: https://developers.formstack.com/reference#form-id-put.
- [Delete] action
-
Endpoint URL address:
/form/{{=item.id}}.json
.Documentation: https://developers.formstack.com/reference#form-id-delete.
- id
A key field. Data type: DT_I4
- name
Template: ShortText.
- viewkey
Template: ShortText.
- views
Template: ShortText.
- created
Template: DateTime. A read-only field.
- updated
Template: DateTime. A read-only field.
- deleted
Data type: DT_BOOL
- db
Data type: DT_I4
- submissions
Data type: DT_I4 A read-only field.
- submissions_unread
Data type: DT_I4 A read-only field.
- submissions_today
Data type: DT_I4 A read-only field.
- last_submission_id
Data type: DT_I4 A read-only field.
- last_submission_time
Template: DateTime. A read-only field.
- url
Template: ShortText. A read-only field.
- data_url
Template: ShortText. A read-only field.
- summary_url
Template: ShortText. A read-only field.
- rss_url
Template: ShortText. A read-only field.
- encrypted
Data type: DT_I4
- thumbnail_url
Template: ShortText. A read-only field.
- submit_button_title
Template: ShortText.
- inactive
Data type: DT_I4
- timezone
Template: ShortText.
- language
Template: ShortText.
- num_columns
Template: ShortText. A read-only field.
- progress_meter
Template: ShortText. A read-only field.
- should_display_one_question_at_a_time
Data type: DT_BOOL
- can_access_1q_feature
Data type: DT_BOOL
- is_workflow_form
Data type: DT_BOOL
- is_workflow_published
Data type: DT_BOOL
- javascript
Template: ShortText.
- html
Template: ShortText.
- fields
Field components:
- An array.
-
Uses template:
BasicFieldT
.
- submissions_details
The gathered value is processed with
{{=connection.resourceManager['Submission'].getData({ parameters: ['form_id=' + item.id] })}}
expression. Field components:- An array.
-
Uses template:
SubmissionT
.
- partial_submissions_details
The gathered value is processed with
{{=connection.resourceManager['Submission'].getData({ endpoint: 'Partial', parameters: ['form_id=' + item.id] })}}
expression. Field components:- An array.
-
Uses template:
SubmissionT
.
- folder
The value is gathered from
/folder/{{=item.folder}}
address. The gathered value is processed with{{= [response]}}
expression. Field components:- An array.
-
Uses template:
FolderT
.
- email_notifications
The value is gathered from
/form/{{=item.id}}/notification
address. The gathered value is processed with{{= response.notifications}}
expression. Field components:- An array.
-
Uses template:
EmailNotificationT
.
- confirmation_emails
The value is gathered from
/form/{{=item.id}}/notification
address. The gathered value is processed with{{= response.confirmations}}
expression. Field components:- An array.
-
Uses template:
ConfirmationEmailT
.
- webhooks
The value is gathered from
/form/{{=item.id}}/webhook
address. The gathered value is processed with{{= response.webhooks}}
expression. Field components:- An array.
-
Uses template:
WebhookT
.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/form/{{=parameters.id}}/field.json
.
The result is extracted from:{{=response}}
.The action has the following user-defined parameters:
- id: Required. Specify the form_id.
Documentation: https://developers.formstack.com/reference#form-id-field-get.
- [Read Single] action
-
Endpoint URL address:
/field/{{=parameters.id}}.json
.The action has the following user-defined parameters:
- id: Required. Specify the field_id.
Documentation: https://developers.formstack.com/reference#field-id-get.
- [Create] action
-
Endpoint URL address:
/form/{{=item.id}}/field.json
.Documentation: https://developers.formstack.com/reference#form-id-field-post.
- [Update] action
-
Endpoint URL address:
/field/{{=item.id}}.json
.Documentation: https://developers.formstack.com/reference#field-id-put.
- [Delete] action
-
Endpoint URL address:
/field/{{=item.id}}.json
.Documentation: https://developers.formstack.com/reference#field-id-delete.
The resource includes the fields from the BasicFieldT template.
- attributes
Template: LongText. A composite field.
- description_callout
Template: ShortText.
- field_type
Template: ShortText.
- options
Template: LongText. Field components:
- An array.
- Contains the following components: label, value.
- options_values
Template: LongText. Field components:
- An array.
- Contains the following components: label, value.
- colspan
Template: ShortText.
- sort
Template: ShortText.
- logic
Template: LogicT.
- calculation
Template: ShortText.
- workflow_access
Template: ShortText.
- default_value
Template: ShortText.
- minlength
Data type: DT_I4
- maxlength
Template: ShortText.
- placeholder
Template: ShortText.
- field_one_calculation
Data type: DT_I4
- field_two_calculation
Data type: DT_I4
- calculation_units
Template: ShortText.
- calculation_operator
Template: ShortText.
- calculation_type
Template: ShortText.
- calculation_allow_negatives
Data type: DT_I4
- hide_input_characters
Data type: DT_I4
- remove_data_from_emails
Data type: DT_I4
- require_confirmation
Data type: DT_I4
- restrict_data_access
Data type: DT_I4
- option_layout
Template: ShortText.
- option_other
Template: ShortText.
- randomize_options
Template: ShortText.
- option_store
Template: ShortText.
- option_show_values
Template: ShortText.
- use_images
Data type: DT_I4
- image_dimensions
Template: ShortText.
- image_height
Data type: DT_I4
- image_width
Data type: DT_I4
- lock_image_ratio
Data type: DT_BOOL
- lock_image_ratio_option
Template: ShortText.
- image_label_alignment
Template: ShortText.
- section_break
Template: ShortText.
- section_heading
Template: ShortText.
- section_text
Template: ShortText.
- text_editor
Template: ShortText.
- label_position
Template: ShortText.
- num_columns
Template: ShortText.
- middle_initial_optional
Data type: DT_I4
- middle_name_optional
Data type: DT_I4
- prefix_optional
Data type: DT_I4
- suffix_optional
Data type: DT_I4
- show_country
Data type: DT_I4
- format
Template: ShortText.
- hide_address
Data type: DT_I4
- hide_address2
Data type: DT_I4
- hide_city
Data type: DT_I4
- hide_state
Data type: DT_I4
- hide_zip
Data type: DT_I4
- hide_option_button
Data type: DT_BOOL
- option_checkall
Data type: DT_I4
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/folder.json
.
The result is extracted from:{{=response.folders}}
.Documentation: https://developers.formstack.com/reference#folder-get.
- [Read Single] action
-
Endpoint URL address:
/folder/{{=parameters.id}}.json
.The action has the following user-defined parameters:
- id: Required. Specify the folder_id.
Documentation: https://developers.formstack.com/reference#folder-id-get.
- [Create] action
-
Endpoint URL address:
/folder.json
.Documentation: https://developers.formstack.com/reference#folder-post.
- [Update] action
-
Endpoint URL address:
/folder/{{=item.id}}.json
.Documentation: https://developers.formstack.com/reference#folder-id-put.
- [Delete] action
-
Endpoint URL address:
/folder/{{=item.id}}.json
.Documentation: https://developers.formstack.com/reference#folder-id-delete.
The resource includes the fields from the FolderT template.
- subfolders
Template: FolderT.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/form/{{=parameters.form_id}}/submission.json
.
The result is extracted from:{{=response.submissions}}
.The action has the following user-defined parameters:
- form_id: Required. Specify the form identifier.
- X-FS-ENCRYPTION-PASSWORD: Optional.
The following request parameters will be automatically processed:
-
X-FS-ENCRYPTION-PASSWORD:
{{=parameters.get('X-FS-ENCRYPTION-PASSWORD')}}
Documentation: https://developers.formstack.com/reference#form-id-submission-get.
- [Read Single] action
-
Endpoint URL address:
/submission/{{=parameters.form_id}}.json
.The action has the following user-defined parameters:
- form_id: Required. Specify the submission_id.
Documentation: https://developers.formstack.com/reference#submission-id-get.
- [Read Partial] action
-
Endpoint URL address:
/form/{{=parameters.form_id}}/partialsubmission
.
The result is extracted from:{{=response.partial_submissions}}
.The action has the following user-defined parameters:
- form_id: Required. Specify the form identifier.
Documentation: https://developers.formstack.com/reference#form-id-partialsubmission-get.
- [Create] action
-
Endpoint URL address:
/form/{{=item.id}}/submission.json
.The action has the following user-defined parameters:
- id: Required. Specify the form_id.
Documentation: https://developers.formstack.com/reference#form-id-submission-post.
- [Update] action
-
Endpoint URL address:
/submission/{{=item.id}}.json
.The action has the following user-defined parameters:
- id: Required. Specify the submitted form_id.
Documentation: https://developers.formstack.com/reference#submission-id-put.
- [Delete] action
-
Endpoint URL address:
/submission/{{=item.id}}.json
.The action has the following user-defined parameters:
- id: Required. Specify the form_id for this submission.
Documentation: https://developers.formstack.com/reference#submission-id-delete.
The resource includes the fields from the SubmissionT template.
- read
Data type: DT_BOOL
- encryption_password
Template: ShortText.
- [External]
-
The external fields URL address:
/form/{{=parameters.form_id}}/field.json
. The external fields list is extracted from:{{=response}}
.- field_{{=external.id}}
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/form/{{=parameters.form_id}}/confirmation
.
The result is extracted from:{{=response.confirmations}}
.The action has the following user-defined parameters:
- form_id: Required. Specify the form identifier.
Documentation: https://developers.formstack.com/reference#form-id-confirmation-get.
- [Read Single] action
-
Endpoint URL address:
/confirmation/{{=parameters.email_id}}
.The action has the following user-defined parameters:
- email_id: Required. Specify the email identifier.
Documentation: https://developers.formstack.com/reference#confirmation-id-get.
- [Create] action
-
Endpoint URL address:
/form/{{=item.id}}/confirmation
.Documentation: https://developers.formstack.com/reference#form-id-confirmation-post.
- [Update] action
-
Endpoint URL address:
/confirmation/{{=item.id}}
.Documentation: https://developers.formstack.com/reference#confirmation-id-put.
- [Delete] action
-
Endpoint URL address:
/confirmation/{{=item.id}}
.Documentation: https://developers.formstack.com/reference#confirmation-id-delete.
The resource includes the fields from the ConfirmationEmailT template.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/form/{{=parameters.form_id}}/notification
.
The result is extracted from:{{=response.notifications}}
.The action has the following user-defined parameters:
- form_id: Required. Specify the form identifier.
Documentation: https://developers.formstack.com/reference#form-id-notification-get.
- [Read Single] action
-
Endpoint URL address:
/notification/{{=parameters.email_id}}
.The action has the following user-defined parameters:
- email_id: Required. Specify the email identifier.
Documentation: https://developers.formstack.com/reference#notification-id-get.
- [Create] action
-
Endpoint URL address:
/form/{{=item.id}}/notification
.Documentation: https://developers.formstack.com/reference#form-id-notification-post.
- [Update] action
-
Endpoint URL address:
/notification/{{=item.id}}
.Documentation: https://developers.formstack.com/reference#notification-id-put.
- [Delete] action
-
Endpoint URL address:
/notification/{{=item.id}}
.Documentation: https://developers.formstack.com/reference#notification-id-delete.
The resource includes the fields from the EmailNotificationT template.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/form/{{=parameters.form_id}}/webhook
.
The result is extracted from:{{=response.webhooks}}
.The action has the following user-defined parameters:
- form_id: Required. Specify the form identifier.
Documentation: https://developers.formstack.com/reference#form-id-webhook-get.
- [Read Single] action
-
Endpoint URL address:
/webhook/{{=parameters.id}}
.The action has the following user-defined parameters:
- id: Required. Specify webhook identifier.
Documentation: https://developers.formstack.com/reference#webhook-id-get.
- [Create] action
-
Endpoint URL address:
/form/{{=item.id}}/webhook
.Documentation: https://developers.formstack.com/reference#form-id-webhook-post.
- [Update] action
-
Endpoint URL address:
/webhook/{{=item.id}}
.Documentation: https://developers.formstack.com/reference#webhook-id-put.
- [Delete] action
-
Endpoint URL address:
/webhook/{{=item.id}}
.Documentation: https://developers.formstack.com/reference#webhook-id-delete.
The resource includes the fields from the WebhookT template.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/smartlist
.
The result is extracted from:{{=response.results}}
.Documentation: https://developers.formstack.com/reference#smartlist-get-all.
- [Read Single] action
-
Endpoint URL address:
/smartlist/{{=parameters.id}}
.The action has the following user-defined parameters:
- id: Required. Specify the smartList_id.
Documentation: https://developers.formstack.com/reference#smartlist-get-one.
- [Create] action
-
Endpoint URL address:
/smartlist
.Documentation: https://developers.formstack.com/reference#smartlist-create.
- [Update] action
-
Endpoint URL address:
/smartlist/{{=item.id}}
.Documentation: https://developers.formstack.com/reference#smartlist-update.
- [Delete] action
-
Endpoint URL address:
/smartlist/{{=item.id}}
.Documentation: https://developers.formstack.com/reference#smartlist-delete.
- id
A key field. Data type: DT_I4
- created
Template: DateTime. A read-only field.
- name
Template: ShortText.
- updated
Template: DateTime. A read-only field.
- useImages
Data type: DT_BOOL
- useSeparateValues
Data type: DT_BOOL
- smartlist_options
The value is gathered from
/smartlist/{{=item.id}}/option
address. The gathered value is processed with{{=response.results}}
expression. Field components:- An array.
- Contains the following components: created, updated, imageUrl, label, id, sort, value.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/smartlist/{{=parameters.id}}/option
.
The result is extracted from:{{=response.results}}
.The action has the following user-defined parameters:
- id: Required. Specify the smartList_id.
Documentation: https://developers.formstack.com/reference#smartlist-option-get-all.
- [Read Single option] action
-
Endpoint URL address:
/smartlist/{{=parameters.id}}/option/{{=parameters.optionId}}
.The action has the following user-defined parameters:
- id: Required. Specify the smartlist_id.
- optionId: Required. Specify the option_id.
Documentation: https://developers.formstack.com/reference#smartlist-option-get-one.
- [Create] action
-
Endpoint URL address:
/smartlist/{{=item.id}}/option
.Documentation: https://developers.formstack.com/reference#smartlist-option-create.
- [Update] action
-
Endpoint URL address:
/smartlist/{{=item.id}}/option/{{=item.optionId}}
.Documentation: https://developers.formstack.com/reference#smartlist-option-update.
- [Delete] action
-
Endpoint URL address:
/smartlist/{{=item.id}}/option/{{=item.optionId}}
.Documentation: https://developers.formstack.com/reference#smartlist-option-delete.
- id
A key field. Data type: DT_I4
- optionId
A key field. Data type: DT_I4
- created
Template: DateTime. A read-only field.
- name
Template: ShortText.
- imageUrl
Template: ShortText.
- label
Template: ShortText.
- updated
Template: DateTime. A read-only field.
- value
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/portal
.
The result is extracted from:{{=response}}
.Documentation: https://developers.formstack.com/reference#portal-all.
- [Read Single] action
-
Endpoint URL address:
/portal/{{=parameters.id}}
.The action has the following user-defined parameters:
- id: Required. Specify the portal_id.
Documentation: https://developers.formstack.com/reference#portal-get-one.
- [Update] action
-
Endpoint URL address:
/portal/{{=item.id}}
.Documentation: https://developers.formstack.com/reference#portal-update.
- [Delete] action
-
Endpoint URL address:
/portal/{{=item.id}}
.Documentation: https://developers.formstack.com/reference#portal-delete.
- id
A key field. Data type: DT_I4
- name
Template: ShortText.
- description
Template: ShortText.
- avatar
Template: ShortText.
- avatarContent
Data type: DT_IMAGE The value is gathered from
{{=new Uri(connection.serverHost).authority()/ + item.portalUsers.avatarURI}}
address. Before setting, the value is processed with{{=getClrType('System.Convert').ToBase64String(value.readAll())}}
expression.- created
Template: DateTime. A read-only field.
- timezone
Template: ShortText.
- participantCount
Data type: DT_I4 A read-only field.
- portalForms
Field components:
- An array.
- Contains the following components: id, name, deadline, completedUserCount, description, formUrl, formId, notifyUsers, usersPerformance.
- portalUsers
Field components:
- An array.
- Contains the following components: id, avatarUrl, email, name, type.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/portal/{{=parameters.portal_id}}
.
The result is extracted from:{{=response.portalUsers}}
.The action has the following user-defined parameters:
- portal_id: Required. Specify the portal identifier.
Documentation: https://developers.formstack.com/reference#portal-get-one.
- [Create] action
-
Endpoint URL address:
/portal/{{=item.id}}/user
.Documentation: https://developers.formstack.com/reference#portal-add-user.
- [Update] action
-
Endpoint URL address:
/portal/{{=item.id}}/user
.Documentation: https://developers.formstack.com/reference#portal-edit-user.
- [Delete] action
-
Endpoint URL address:
/portal/{{=item.id}}/user
.Documentation: https://developers.formstack.com/reference#portal-delete-user.
- id
A key field. Data type: DT_I4
- avatarUrl
Template: ShortText.
Template: ShortText.
- name
Template: ShortText.
- type
Template: ShortText.
- emails
Template: LongText. A composite field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/portal/{{=parameters.portal_id}}
.
The result is extracted from:{{=response.portalForms}}
.The action has the following user-defined parameters:
- portal_id: Required. Specify the portal identifier.
Documentation: https://developers.formstack.com/reference#portal-get-one.
- [Create] action
-
Endpoint URL address:
/portal/{{=item.id}}/form
.Documentation: https://developers.formstack.com/reference#portal-add-form.
- [Update] action
-
Endpoint URL address:
/portal/{{=item.id}}/form/{{=item.portalFormId}}
.Documentation: https://developers.formstack.com/reference#portal-update-form.
- [Delete] action
-
Endpoint URL address:
/portal/{{=item.id}}/form/{{=item.portalFormId}}
.Documentation: https://developers.formstack.com/reference#portal-delete-form.
- id
A key field. Data type: DT_I4
- formId
Data type: DT_I4
- portalFormId
A key field. Template: ShortText.
- name
Template: ShortText.
- deadline
Field components:
-
Uses template:
ShortText
. - Contains the following components: frequency, dueDay, dueTime, earlyReminderHours.
-
Uses template:
- notifyUsers
Data type: DT_BOOL
- description
Template: ShortText.
- [Read] action
-
The result is extracted from:{{=[response]}}
.
The result is paginated.The following request parameters will be automatically processed:
-
page:
{{=parameters.iterator}}
-
per_page:
{{=parameters.batchSize}}
-
_includeUserParameters:
{{=parameters}}
-
page:
- [Create] action
-
The action uses POST method.The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}}
-
application/json:
{{=item}}
-
_includeUserParameters:
- [Update] action
-
The action uses PUT method.The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}}
-
application/json:
{{=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
- LogicT
Field components:
-
Uses template:
ShortText
. - Contains the following components: action, conditional, checks.
-
Uses template:
- FolderT
Field components:
- An array.
- Contains the following components: id, name, parent, permissions.
- BasicFieldT
Field components:
-
Uses template:
ShortText
. - Contains the following components: id, label, hide_label, description, name, type, default, required, uniq, hidden, readonly, show_initial, show_middle, show_prefix, show_suffix, text_size.
-
Uses template:
- SubmissionT
Field components:
-
Uses template:
DateTime
. - Contains the following components: id, timestamp, user_agent, remote_addr, payment_status, latitude, longitude, form, data, total_submissions, totalSubmissionsByDay.
-
Uses template:
- EmailNotificationT
Field components:
-
Uses template:
ShortText
. - Contains the following components: id, form, name, from_type, from_value, recipients, subject, type, hide_empty, show_section, message, attach_limit, logic.
-
Uses template:
- ConfirmationEmailT
Field components:
-
Uses template:
ShortText
. - Contains the following components: id, form, name, to_field, sender, subject, type, format, hide_empty, show_section, message, delay, logic.
-
Uses template:
- WebhookT
Field components:
-
Uses template:
ShortText
. - Contains the following components: id, url, handshake_key, name, content_type, use_subfield_ids, no_subfield_names, include_field_type, file_transfer_type, standardize_field_values, post_data_field_keys, logic.
-
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.