Overview

The Workflow Import Queue is a Workflow-enabled bulk import tool that lets users upload CSV files through the web UI to import/update data.

This API is an alternative way of starting an import process; instead of a user uploading a CSV file through the browser, and API client sends a JSON payload to the API endpoint.

The end result is the same: in both cases, a WORKFLOW_IMPORT_QUEUE_BATCH is created with one row per imported data record and is then processed on a background queue.

Supported features

This is an alternative way of getting data into the import queue, but once the data is in the queue it supports the full set of Workflow Import Queue functionality.

The main difference is that the UI validates the data, gives the user a summary of what operations will be performed, and waits for user confirmation before actually processing the data.

There is no “prompt for confirmation” element to this API call; the posted data is added directly to the processing queue.

Using the API

Calling this API requires an API Key with the BeginWorkflowImportProcess permission.

The key should be passed using the “apikey” authorization scheme.

Authorization: apikey xxxxxxxxxxxxxxxxx

HTTP Request

Payload is a JSON document in JSON Lines format submitted via HTTP Post.

Each line contains a full JSON-formatted data row to process.

{
  importProcessId: <int>,
  sendFailureNoticeOnErrorTo: "comma separated list of email addresses",
  data: [
    { data row 1, on single line },
    { data row 2, on single line },
    ...
  ]
}

HTTP Response

The HTTP response is…

TODO

Error messages