Jump to

• Request
• Response
• Examples

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.

  • [0]: string

  {
      "name":"fields",
      "in":"query",
      "description":"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.",
      "required":false,
      "type":"array",
      "items":{
          "type":"string"
      },
      "collectionFormat":"csv"
  }

• links(optional): array
  Collection Format: csv

  Filter the specified link rel's.

  • [0]: string

  {
      "name":"links",
      "in":"query",
      "description":"Filter the specified link rel's.",
      "required":false,
      "type":"array",
      "items":{
          "type":"string"
      },
      "collectionFormat":"csv"
  }

Back to Top

Response

Supported Media Types

• application/json

200 Response

The user's preferences.

Body ()

Root Schema : UserPreferencesResponse

Match All

Show Source

• object UserPreferences
• object LinksResponseFeature

{
    "allOf":[
        {
            "$ref":"#/definitions/UserPreferences"
        },
        {
            "$ref":"#/definitions/LinksResponseFeature"
        }
    ]
}

Nested Schema : UserPreferences

Type: object

Show Source

• accessibility(optional): object AccessibilityUserPreferences
• timeZone(optional): object TimeZoneUserPreferences

{
    "type":"object",
    "properties":{
        "accessibility":{
            "$ref":"#/definitions/AccessibilityUserPreferences"
        },
        "timeZone":{
            "$ref":"#/definitions/TimeZoneUserPreferences"
        }
    }
}

Nested Schema : LinksResponseFeature

Type: object

Show Source

• links(optional): array links
  Includes 'canonical'.

{
    "properties":{
        "links":{
            "type":"array",
            "description":"Includes 'canonical'.",
            "items":{
                "$ref":"#/definitions/HATEOASLink"
            }
        }
    }
}

Nested Schema : AccessibilityUserPreferences

Type: object

Show Source

• highContrast(optional): boolean
  Default Value: false

  Indicates if high contrast mode is enabled in the in the Management Portal. Value is false if high contrast mode is disabled and true if enabled.
• largeFonts(optional): boolean
  Default Value: false

  Indicates if large fonts are displayed in the Management Portal. Value is false if default font sizes are displayed and true if large fonts are displayed.
• screenReader(optional): boolean
  Default Value: false

  Indicates if screen reader mode is enabled in the Management Portal. Value is false if screen reader mode is disabled and true if enabled.

{
    "type":"object",
    "properties":{
        "largeFonts":{
            "type":"boolean",
            "description":"Indicates if large fonts are displayed in the Management Portal. Value is <code>false</code> if default font sizes are displayed and <code>true</code> if large fonts are displayed.",
            "default":false
        },
        "highContrast":{
            "type":"boolean",
            "description":"Indicates if high contrast mode is enabled in the in the Management Portal. Value is <code>false</code> if high contrast mode is disabled and <code>true</code> if enabled.",
            "default":false
        },
        "screenReader":{
            "type":"boolean",
            "description":"Indicates if screen reader mode is enabled in the Management Portal. Value is <code>false</code> if screen reader mode is disabled and <code>true</code> if enabled.",
            "default":false
        }
    }
}

Nested Schema : TimeZoneUserPreferences

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "timeZoneId":{
            "type":"string",
            "description":"The ID of the current platform time zone. This must be a valid Java time zone."
        },
        "usePlatformTimeZone":{
            "type":"boolean",
            "description":"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.",
            "default":true
        }
    }
}

Nested Schema : links

Type: array

Includes 'canonical'.

Show Source

• Array of: object HATEOASLink

{
    "type":"array",
    "description":"Includes 'canonical'.",
    "items":{
        "$ref":"#/definitions/HATEOASLink"
    }
}

Nested Schema : HATEOASLink

Type: object

Show Source

• href(optional): string
  Link href.
• method(optional): string
  HTTP Operation GET, POST, PUT
• rel(optional): string
  Link relation.

{
    "type":"object",
    "properties":{
        "method":{
            "type":"string",
            "description":"HTTP Operation GET, POST, PUT"
        },
        "rel":{
            "type":"string",
            "description":"Link relation."
        },
        "href":{
            "type":"string",
            "description":"Link href."
        }
    }
}

403 Response

Forbidden.

Body ()

Root Schema : Error

Type: object

Show Source

• 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

{
    "type":"object",
    "required":[
        "title",
        "type"
    ],
    "properties":{
        "type":{
            "type":"string",
            "description":"Error type"
        },
        "title":{
            "type":"string",
            "description":"Summary error message"
        },
        "detail":{
            "type":"string",
            "description":"Detailed error message"
        },
        "instance":{
            "type":"string",
            "description":"URI to the link that provides more detail about the error"
        },
        "errorCode":{
            "type":"string",
            "description":"Application specific error code"
        },
        "errorPath":{
            "type":"string"
        },
        "status":{
            "type":"string",
            "description":"HTTP status code"
        },
        "errorDetails":{
            "type":"array",
            "description":"additional errors",
            "items":{
                "$ref":"#/definitions/Error"
            }
        }
    }
}

Nested Schema : errorDetails

Type: array

additional errors

Show Source

• Array of: object Error

{
    "type":"array",
    "description":"additional errors",
    "items":{
        "$ref":"#/definitions/Error"
    }
}

500 Response

Unexpected error.

Body ()

Root Schema : Error

Type: object

Show Source

• 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

{
    "type":"object",
    "required":[
        "title",
        "type"
    ],
    "properties":{
        "type":{
            "type":"string",
            "description":"Error type"
        },
        "title":{
            "type":"string",
            "description":"Summary error message"
        },
        "detail":{
            "type":"string",
            "description":"Detailed error message"
        },
        "instance":{
            "type":"string",
            "description":"URI to the link that provides more detail about the error"
        },
        "errorCode":{
            "type":"string",
            "description":"Application specific error code"
        },
        "errorPath":{
            "type":"string"
        },
        "status":{
            "type":"string",
            "description":"HTTP status code"
        },
        "errorDetails":{
            "type":"array",
            "description":"additional errors",
            "items":{
                "$ref":"#/definitions/Error"
            }
        }
    }
}

Nested Schema : errorDetails

Type: array

additional errors

Show Source

• Array of: object Error

{
    "type":"array",
    "description":"additional errors",
    "items":{
        "$ref":"#/definitions/Error"
    }
}

Back to Top

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"
    }
  ]
}

Back to Top