Bulk Operations: Utilities

Note: All BDO endpoints are only accessible to Creators and Express Administrators.

Three utility endpoints support the main Bulk Data Operations workflow:

• Upload-Link — generate a pre-signed URL to upload a file to the Unqork before importing
• Download-Link — generate a pre-signed URL to download a file after exporting
• Get Job Details — check the status and details of any in-progress or completed BDO job

Upload-Link

The Upload-Link endpoint generates a URL for uploading source files to the Unqork Cloud. Use it before running BDO Import to get the fileLocation value the import endpoint requires.

Use the HTTP POST method (no request body required):

https://{environment}.unqork.io/fbu/uapi/bulk-operations/upload-link

Example Response

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

Uploading a File Using Postman

Files larger than 100 MB are not supported.

After generating the uploadLink value:

1. Create a POST request to https://{environment}/api{uploadLink} — for example, https://training.unqork.io/api/files/6734ce93abs9a01036b3f07c.
2. In Headers, set Content-Type to multipart/form-data.
3. In the Body tab, set the data type to form-data.
4. In the Key column, enter file and set the type to File.
5. In the Value column, select the submission data file from the local machine.
6. Click Send.

The response body returns the fileKey value used in the BDO Import fileLocation field:

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

Download-Link

The Download-Link endpoint generates a URL for downloading exported files from the Unqork Cloud. Use it after running BDO Export to retrieve the output file.

Use the HTTP POST method:

https://{environment}.unqork.io/fbu/uapi/bulk-operations/download-link

Request Body

{
  "fileLocation": "string"
}

Example Response

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

Downloading the File

Use the downloadLink value in a request:

https://{environment}/api{downloadLink}

For example: https://training.unqork.io/api/files/6734ce93abs9a01036b3f07c

In Postman: In the Body Response window, select the (ellipsis) next to Save Response, then select Save Response to file. Enter a name and local , then click Save.

Get Job Details

The Get Job Details endpoint returns the status and details of any BDO job: Import, Export, Update, or Delete. Use the HTTP GET method:

https://{environment}.unqork.io/fbu/uapi/bulkOperations/jobs/{jobId}

Note: The Get Job Details endpoint uses the bulkOperations path (not bulk-operations). All other BDO endpoints use the bulk-operations path.

Replace {jobId} with the id value from the operation's initial response.

Key Response Properties

Example — Export Job

{
  "id": "67114d26340b0b7c0510c680",
  "data": {
    "type": "EXPORT",
    "name": "Example Export",
    "steps": [
      {
        "stepType": "EXPORT",
        "status": "completed",
        "files": [
          {
            "destination": {
              "name": "0",
              "location": "unqorkResource/export/78b9abdc-df4a-42e0-8b02-1ce0377a1a61/0.csv",
              "format": "CSV"
            }
          }
        ],
        "details": {
          "docs": { "total": 4, "processed": 4 }
        }
      }
    ],
    "status": "completed"
  }
}

Example — Import Job

{
  "id": "6711511ab056c32e103b11e5",
  "data": {
    "type": "UPDATE",
    "name": "Import Example 1",
    "steps": [
      {
        "stepType": "UPDATE",
        "status": "completed",
        "details": {
          "docs": { "total": 4, "processed": 4 }
        }
      }
    ],
    "status": "completed"
  }
}

Example — Delete Job

{
  "id": "6728e46499610f86e6fac431",
  "data": {
    "type": "DELETE",
    "name": "Delete Example",
    "steps": [
      {
        "stepType": "DELETE",
        "status": "completed",
        "details": {
          "docs": { "total": 32, "processed": 32 }
        }
      }
    ],
    "status": "completed"
  }
}