Path: / {BASE} / config / data / {key}

Return the string or list value for the configuration key passed as argument.

Path parameters:
key - the configuration key for which to return the value

Method Summary
ResourceDescription
GET /{BASE}/config/data/{key}Return the string or list value for the configuration key passed as argument.
POST /{BASE}/config/data/{key}?comment=…&type=…Set the configuration with the key passed in the path argument.
DELETE /{BASE}/config/data/{key}Delete the configuration with the key passed in the path argument.

Method Detail
HTTP Example:
GET /{BASE}/config/data/{key}

API Example:

ConfigurationWebService.getConfiguration({'key': /* key the configuration key for which to return the value */});

Return the string or list value for the configuration key passed as argument.

Output:
javax.ws.rs.core.Response - the value of the requested configuration
Produces:
application/json
HTTP return codes:
200 - if the configuration key exists
404 - if the configuration key does not exist
HTTP Example:
POST /{BASE}/config/data/{key}?comment=…&type=…

API Example:

ConfigurationWebService.setConfiguration({'comment': /* Set the configuration with the key passed in the path argument. */,
  'type': /* Set the configuration with the key passed in the path argument. */,
  'key': /* key the configuration key to set */});

Set the configuration with the key passed in the path argument. The input has to be a JSON list of String values sent in the body of the request

Output:
javax.ws.rs.core.Response - OK if the value was set correctly, ERROR if parsing failed
Query parameters:
comment
type
Consumes:
application/json
HTTP return codes:
200 - if the configuration was set
400 - if the input sent in the body could not be parsed
HTTP Example:
DELETE /{BASE}/config/data/{key}

API Example:

ConfigurationWebService.deleteConfiguration({'key': /* key the configuration to remove */});

Delete the configuration with the key passed in the path argument.

Output:
javax.ws.rs.core.Response - 200 (OK) if the configuration was removed successfully, 500 (server error) otherwise
HTTP return codes:
200 - if the configuration was removed successfully
500 - if there was an error while removing the configuration