QPR ProcessAnalyzer API - Revision history

Ollvihe: /* Synchronize users and groups */

2025-06-02T08:41:25Z

Synchronize users and groups

← Older revision		Revision as of 08:41, 2 June 2025
Line 264:		Line 264:
	}		}
	</pre>		</pre>

	~~<syntaxhighlight lang="python" line>~~
	~~...~~
	~~</syntaxhighlight>~~

Ollvihe: /* Run query to fetch data */

2025-03-28T09:38:38Z

Run query to fetch data

← Older revision		Revision as of 09:38, 28 March 2025
Line 65:		Line 65:
	Following Python function performs a query to fetch data from QPR ProcessAnalyzer by calling the REST API. It performs following steps: (1) login to QPR ProcessAnalyzer, (2) run the query, (3) write fetched data to a file, and (4) log out.		Following Python function performs a query to fetch data from QPR ProcessAnalyzer by calling the REST API. It performs following steps: (1) login to QPR ProcessAnalyzer, (2) run the query, (3) write fetched data to a file, and (4) log out.

	The query is in the "json" parameter of the /api/expression/query. ~~The~~ query for a chart can be found in the ''Advanced'' tab by clicking the ''Query'' button.		The query is in the "json" parameter of the /api/expression/query request. For example, query for a chart can be found in the chart settings ''Advanced'' tab by clicking the ''Query'' button.

	<syntaxhighlight lang="python" line>		<syntaxhighlight lang="python" line>

Ollvihe: /* Run query to fetch data */

2025-03-28T09:36:23Z

Run query to fetch data

← Older revision		Revision as of 09:36, 28 March 2025
Line 64:		Line 64:
	=== Run query to fetch data ===		=== Run query to fetch data ===
	Following Python function performs a query to fetch data from QPR ProcessAnalyzer by calling the REST API. It performs following steps: (1) login to QPR ProcessAnalyzer, (2) run the query, (3) write fetched data to a file, and (4) log out.		Following Python function performs a query to fetch data from QPR ProcessAnalyzer by calling the REST API. It performs following steps: (1) login to QPR ProcessAnalyzer, (2) run the query, (3) write fetched data to a file, and (4) log out.

			The query is in the "json" parameter of the /api/expression/query. The query for a chart can be found in the ''Advanced'' tab by clicking the ''Query'' button.

	<syntaxhighlight lang="python" line>		<syntaxhighlight lang="python" line>

Ollvihe: /* Introduction */

2025-03-28T09:32:50Z

Introduction

← Older revision		Revision as of 09:32, 28 March 2025
Line 1:		Line 1:
	== Introduction ==		== Introduction ==
	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 create integrations to other applications and automate operations in the process mining environment.

	QPR ProcessAnalyzer API is a JSON based API following the REST design principles. ~~All~~ endpoints ~~(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 endpoints requiring prior authenticated session, need to have a HTTP request header ''Authorization'' with value ''Bearer <access token>'' to identify the session.		QPR ProcessAnalyzer API is a JSON-based API following the REST design principles. Most of the endpoints 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 endpoints 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):		Url for calling the API has the following form (replace the server hostname with a correct one):

Ollvihe at 09:31, 28 March 2025

2025-03-28T09:31:20Z

← Older revision		Revision as of 09:31, 28 March 2025
Line 1:		Line 1:
			== Introduction ==
	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.

Ollvihe at 09:30, 28 March 2025

2025-03-28T09:30:50Z

← Older revision		Revision as of 09:30, 28 March 2025
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 [[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.		QPR ProcessAnalyzer API is a JSON based API following the REST design principles. All endpoints (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 endpoints 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):		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/<endpointName>
	</pre>		</pre>

	Following ~~methods~~ are available:		== Available endpoints ==
			Following endpoints are available:
	{\| class="wikitable"		{\| class="wikitable"
	!'''~~Method~~'''		!'''Endpoint'''
	! '''Description'''		! '''Description'''
	\|-		\|-
Line 50:		Line 51:
	\|}		\|}

	In addition, there are ~~methods~~ for		In addition, there are endpoints for
	* [[Web API for Workspace Elements\|moving and deleting workspace elements]]		* [[Web API for Workspace Elements\|moving and deleting workspace elements]]
	* [[Web_API_for_Projects\|projects]]		* [[Web_API_for_Projects\|projects]]
Line 59:		Line 60:
	* [[Web_API_for_User_Management\|users, groups and roles]]		* [[Web_API_for_User_Management\|users, groups and roles]]

	== ~~Examples~~ ==		== Usage examples ==
	=== Run query to fetch data ===		=== Run query to fetch data ===
	Following Python function performs a query to fetch data from QPR ProcessAnalyzer by calling the REST API. It performs following steps: (1) login to QPR ProcessAnalyzer, (2) run the query, (3) write fetched data to a file, and (4) log out.		Following Python function performs a query to fetch data from QPR ProcessAnalyzer by calling the REST API. It performs following steps: (1) login to QPR ProcessAnalyzer, (2) run the query, (3) write fetched data to a file, and (4) log out.

Ollvihe at 09:29, 28 March 2025

2025-03-28T09:29:13Z

← Older revision		Revision as of 09:29, 28 March 2025
Line 264:		Line 264:
	...		...
	</syntaxhighlight>		</syntaxhighlight>

	~~[[Category: QPR ProcessAnalyzer]]~~

Ollvihe at 09:28, 28 March 2025

2025-03-28T09:28:56Z

← Older revision		Revision as of 09:28, 28 March 2025
Line 264:		Line 264:
	...		...
	</syntaxhighlight>		</syntaxhighlight>

	~~__NOTOC__~~

	[[Category: QPR ProcessAnalyzer]]		[[Category: QPR ProcessAnalyzer]]

Ollvihe at 09:26, 28 March 2025

2025-03-28T09:26:11Z

← Older revision		Revision as of 09:26, 28 March 2025
Line 61:		Line 61:
	== Examples ==		== Examples ==
	=== Run query to fetch data ===		=== Run query to fetch data ===
	Following Python function performs a query to fetch data from QPR ProcessAnalyzer by calling the REST API. ~~The function does~~ following: (1) login to QPR ProcessAnalyzer, (2) ~~perform~~ the query, (3) write fetched data to a file, and (4) log out.		Following Python function performs a query to fetch data from QPR ProcessAnalyzer by calling the REST API. It performs following steps: (1) login to QPR ProcessAnalyzer, (2) run the query, (3) write fetched data to a file, and (4) log out.

	<syntaxhighlight lang="python" line>		<syntaxhighlight lang="python" line>
Line 146:		Line 146:

	=== Trigger script run ===		=== Trigger script run ===
	Following Python function starts a script in QPR ProcessAnalyzer by calling the REST API. ~~The function does~~ following: (1) login to QPR ProcessAnalyzer, (2) start the script, and (3) log out. The call just starts the script without waiting for it to complete (asynchronous behavior).		Following Python function starts a script in QPR ProcessAnalyzer by calling the REST API. It performs following steps: (1) login to QPR ProcessAnalyzer, (2) start the script, and (3) log out. The call just starts the script without waiting for it to complete (asynchronous behavior).

	<syntaxhighlight lang="python" line>		<syntaxhighlight lang="python" line>

Ollvihe at 09:17, 28 March 2025

2025-03-28T09:17:28Z

← Older revision		Revision as of 09:17, 28 March 2025
Line 61:		Line 61:
	== Examples ==		== Examples ==
	=== Run query to fetch data ===		=== Run query to fetch data ===
	Following function ~~written in Python~~ performs a query to fetch data from QPR ProcessAnalyzer by calling the REST API. The function does following: (1) login to QPR ProcessAnalyzer, (2) perform the query, (3) write fetched data to a file, and (4) log out.		Following Python function performs a query to fetch data from QPR ProcessAnalyzer by calling the REST API. The function does following: (1) login to QPR ProcessAnalyzer, (2) perform the query, (3) write fetched data to a file, and (4) log out.

	<syntaxhighlight lang="python" line>		<syntaxhighlight lang="python" line>
Line 146:		Line 146:

	=== Trigger script run ===		=== Trigger script run ===
	Following function ~~written in Python~~ starts a script in QPR ProcessAnalyzer by calling the REST API. The function does following: (1) login to QPR ProcessAnalyzer, (2) start the script, and (3) log out. The call just starts the script without waiting for it to complete (asynchronous behavior).		Following Python function starts a script in QPR ProcessAnalyzer by calling the REST API. The function does following: (1) login to QPR ProcessAnalyzer, (2) start the script, and (3) log out. The call just starts the script without waiting for it to complete (asynchronous behavior).

	<syntaxhighlight lang="python" line>		<syntaxhighlight lang="python" line>