Bulk Operations: Download-Link

This feature is currently in production early-access. Functionality is subject to change as this feature is prepared for general access.

Overview

The Bulk Operations (BO) Download-Link 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. endpoint generates a URL address for exporting data out of the Unqork platform. For example, you could use the Bulk Data Operation: Export API Endpoint to export submission data Also known as Record Data. Submission data consists of information saved by Unqork components. View submission data by using the angular command, or in Record Collections. into the Unqork Cloud, then generate a download link to retrieve the file. You can generate a download link using curl, Postman, or any other service that supports a POST The HTTP POST method is used to send data to a server to create or update a resource, typically including the data in the body of the request. request.

After generating a download link, you can download the submission data using a web browser, Postman, or any service that supports a GET The HTTP GET method is used to request data from a server, typically retrieving information without modifying any resources. request.

Discover how to set up API calls using a third-party program, view our Testing API Endpoints Using Third-Party Applications article.

Test the BO Download-Link endpoint using the Unqork Services page. To access the Unqork Services page, enter the following address into your browser: https://{environment}.unqork.io/fbu/uapi/docs/documentation/#/Bulk%20Operations/createDownloadLink. Replace {environment} with the name of your Unqork environment.

Creating a Download-Link Using Bulk Operations

BO Download-Link uses the HTTP HTTP (Hypertext Transfer Protocol) is an application-layer protocol used to transmit hypermedia documents like HTML. POST The HTTP POST method is used to send data to a server to create or update a resource, typically including the data in the body of the request. method and the following endpoint: https://{environment}.unqork.io/fbu/uapi/bulk-operations/download-link. Replace {environment} with the name of your Unqork environment.

Insert the following into the request body:

Copy 
{
  "fileLocation": "string"
}

The following parameter is available for the Bulk Data Download-Link schema Schema is a declarative language that defines the structure, content, and constraints of the data.:

Key

Possible Values

Description

 Required

fileLocation

string (no spaces)

Enter the Unqork Cloud file location key's value generated from the BDO Export operation. For example, unqorkResource/export/78bdc-df4a-41a61/0.csv.

You can find the Unqork Cloud file location using the BDO Get Job Details endpoint targeting the BDO Export's id value.

Optional

Example Response

In the BO Download-Link response below, the downloadLink field contains the address of the exported file for download:

Copy 
{
    "downloadLink": "/files/6734ce93abs9a01036b3f07c"
}

Retrieving a File Using the Download Link

After generating a download link value, create a GET The HTTP GET method is used to request data from a server, typically retrieving information without modifying any resources. call using a web browser, Postman, or other API service.

Use the following endpoint: https://{{environment}}/api{{createFileDownloadLink}}. Replace {{environment}} with the name of your Unqork environment, and {{createFileDownloadLink}} with the downloadLink value. For example, https://training.unqork.io/api/files/6734ce93abs9a01036b3f07c.

Downloading Data Using Postman

To download the data using Postman:

1. In the Body Response window, next to the Save Response button, click the ⋯ (ellipsis) button.
2. From the drop-down, select Save Response to file.

A static image displaying the Postman application. The triple elipsis button is highlighted, and the Save response to file button is highlighted.

3. Enter a name for the file and specify a local location where you want to download the file.
4. Click Save. The file saves in the format specified during the BDO Export operation.

Resources