Web API: Cancel: Difference between revisions

From QPR ProcessAnalyzer Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 6: Line 6:


<pre>
<pre>
Url: POST /api/cancel
Url: POST /api/analysis/cancel
Content-Type: application/json;charset=UTF-8
Content-Type: application/json;charset=UTF-8
Body:
Body:

Revision as of 19:47, 27 February 2021

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 /api/analysis/cancel
Content-Type: application/json;charset=UTF-8
Body:
[ "queryIdentifier1", "queryIdentifier2", "queryIdentifier3"]