Skip to content
This repository has been archived by the owner on Sep 25, 2022. It is now read-only.

Pausing an Import

Peter Monks edited this page Jul 19, 2016 · 3 revisions

Note: These Web Scripts were added in v2.1.0 of the tool - they are not available in earlier versions.

Pause Web Script

The pause Web Script is an HTTP POST Web Script located at service path /bulk/import/pause that will pause an in-progress import (or return an error, if one isn't in progress or if it's already paused). The current state of the bulk import tool can be determined via the status Web Script.

As a convenience for human operators, this Web Script can also be invoked from the status Web Script, via the orange "pause" button visible in the HTML version of the Web Script (it is not visible if the import is already paused).

Notes:

  • Imports are paused asynchronously, so although this Web Script will return immediately the bulk import may take some time (typically seconds) to come to a complete pause.
  • This web script is useful for scripted approaches - it can be used to pause an in-progress import in order to perform other operations (e.g. database maintenance).

Resume Web Script

The resume Web Script is an HTTP POST Web Script located at service path /bulk/import/resume that will resume a paused import (or return an error, if it's not paused). The current state of the bulk import tool can be determined via the status Web Script.

As a convenience for human operators, this Web Script can also be invoked from the status Web Script, via the green "resume" button visible in the HTML version of the Web Script when an import is paused (it is not visible if the import is not paused).

Notes:

  • This web script is useful for scripted approaches - it can be used to resume a paused import.

Back to usage.

Clone this wiki locally