Update an analytic option
patch
/hcmRestApi/resources/11.13.18.05/talentReviewMeetingTemplates/{talentReviewMeetingTemplatesUniqID}/child/analyticTypes/{analyticTypesUniqID}
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> -
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
-
AnalyticViewMode: string
Maximum Length:
30
Indicates if the box chart view is an XY view or a single rating view. -
AnalyticViewName: string
Maximum Length:
240
Name of the box chart view created in the talent review meeting template. -
boxLabels: array
Box Labels
Title:
Box Labels
The boxLabels resource is a child of the analyticTypes resource and provides all the labels for the boxes of the box chart matrix. -
boxRatings: array
Box Ratings
Title:
Box Ratings
The boxRatings resource is a child of the analyticTypes resource and provides all the ratings associated with the box chart matrix. -
ColorSchemeCode: string
Title:
Color Scheme
Maximum Length:30
Code that identifies the color scheme used for the box chart view. -
DefaultViewFlag: boolean
Maximum Length:
30
Indicates if the box chart view is the default view. -
HorizontalAxisCode: string
Maximum Length:
30
Code for the rating used on the X-Axis of the box chart or for the single rating view. -
MetricCode: string
Maximum Length:
30
Code for the rating used in the talent review meeting template. -
SubmitBoxAsgnmntFlag: boolean
Maximum Length:
30
Indicates if the box assignment is submitted. -
VerticalAxisCode: string
Title:
Vertical Axis Value
Maximum Length:30
Code for the rating used on the Y-Axis of the box chart. -
ViewColumnCount: string
Maximum Length:
30
Number of columns used in the box chart view. -
ViewRowCount: string
Maximum Length:
30
Number of rows used in the box chart view.
Nested Schema : Box Labels
Type:
array
Title:
Box Labels
The boxLabels resource is a child of the analyticTypes resource and provides all the labels for the boxes of the box chart matrix.
Show Source
Nested Schema : Box Ratings
Type:
array
Title:
Box Ratings
The boxRatings resource is a child of the analyticTypes resource and provides all the ratings associated with the box chart matrix.
Show Source
Nested Schema : schema
Type:
Show Source
object
-
BoxcellBackgroundColor: string
Maximum Length:
2000
Background color for the box of the box chart. -
BoxLabel: string
Maximum Length:
400
Label for the box of the box chart. -
BoxSequence: integer
(int64)
Sequence for the box of the box chart.
-
DisplaySequence: integer
Display sequence for the box cell label.
Nested 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-item-response
Type:
Show Source
object
-
AnalyticTypeId: integer
(int64)
Unique identifier for the box chart view.
-
AnalyticViewMode: string
Maximum Length:
30
Indicates if the box chart view is an XY view or a single rating view. -
AnalyticViewName: string
Maximum Length:
240
Name of the box chart view created in the talent review meeting template. -
boxLabels: array
Box Labels
Title:
Box Labels
The boxLabels resource is a child of the analyticTypes resource and provides all the labels for the boxes of the box chart matrix. -
boxRatings: array
Box Ratings
Title:
Box Ratings
The boxRatings resource is a child of the analyticTypes resource and provides all the ratings associated with the box chart matrix. -
BusinessGroupId: integer
(int64)
Unique identifier for the business group for which the talent review meeting template will be used.
-
ColorSchemeCode: string
Title:
Color Scheme
Maximum Length:30
Code that identifies the color scheme used for the box chart view. -
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the rating. -
CreationDate: string
(date-time)
Read Only:
true
Date the rating was created. -
DefaultViewFlag: boolean
Maximum Length:
30
Indicates if the box chart view is the default view. -
HorizontalAxisCode: string
Maximum Length:
30
Code for the rating used on the X-Axis of the box chart or for the single rating view. -
HorizontalAxisLabel: string
Read Only:
true
Maximum Length:240
Label for the horizontal axis for the box chart view. -
HorizontalAxisRatingModelId: integer
(int64)
Read Only:
true
Rating model for the horizontal axis for the box chart view. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date the rating was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who last updated the rating. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MetricCode: string
Maximum Length:
30
Code for the rating used in the talent review meeting template. -
SingleRatingLabel: string
Read Only:
true
Maximum Length:240
Label for the single rating view. -
SingleRatingModelId: integer
(int64)
Read Only:
true
Rating model for the single rating view. -
SubmitBoxAsgnmntFlag: boolean
Maximum Length:
30
Indicates if the box assignment is submitted. -
VerticalAxisCode: string
Title:
Vertical Axis Value
Maximum Length:30
Code for the rating used on the Y-Axis of the box chart. -
VerticalAxisLabel: string
Read Only:
true
Maximum Length:240
Label for the vertical axis for the box chart view. -
VerticalAxisRatingModelId: integer
(int64)
Read Only:
true
Rating model for the vertical axis for the box chart view. -
ViewColumnCount: string
Maximum Length:
30
Number of columns used in the box chart view. -
ViewModeMeaning: string
Title:
Meaning
Read Only:true
Maximum Length:80
Indicates if the box chart view is a single rating view or an XY view. -
ViewRowCount: string
Maximum Length:
30
Number of rows used in the box chart view.
Nested Schema : Box Labels
Type:
array
Title:
Box Labels
The boxLabels resource is a child of the analyticTypes resource and provides all the labels for the boxes of the box chart matrix.
Show Source
Nested Schema : Box Ratings
Type:
array
Title:
Box Ratings
The boxRatings resource is a child of the analyticTypes resource and provides all the ratings associated with the box chart matrix.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : talentReviewMeetingTemplates-analyticTypes-boxLabels-item-response
Type:
Show Source
object
-
AnalyticBoxLabelId: integer
(int64)
Unique identifier for the box label.
-
BoxcellBackgroundColor: string
Maximum Length:
2000
Background color for the box of the box chart. -
BoxLabel: string
Maximum Length:
400
Label 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 cell labels will be used.
-
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the box cell label. -
CreationDate: string
(date-time)
Read Only:
true
Date the box cell label was created. -
DisplaySequence: integer
Display sequence for the box cell label.
-
LastUpdateDate: string
(date-time)
Read Only:
true
Date the box cell label was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who last updated the box cell label. -
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.
Nested 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
Links
- boxLabels
-
Parameters:
- analyticTypesUniqID:
$request.path.analyticTypesUniqID
- talentReviewMeetingTemplatesUniqID:
$request.path.talentReviewMeetingTemplatesUniqID
The boxLabels resource is a child of the analyticTypes resource and provides all the labels for the boxes of the box chart matrix. - analyticTypesUniqID:
- boxRatings
-
Parameters:
- analyticTypesUniqID:
$request.path.analyticTypesUniqID
- talentReviewMeetingTemplatesUniqID:
$request.path.talentReviewMeetingTemplatesUniqID
The boxRatings resource is a child of the analyticTypes resource and provides all the ratings associated with the box chart matrix. - analyticTypesUniqID: