Web API: Usersettings: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| Line 5: | Line 5: | ||
== PUT /api/usersettings/{key}/{value} == | == PUT /api/usersettings/{key}/{value} == | ||
Stores individual setting to the server. | Stores individual user setting to the server. | ||
<pre> | <pre> | ||
Url: PUT /api/usersettings/{key}/{value} | Url: PUT /api/usersettings/{key}/{value} | ||
| Line 16: | Line 16: | ||
== POST /api/usersettings/ == | == POST /api/usersettings/ == | ||
Stores multiple settings to the server. | Stores multiple user settings to the server at the same time. Possible existing settings in the server that are not mentioned in the request, are not removed. | ||
<pre> | <pre> | ||
Url: POST /api/usersettings/ | Url: POST /api/usersettings/ | ||
</pre> | </pre> | ||
The request body contains an object that has | The request body contains an object that has fields for all the settings to be stored. | ||
Returns HTTP code 204 (No content). | Returns HTTP code 204 (No content). | ||
[[Category: QPR ProcessAnalyzer]] | [[Category: QPR ProcessAnalyzer]] | ||
Revision as of 13:32, 4 October 2021
The usersettings operation saves user specific settings to server. The PUT version is used to store an 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 user 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 user settings to the server at the same time. Possible existing settings in the server that are not mentioned in the request, are not removed.
Url: POST /api/usersettings/
The request body contains an object that has fields for all the settings to be stored.
Returns HTTP code 204 (No content).