Web API: Operations/terminate: Difference between revisions

From QPR ProcessAnalyzer Wiki
Jump to navigation Jump to search
(Created page with "The '''operations/terminate''' terminates selected operations (i.e. end tasks). This only send the termination signal to the operations, and depending on the operation, they m...")
 
No edit summary
Line 1: Line 1:
The '''operations/terminate''' terminates selected operations (i.e. end tasks). This only send the termination signal to the operations, and depending on the operation, they might not immediately end.
The '''operations/terminate''' initiates termination for selected operations that are running in the server (i.e. end tasks). This only send the termination signal to the operations, and depending on the operation, they might not end immediately.


HTTP request header '''Authorization''' with value '''Bearer <access token>''' needs to be in place to identify the session.  
HTTP request header '''Authorization''' with value '''Bearer <access token>''' needs to be in place to identify the session.  
Line 7: Line 7:
</pre>
</pre>


The body contains an array of operation id's (numbers) to be terminated.
The request body contains an array of operation id's (numbers) to be terminated.


Returns HTTP code 204 (No content).
Returns HTTP code 204 (No content).


[[Category: QPR ProcessAnalyzer]]
[[Category: QPR ProcessAnalyzer]]

Revision as of 15:32, 1 December 2020

The operations/terminate initiates termination for selected operations that are running in the server (i.e. end tasks). This only send the termination signal to the operations, and depending on the operation, they might not end immediately.

HTTP request header Authorization with value Bearer <access token> needs to be in place to identify the session.

Url: PUT /operations/terminate

The request body contains an array of operation id's (numbers) to be terminated.

Returns HTTP code 204 (No content).