Overview
Configuration is provided for establishing connections with the Goformz 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 a service resource.
Insert data
Use REST Destination component to insert data into a service resource.
Quick Start
This guide provides a step-by-step walkthrough on how to create a connection to the GoFormz REST API using COZYROC's REST Connection Manager using OAuth Client Credentials Flow.
Step 1: Open Visual Studio as Administrator and add a REST Connection Manager by right-clicking in the Connection Managers area and selecting New Connection > REST.
Step 2: From the Configuration dropdown menu, select GoFormz.
Step 3: Provide client_id, client_secret. Then press Test Connection button.
Congratulations! You’ve successfully established a connection to your GoFormz instance. You’re now ready to begin integrating and working with your data.
This guide demonstrates how to read data from the GoFormz service using the COZYROC REST Source component.
Step 1: Select an existing Data Flow Task or create a new Data Flow Task to begin configuring your data extraction.
Step 2: Open the SSIS Toolbox, then drag and drop the COZYROC REST Source component onto the Data Flow design surface.
Step 3: Double-click the REST Source component to open its settings. From the dropdown menu, select your GoFormz connection. Then, choose the desired resource from the list available in the second dropdown below.
If necessary, you can add additional parameters in the grid at the bottom..
Step 4: Click on the Columns tab, then select the GoFormz resource columns you want to retrieve.
Step 5: Click Preview to verify that all the required resource columns are included.
Congratulations! You have successfully learned how to read data from the GoFormz service.
This guide provides a step-by-step demonstration on how to write data to the GoFormz service resource using the COZYROC REST Destination component.
Step 1: Select an existing Data Flow Task or create a new one.
Step 2. Open the SSIS Toolbox, then drag and drop the COZYROC REST Destination component onto the design surface.
Step 3: Double-click the REST Destination component to open its settings. Select your GoFormz connection from the dropdown menu, then choose the desired resource action and the resource you wish to work with.
Step 4: Click the Mapping tab and map the input columns according to the process you are configuring.
If you need to provide input for other composite resource objects, adjust the inputs above accordingly and map the corresponding columns.
You’re all set! You have successfully learned how to write data to the GoFormz resource.
Configuration
Base URL address: https://api.goformz.com/v2.
- OAuth 2 Client Credentials
-
The authentication uses a session token.
The authentication has the following user-defined parameters:
- client_id: Required. Specify client identifier.
- client_secret: Required. Specify client secret.
The following request parameters will be automatically processed during the authentication process:
-
Authorization:
Bearer {{=token.Access}}
Documentation: https://datatracker.ietf.org/doc/html/rfc6749#section-1.3.4.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/templates/{{=GoFormz.UI.TemplateEditor.getValue(parameters)}}/formz.The action has the following user-defined parameters:
- templateId: Required. Specify the template identifier.
Documentation: https://api.goformz.com/swagger/index.html#/Formz/GetForm_V2.
- [Create] action
-
Endpoint URL address:
/formz.The action has the following user-defined parameters:
- templateId: Required. Specify the template identifier.
Documentation: https://developers.goformz.com/reference/create-a-form.
- [Update] action
-
Endpoint URL address:
/formz/{{=item.formId}}.The action has the following user-defined parameters:
- templateId: Required. Specify the template identifier.
- formId: Required. Specify the form identifier.
Documentation: https://developers.goformz.com/reference/update-an-existing-form.
- [Delete] action
-
Endpoint URL address:
/formz/{{=item.formId}}.Documentation: https://developers.goformz.com/reference/delete-a-form.
The resource includes the fields from the Form template.
- action
Field components:
-
Uses template:
ActionT. - Contains the following components: complete, reopen.
-
Uses template:
Data type: DT_IMAGE The gathered value is processed with
{{=GoFormz.getFormPDF(item, parameters)}}expression.
- [External]
-
The external fields URL address:
/templates/{{=GoFormz.UI.TemplateEditor.getValue(parameters)}}. The external fields list is extracted from:{{=GoFormz.getFormFields(_.values(response.fields))}}.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/templates.Documentation: https://developers.goformz.com/reference/get-a-list-of-templates.
- [Read Single] action
-
Endpoint URL address:
/templates/{{=GoFormz.UI.TemplateEditor.getValue(parameters)}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- templateId: Required. Specify the template identifier.
Documentation: https://developers.goformz.com/reference/get-a-template.
- id
Template: Id.
- name
Template: ShortText.
- url
Template: LongText.
- fields
Template: MetadataT.
- pages
Field components:
- An array.
-
Uses template:
Page.
- dataLayouts
Field components:
- An array.
- Contains the following components: id, tabs.
- forms
The value is gathered from
/templates/{{=item.id}}/formzaddress. Field components:- An array.
-
Uses template:
Form.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/groups.Documentation: https://developers.goformz.com/reference/get-a-list-of-groups.
- [Read Single] action
-
Endpoint URL address:
/groups/{{=GoFormz.UI.GroupEditor.getValue(parameters)}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- groupId: Required. Specify the group identifier.
Documentation: https://developers.goformz.com/reference/get-a-group.
- id
Template: Id.
- name
Template: ShortText.
- url
Template: LongText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/users.Documentation: https://developers.goformz.com/reference/get-a-list-of-users.
- [Read Single] action
-
Endpoint URL address:
/users/{{=GoFormz.UI.UserEditor.getValue(parameters)}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- userId: Required. Specify the user identifier.
Documentation: https://developers.goformz.com/reference/get-a-user.
- id
Template: Id.
- name
Template: ShortText.
- url
Template: LongText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/datasources.Documentation: http://developers.goformz.com/reference/get-a-list-of-data-sources.
- [Read Single] action
-
Endpoint URL address:
/datasources/{{=GoFormz.UI.DataSourceEditor.getValue(parameters)}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- dataSourceId: Required. Specify the data source identifier.
Documentation: https://developers.goformz.com/reference/get-a-data-source.
- [Create] action
-
Endpoint URL address:
/datasources.Documentation: https://developers.goformz.com/reference/create-a-data-source.
- [Update] action
-
Endpoint URL address:
/datasources/{{=item.id}}.Documentation: https://developers.goformz.com/reference/update-an-existing-data-source-1.
- [Delete] action
-
Endpoint URL address:
/datasources/{{=item.id}}.Documentation: https://developers.goformz.com/reference/update-an-existing-data-source-1.
- id
Template: Id.
- name
Template: ShortText.
- isPublic
Data type: DT_BOOL
- copyLocal
Data type: DT_BOOL
- columns
Template: LongText. A composite field.
- indexes
Template: LongText. A composite field.
- lastUpdatedDate
Template: DateTime. A read-only field.
- lastUpdatedBy
Template: ShortText. A read-only field.
- lastRowUpdatedDate
Template: DateTime. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/datasources/{{=GoFormz.UI.DataSourceEditor.getValue(parameters)}}/rows.
The result is extracted from:{{=GoFormz.getDataRows(resource.getFields(parameters), response)}}.The action has the following user-defined parameters:
- dataSourceId: Required. Specify the data source identifier.
Documentation: https://developers.goformz.com/reference/get-a-list-of-data-source-rows.
- [Read Single] action
-
Endpoint URL address:
/datasources/{{=GoFormz.UI.DataSourceEditor.getValue(parameters)}}/rows/{{=parameters.rowId}}.
The result is extracted from:{{=GoFormz.getDataRows(resource.getFields(parameters), [response])}}.The action has the following user-defined parameters:
- dataSourceId: Required. Specify the data source identifier.
- rowId: Required. Specify the row identifier.
Documentation: https://developers.goformz.com/reference/get-a-data-source-row.
- [Create] action
-
Endpoint URL address:
/datasources/{{=GoFormz.UI.DataSourceEditor.getValue(parameters)}}/rows/batch.
The result is extracted from:{{=undefined}}.The action has the following user-defined parameters:
- dataSourceId: Required. Specify the data source identifier.
The following request parameters will be automatically processed:
-
application/json:
{{={ items: GoFormz.updateDataRows(resource.getFields(parameters), batch)} }}
Documentation: https://developers.goformz.com/reference/batch-create-data-source-rows.
- [Update] action
-
Endpoint URL address:
/datasources/{{=GoFormz.UI.DataSourceEditor.getValue(parameters)}}/rows/batch.
The result is extracted from:{{=undefined}}.The action has the following user-defined parameters:
- dataSourceId: Required. Specify the data source identifier.
The following request parameters will be automatically processed:
-
application/json:
{{={ items: GoFormz.updateDataRows(resource.getFields(parameters), batch)} }}
Documentation: https://developers.goformz.com/reference/batch-update-data-source-rows.
- [Delete] action
-
Endpoint URL address:
/datasources/{{=GoFormz.UI.DataSourceEditor.getValue(parameters)}}/rows/batch.
The result is extracted from:{{=undefined}}.The action has the following user-defined parameters:
- dataSourceId: Required. Specify the data source identifier.
The following request parameters will be automatically processed:
-
application/json:
{{={ ids: _.pluck(batch, 'id') } }}
Documentation: https://developers.goformz.com/reference/batch-delete-data-source-rows.
- id
Template: Id.
- keyColumn
Template: ShortText.
- value
Template: LongText.
- url
Template: LongText.
- lastUpdatedDate
Template: DateTime. A read-only field.
- lastUpdatedBy
Template: ShortText.
- [External]
-
The external fields URL address:
/datasources/{{=GoFormz.UI.DataSourceEditor.getValue(parameters)}}. The external fields list is extracted from:{{=GoFormz.getDataSourceFields(response)}}.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/webhooks.Documentation: https://developers.goformz.com/reference/get-webhooks.
- [Read Single] action
-
Endpoint URL address:
/webhooks/{{=parameters.webhookId}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- webhookId: Required. Specify the webhook identifier.
Documentation: https://developers.goformz.com/reference/get-a-webhook.
- [Create] action
-
Endpoint URL address:
/webhooks.Documentation: https://developers.goformz.com/reference/create-a-webhook.
- [Update] action
-
Endpoint URL address:
/webhooks.
The action uses PUT method.Documentation: https://developers.goformz.com/reference/update-an-existing-webhook.
- [Delete] action
-
Endpoint URL address:
/webhooks.Documentation: https://developers.goformz.com/reference/delete-a-webhook.
- id
Template: Id.
- eventType
Template: ShortText.
- targetUrl
Template: LongText.
- entityId
Template: ShortText.
- [Read] action
-
The result is paginated.The following request parameters will be automatically processed:
-
pageSize:
{{=parameters.batchSize}} -
pageNumber:
{{=parameters.iterator}} -
_includeUserParameters:
{{=parameters}}
-
pageSize:
- [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 PATCH 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
- Decimal
Data type: DT_R8
- Boolean
Data type: DT_BOOL
- Id
A key field. Template: ShortText.
- LocationT
Field components:
- Contains the following components: latitude, longitude, accuracy.
- Form
Field components:
-
Uses template:
Id. - Contains the following components: formId, name, overrideDefaultFormName, status, lastUpdateDate, assignment, location, templateId, templateUrl.
-
Uses template:
- Link
Field components:
-
Uses template:
Id. - Contains the following components: id, link.
-
Uses template:
- MetadataT
The gathered value is processed with
{{=_.map(value, function(v, k) { return { name: k, value: v }; })}}expression. Field components:- An array.
- Contains the following components: name, value.
- ImageFile
Field components:
-
Uses template:
ShortText. - Contains the following components: id, imageFile, name, type.
-
Uses template:
- Signature
Template: ImageFile. Field components:
-
Uses template:
LocationT. - Contains the following components: location, lines.
-
Uses template:
- FieldPosition
Field components:
-
Uses template:
ShortText. - Contains the following components: id, fieldId, h, w, y, x.
-
Uses template:
- Position
Field components:
-
Uses template:
ShortText. - Contains the following components: id, sortNumber, fieldId.
-
Uses template:
- TemplateSection
Field components:
-
Uses template:
ShortText. - Contains the following components: id, name, sortNumber, positions.
-
Uses template:
- Page
Field components:
-
Uses template:
Id. - Contains the following components: id, number, fieldPositions.
-
Uses template:
- Tab
Field components:
-
Uses template:
Id. - Contains the following components: id, name, sortNumber, sections.
-
Uses template:
- ActionT
Knowledge Base
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.