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 | The '''importfile''' operation imports data from a file to QPR ProcessAnalyzer [[Data_Tables_in_QPR_ProcessAnalyzer|datatable]]. | ||
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 6: | Line 6: | ||
Url: POST /api/importfile?param1=value1¶m2=value2¶m3=value3 | Url: POST /api/importfile?param1=value1¶m2=value2¶m3=value3 | ||
Content-Type: multipart/form-data | Content-Type: multipart/form-data | ||
Body: file contents | Authorization: Bearer <access token> | ||
Body: <file contents> | |||
</pre> | </pre> | ||
Line 12: | Line 13: | ||
* '''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'''. | ||
* '''importMode''' (string): Defines what kind of data is imported. Options are '''datatable''', '''events''' and '''cases'''. Needed when fileType=csv. | * '''importMode''' (string): Defines what kind of data is imported. Options are '''datatable''', '''events''' and '''cases'''. Needed when fileType=csv. | ||
* '''projectId''' (string): Project id. Needed when creating a new model or a new | * '''projectId''' (string): Project id. Needed when creating a new model or a new datatable. | ||
* '''newObjectName''' (string): Model or datatable name. Needed when creating a new model or a new datatable. | * '''newObjectName''' (string): Model or datatable name. Needed when creating a new model or a new datatable. | ||
* '''objectId''' (integer): Model or datatable id. Needed when importing data to an existing model or a datatable. | * '''objectId''' (integer): Model or datatable id. Needed when importing data to an existing model or a datatable. | ||
Line 19: | Line 20: | ||
* '''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. | ||
* '''csvStartImportFromLine''' (integer): The column name row in the csv file. | * '''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 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. | ||
* '''isCompressed''' (boolean): When true, | * '''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). | ||
[[Category: QPR ProcessAnalyzer]] | [[Category: QPR ProcessAnalyzer]] |
Revision as of 15:58, 3 June 2020
The importfile operation imports data from a file to QPR ProcessAnalyzer datatable.
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 Authorization: Bearer <access token> 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.
- projectId (string): Project id. Needed when creating a new model or a new datatable.
- newObjectName (string): Model or datatable name. Needed when creating a new model or a new datatable.
- 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).