Bulk Operations: Upload-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) Upload-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 uploading source files with data. For example, you can generate an upload link to upload 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. files into the Unqork Cloud. Then, import them into a Records Collection using the BDO Import endpoint. You can generate a upload-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 an upload link, Creators can create an POST The HTTP GET method is used to request data from a server, typically retrieving information without modifying any resources. request to upload the submission data file using the upload link.

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 Upload-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/createUploadLink. Replace {environment} with the name of your Unqork environment.

Creating an Upload-Link Using Bulk Operations

The BO Upload-Link API 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/upload-link. Replace {environment} with the name of your Unqork environment.

Unlike the BO Download-Link Endpoint, no request body is required to generate an upload link.

Example Response

In the BO Upload-Link response below, the uploadLink field contains the partial address of the exported file for upload:

Copy 
{
    "uploadLink": "/files/67362e899daeec21a884b60b"
}

Uploading a File Using Postman

While multiple services can upload a file to the Unqork Cloud, the example below is for uploading a file using the Postman API service.

Files larger than 100mb are not supported.

In Postman, after generating the uploadLink value:

1. Create 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 using the following endpoint: https://{{environment}}/api{{createFileUploadLink}}. Replace {environment} with the name of your Unqork environment, and {{createFileUploadLink}} with the uploadLink value. For example, https://training.unqork.io/api/files/6734ce93abs9a01036b3f07c.

If you are composing the URL programmatically, the link includes the forward slash.

A static image displaying the Postman application. the Upload Request is set to POST and is pointed at the required endpoint.

2. In the request's Headers, add or set the Content-Type field to multipart/form-data.

A static image displaying the Postman Headers tab. The headers include the Content-Type key with a value of multipart/form-data.

3. In the Body tab, set the data type to form-data. The key-value table displays.
4. In the Key column, enter file.
5. In the Key column, set the Text drop-down to File.
6. In the Value column, click the Select Files cell. A drop-down displays.
7. Click + New file from local machine.

A static image displaying the Postman Body. the form-data type is selected, and the file key's value is selected, displaying a file selection box.

8. Navigate to and select the submission data file.
9. Click Send. The response body returns the Unqork Cloud fileKey used in the BDO Import endpoint.

A static image displaying the Postman Response Body. The fileKey field displays the Unqork Cloud path used in the BDO Import endpoint.

Example Response

After uploading a file, the fileKey field displays the Unqork Cloud file path used in the BDO Import endpoint's fileLocation field:

Copy 
{
    "fileKey": "unqorkResource/36bac174-1a20-4072-b976-eeeaea879343.csv"
}

Learn how to import an uploaded file using our Bulk Data Operations: Import article.

Resources