Versions Compared

Version Old Version 10 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
?fileName={filename}
&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 /wiki/spaces/DOCS/pages/1569915157 to use;

  • creationPath - a string, up to 15 characters in length, consisting 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 if any records fail to process

...