Web API: Cancel: Difference between revisions

From QPR ProcessAnalyzer Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 1: Line 1:
The '''Cancel''' operation is used to cancels currently running queries in the server. HTTP method is '''POST'''. Does not return any data.
The '''Cancel''' operation is used to cancels currently running queries in the server. Does not return any data.


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.  


The payload is a JSON array of query identifiers to be cancelled.
Request body is a JSON array of query identifiers to be cancelled.


Example:
<pre>
<pre>
url: http://SERVER/qprpa/api/cancel
Url: POST /api/cancel
Body:
Body:
[
[

Revision as of 10:55, 16 May 2020

The Cancel operation is used to cancels currently running queries in the server. Does not return any data.

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

Request body is a JSON array of query identifiers to be cancelled.

Url: POST /api/cancel
Body:
[
  "query1", "query2"
]