QPR ProcessAnalyzer API: Difference between revisions
No edit summary |
No edit summary |
||
| Line 1: | Line 1: | ||
QPR ProcessAnalyzer API can be used to build integrations with other applications and automate operations in the process mining system. | QPR ProcessAnalyzer API can be used to build integrations with other applications and automate operations in the process mining system. | ||
QPR ProcessAnalyzer API is a JSON based API following the REST design principles. All methods (except the | QPR ProcessAnalyzer API is a JSON based API following the REST design principles. All methods (except the [[Web_API:_Token|token]] and [[Web_API:_Serverinfo|serverinfo]]) require a prior login to establish a session. The session is initialized with the [[Web_API:_Token|token]] call with username and password, and the access token is returned as a response for a successful login. The methods requiring prior authenticated session, need to have a HTTP request header ''Authorization'' with value ''Bearer <access token>'' to identify the session. | ||
Url for calling the API has the following form (replace the server | Url for calling the API has the following form (replace the server hostname with a correct one): | ||
<pre> | <pre> | ||
https://customer.onqpr.com/qprpa/api/<methodName> | https://customer.onqpr.com/qprpa/api/<methodName> | ||
Revision as of 22:02, 15 February 2022
QPR ProcessAnalyzer API can be used to build integrations with other applications and automate operations in the process mining system.
QPR ProcessAnalyzer API is a JSON based API following the REST design principles. All methods (except the token and serverinfo) require a prior login to establish a session. The session is initialized with the token call with username and password, and the access token is returned as a response for a successful login. The methods requiring prior authenticated session, need to have a HTTP request header Authorization with value Bearer <access token> to identify the session.
Url for calling the API has the following form (replace the server hostname with a correct one):
https://customer.onqpr.com/qprpa/api/<methodName>
Following methods are available:
| Method | Description |
|---|---|
| token | Login user using username and password and get a session token as a response. |
| signout | Logs out a user session. |
| expression | Runs an expression. |
| expression/query | Runs query written using the expression language and returns result data as response. |
| filters | Get filters for all models or filters for a single model. |
| serverinfo | Returns common system information needed by UI, such as the default UI language and in whether SSO has been configured. |
| importfile | Import data into datatable from .csv, .xes or .pacm file. |
| usersettings | Save user specific settings to the server. |
| operations/terminate | Stops the defined tasks (by the task id) to save computing resources. |
| analysis/cancel | Stops currently running tasks (by the task identifier) to save computing resources. |
| saml2/Acs | Identity provides sends the SAML assertion to this endpoint, which responses with 302 containing a url with the samlhash. |
In addition, there are methods for