REST - Client - ClientPreference

REST-Interface

Zurück zur Übersicht

Get clientpreference by key

Get by preferenceKey (cached, currently string-only).
URL
GET <application-url>/api/client/preference/<preferenceKey>

Path parameter

  • preferenceKey

Produces

text/plain

String - preference-value

  • 200 OK
  • 400 BAD_REQUEST
  • 404 NOT_FOUND
  • 500 INTERNAL_SERVER_ERROR

Permission
ADMINISTRATE_ALL

Sample
GET http://localhost:8080/mtr-backend/api/client/preference/general.fileUploadMaxSizeBytes

Get clientpreferences (map)

Get all client-preferences as map.
URL
GET <application-url>/api/client/preference

Produces

application/json
application/xml

com.matterial.mtr.api.object.PreferenceMapContainer

  • 200 OK
  • 500 INTERNAL_SERVER_ERROR

Permission
ADMINISTRATE_ALL

Sample
GET http://localhost:8080/mtr-backend/api/client/preference

Store clientpreference

Update the given preference.
URL
PUT <application-url>/api/client/preference/<preferenceKey>

Path parameter

  • preferenceKey

Consumes

text/plain

String - preferenceValue

Produces

text/plain

Integer - updated rows

  • 200 OK
  • 400 BAD_REQUEST
  • 500 INTERNAL_SERVER_ERROR

Permission
ADMINISTRATE_ALL

Sample
PUT http://localhost:8080/mtr-backend/api/client/preference/general.fileUploadMaxSizeBytes

Remove clientpreference

URL
DELETE <application-url>/api/client/preference/<preferenceKey>

Path parameter

  • preferenceKey

Produces

text/plain

Integer - count of removed

  • 200 OK
  • 400 BAD_REQUEST
  • 404 NOT_FOUND
  • 500 INTERNAL_SERVER_ERROR

Permission
ADMINISTRATE_ALL

Sample
DELETE http://localhost:8080/mtr-backend/api/client/preference/general.fileUploadMaxSizeBytes

×