Web API: Cancel: Difference between revisions

From QPR ProcessAnalyzer Wiki
Jump to navigation Jump to search
(Created page with "The '''Cancel''' operation is used to cancels currently running queries in the server. HTTP method is '''POST'''. Does not return any data. HTTP request header '''Authorizati...")
 
No edit summary
 
(6 intermediate revisions by the same user not shown)
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''' method 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.  


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


Example:
<pre>
<pre>
url: http://SERVER/qprpa/api/cancel
Url: POST qprpa/api/analysis/cancel
Content-Type: application/json;charset=UTF-8
Body:
Body:
[
[ "queryIdentifier1", "queryIdentifier2", "queryIdentifier3"]
  "query1", "query2"
]
</pre>
</pre>
[[Category: QPR ProcessAnalyzer]]

Latest revision as of 23:35, 17 February 2022

The Cancel method 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 an array of query identifiers to be cancelled.

Url: POST qprpa/api/analysis/cancel
Content-Type: application/json;charset=UTF-8
Body:
[ "queryIdentifier1", "queryIdentifier2", "queryIdentifier3"]