Start import configuration

post https://example.com/settings/v1/configuration/imports/start

Request Body Parameters:

Parameter	Type	Mandatory	Description	Example
exportId	string	true
importType	string	true	Values:CLEAN_IMPORT

This API requires SETTINGS_CONFIGURATION_START_IMPORT permission(s).

Responses

Parameter	Type	Description
id	string
name	string
description	string
status	string	Values:IN_PROGRESS,FAILED,SUCCESS
importType	string	Values:CLEAN_IMPORT
errorMessage	string
lastModifiedTime	string
creationTime	string

Language

Credentials

Bearer

JWT


xxxxxxxxxx
1
curl --request POST \
2
     --url https://example.com/settings/v1/configuration/imports/start \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "importType": "CLEAN_IMPORT"
8
}
9
'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201The below table describes the response parameters: ParameterTypeDescriptionExampleidstringnamestringdescriptionstringstatusstringValues:IN_PROGRESS,FAILED,SUCCESSimportTypestringValues:CLEAN_IMPORTerrorMessagestringlastModifiedTimestringcreationTimestring

400Bad Request

401Code : TOKEN_NOT_VALID, Details: []

403Code : ACCESS_DENIED, Details: []

404Code : EXPORT_METADATA_NOT_FOUND, Details: [exportId]

409Code : IMPORT_PROCESS_IS_ALREADY_ACTIVE, Details: [importName] Code : NOT_CORRESPONDING_BIOT_VERSION, Details: [importBiotVersion, biotVersion]

500Code : INTERNAL_SERVER_ERROR, Details: []

504Code : GATEWAY_TIMEOUT, Details: []