Config (export) admin API Resource

System configuration drafts handling WS

POST /admin/config/export/json

Export current configuration

Example of request:

{"dictionaries":true,"perspectiveSets":true,"presentations":true,"globalLayers":true,"printFormats":true,"toolsets":true, "templates":true, "templatesList" : [{"id":33},{"id":34}]}

Request Parameters
name type description default constraints
dictionaries form   required boolean
globalLayers form   required boolean
presentations form   required boolean
printFormats form   required boolean
templates form   required boolean
templatesList form    
toolsets form   required boolean
Response Body
media type data type description
application/json object JSON Response with current configuration.

POST /admin/config/import/draft/json

Import configuration Draft from json uploadFile

Request Parameters
name type description default constraints
configDraftId query the draft of configurationId to perform import   long
objectclasses query if true, objectclasses configuration is imported   required boolean
perspectives query if true, perspectives configuration is imported   required boolean
skipDuplicates query if true, duplicate Objects are skipped   required boolean
skipMatched query applies only when skipDuplicates is false, if false matched Objects are updated, true - they are skipped   required boolean
Request Body
media type data type
multipart/form-data (custom)
Response Body
media type data type description
application/json object JSON response with detailed import report

Example of response:

{"list": [{"errorMessage": "Skipped class 'hdv_h3_floor'","errorContext": "Object Classes Import","errorLevel": "INFO"}, "errorMessage": "Skipped field 'fi2spsys_name_h3' for class '131'","errorContext": "Object Class Fields Import","errorLevel": "INFO"},],"success": true}

POST /admin/config/import/json/{fileGUID}

Start import configuration

Request Parameters
name type description default constraints
fileGUID path   long
Request Body
media type data type
*/* object
Response Body
media type data type description
application/json object JSON Response with information about GUID of file to import configuration.

GET /admin/config/export/draft/json/{configDraftId}

Export configuration Draft to json file

Request Parameters
name type description default constraints
configDraftId path the draft of configurationId to perform export   long
objectclasses query if true, objectClasses configuration is exported   required boolean
perspectives query if true, perspectives configuration is exported   required boolean
Response Body
media type data type description
application/json object json file with configuration Draft configuration

POST /admin/config/export/draft/json/{configDraftId}

Request Parameters
name type description default constraints
configDraftId path   long
Response Body
media type data type description
application/json object

POST /admin/config/import/upload/json/{mode}

Upload configuration XML to import

Request Parameters
name type description default constraints
mode path    
Request Body
media type data type
multipart/form-data (custom)
Response Body
media type data type description
application/json object JSON Response with information about GUID of file to import configuration and available import options.

Example of response:

{"message":{"dictionaries":true,"presentations":false,"globalLayers":true,"printFormats":true,"toolsets":false,"templates":true,"templatesList":[],"skipMatched":false},"configurationId":"19","success":true}