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

{
"data": [
["ResourceType", "Provider", "ResourceKey", "ResourceOwner"],
["ActiveDirectory", "DOMAIN", "CN=Group,DC=domain,DC=com", "DOMAIN\\username"]
],
"formTemplateString": "{\"templates\":[{\"key\":\"clear_config\",\"value\":false}]}"
}

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

Get Save Action Form Template (GET)

Get Formdata for importing configs.

Route

URI	/api/v1/importdata/{serviceId}/form
Method	GET
Result	JSON – IFormTemplate

Parameters

Name	Type	Mandatory	Description
serviceId	string	Yes

Example

GET http://localhost/api/v1/importdata/{serviceId}/form

Get Data Import Service Info (GET)

Get basic infos about an import scenario

Route

URI	/api/v1/importdata/{serviceId}/info
Method	GET
Result	JSON – DataImportServiceMetaInfo

Parameters

Name	Type	Mandatory	Description
serviceId	string	Yes

Response Structure Returns DataImportServiceMetaInfo object containing:

• Title: string value

• Description: string value

• ColumnTitles: string[] value

• RequiresCommentOnSave: Indicates if the save action requires a comment to be submitted along with the data.

Example

GET http://localhost/api/v1/importdata/{serviceId}/info

Example Response

{     "Title": "sample",     "Description": "sample",     "ColumnTitles": {},     "RequiresCommentOnSave": true }

Load Import Data (GET)

Load configuration data from backend and gives back a csv formatted string.

Route

URI	/api/v1/importdata/{serviceId}/load
Method	GET
Result	JSON – SuccessResult

Parameters

Name	Type	Mandatory	Description
serviceId	string	Yes

Response Structure Returns SuccessResult object containing:

• success: bool value

• data: object value

Example

GET http://localhost/api/v1/importdata/{serviceId}/load

Example Response

{     "success": true,     "data": {} }

Save Import Data (POST)

Import data from client to backend for configurations.

Route

URI	/api/v1/importdata/{serviceId}/save
Method	POST
Result	JSON – DataImportSaveResult

Parameters

Name	Type	Mandatory	Description
serviceId	string	Yes
data	Required]SaveImportData	No

Response Structure Returns DataImportSaveResult object containing:

• Errors: Dictionary<int, string> value

Example

POST http://localhost/api/v1/importdata/{serviceId}/save

Example Response

{     "Errors": {} }