Update a display option preference
patch
/hcmRestApi/resources/11.13.18.05/talentReviewMeetingTemplates/{talentReviewMeetingTemplatesUniqID}/child/displayOptionPreferences/{displayOptionPreferencesUniqID}
Request
Path Parameters
-
displayOptionPreferencesUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Display Option Preferences resource and used to uniquely identify an instance of Display Option Preferences. The client should not generate the hash key value. Instead, the client should query on the Display Option Preferences collection resource in order to navigate to a specific instance of Display Option Preferences to get the hash key.
-
talentReviewMeetingTemplatesUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Talent Review Meeting Templates resource and used to uniquely identify an instance of Talent Review Meeting Templates. The client should not generate the hash key value. Instead, the client should query on the Talent Review Meeting Templates collection resource in order to navigate to a specific instance of Talent Review Meeting Templates to get the hash key.
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
-
DashboardTmplId: integer
(int64)
Unique identifier for the talent review meeting template.
-
DisplayOptnPreferenceId: integer
(int64)
Unique identifier for the display option preference.
-
DisplayOptnType: string
Maximum Length:
30
Display option type. -
DisplayOptnValue: string
Maximum Length:
30
Display option value. -
DisplayValueColor: string
Maximum Length:
30
Color preference specified for the display option. -
DisplayValueShape: string
Maximum Length:
30
Shape preference specified for the display option.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
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.
Root Schema : talentReviewMeetingTemplates-displayOptionPreferences-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the display option preference. -
CreationDate: string
(date-time)
Read Only:
true
Date the display option preference was created. -
DashboardTmplId: integer
(int64)
Unique identifier for the talent review meeting template.
-
DisplayOptnPreferenceId: integer
(int64)
Unique identifier for the display option preference.
-
DisplayOptnType: string
Maximum Length:
30
Display option type. -
DisplayOptnValue: string
Maximum Length:
30
Display option value. -
DisplayValueColor: string
Maximum Length:
30
Color preference specified for the display option. -
DisplayValueShape: string
Maximum Length:
30
Shape preference specified for the display option. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date the display option preference was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who last updated the display option preference. -
links: array
Links
Title:
Links
The link relations associated with the resource instance.
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.