REST - InstanceControl - Preference
REST-Interface
REST-Interface
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
Permission
systemAccountRequired
Sample
GET http://localhost:8080/mtr-backend/api/instancecontrol/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/bypreferencekey/<preferenceKey>
Path parameter
parameter | mandatory | possible values | default | description |
---|---|---|---|---|
preferenceKey | yes | - | - | a preference key |
Produces
text/plain
String - preference-value
Permission
systemAccountRequired
Sample
GET http://localhost:8080/mtr-backend/api/instancecontrol/preference/cache/bypreferencekey/general.application.context.backend
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
Permission
-
Sample
GET http://localhost:8080/mtr-backend/api/instancecontrol/preference/cache/unrestricted
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
Produces
text/plain
String - preference-value
Permission
-
Sample
GET http://localhost:8080/mtr-backend/api/instancecontrol/preference/cache/byunrestrictedkey/auth.oauth2.google.supported
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
Permission
systemAccountRequired
Sample
GET http://localhost:8080/mtr-backend/api/instancecontrol/preference/cache/reinit
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
Permission
systemAccountRequired
Sample
PUT http://localhost:8080/mtr-backend/api/instancecontrol/preference/auth.ntlm.supported