Update user preferences
/apiplatform/administration/v1/preferences/user
Updates the preferences of the user accessing this resource. Request must be in the merge patch format specified in RFC 7396.
Request
- application/merge-patch+json
object
-
highContrast(optional):
boolean
Default Value:
false
Indicates if high contrast mode is enabled in the in the Management Portal. Value isfalse
if high contrast mode is disabled andtrue
if enabled. -
largeFonts(optional):
boolean
Default Value:
false
Indicates if large fonts are displayed in the Management Portal. Value isfalse
if default font sizes are displayed andtrue
if large fonts are displayed. -
screenReader(optional):
boolean
Default Value:
false
Indicates if screen reader mode is enabled in the Management Portal. Value isfalse
if screen reader mode is disabled andtrue
if enabled.
object
-
timeZoneId(optional):
string
The ID of the current platform time zone. This must be a valid Java time zone.
-
usePlatformTimeZone(optional):
boolean
Default Value:
true
Indicates if all times and dates are displayed using the platform time zone, regardless of the user's time zone settings. If disabled, users' browser time zone settings are used to display times and dates. Value is true if times and dates are displayed using the platform time zone and false if times and dates are displayed using each user's time zone.
Response
- application/json
204 Response
403 Response
object
-
detail(optional):
string
Detailed error message
-
errorCode(optional):
string
Application specific error code
-
errorDetails(optional):
array errorDetails
additional errors
-
errorPath(optional):
string
-
instance(optional):
string
URI to the link that provides more detail about the error
-
status(optional):
string
HTTP status code
-
title:
string
Summary error message
-
type:
string
Error type
500 Response
object
-
detail(optional):
string
Detailed error message
-
errorCode(optional):
string
Application specific error code
-
errorDetails(optional):
array errorDetails
additional errors
-
errorPath(optional):
string
-
instance(optional):
string
URI to the link that provides more detail about the error
-
status(optional):
string
HTTP status code
-
title:
string
Summary error message
-
type:
string
Error type
Examples
The following example shows how to update preferences in Oracle API Platform Cloud Service for the user sending the request by submitting a PATCH request on the REST resource using cURL. For more information about cURL, see Use cURL.
curl -i -X PATCH -u apicsadmin:password -H "Content-Type:'application/merge-patch+json" -d @user.json https://example.com/apiplatform/administration/v1/preferences/user
Example of Request Body
The following shown an example response body in JSON format (included with the request above in a file named user.json
) enabling accessibility features for the user sending the request. You need to include only the preferences you wish to change in the request body.
{ "accessibility": { "largeFonts": "true", "highContrast": "true", "screenReader": "true" } }
Example of Response Headers
The following shows an example of the response headers.
HTTP/1.1 204 No Content Server: Oracle-Traffic-Director/12.2.1.0.0 Date: Fri, 09 Feb 2018 10:19:49 GMT Content-type: application/json X-oracle-dms-ecid: a7070a18-e96d-4e69-a511-58eafd07a798-0000c08b X-oracle-dms-rid: 0:1 Via: 1.1 otd_opc Proxy-agent: Oracle-Traffic-Director/12.2.1.0.0