Versions Compared

Version Old Version 7 New Version Current
Changes made by

Seth Petry-Johnson

Seth Petry-Johnson

Saved on

Key

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

Allows a Workflow Import process to be started via an API call, rather than uploading a file via the UI.

Introduced in 11.0.33.

Note

This API is considered experimental and is intended for internal use only at this time. We will probably open it up for 3rd party access in the future, after we’ve finished internal evaluation

The API schema may change from release to release. Do not build mission-critical integrations around this API without talking to a senior technical consultant first.

Table of Contents

Overview

...

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

[Request body]
-----------------
{ JSON data row 1, on single line }
{ JSON data row 2, on single line }

  • fileName - displayed in the “Recent Imports” part of the UI; provide a human-readable description of this particular import, such as “ACME Process {yyyy/mm/dd}”

  • importProcessId - the ID of the Workflow Import Queue "file type" /wiki/spaces/DOCS/pages/1569915157 to use;

  • creationPath - (optional) a string, up to 10 15 characters in length, that identifiers the system calling the API. This is used to track which Batches were created through which integrations. This value, if provided, is prefixed with “IMPORT_QUEUE_API:” before being saved in the databaseconsisting only of upper case letters, numbers, and underscores. See below for explanation.

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

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

...

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.

Purpose of “creationPath”

The purpose of the creationPath argument is to identify which Import Queue Batches were created from which external integrations.

Callers should provide a 1-15 character string, consisting of UPPER CASE letters, numbers, and underscores only, that identifies their application.

This will be prefixed with “IMPORT_QUEUE_API:” and then stored in the IMPORT_QUEUE_BATCH.CREATION_PATH column.

For example, the Learning Hub integration passes creationPath=LH. Therefore, all import queue batches created by the Learning Hub integration can be found by searching for “IMPORT_QUEUE_API:LH”.

HTTP Response

The HTTP response 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.

...