Bulk Data Operations

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

The Bulk Data Operations (BDO) API lets Creators move large volumes of submission data into and out of the Unqork platform. Four operations are available:

• Export — download submission data to a file or cloud storage
• Import — upload submission data from a file or cloud storage
• Update — update existing Data Model records in bulk
• Delete — soft-delete or permanently delete submission records

All BDO jobs are limited to 100 MB. Use Bulk Operations: Utilities to generate upload and download links, and to check job status.

Test any endpoint: Access the Unqork Services page at https://{environment}.unqork.io/fbu/uapi/docs/documentation/#/Bulk%20Operations/. Replace {environment} with the environment name.

Export

The BDO Export endpoint downloads submission data out of Unqork to a file or cloud storage. Use the HTTP POST method:

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

Request Body

{
  "cloudStorageBucketName": "string",
  "cloudStorageServiceName": "string",
  "cloudStorageTargetDirectory": "string",
  "resourceId": "string",
  "dateFieldEndToFilterOn": "string",
  "dateFieldStartToFilterOn": "string",
  "dateFieldToFilterOn": "created",
  "exportFullRecord": true,
  "fileFormat": "CSV",
  "includeAttachments": true,
  "name": "string",
  "numberOfFilesToGenerate": 1,
  "targetRecordType": "ALL"
}

Parameters

Example Response

{
  "id": "67129acfc2f4b88db7a26b59",
  "created": 1729272527398,
  "data": {
    "type": "EXPORT",
    "name": "Example Export",
    "steps": [
      {
        "stepType": "EXPORT",
        "status": "created",
        "files": [
          {
            "destination": {
              "name": "0",
              "location": "unqorkResource/export/9adf217f-5ccb-449c-9920-f1e0000597d7/0.csv",
              "format": "CSV"
            }
          }
        ]
      }
    ]
  }
}

The location value contains the file's download address. Use BDO Download-Link to retrieve the file.

Large exports: Use /fbu/uapi/bulkOperations/job/{jobId} to check job status. See Get Job Details.

Import

The BDO Import endpoint uploads submission data into Unqork from a file or cloud storage. Use the HTTP POST method:

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

Before importing, use BDO Upload-Link to upload the file and get an Unqork file address.

Request Body

{
  "dataModelOrModuleId": "string",
  "fallbackRecordOwner": "string",
  "fileFormat": "CSV",
  "fileLocation": "string",
  "name": "string",
  "storeInData": "false"
}

Parameters

Example Response

{
  "id": "67169684ec1bf4776fa760a5",
  "created": 1729533572882,
  "data": {
    "type": "UPDATE",
    "name": "Import API Test 1",
    "steps": [
      {
        "stepType": "UNZIP",
        "status": "created"
      },
      {
        "stepType": "UPDATE",
        "status": "created"
      }
    ]
  }
}

Check job status using the Get Job Details endpoint with the response id value.

Update

The BDO Update endpoint updates existing Data Model records in bulk. Only available for Data Model records. Use the HTTP method:

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

Request Body

{
  "createdDateUpdateValue": "string",
  "dataModelOrModuleId": "string",
  "fallbackRecordOwner": "string",
  "fileFormat": "CSV",
  "fileLocation": "string",
  "name": "string",
  "storeInData": "true",
  "uniqueKey": "string",
  "upsert": "false"
}

Parameters

Check job status using the Get Job Details endpoint with the response id value.

Delete

The BDO Delete endpoint soft-deletes or permanently deletes submission records. BDO Delete is disabled by design. Contact an Unqork representative to enable it.

Use the HTTP POST method:

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

BDO Delete removes a maximum of 500,000 records per operation. Larger collections require multiple runs.

Soft Delete and Hard Delete

Delete operates in two stages:

• Soft delete (first run): Archives records, removing them from Record Collections but retaining them in the database. Records can be recovered.
• Hard delete (second run with destroy=true): Permanently and irreversibly deletes all archived records. Use for PII or sensitive data that must not be retained.

Unqork recommends exporting a copy of records before deleting. Contact an Unqork representative to recover soft-deleted records.

Query String Parameters

Body Parameters

{
  "dataModelOrModuleId": "string",
  "name": "string",
  "dateFieldToFilterOn": "created",
  "dateFieldStartToFilterOn": "string",
  "dateFieldEndToFilterOn": "string"
}

Example Response

{
  "id": "6728e46499610f86e6fac431",
  "created": 1730733156824,
  "data": {
    "type": "DELETE",
    "name": "Delete Example",
    "steps": [
      {
        "stepType": "DELETE",
        "status": "created",
        "options": {
          "delete": {
            "mode": "DELETE",
            "dataSource": "MODULE",
            "targetRecords": "ARCHIVED"
          }
        }
      }
    ]
  }
}

Check job status using the Get Job Details endpoint with the response id value.