Data Extraction in Unqork

Overview

This article provides a comprehensive guideline for extracting the various types of data that Unqork stores. Clients can find instructions for extracting meaningful data for their organization. By adhering to these instructions, clients can extract their submission data, attachment data, and other data stored in Unqork.

IMPORTANT  You must generate an access token before using any of these APIs. Please refer to our API documentation for generating an access token for authentication: https://developers.unqork.io/#section/Authentication.

TIP  This article focuses on the types of data you can extract data from Unqork. To learn how to extract this data and use preconfigured modules to do so, view our How to: Extract Data From Unqork article.

Submission Data Extraction

Submission data refers to information stored when end-users End-users, also known as Express Users, are the individuals accessing an application through Express View. In most cases, end-users are the customers using the product. interact with your modules and save their inputs. Your end-user creates a new submission (and submission ID) every time they save or submit their data.

Clients typically need to access their submission data depending on the context of the data involved. Below are some examples of why extracting submission data might be useful.

Record Keeping and Compliance

  • Audit Purposes: Clients might need their submission data for auditing or compliance purposes to ensure adherence to industry regulations, internal policies, or legal requirements.

Data Ownership and Reporting

  • Ownership: Clients might want a copy of all submission data submitted and stored in their applications.

  • Analysis and Reporting: Clients might want information for internal analysis and reporting on business conducted in their Unqork applications.

Data Migration

  • Migration: Clients might need submission data for a different platform or service. Clients might be interested in preserving this information for future business purposes.

Extracting Submission Data

In this section, you'll explore the ways you can extract your data from Unqork.

Schema Module Submissions

Use the following API APIs (application programming interfaces) are a set of protocols and definitions developers use to build and integrate application software. APIs act as the connective tissue between products and services. format to retrieve the first 50 submissions from your schema module: https://{host}/api/1.0/modules/{moduleId}/submissions. You’ll replace {host} with your Unqork environment URL and {moduleId} with the module ID of your schema module.

For example, https://trainingx.unqork.io/api/1.0/modules/63a4c85986e5d0ecb416c8a7/submissions.

IMPORTANT  

Check the Response Header: More items must be retrieved if the next link header is present. You’ll find your current API call link and the next link that contains the next 50 submissions.

For example, https://{host}/api/1.0/modules/{moduleId}/submissions?offset=50).

Repeat the API GET calls until no more new submissions remain, signified by no next link being present.

Schema Workflow Submissions

Use the following API APIs (application programming interfaces) are a set of protocols and definitions developers use to build and integrate application software. APIs act as the connective tissue between products and services. format to retrieve the first 50 submissions from your schema workflow: https://{host}/api/1.0/workflows/{workflowId}/submissions. You’ll replace {host} with your Unqork environment URL and {workflowId} with the workflow ID of your schema workflow.

For example, https://trainingx.unqork.io/api/1.0/workflows/63740406be1640f9a87a6b6e/submissions.

IMPORTANT  

Check the Response Header: More items must be retrieved if the next link header is present. You’ll find your current API call link and the next link that contains the next 50 submissions.

For example, https://{host}/api/1.0/workflows/{workflowId}/submissions?offset=50).

Repeat the API GET calls until no more new submissions remain, signified by no next link being present.

FAQ

Q: Do I use my Unqork Express or Designer environment URL in the {host} portion of the API?

A: This API can be used with either the Unqork Express or Designer environment URL.

Q: Is it possible to use the API to get more than 50 submissions at one time?

A: The maximum number of submissions that can be retrieved with a single API call is 50. However, you can use scripting to automate the process and run additional API calls.

Q: Are there any alternate methods that can be used to export submissions?

A: If the Bulk Record Data Export feature is available in your environment, use it to export submissions from each Record Collection.

Resources