Update a set of user preferences
patch
/fscmRestApi/resources/11.13.18.05/publicSectorUserPreferences/{UserId}
Request
Path Parameters
-
UserId(required): string
The unique identifier for the user associated with the user preferences.
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
Currency: string
The monetary currency for the current user.
-
CurrentLanguage: string
The code for the language being used for the current session. When the session ends, the session language code reverts to the default value, en (English).
-
DateFormat: string
The format in which dates are displayed to the current user.
-
DecimalSeperator: string
This character used as a decimal separator for integers displayed in decimal form.
-
GroupingSeperator: string
The character used as a grouping separator for numbers displayed to the current user. For example, the American English number 1,000 uses a comma as the grouping seperator.
-
NlsLanguageCode: string
The national language support code.
-
NlsLanguageString: string
The description or name of the language represented by the national language code.
-
NumberFormat: string
The format in which numbers are displayed to the user.
-
Territory: string
The two-character code that represents the current user's territory. For example, the territory code for The United States of America is US.
-
TimeFormat: string
This format in which time is dispalyed to the current user.
-
TimeZone: string
This time zone associated with the current user.
-
UserDisplayName: string
The language in which all person names are displayed for a global area.
-
UserName: string
The name of the user who is currently logged in.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version(required):
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : publicSectorUserPreferences-item-response
Type:
Show Source
object
-
Currency: string
The monetary currency for the current user.
-
CurrentLanguage: string
The code for the language being used for the current session. When the session ends, the session language code reverts to the default value, en (English).
-
DateFormat: string
The format in which dates are displayed to the current user.
-
DecimalSeperator: string
This character used as a decimal separator for integers displayed in decimal form.
-
GroupingSeperator: string
The character used as a grouping separator for numbers displayed to the current user. For example, the American English number 1,000 uses a comma as the grouping seperator.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
NlsLanguageCode: string
The national language support code.
-
NlsLanguageString: string
The description or name of the language represented by the national language code.
-
NumberFormat: string
The format in which numbers are displayed to the user.
-
Territory: string
The two-character code that represents the current user's territory. For example, the territory code for The United States of America is US.
-
TimeFormat: string
This format in which time is dispalyed to the current user.
-
TimeZone: string
This time zone associated with the current user.
-
UserDisplayName: string
The language in which all person names are displayed for a global area.
-
UserId: string
The unique identifier for the user associated with the user preferences.
-
UserName: string
The name of the user who is currently logged in.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.