Web API: Usersettings: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| Line 1: | Line 1: | ||
The '''Usersettings''' saves user specific settings to server. | The '''Usersettings''' saves user specific settings to server. The PUT version is used to store individual setting and the POST version to store multiple settings. | ||
HTTP request header '''Authorization''' with value '''Bearer <access token>''' needs to be in place to identify the session. | HTTP request header '''Authorization''' with value '''Bearer <access token>''' needs to be in place to identify the session. | ||
== PUT /api/usersettings/{key}/{value} == | |||
Stores individual setting to the server. | |||
<pre> | <pre> | ||
| Line 8: | Line 11: | ||
The '''key''' is the setting name and '''value''' is the setting value. | The '''key''' is the setting name and '''value''' is the setting value. | ||
Returns HTTP code 204 (No content). | |||
== POST /api/usersettings/ == | |||
Stores multiple settings to the server. | |||
<pre> | |||
Url: POST /api/usersettings/ | |||
</pre> | |||
The request body contains an object that has properties for all the stored settings. | |||
Returns HTTP code 204 (No content). | Returns HTTP code 204 (No content). | ||
[[Category: QPR ProcessAnalyzer]] | [[Category: QPR ProcessAnalyzer]] | ||
Revision as of 14:09, 20 September 2021
The Usersettings saves user specific settings to server. The PUT version is used to store individual setting and the POST version to store multiple settings.
HTTP request header Authorization with value Bearer <access token> needs to be in place to identify the session.
PUT /api/usersettings/{key}/{value}
Stores individual setting to the server.
Url: PUT /api/usersettings/{key}/{value}
The key is the setting name and value is the setting value.
Returns HTTP code 204 (No content).
POST /api/usersettings/
Stores multiple settings to the server.
Url: POST /api/usersettings/
The request body contains an object that has properties for all the stored settings.
Returns HTTP code 204 (No content).