Data Extraction in Unqork

This article covers the methods available for extracting data from Unqork, including submission data, attachment data, module and workflow definitions, and style sheets.

Note: An access token is required before using any of these APIs. See Authentication in the Unqork API documentation.

Submission Data

Submission data refers to information stored when end-users interact with modules and save their inputs. Each save or submit action creates a new submission and a unique submission ID.

Common reasons to extract submission data include:

• Audit and compliance: Auditing or demonstrating adherence to industry regulations, internal policies, or legal requirements.
• Data ownership: Retaining a copy of all submission data submitted and stored in Unqork applications.
• Analysis and reporting: Using submission data for internal analysis and business reporting.
• Data migration: Moving submission data to a different platform or service.

Endpoints

Replace {host} with the Unqork environment URL and the ID placeholder with the module or workflow ID. Both endpoints return up to 50 submissions per call.

Check the Response Header: If a next link header is present, more submissions are available. Repeat API calls using the next link until no next link displays.

FAQ

Can the API retrieve more than 50 submissions at one time?

No. The maximum per API call is 50. Use scripting to automate additional calls.

Are there alternate methods for exporting submissions?

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

Exporting Submission Data

Unqork's internal API supports exporting submission data to the cloud or locally. See Bulk Data Operations for details.

Attachment Data

Attachment data refers to images or files saved as part of a submission, like /Excel, PDF, or image files.

Use the same submission endpoints to retrieve attachment data. In the response, submissions with attachment data include Storage Delivery links in the following format:

https://{host}/fbu/files/{filePath}?signature={signature}

Repeat API calls until no next link is present, retrieving attachment data from each Cloud Storage Delivery link.

FAQ

How long is the Cloud Storage Delivery link valid?

24 hours.

Does the link change when making the same API call more than once?

Yes. Each API call generates a new link. Previous links remain valid for 24 hours from when they were generated.

Resources

• Get Module Submissions — API reference for retrieving module submission records
• Get Workflow Submissions — API reference for retrieving workflow submission records
• Paging — how to paginate through large result sets
• Cloud Storage Delivery — how Cloud Storage Delivery links work

Configuration Data

Exporting configuration data lets organizations maintain ownership of their intellectual property. Copying module or workflow definitions lets Creators duplicate configurations across environments.

Module Definition

1. Open the module in the Module Builder.
2. At the top right, select the (ellipsis) to open the drop-down, hover over Modify Module, and select Copy Module. The module definition copies to the clipboard.
3. Paste the definition into a text or code editor to save it.

Workflow Definition

1. Open the workflow in the Workflow Builder.
2. At the top right, select the (ellipsis) to open the drop-down, hover over Modify Workflow, and select Copy Workflow. The workflow definition copies to the clipboard.
3. Paste the definition into a text or code editor to save it.

FAQ

What should Creators consider when reusing an existing definition?

When pasting a definition into a new environment or application, any environment-specific configurations may not exist in the new context. These include Plug-In component services, references to other module IDs, and module RBAC permissions.

Style Sheets

Environments styled with custom CSS can export those style sheets from Style Administration.

1. Log in to the environment.
2. Navigate to Administration > Environment > Style Administration.
3. In the table, locate the style to export.
4. Select Manage ▾ and select Download.

FAQ

Can the style sheet be deleted after downloading?

Yes. See Style Administration for details.