Versions Compared

Version Old Version 2 New Version 3
Changes made by

Seth Petry-Johnson

Seth Petry-Johnson

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Code Block
Authorization: apikey xxxxxxxxxxxxxxxxx

HTTP Request

...

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

{ importProcessId: <int>, sendFailureNoticeOnErrorTo: "comma separated list of email addresses", data: [
Code Block
languagejson
Info

For implementation reasons, this API endpoint uses querystring parameters AND a request body.

The querystring parameters provide some control data, and the request body contains the data to be imported.

The URI provides control data:

Code Block
POST /API/WorkflowImportQueue/CreateBatch
?importProcessId={id}
&sendSuccessEmailTo={email}
&sendFailureEmailTo={email}

  • importProcessId - the ID of the Workflow Import Queue "file type" to use;

  • sendSuccessEmailTo - (optional) an email address to notify of a successful import process

  • sendFailureEmailTo - (optional) an email address to notify in any records fail to process

The request body contains the data to import, using the JSON Lines format.

Code Block
languagejson
[
  { data row 1, on single line },
    { data row 2, on single line },
    ...
  ]
}
]

Each element in that array is the equivalent to a data row in an uploaded CSV file.

Note

In order to support large number of records in an API call, the request body must use the JSON Lines format or the request will fail.

HTTP Response

The HTTP response is…contains the WORKFLOW_IMPORT_QUEUE_BATCH_ID that can be used to locate it in the system, as well as a hyperlink to the results in the UI.

Code Block
languagejson
TODO{
  queueBatchId: "abc-def-123",
  queueBatchDetails: "https://www.someLB.com/Admin/Whatever?batchId=abc-def-123"
}

Error messages

Error

Reason / How to fix