Web API: Importfile: Difference between revisions
Jump to navigation
Jump to search
m (Ollvihe moved page Web API: ImportData to Web API: Importfile without leaving a redirect) |
No edit summary |
||
Line 10: | Line 10: | ||
Following parameters can be defined: | Following parameters can be defined: | ||
* '''fileType''' (string): Defines | * '''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. | * '''importMode''' (string): Defines what kind of data is imported. Options are '''datatable''', '''events''' and '''cases'''. Needed when fileType=csv. | ||
* '''projectId''' (string): Project id. | * '''projectId''' (string): Project id. Needed when creating a new model or a new data table. | ||
* '''newObjectName''' (string): Model or datatable name. | * '''newObjectName''' (string): Model or datatable name. Needed when creating a new model or a new datatable. | ||
* '''objectId''' (integer): Model or datatable id. | * '''objectId''' (integer): Model or datatable id. Needed when importing data to an existing model or a datatable. | ||
* '''csvDelimiter''' (string): | * '''csvDelimiter''' (string): Column delimiter character for the csv format. | ||
* '''csvQualifier''' (string): Character used to enclose strings. | * '''csvQualifier''' (string): Character used to enclose strings for the csv format. | ||
* '''csvTimeFormat''' (string): | * '''csvTimeFormat''' (string): Date format to use when interpreting date values for the csv format. | ||
* '''csvStartImportFromLine''': | * '''csvStartImportFromLine''' (integer): The column name row in the csv file. | ||
* '''append''' (boolean): When true, the possible previous data is preserved. When | * '''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. | ||
* '''isCompressed''' (boolean): When true, input stream is zipped (gzip). Always true if FileType=pacm. | * '''isCompressed''' (boolean): When true, input stream is zipped (gzip format). Always true if FileType=pacm. | ||
[[Category: QPR ProcessAnalyzer]] |
Revision as of 18:29, 27 May 2020
The importfile operation imports data from a file to QPR ProcessAnalyzer datatables.
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.
- projectId (string): Project id. Needed when creating a new model or a new data table.
- 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 columns are deleted.
- isCompressed (boolean): When true, input stream is zipped (gzip format). Always true if FileType=pacm.