Jump to

• Request
• Response

This API has been deprecated and will be removed in a future release. Use PATCH operation to update user preferences

put

/apiplatform/administration/v1/preferences/user

Updates the preferences of the user accessing this resource. All fields are optional; send only the field(s) you want to update in the request.

All authenticated users can access this resource.

Request

Supported Media Types

• application/json

Body ()

Root Schema : UserPreferencesUpdate

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 : 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
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

204 Response

Preferences successfully updated.

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