Parameters admin API Resource

System parameters handling WS

GET /api/admin/parameters/externalpass

Request Parameters
name type description
fieldId query
Response Body
media type data type description
application/json object (JSON)

Example

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

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

                
...

PUT /api/admin/parameters/externalpass

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

Example

Request
PUT /api/admin/parameters/externalpass
Content-Type: application/json
Accept: application/json

                
{
  "userParam" : true,
  "fieldType" : "...",
  "fieldId" : "...",
  "nullable" : true,
  "clientParam" : true,
  "fieldValue" : "...",
  "parameterSection" : "SightSeer"
}
Response
HTTP/1.1 204 No Content
Content-Type: application/json

                
{ }

GET /api/admin/parameters/json

Get list of system parameters

Response Body
media type data type description
application/json ParametersSections (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"}}}}

Example

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

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

                
{ }

GET /api/admin/parameters/areareport/json

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

Example

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

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

                
{ }

PUT /api/admin/parameters/areareport/json

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

Example

Request
PUT /api/admin/parameters/areareport/json
Content-Type: application/json
Accept: application/json

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

                
{ }

GET /api/admin/parameters/arrows/json

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

Example

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

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

                
{ }

PUT /api/admin/parameters/arrows/json

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

Example

Request
PUT /api/admin/parameters/arrows/json
Content-Type: application/json
Accept: application/json

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

                
{ }

GET /api/admin/parameters/general/json

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

Example

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

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

                
{ }

PUT /api/admin/parameters/general/json

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

Example

Request
PUT /api/admin/parameters/general/json
Content-Type: application/json
Accept: application/json

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

                
{ }

GET /api/admin/parameters/hopa/json

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

Example

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

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

                
{ }

PUT /api/admin/parameters/hopa/json

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

Example

Request
PUT /api/admin/parameters/hopa/json
Content-Type: application/json
Accept: application/json

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

                
{ }

GET /api/admin/parameters/labels/json

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

Example

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

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

                
{ }

PUT /api/admin/parameters/labels/json

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

Example

Request
PUT /api/admin/parameters/labels/json
Content-Type: application/json
Accept: application/json

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

                
{ }

GET /api/admin/parameters/print/json

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

Example

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

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

                
{ }

PUT /api/admin/parameters/print/json

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

Example

Request
PUT /api/admin/parameters/print/json
Content-Type: application/json
Accept: application/json

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

                
{ }

GET /api/admin/parameters/quickprint/json

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

Example

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

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

                
{ }

PUT /api/admin/parameters/quickprint/json

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

Example

Request
PUT /api/admin/parameters/quickprint/json
Content-Type: application/json
Accept: application/json

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

                
{ }

GET /api/admin/parameters/versioning/json

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

Example

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

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

                
{ }

PUT /api/admin/parameters/versioning/json

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

Example

Request
PUT /api/admin/parameters/versioning/json
Content-Type: application/json
Accept: application/json

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

                
{ }

GET /api/admin/parameters/{sectionName}/json

Get list of system parameters

Request Parameters
name type description
sectionName path
Response Body
media type data type description
application/json HdcMapTOOfStringAndString (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"}}

Example

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

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

                
{ }

PUT /api/admin/parameters/{sectionName}/json

Update value of system 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","dataDirectoryFileLimit":"12"}

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/admin/parameters/{sectionName}/json
Content-Type: application/json
Accept: application/json

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

                
{ }