Web API: Cancel: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| (2 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
The '''Cancel''' | 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. | ||
Request body is | Request body is an array of query identifiers to be cancelled. | ||
<pre> | <pre> | ||
Url: POST /api/cancel | Url: POST qprpa/api/analysis/cancel | ||
Content-Type: application/json;charset=UTF-8 | Content-Type: application/json;charset=UTF-8 | ||
Body: | Body: | ||
[ | [ "queryIdentifier1", "queryIdentifier2", "queryIdentifier3"] | ||
] | |||
</pre> | </pre> | ||
[[Category: QPR ProcessAnalyzer]] | [[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"]