API Documentation

REST - InstanceControl - Preference

REST-Interface

Get preferences (map)

Attention:
This API requires the systemAccount which is only available in on-premises installations (private cloud).

Get all global preferences as map (PreferenceMapContainer).
URL
GET <application-url>/api/instancecontrol/preference/cache

Produces

application/json
application/xml

com.matterial.mtr.api.object.PreferenceMapContainer

  • 200 OK

Permission
systemAccountRequired

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

Get preference by key

Attention:
This API requires the systemAccount which is only available in on-premises installations (private cloud).

URL
GET <application-url>/api/instancecontrol/preference/cache/bypreferencekey/<preferenceKey>

Path parameter

parameter mandatory possible values default description
preferenceKey yes - - a preference key

Produces

text/plain

String - preference-value

  • 200 OK

Permission
systemAccountRequired

Sample
GET http://localhost:8080/mtr-backend/api/instancecontrol/preference/cache/bypreferencekey/general.application.context.backend

Get unrestricted preferences (map)

Since 2.4
Get all unrestricted preferences as map (PreferenceMapContainer).
This resource could be invoked without being logged-in.
URL
GET <application-url>/api/instancecontrol/preference/cache/unrestricted

Produces

application/json
application/xml

com.matterial.mtr.api.object.PreferenceMapContainer

  • 200 OK

Permission
-

Sample
GET http://localhost:8080/mtr-backend/api/instancecontrol/preference/cache/unrestricted

Get unrestricted preference by key

This resource could be invoked without being logged-in for some special pref-keys.
URL
GET <application-url>/api/instancecontrol/preference/cache/byunrestrictedkey/<preferenceKey>

Path parameter

  • preferenceKey
    possible values:
    • auth.ntlm.jespaSupported
    • auth.oauth2.google.supported
    • auth.oauth2.microsoft.supported
    • auth.oauth2.cobot.supported
    • general.demo.hostname
    • general.inhouse.enabled

Produces

text/plain

String - preference-value

  • 200 OK

Permission
-

Sample
GET http://localhost:8080/mtr-backend/api/instancecontrol/preference/cache/byunrestrictedkey/auth.oauth2.google.supported

Reinit preference-cache

Attention:
This API requires the systemAccount which is only available in on-premises installations (private cloud).

URL
GET <application-url>/api/instancecontrol/preference/cache/reinit

  • 202 ACCEPTED

Permission
systemAccountRequired

Sample
GET http://localhost:8080/mtr-backend/api/instancecontrol/preference/cache/reinit

Store preference

Attention:
This API requires the systemAccount which is only available in on-premises installations (private cloud).

URL
PUT <application-url>/api/instancecontrol/preference/<preferencekey>

Consumes

text/plain

String - preference-value

Produces

  • 202 ACCEPTED
  • 304 NOT_MODIFIED
  • 500 INTERNAL_SERVER_ERROR

Permission
systemAccountRequired

Sample
PUT http://localhost:8080/mtr-backend/api/instancecontrol/preference/auth.ntlm.supported

Contact sales