QPR ProcessAnalyzer API: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| Line 16: | Line 16: | ||
||Login user using username and password and get a session token as a response. | ||Login user using username and password and get a session token as a response. | ||
|- | |- | ||
||[[Web_API:_Signout|signout]] | ||[[Web_API:_Signout|api/signout]] | ||
||Logs out a user session. | ||Logs out a user session. | ||
|- | |- | ||
||[[Web_API:_Expression|expression]] | ||[[Web_API:_Expression|api/expression]] | ||
||Runs an expression. | ||Runs an expression. | ||
|- | |- | ||
||[[Web_API:_Expression/query|expression/query]] | ||[[Web_API:_Expression/query|api/expression/query]] | ||
||Runs query written using the expression language and returns result data as response. | ||Runs query written using the expression language and returns result data as response. | ||
|- | |- | ||
||[[Web_API:_Filters|filters]] | ||[[Web_API:_Filters|api/filters]] | ||
||Get filters for all models or filters for a single model. | ||Get filters for all models or filters for a single model. | ||
|- | |- | ||
||[[Web_API:_Serverinfo|serverinfo]] | ||[[Web_API:_Serverinfo|api/serverinfo]] | ||
||Returns common system information needed by UI, such as the default UI language and in whether SSO has been configured. | ||Returns common system information needed by UI, such as the default UI language and in whether SSO has been configured. | ||
|- | |- | ||
||[[Web_API:_Importfile|importfile]] | ||[[Web_API:_Importfile|api/importfile]] | ||
||Import data into datatable from .csv, .xes or .pacm file. | ||Import data into datatable from .csv, .xes or .pacm file. | ||
|- | |- | ||
||[[Web_API:_Usersettings|usersettings]] | ||[[Web_API:_Usersettings|api/usersettings]] | ||
||Save user specific settings to the server. | ||Save user specific settings to the server. | ||
|- | |- | ||
||[[Web_API:_Operations/terminate|operations/terminate]] | ||[[Web_API:_Operations/terminate|api/operations/terminate]] | ||
||Stops the defined tasks (by the task id) to save computing resources. | ||Stops the defined tasks (by the task id) to save computing resources. | ||
|- | |- | ||
||[[Web_API:_Cancel|analysis/cancel]] | ||[[Web_API:_Cancel|api/analysis/cancel]] | ||
||Stops currently running tasks (by the task identifier) to save computing resources. | ||Stops currently running tasks (by the task identifier) to save computing resources. | ||
|- | |- | ||
||[[Web_API:_saml2/Acs|saml2/Acs]] | ||[[Web_API:_saml2/Acs|api/saml2/Acs]] | ||
||Identity provides sends the SAML assertion to this endpoint, which responses with 302 containing a url with the samlhash. | ||Identity provides sends the SAML assertion to this endpoint, which responses with 302 containing a url with the samlhash. | ||
|- | |- | ||
||[[Web_API:_saml2|saml2]] | ||[[Web_API:_saml2|api/saml2]] | ||
||Returns the SAML 2.0 service provider metadata, if SAML 2.0 authentication has been configured. | ||Returns the SAML 2.0 service provider metadata, if SAML 2.0 authentication has been configured. | ||
|} | |} | ||
Revision as of 09:54, 16 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. |
| api/signout | Logs out a user session. |
| api/expression | Runs an expression. |
| api/expression/query | Runs query written using the expression language and returns result data as response. |
| api/filters | Get filters for all models or filters for a single model. |
| api/serverinfo | Returns common system information needed by UI, such as the default UI language and in whether SSO has been configured. |
| api/importfile | Import data into datatable from .csv, .xes or .pacm file. |
| api/usersettings | Save user specific settings to the server. |
| api/operations/terminate | Stops the defined tasks (by the task id) to save computing resources. |
| api/analysis/cancel | Stops currently running tasks (by the task identifier) to save computing resources. |
| api/saml2/Acs | Identity provides sends the SAML assertion to this endpoint, which responses with 302 containing a url with the samlhash. |
| api/saml2 | Returns the SAML 2.0 service provider metadata, if SAML 2.0 authentication has been configured. |
In addition, there are methods for