Versions Compared

Key

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

Table of Contents

Cancel all started tasks

Description

By calling this endpoint, all the started tasks across all nodes will be reopen or reopen and executed if they are automatic tasks. Automatic tasks will also be executed.

Info
iconfalse

PUT http://<server>:<port>/<runtime_name>/api/v1/scheduler/tasks/cancelStarted

Setting the property blueriq.processengine.cancel-started-tasks to true when running in a multi-node environment might cause problems because while the cancellation of started tasks triggered by on one node might not know that is running, a specific task could be still in progress on another node and it might cancel itbe reopen.

Cancel all started tasks endpoint was created in order to avoid these types of situations.

Info

The endpoint overrules the blueriq.processengine.cancel-started-tasks property.

Usage

The following steps should be followed for using this endpoint:

  1. Make sure that there exist exists a runtime user with a role that has the permission SCHEDULER_MANAGER.
  2. Check that blueriq.oauth2.client-id and blueriq.oauth2.secret are defined in application.properties file. If they are missing, please define them.
  3. Access Runtime Swagger Interface:

     http

     

    Info
    iconfalse
    http://<server>:<port>/<runtime>/api/v1/docs/index.html
  4. Fill the username and the password and press Generate Token in order to obtain a new token.
  5. Expand scheduler.
  6. Expand PUT /scheduler/maintenance/tasks/cancelStarted.
  7. Press Try it out!