Get user preferences
get
/apiplatform/administration/v1/preferences/user
Returns the preferences for the user accessing this resource. The response also contains HATEOAS links to related operations.
All authenticated users can access this resource.
Request
Supported Media Types
- application/json
Query Parameters
-
fields(optional): array
Collection Format:
csv
Pass optional fields, separated by commas, in this parameter to return them in the response. See the operation's description for a list of field values. - links(optional): array
Response
Supported Media Types
- application/json
200 Response
The user's preferences.
Nested Schema : LinksResponseFeature
Type:
Show Source
object
-
links(optional):
array links
Includes 'canonical'.
Nested Schema : AccessibilityUserPreferences
Type:
Show Source
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.
Nested Schema : TimeZoneUserPreferences
Type:
Show Source
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.
Nested Schema : HATEOASLink
Type:
Show Source
object
-
href(optional):
string
Link href.
-
method(optional):
string
HTTP Operation GET, POST, PUT
-
rel(optional):
string
Link relation.
403 Response
Forbidden.
Root Schema : Error
Type:
Show Source
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
Unexpected error.
Root Schema : Error
Type:
Show Source
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 retrieve the requesting preferences of the user in Oracle API Platform Cloud Service by submitting a GET request on the REST resource using cURL. For more information about cURL, see Use cURL.
curl -i -X GET -u apicsadmin:password https://example.com/apiplatform/administration/v1/preferences/user
Example of Response Headers
The following shows an example of the response headers.
HTTP/1.1 200 OK Server: Oracle-Traffic-Director/12.2.1.0.0 Date: Mon, 02 Jan 2017 13:33:18 GMT Content-length: 392 Content-type: application/json X-oracle-dms-ecid: o64xd1HrR00000000 X-oracle-dms-rid: 0:1 Via: 1.1 otd_opc Proxy-agent: Oracle-Traffic-Director/12.2.1.0.0
Example of Response Body
The following example shows the contents of the response body in JSON format, including the current preferences of the user and HATEOAS links to related operations:
{ "accessibility": { "largeFonts": false, "highContrast": true, "screenReader": false }, "timeZone": { "timeZoneId": "Africa/Abidjan", "usePlatformTimeZone": false }, "links": [ { "method": "GET", "rel": "canonical", "href": "https://example.com:443/apiplatform/administration/v1/preferences/user" }, { "method": "POST", "rel": "edit", "href": "https://example.com:443/apiplatform/administration/v1/preferences/user" } ] }