Update a box rating
patch
/hcmRestApi/resources/11.13.18.05/talentReviewMeetingTemplates/{talentReviewMeetingTemplatesUniqID}/child/analyticTypes/{analyticTypesUniqID}/child/boxRatings/{boxRatingsUniqID}
Request
Path Parameters
-
analyticTypesUniqID(required): string
This is the hash key of the attributes which make up the composite key--- AnalyticTypeId and BusinessGroupId ---for the Analytic Types resource and used to uniquely identify an instance of Analytic Types. The client should not generate the hash key value. Instead, the client should query on the Analytic Types collection resource with a filter on the primary key values in order to navigate to a specific instance of Analytic Types.
For example: analyticTypes?q=AnalyticTypeId=<value1>;BusinessGroupId=<value2> -
boxRatingsUniqID(required): string
This is the hash key of the attributes which make up the composite key--- BoxRatingMappingId and BusinessGroupId ---for the Box Ratings resource and used to uniquely identify an instance of Box Ratings. The client should not generate the hash key value. Instead, the client should query on the Box Ratings collection resource with a filter on the primary key values in order to navigate to a specific instance of Box Ratings.
For example: boxRatings?q=BoxRatingMappingId=<value1>;BusinessGroupId=<value2> -
talentReviewMeetingTemplatesUniqID(required): string
This is the hash key of the attributes which make up the composite key--- DashboardTemplateId and BusinessGroupId ---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 with a filter on the primary key values in order to navigate to a specific instance of Talent Review Meeting Templates.
For example: talentReviewMeetingTemplates?q=DashboardTemplateId=<value1>;BusinessGroupId=<value2>
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
-
BoxcellBackgroundColor: string
Maximum Length:
2000
Background color for the box of the box chart. -
BoxSequence: integer
(int64)
Sequence for the box of the box chart.
-
BusinessGroupId: integer
(int64)
Unique identifier for the business group for which the box rating applies.
-
MetricRatingModelId: integer
(int64)
Unique identifier for the rating model used for the rating included in the talent review meeting template.
-
RatingLevelId: integer
(int64)
Unique identifier for the rating level.
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-analyticTypes-boxRatings-item-response
Type:
Show Source
object
-
BoxcellBackgroundColor: string
Maximum Length:
2000
Background color for the box of the box chart. -
BoxRatingMappingId: integer
(int64)
Unique identifier for the box rating mapping.
-
BoxSequence: integer
(int64)
Sequence for the box of the box chart.
-
BusinessGroupId: integer
(int64)
Unique identifier for the business group for which the box rating applies.
-
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the box rating. -
CreationDate: string
(date-time)
Read Only:
true
Date the box rating was created. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date the box rating was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who last updated the box rating. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MetricRatingModelId: integer
(int64)
Unique identifier for the rating model used for the rating included in the talent review meeting template.
-
RatingLevelId: integer
(int64)
Unique identifier for the rating level.
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.