Import Data APIs
Get Import Configuration (GET)
Returns configuration for a specific import service.
Route
|
URI |
/api/v1/importdata/{serviceId}/info |
|
Method |
GET |
|
Result |
JSON – ImportConfigModel |
Parameters
|
Property |
Type |
Mandatory |
Description |
|---|---|---|---|
|
serviceId |
string |
Yes |
The service identifier (in URL path) |
Example
GET http://localhost/api/v1/importdata/csv_import/info
Get Import Form (GET)
Returns the form template for an import service.
Route
|
URI |
/api/v1/importdata/{serviceId}/form |
|
Method |
GET |
|
Result |
JSON – FormTemplateModel |
Parameters
The service identifier.
Example
GET http://localhost/api/v1/importdata/csv_import/form
Save Import Data (POST)
Saves imported data through a specific service.
Route
|
URI |
/api/v1/importdata/{serviceId}/save |
|
Method |
POST |
|
Result |
JSON – ImportSaveResult |
Parameters
| Name | Type | Mandatory | Description | |——|——|———–|————-| | serviceId | string | Yes | The service identifier (in URL path) |
Body: Import data
Example
POST http://localhost/api/v1/importdata/csv_import/save
Content-Type: application/json
{import data}
Load Import Data (GET)
Loads previously imported data.
Route
|
URI |
/api/v1/importdata/{serviceId}/load |
|
Method |
GET |
|
Result |
JSON – ImportedDataModel |
Parameters
The service identifier.
Example
GET http://localhost/api/v1/importdata/csv_import/load