QPR ProcessAnalyzer API: Difference between revisions

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


Following methods are available:
Following methods are available:
* [[Web_API:_Token|token]]: Login user using username and password and get a session token as a response.
{| class="wikitable"
* [[Web_API:_Signout|signout]]: Logs out a user session.
!'''Method'''
* [[Web_API:_Expression|expression]]: Runs an expression.
! '''Description'''
* [[Web_API:_Expression/query|expression/query]]: Runs query written using the expression language and returns result data as response.
|-
* [[Web_API:_Filters|filters]]: Get filters for all models or filters for a single model.
||[[Web_API:_Token|token]]
* [[Web_API:_Serverinfo|serverinfo]]: Returns common system information needed by UI, such as the default UI language and in whether SSO has been configured.
||Login user using username and password and get a session token as a response.
* [[Web_API:_Importfile|importfile]]: Import data into datatable from .csv, .xes or .pacm file.
|-
* [[Web_API:_Usersettings|usersettings]]: Save user specific settings to the server.
||[[Web_API:_Signout|signout]]
* [[Web_API:_Operations/terminate|operations/terminate]]: Stops the defined tasks (by the task id) to save computing resources.
||Logs out a user session.
* [[Web_API:_Cancel|analysis/cancel]]: Stops currently running tasks (by the task identifier) to save computing resources.
|-
* [[Web_API:_saml2/Acs|saml2/Acs]]: Identity provides sends the SAML assertion to this endpoint, which responses with 302 containing a url with the samlhash.
||[[Web_API:_Expression|expression]]
||Runs an expression.
|-
||[[Web_API:_Expression/query|expression/query]]
||Runs query written using the expression language and returns result data as response.
|-
||[[Web_API:_Filters|filters]]
||Get filters for all models or filters for a single model.
|-
||[[Web_API:_Serverinfo|serverinfo]]
||Returns common system information needed by UI, such as the default UI language and in whether SSO has been configured.
|-
||[[Web_API:_Importfile|importfile]]
||Import data into datatable from .csv, .xes or .pacm file.
|-
||[[Web_API:_Usersettings|usersettings]]
||Save user specific settings to the server.
|-
||[[Web_API:_Operations/terminate|operations/terminate]]
||Stops the defined tasks (by the task id) to save computing resources.
|-
||[[Web_API:_Cancel|analysis/cancel]]
||Stops currently running tasks (by the task identifier) to save computing resources.
|-
||[[Web_API:_saml2/Acs|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
In addition, there are methods for

Revision as of 21:59, 15 February 2022

QPR ProcessAnalyzer API can be used to create integration with other applications and automate many operations in process mining.

QPR ProcessAnalyzer API is a JSON based API following the REST design principles. All methods (except the Token and ServerInfo) require a prior login which is performed with the Token call with username and password, and the access token is returned as a response for a successful login. The methods requiring the prior authenticated session, need to have a HTTP request header Authorization with value Bearer <access token> in place to identify the session.

Url for calling the API has the following form (replace the server DNS name 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