Web API: Importfile: Difference between revisions

From QPR ProcessAnalyzer Wiki
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 the 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. Used 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. Used when creating a new model or new data table.
* '''projectId''' (string): Project id. Needed when creating a new model or a new data table.
* '''newObjectName''' (string): Model or datatable name. Used when creating a new model or new datatable.
* '''newObjectName''' (string): Model or datatable name. Needed when creating a new model or a new datatable.
* '''objectId''' (integer): Model or datatable id. Used when importing data to an existing model or datatable.
* '''objectId''' (integer): Model or datatable id. Needed when importing data to an existing model or a datatable.
* '''csvDelimiter''' (string): Delimiter character for CSV format.
* '''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): The date format to use when interpreting date values.
* '''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 importing to datatable with append=0, columns are reset.
* '''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&param2=value2&param3=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.