User parameters API Resource

GET /api/parameters/json

Get list of all user parameters

Response Body
media type data type description
application/json object (JSON) JSON with list of system parameters.

Example of response:

{"list":{"General":{"list":{"DocumentUnits":"7","HideEmptyFields":"true","ShowObjectPropertiesOnHover":"true","RasterUnits":"7","Language":"1","VersionId":"20","DrawingAutoSave":"true","VectorUnits":"7","MapUnits":"7","DrawingAutoSaveDelay":"10","Theme":"classic-blue"}}}}

Example

Request
GET /api/parameters/json
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
...

PUT /api/parameters/resetuserparams

Response Body
media type data type description
application/json HdcSuccessTO (JSON)

Example

Request
PUT /api/parameters/resetuserparams
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 204 No Content
Content-Type: application/json

                
{ }

GET /api/parameters/{sectionName}/json

Get list of user parameters for chosen group

Request Parameters
name type description
sectionName path name of group of parameters ex. general.
Response Body
media type data type description
application/json object (JSON) JSON with list of system parameters.

Example of response:

{"list":{"DocumentUnits":"7","HideEmptyFields":"true","ShowObjectPropertiesOnHover":"true","RasterUnits":"7","Language":"1","VersionId":"20","DrawingAutoSave":"true","VectorUnits":"7","MapUnits":"7","DrawingAutoSaveDelay":"10","Theme":"classic-blue"}}

Example

Request
GET /api/parameters/{sectionName}/json
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
...

PUT /api/parameters/{sectionName}/json

Update value of user parameters. Please note that this WS couldn't be used for setting versionId parameter, it will be omitted. To change versionId please use av rest.

Example of request:

{"DocumentUnits":"5","HideEmptyFields":"true","RasterUnits":"3"}

Request Parameters
name type description
sectionName path
Request Body
media type data type
application/json string (JSON)
Response Body
media type data type description
application/json HdcSuccessTO (JSON) JSON Response with information, whether the saving has or has not been succeeded.

Example

Request
PUT /api/parameters/{sectionName}/json
Content-Type: application/json
Accept: application/json

                
...
Response
HTTP/1.1 204 No Content
Content-Type: application/json

                
{ }