Page History

Cancel all started tasks

Description

By calling this endpoint, all the started tasks across all nodes will be reopen. Automatic tasks will also be executed.

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 on one node is running, a specific task could be still in progress on another node and it might be reopen.

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

Usage

The following steps should be followed for using this endpoint:

1. Make sure that there 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: 

   Info
   icon false
   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!

Update Application Name And Version

Description

By calling one of these endpointsendpoint, the application id ids for some specific cases will be updated for the cases and jobs matching the specified criteriawith new values.

Steps:

1. Find all cases where by current application id contains the old application name. If old application version case id is specified in the url, find all cases the case where application id matches with the name and versionthe one sent in the request.
2. Update application id for these cases with the new data sent in the request body.
3. Get the jobs for the found cases and update them accordingly.
   
   

Request examples:

1. Update application name.

   1.1 Update application name on every version of your old application
   
   
   The application ids, for the cases with the current application id All cases where application name is "export-TestOldProject:0.0-Trunk", are updated to "export-TestNewProject:0.0-Trunk". 

   Info
   icon false
   PUT http://<server>:<port>/<runtime_name>/api/v1/scheduler/maintenance/applications/export-TestOldProject:0.0-Trunk { "name" : "export-TestNewProject" }

   Note
   title Note
   If you do not specify the old application version in the url, this endpoint will update the application name for every version of the specified old application. If you would like to update the application name only for a specific version, you should use the endpoints below.

    

2. 1.2. Update application name for a specific version
   All cases where application name is "export-TestOldProject" and version is "Update application version
   
   The application ids, for the cases with the current application id "export-TestOldProject:0.0-Trunk" are , are updated to "export-TestNewProject". Version remains the same-TestOldProject:0.1-Trunk". 
   

   Info
   icon false
   PUT http://<server>:<port>/<runtime_name>/api/v1/scheduler/maintenance/applications/export-TestOldProject/:0.0-Trunk { "nameversion" : "export0.1-TestNewProjectTrunk" }

3. Update application id (both name and version
   All cases where application name is )
   
   The application ids, for the cases with the current application id "export-TestOldProject" and version is ":0.0-Trunk", version is  are updated to "export-TestNewProject:0.1-Trunk". Application name remains the same. 
   

   Info
   icon false
   PUT http://<server>:<port>/<runtime_name>/api/v1/scheduler/maintenance/applications/export-TestOldProject/0.0-Trunk { "name" : "export-TestNewProject", "version" : "0.1-Trunk" }

4. Update application id (both name and version)for a specific case
   1. Update application name
      

      The application id, for the case with the current application id 

   
   All cases where application name is

   1. "export-TestOldProject

   " and version is "

   1. :0.0-Trunk"

   , application name is

   1. and case id 1, is updated to "export-TestNewProject

   " and version is updated to "

   1. :0.

   1

   1. 0-Trunk". 

      Info
      icon false
      PUT http://<server>:<port>/<runtime_name>/api/v1/scheduler/maintenance/applications/export-TestOldProject

   /

   1. :0.0-Trunk?caseId=1 { "name" : "export-TestNewProject"

   ,

   1. }

   "version" : "0.1-Trunk"
}

Usage

The following steps should be followed for using this endpoint:

1. 1. Update application version
      

      The application id, for the case with the current application id "export-TestOldProject:0.0-Trunk" and case id 1, is updated to "export-TestOldProject:0.1-Trunk".

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

   1.  

      Info
      icon false
      PUT http://<server>:<port>/

   <runtime>

   1. <runtime_name>/api/v1

   /docs

   1. /

   index.html
5. Fill the username and the password and press Generate Token in order to obtain a new token.
6. Expand scheduler.
7. Expand PUT /

   1. scheduler/maintenance/applications/

   {oldApplicationName} or PUT /scheduler/maintenance/applications/{oldApplicationName}/{oldApplicationVersion}.
8. Specify the old application name you would like to update. Optionally specify the application version.
9. Specify the body of the request with the new application name, or new application version or both.
10. Press Try it out!

Update Application Name and Version for a Case

Description

1. 1. export-TestOldProject:0.0-Trunk?caseId=1 { "version" : "0.1-Trunk" }

   2. Update application id
      

      The application id, for the case with the current application id "export-TestOldProject:0.0-Trunk" and case id 1, is updated to "export-TestNewProject:0.1-Trunk". 

      Info
      icon false
      PUT http://<server>:<port>/<runtime_name>/api/v1/scheduler/maintenance/applications/

1. 1. export-TestOldProject/0.0-Trunk?caseId=1 { "name" :

1. 1. "export-TestNewProject", "version" :

Steps:

1. Finds the case with the specified case id. 
2. Update the application id for the case found.  Application id is updated with the new application name sent in the request body. Optionally, if specified in the body, application version will be updated as well.
3. Calls the scheduler to find all jobs for the case from step 1.
4. Updates all the jobs with the new application id.

   1. "0.1-Trunk" }

Usage

The following steps should be followed for using this endpoint:

1. Make sure that there 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: 

   Info
   icon false
   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/applications/cases/{caseIdcurrentApplicationId}.
7. Specify the case idrequest parameters.
8. Press Try it out!