Get a set of user preferences
get
/fscmRestApi/resources/11.13.18.05/publicSectorUserPreferences/{UserId}
Request
Path Parameters
-
UserId: string
The unique identifier for the user associated with the user preferences.
Query Parameters
-
dependency: string
This parameter specifies dependencies which are attributes that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The attributes specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the attributes will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency attributes. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource attributes. Only the specified attributes are returned, which means that if no attributes are specified, no attributes are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource attributes. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
Response
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
Default Response
The following table describes the default response for this task.
Root Schema : publicSectorUserPreferences-item
Type:
Show Source
object
-
Currency(optional):
string
The monetary currency for the current user.
-
CurrentLanguage(optional):
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(optional):
string
The format in which dates are displayed to the current user.
-
DecimalSeperator(optional):
string
This character used as a decimal separator for integers displayed in decimal form.
-
GroupingSeperator(optional):
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(optional):
array Items
Title:
Items
Link Relations -
NlsLanguageCode(optional):
string
The national language support code.
-
NlsLanguageString(optional):
string
The description or name of the language represented by the national language code.
-
NumberFormat(optional):
string
The format in which numbers are displayed to the user.
-
Territory(optional):
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(optional):
string
This format in which time is dispalyed to the current user.
-
TimeZone(optional):
string
This time zone associated with the current user.
-
UserDisplayName(optional):
string
The language in which all person names are displayed for a global area.
-
UserId(optional):
string
The unique identifier for the user associated with the user preferences.
-
UserName(optional):
string
The name of the user who is currently logged in.
Nested Schema : link
Type:
Show Source
object
-
href(optional):
string
Title:
hyperlink reference
The URI to the related resource. -
rel(optional):
string
Title:
relation
The name of the relation to the resource instance. Example: self.