Change some of this user's console preferences
const url = 'http://localhost:11044/api/v1/profile/console';const options = { method: 'PUT', headers: {'X-Embabel-Api-Key': '<X-Embabel-Api-Key>', 'Content-Type': 'application/json'}, body: '{"entries":{"additionalProperty":{"at":1,"value":"example"}}}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request PUT \ --url http://localhost:11044/api/v1/profile/console \ --header 'Content-Type: application/json' \ --header 'X-Embabel-Api-Key: <X-Embabel-Api-Key>' \ --data '{ "entries": { "additionalProperty": { "at": 1, "value": "example" } } }'Merges entry by entry: each named setting replaces the stored one unless the stored one was set later (at), so the last change wins whichever browser sends it first. Settings not named are kept. Answers the whole document as stored afterwards, which is what a browser should now show.
Authorizations
Section titled “Authorizations”Request Bodyrequired
Section titled “Request Bodyrequired”The settings to change in entries, each {value, at}: value is any JSON, null to remove the setting; at is when it was changed, epoch milliseconds
Settings to change, each with the time it was changed; settings not named are left as they are
object
The settings to change, by key. A key is 1-64 letters, digits, ‘.’, ‘_’ or ‘-’, starting with a letter or digit
object
One console setting and when it was set
object
When the change was made, epoch milliseconds. A write older than the stored entry is ignored; a time ahead of the server’s clock is taken as now
The setting’s value as the console wrote it, any JSON; null removes the setting
Example generated
{ "entries": { "additionalProperty": { "at": 1, "value": "example" } }}Responses
Section titled “Responses”The preferences as stored after the change
The acting user’s console preferences in their active world: theme, wallpaper, window layout, dock pins and the like, keyed by setting
object
Each setting by key. An entry whose value is null was removed, and is kept so an older write cannot bring it back
object
One console setting and when it was set
object
When the change was made, epoch milliseconds. A write older than the stored entry is ignored; a time ahead of the server’s clock is taken as now
The setting’s value as the console wrote it, any JSON; null removes the setting
Format of this document; 1
When a write last changed something, by the server’s clock; null when nothing has been stored
Increases by one on every write that changed something; 0 when nothing has been stored
A setting name that is not 1-64 letters, digits, ‘.’, ‘_’ or ‘-’, or more than 64 settings
The body the servlet error dispatch answers for a status raised by an exception rather than written by the endpoint. Every failure except 404, which answers the not-found HTML page
object
The status’s standard reason phrase, such as Bad Request or Forbidden
The request path that failed
The HTTP status code, repeated from the status line
Not authenticated
The preferences would be larger than 6 MiB; nothing was changed
The body the servlet error dispatch answers for a status raised by an exception rather than written by the endpoint. Every failure except 404, which answers the not-found HTML page
object
The status’s standard reason phrase, such as Bad Request or Forbidden
The request path that failed
The HTTP status code, repeated from the status line