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. Does not return any data.
The '''Cancel''' operation cancels currently running queries in the server. This can be done to improve performance if the query results are not needed. The operation 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.  

Revision as of 13:51, 16 May 2020

The Cancel operation cancels currently running queries in the server. This can be done to improve performance if the query results are not needed. The operation 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
Content-Type: application/json;charset=UTF-8
Body:
[
  "query1", "query2"
]