Web API: Importfile: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
Line 1: | Line 1: | ||
The '''importfile''' operation imports data from a file to QPR ProcessAnalyzer [[QPR_ProcessAnalyzer_Project_Workspace#Managing_Datatables|datatable]]. | The '''importfile''' operation imports data from a file to QPR ProcessAnalyzer [[QPR_ProcessAnalyzer_Project_Workspace#Managing_Datatables|datatable]]. | ||
Only UTF-8 type of data is supported, so file needs to be converted into UTF-8. Invalid characters are still supported by the import. 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 type of data is supported, so the file needs to be converted into UTF-8 to be able to import it successfully. Invalid characters are still supported by the import and they are stored unchanged as invalid characters. 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. |
Revision as of 12:17, 9 March 2021
The importfile operation imports data from a file to QPR ProcessAnalyzer datatable.
Only UTF-8 type of data is supported, so the file needs to be converted into UTF-8 to be able to import it successfully. Invalid characters are still supported by the import and they are stored unchanged as invalid characters. 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.
Url: POST /api/importfile?param1=value1¶m2=value2¶m3=value3 Content-Type: multipart/form-data Body: <file contents>
Following parameters can be defined:
- fileType (string): Defines content format of the imported file. Options are csv, pacm and xes.
- importMode (string): Defines what kind of data is imported. Options are datatable, events and cases. Needed when fileType=csv.
- objectId (integer): Model or datatable id. Needed when importing data to an existing model or a datatable.
- csvDelimiter (string): Column delimiter character for the csv format.
- csvQualifier (string): Character used to enclose strings for the csv format.
- csvTimeFormat (string): Date format to use when interpreting date values for the csv format.
- csvStartImportFromLine (integer): The column name row in the csv file.
- 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.
- 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).