Web API: Importfile - Revision history

Ollvihe at 23:03, 7 May 2025

2025-05-07T23:03:32Z

← Older revision		Revision as of 23:03, 7 May 2025
Line 1:		Line 1:
	The '''importfile''' operation imports data from a text file to a [[QPR_ProcessAnalyzer_Project_Workspace#Datatables\|datatable]].		The '''importfile''' operation imports data from a text file to a [[QPR_ProcessAnalyzer_Project_Workspace#Datatables\|datatable]]. The import can be done to an existing or to a new datatable that is created during the import. For an existing datatable, imported data can be appended to the existing data or the existing data can be overwritten.

	UTF-8 is the only supported character encoding for the imported file. In case any other character encoding is used, characters in the imported file may be interpreted incorrectly.		UTF-8 is the only supported character encoding for the imported file. In case any other character encoding is used, characters in the imported file may be interpreted incorrectly.

Ollvihe at 23:02, 7 May 2025

2025-05-07T23:02:02Z

← Older revision		Revision as of 23:02, 7 May 2025
Line 12:		Line 12:

	Following query parameters can be defined:		Following query parameters can be defined:
	* '''fileType''' (string): Defines ~~format of~~ the imported file. Options are '''csv''' (~~default~~), '''pacm''' and '''xes'''.		* '''fileType''' (string): Defines the imported file format. Options are '''csv''' (comma-separated values), '''pacm''' (QPR ProcessAnalyzer model format) and '''xes''' (see https://www.tf-pm.org/resources/xes-standard/about-xes). If not specified, the csv is assumed.
	* '''~~objectId~~''' (integer): ~~Datatable~~ id. ~~Used when~~ importing data to an existing datatable.		* '''projectId''' (integer): When creating a new datatable, defines project id where the datatable is created.
			* '''objectId''' (integer): When importing data to an existing datatable, defines the target datatable id.
			* '''newObjectName''': When creating a new datatable, defines the datatable name.
	* '''append''' (boolean): When ''true'', existing data in the destination datatable is preserved. When ''false'', existing data is removed and also datatable columns are deleted.		* '''append''' (boolean): When ''true'', existing data in the destination datatable is preserved. When ''false'', existing data is removed and also datatable columns are deleted.
	* '''matchByColumns''': JSON array of datatable columns that are used to match the imported rows as follows: If a matching row is found, that existing row is updated (with columns not listed by this setting). In other case, a new row is created to the datatable. By default, no matching columns are defined, so all data is imported as new rows.		* '''matchByColumns''': JSON array of datatable columns that are used to match the imported rows as follows: If a matching row is found, that existing row is updated (with columns not listed by this setting). In other case, a new row is created to the datatable. By default, no matching columns are defined, so all data is imported as new rows.
Line 20:		Line 22:
	* '''csvQualifier''' (string): Character used to enclose strings for the csv format.		* '''csvQualifier''' (string): Character used to enclose strings for the csv format.
	* '''csvStartImportFromLine''' (integer): The column name row in the csv file.		* '''csvStartImportFromLine''' (integer): The column name row in the csv file.
	* '''isCompressed''' (boolean): When true, the file is compressed using gzip format. Only csv and xes files can be provided as compressed (pacm file is already a gzip file).		* '''isCompressed''' (boolean): When ''true'', the file is compressed using the gzip format. Only the csv and xes files can be provided as compressed (pacm file is already a gzip file).

	When importing to an existing datatable, data needs to be converted into each column's datatype. Conversions are made for each datatype as follows:		When importing to an existing datatable, data needs to be converted into each column's datatype. Conversions are made for each datatype as follows:

Ollvihe at 22:53, 7 May 2025

2025-05-07T22:53:41Z

Ollvihe at 22:49, 7 May 2025

2025-05-07T22:49:46Z

← Older revision		Revision as of 22:49, 7 May 2025
Line 1:		Line 1:
	The '''importfile''' operation imports data from a text file to a [[QPR_ProcessAnalyzer_Project_Workspace#~~Managing_Datatables~~\|datatable]].		The '''importfile''' operation imports data from a text file to a [[QPR_ProcessAnalyzer_Project_Workspace#Datatables\|datatable]].

	UTF-8 is the only supported character encoding, so the file needs to be converted into UTF-8 for the import. In case some other character encoding is used, it might lead to invalid characters, which are still imported. In case invalid characters are imported, either a new import needs to be made with a corrected file, or the data needs to be cleaned using a script.		UTF-8 is the only supported character encoding, so the file needs to be converted into UTF-8 for the import. In case some other character encoding is used, it might lead to invalid characters, which are still imported. In case invalid characters are imported, either a new import needs to be made with a corrected file, or the data needs to be cleaned using a script.

Ollvihe at 10:05, 16 February 2022

2022-02-16T10:05:32Z

← Older revision		Revision as of 10:05, 16 February 2022
Line 6:		Line 6:

	<pre>		<pre>
	Url: POST /api/importfile?param1=value1&param2=value2&param3=value3		Url: POST qprpa/api/importfile?param1=value1&param2=value2&param3=value3
	Content-Type: multipart/form-data		Content-Type: multipart/form-data
	Body: <file contents>		Body: <file contents>

Ollvihe at 14:38, 28 January 2022

2022-01-28T14:38:02Z

← Older revision		Revision as of 14:38, 28 January 2022
Line 1:		Line 1:
	The '''importfile''' operation imports data from a text file to a [[QPR_ProcessAnalyzer_Project_Workspace#Managing_Datatables\|datatable]].		The '''importfile''' operation imports data from a text file to a [[QPR_ProcessAnalyzer_Project_Workspace#Managing_Datatables\|datatable]].

	~~Only~~ UTF-8 character encoding ~~is supported~~, so the file needs to be converted into UTF-8 for the import. In case some other character encoding is used, it might lead to invalid characters, which are still imported. In case invalid characters are imported, either a new import needs to be made with a corrected file, or the data needs to be cleaned using a script.		UTF-8 is the only supported character encoding, so the file needs to be converted into UTF-8 for the import. In case some other character encoding is used, it might lead to invalid characters, which are still imported. In case invalid characters are imported, either a new import needs to be made with a corrected file, or the data needs to be cleaned using a script.

	HTTP request header '''Authorization''' with value '''Bearer <access token>''' needs to be in place to identify the session.		HTTP request header '''Authorization''' with value '''Bearer <access token>''' needs to be in place to identify the session.
Line 11:		Line 11:
	</pre>		</pre>

	Following parameters can be defined:		Following query parameters can be defined:
	* '''fileType''' (string): Defines content format of the imported file. Options are '''csv''', '''pacm''' and '''xes'''.		* '''fileType''' (string): Defines content format of the imported file. Options are '''csv''', '''pacm''' and '''xes'''.
	* '''objectId''' (integer): Datatable id. Needed when importing data to an existing datatable.		* '''objectId''' (integer): Datatable id. Needed when importing data to an existing datatable.
Line 24:		Line 24:
	When importing to an existing datatable, data needs to be converted into each column's datatype. Conversions are made for each datatype as follows:		When importing to an existing datatable, data needs to be converted into each column's datatype. Conversions are made for each datatype as follows:
	* String: No conversion needed.		* String: No conversion needed.
	* Integer: ~~Converting~~ to integer.		* Integer: Convert digits to corresponding to integer.
	* Float: Convert to float using period (.) as the decimal separator.		* Float: Convert to float using period (.) as the decimal separator.
	* DateTime: Convert to date using the provided ''csvTimeFormat''.		* DateTime: Convert to date using the provided ''csvTimeFormat''.

Ollvihe at 16:17, 13 January 2022

2022-01-13T16:17:54Z

← Older revision		Revision as of 16:17, 13 January 2022
Line 1:		Line 1:
	The '''importfile''' operation imports data from a text file to a [[QPR_ProcessAnalyzer_Project_Workspace#Managing_Datatables\|datatable]].		The '''importfile''' operation imports data from a text file to a [[QPR_ProcessAnalyzer_Project_Workspace#Managing_Datatables\|datatable]].

	Only UTF-8 character encoding is supported (file needs to be converted into UTF-8 ~~to be able to~~ import ~~it successfully)~~. In case some other character encoding is used, it might lead to invalid characters, which are still imported. In case invalid characters are imported, either a new import needs to be made with a corrected file, or the data needs to be cleaned using a script.		Only UTF-8 character encoding is supported, so the file needs to be converted into UTF-8 for the import. In case some other character encoding is used, it might lead to invalid characters, which are still imported. In case invalid characters are imported, either a new import needs to be made with a corrected file, or the data needs to be cleaned using a script.

	HTTP request header '''Authorization''' with value '''Bearer <access token>''' needs to be in place to identify the session.		HTTP request header '''Authorization''' with value '''Bearer <access token>''' needs to be in place to identify the session.

Ollvihe at 22:54, 7 September 2021

2021-09-07T22:54:20Z

← Older revision		Revision as of 22:54, 7 September 2021
Line 15:		Line 15:
	* '''objectId''' (integer): Datatable id. Needed when importing data to an existing datatable.		* '''objectId''' (integer): Datatable id. Needed when importing data to an existing datatable.
	* '''append''' (boolean): When true, the possible previous data in the destination datatable is preserved. When false, previous data is removed and also datatable columns are deleted.		* '''append''' (boolean): When true, the possible previous data in the destination datatable is preserved. When false, previous data is removed and also datatable columns are deleted.
	* '''matchByColumns''': JSON array of datatable columns that are used to match the imported rows. If a ~~match~~ is found, ~~the~~ existing row is updated. In other case, a new row is created. By default, no matching columns are defined, so all data is imported as new rows.		* '''matchByColumns''': JSON array of datatable columns that are used to match the imported rows as follows: If a matching row is found, that existing row is updated (with columns not listed by this setting). In other case, a new row is created to the datatable. By default, no matching columns are defined, so all data is imported as new rows.
	* '''csvDelimiter''' (string): Column delimiter character for the csv format.		* '''csvDelimiter''' (string): Column delimiter character for the csv format.
	* '''csvTimeFormat''' (string): Date format to use when interpreting date values for the csv format.		* '''csvTimeFormat''' (string): Date format to use when interpreting date values for the csv format.

Ollvihe at 22:52, 7 September 2021

2021-09-07T22:52:44Z

← Older revision		Revision as of 22:52, 7 September 2021
Line 15:		Line 15:
	* '''objectId''' (integer): Datatable id. Needed when importing data to an existing datatable.		* '''objectId''' (integer): Datatable id. Needed when importing data to an existing datatable.
	* '''append''' (boolean): When true, the possible previous data in the destination datatable is preserved. When false, previous data is removed and also datatable columns are deleted.		* '''append''' (boolean): When true, the possible previous data in the destination datatable is preserved. When false, previous data is removed and also datatable columns are deleted.
			* '''matchByColumns''': JSON array of datatable columns that are used to match the imported rows. If a match is found, the existing row is updated. In other case, a new row is created. By default, no matching columns are defined, so all data is imported as new rows.
	* '''csvDelimiter''' (string): Column delimiter character for the csv format.		* '''csvDelimiter''' (string): Column delimiter character for the csv format.
	* '''csvTimeFormat''' (string): Date format to use when interpreting date values for the csv format.		* '''csvTimeFormat''' (string): Date format to use when interpreting date values for the csv format.

Ollvihe at 19:51, 8 June 2021

2021-06-08T19:51:40Z

← Older revision		Revision as of 19:51, 8 June 2021
Line 21:		Line 21:
	* '''isCompressed''' (boolean): When true, the file is compressed using gzip format. Only csv and xes files can be provided as compressed (pacm file is already a gzip file).		* '''isCompressed''' (boolean): When true, the file is compressed using gzip format. Only csv and xes files can be provided as compressed (pacm file is already a gzip file).

	When importing to an existing datatable, data needs to be ~~compatible with the~~ column ~~datatypes~~. ~~Following conversions~~ are made:		When importing to an existing datatable, data needs to be converted into each column's datatype. Conversions are made for each datatype as follows:
	* String: No conversion needed.		* String: No conversion needed.
	* Integer: ~~try convert~~ to integer.		* Integer: Converting to integer.
	* Float: ~~try convert~~ to float using "." as decimal separator.		* Float: Convert to float using period (.) as the decimal separator.
	* DateTime: ~~try convert~~ to date using the provided ''csvTimeFormat''.		* DateTime: Convert to date using the provided ''csvTimeFormat''.
	* Boolean: ~~try convert~~ to boolean with ''true'' as true value and ''false'' as false value.		* Boolean: Convert to boolean with ''true'' as true value and ''false'' as false value.
	* Duration: ~~try convert~~ to integer and interpret the value as ticks (10000 ticks is 1 millisecond).		* Duration: Convert to integer and interpret the value as ticks (10000 ticks is 1 millisecond).
	* ~~Import empty cell~~ as ''null'' ~~value~~.		* Empty data is imported as ''null'' values (applies for all datatypes).

			If conversion is not possible, an error is given and the import stops. Note that part of the data may have been imported successfully to the datatable.

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

← Older revision		Revision as of 22:53, 7 May 2025
Line 1:		Line 1:
	The '''importfile''' operation imports data from a text file to a [[QPR_ProcessAnalyzer_Project_Workspace#Datatables\|datatable]].		The '''importfile''' operation imports data from a text file to a [[QPR_ProcessAnalyzer_Project_Workspace#Datatables\|datatable]].

	UTF-8 is the only supported character encoding~~, so~~ the file ~~needs to be converted into UTF-8 for the import~~. In case ~~some~~ other character encoding is used, ~~it might lead to invalid~~ characters~~, which are still~~ imported~~. In case invalid characters are imported, either a new import needs to be made with a corrected~~ file~~, or the data needs to~~ be ~~cleaned using a script~~.		UTF-8 is the only supported character encoding for the imported file. In case any other character encoding is used, characters in the imported file may be interpreted incorrectly.

	HTTP request header '''Authorization''' with value '''Bearer <access token>''' needs to be in place to identify the session.		HTTP request header '''Authorization''' with value '''Bearer <access token>''' needs to be in place to identify the session.

	<pre>		<pre>
	Url: POST qprpa/api/importfile?~~param1~~=value1&~~param2~~=value2~~&param3=value3~~		Url: POST qprpa/api/importfile?parameter1=value1&parameter2=value2
	Content-Type: multipart/form-data		Content-Type: multipart/form-data
	Body: <file contents>		Body: <file contents>
Line 12:		Line 12:

	Following query parameters can be defined:		Following query parameters can be defined:
	* '''fileType''' (string): Defines ~~content~~ format of the imported file. Options are '''csv''', '''pacm''' and '''xes'''.		* '''fileType''' (string): Defines format of the imported file. Options are '''csv''' (default), '''pacm''' and '''xes'''.
	* '''objectId''' (integer): Datatable id. ~~Needed~~ when importing data to an existing datatable.		* '''objectId''' (integer): Datatable id. Used when importing data to an existing datatable.
	* '''append''' (boolean): When true, ~~the possible previous~~ data in the destination datatable is preserved. When false, ~~previous~~ data is removed and also datatable columns are deleted.		* '''append''' (boolean): When ''true'', existing data in the destination datatable is preserved. When ''false'', existing data is removed and also datatable columns are deleted.
	* '''matchByColumns''': JSON array of datatable columns that are used to match the imported rows as follows: If a matching row is found, that existing row is updated (with columns not listed by this setting). In other case, a new row is created to the datatable. By default, no matching columns are defined, so all data is imported as new rows.		* '''matchByColumns''': JSON array of datatable columns that are used to match the imported rows as follows: If a matching row is found, that existing row is updated (with columns not listed by this setting). In other case, a new row is created to the datatable. By default, no matching columns are defined, so all data is imported as new rows.
	* '''csvDelimiter''' (string): Column delimiter character for the csv format.		* '''csvDelimiter''' (string): Column delimiter character for the csv format.
Line 31:		Line 31:
	* Empty data is imported as ''null'' values (applies for all datatypes).		* Empty data is imported as ''null'' values (applies for all datatypes).

	If conversion is not possible, an error is ~~given~~ and the import stops. Note that ~~part~~ of the data may have been imported successfully to the datatable.		If conversion is not possible, an error is returned and the import stops. Note that some of the data may have been imported successfully to the datatable.

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