QPR ProcessAnalyzer API: Difference between revisions

From QPR ProcessAnalyzer Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 1: Line 1:
QPR ProcessAnalyzer API can be used to automate operations in process mining or create integration with other applications. QPR ProcessAnalyzer has REST-based Web API.
QPR ProcessAnalyzer API can be used to create integration with other applications and automate many operations in process mining.


The API is a JSON based API using the REST design principle. All operations require a prior login which is done with the ''Token'' operation with username and password (the access token is returned as a response for a successful login). All operations (except the Token) need to have a HTTP request header ''Authorization'' with value ''Bearer <access token>'' in place to identify the session.
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 DNS name with a correct one):
Url for calling the API has the following form (replace the server DNS name with a correct one):
<pre>
<pre>
https://customer.onqpr.com/qprpa/api/<operationName>
https://customer.onqpr.com/qprpa/api/<methodName>
</pre>
</pre>


Following operations are available:
Following methods are available:
* [[Web_API:_Token|token]]: Login user using username and password, and get a session token as a response.
* [[Web_API:_Token|token]]: Login user using username and password and get a session token as a response.
* [[Web_API:_Signout|signout]]: Logs out a session.
* [[Web_API:_Signout|signout]]: Logs out a user session.
* [[Web_API:_Expression/query|expression/query]]: Runs query written using the expression language and returns results as a response.
* [[Web_API:_Expression/query|expression/query]]: Runs query written using the expression language and returns result data as response.
* [[Web_API:_Cancel|cancel]]: Cancels currently running operation.
* [[Web_API:_Filters|filters]]: Get filters for all models or filters for a single model.
* [[Web_API:_Filters|filters]]: Get all filters in system or filters in a model.
* [[Web_API:_Serverinfo|serverinfo]]: Gets some basic information about the system, such as the default UI language in whether SSO has been configured (which is needed by the UI).
* [[Web_API:_Serverinfo|serverinfo]]: Gets the default UI language in whether SSO has been configured.
* [[Web_API:_Importfile|importfile]]: Import data into datatable from .csv, .xes or .pacm file.
* [[Web_API:_Importfile|importfile]]: Import data into models and datatables from .csv, .xes and .pacm files.
* [[Web_API:_Usersettings|usersettings]]: Save user specific settings to the server.
* [[Web_API:_Usersettings|usersettings]]: Save user specific settings to the server.
* [[Web_API:_Operations/terminate|operations/terminate]]: Terminates selected operations (i.e. end tasks).
* [[Web_API:_Operations/terminate|operations/terminate]]: Terminates selected operations (i.e. end tasks).
* [[Web_API:_Cancel|cancel]]: Stops currently running task in the server to save computing resources.


In addition, there are Web API operations for
In addition, there are methods for
*[[Web API for Workspace Elements|workspace elements]]
* [[Web API for Workspace Elements|workspace elements]]
* [[Web_API_for_Datatables|datatables]]
* [[Web_API_for_Datatables|datatables]]
* [[Web_API_for_Models|models]]
* [[Web_API_for_Models|models]]

Revision as of 19:34, 23 June 2021

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:

  • token: Login user using username and password and get a session token as a response.
  • signout: Logs out a user session.
  • 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: Gets some basic information about the system, such as the default UI language in whether SSO has been configured (which is needed by the UI).
  • importfile: Import data into datatable from .csv, .xes or .pacm file.
  • usersettings: Save user specific settings to the server.
  • operations/terminate: Terminates selected operations (i.e. end tasks).
  • cancel: Stops currently running task in the server to save computing resources.

In addition, there are methods for

Examples

Move Data from QPR ProcessAnalyzer to Database using PowerShell

Retrieved from "https://wiki.onqpr.com/pa/index.php?title=QPR_ProcessAnalyzer_API&oldid=18555"