Get a talent review meeting template
get
/hcmRestApi/resources/11.13.18.05/talentReviewMeetingTemplates/{talentReviewMeetingTemplatesUniqID}
Request
Path Parameters
-
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>
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields 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 fields 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 fields. 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 fields. Only the specified fields are returned, which means that if no fields are specified, no fields 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 fields. 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 -
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
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.
There's no request body for this operation.
Back to TopResponse
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-item-response
Type:
Show Source
object
-
analyticTypes: array
Analytic Types
Title:
Analytic Types
The analyticTypes resource is a child of the talentReviewMeetingTemplates resource and provides all the analytic options that can be added for the box chart matrix. -
BusinessGroupId: integer
(int64)
Title:
Business Group
Unique identifier for the business group for which the talent review meeting template will be used. -
ColorJobroleAssgn: string
Title:
Job
Maximum Length:30
Default Value:N
Color code for job role assignment. -
ColorLocation: string
Title:
Location
Maximum Length:30
Default Value:N
Color code for location. -
ColorOrgHierarchy: string
Title:
Manager
Maximum Length:30
Default Value:N
Color code for organization hierarchy. -
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the talent review meeting template. -
CreatedByPersonName: string
Read Only:
true
Maximum Length:255
Name of the person who created the talent review meeting template. -
CreateGoalsFlag: boolean
Title:
Add Goal
Maximum Length:30
Default Value:false
Indicates if goals can be added to members of the review population. -
CreationDate: string
(date-time)
Read Only:
true
Date the talent review meeting template was created. -
DashboardTemplateId: integer
(int64)
Unique identifier for the talent review meeting template.
-
dashboardTemplatesDFF: array
dashboardTemplatesDFF
-
DisplayAge: string
Title:
Age
Maximum Length:30
Default Value:N
Indicates if age of the member of the review population needs to be shown. -
DisplayComments: string
Title:
Notes
Maximum Length:30
Default Value:N
Indicates if comments needs to be shown. -
DisplayEthnicity: string
Title:
Ethnicity
Maximum Length:30
Default Value:N
Indicates if ethnicity of the member of the review population needs to be shown. -
DisplayGender: string
Title:
Gender
Maximum Length:30
Default Value:N
Indicates if gender of the member of the review population needs to be shown. -
DisplayImpactOfLoss: string
Title:
Impact of Loss
Maximum Length:30
Default Value:N
Indicates if impact of loss rating needs to available during the talent review. -
DisplayMobility: string
Title:
Mobility
Maximum Length:30
Default Value:N
Indicates if mobility rating needs to available during the talent review. -
displayOptionPreferences: array
Display Option Preferences
Title:
Display Option Preferences
The displayOptionPreferences resource is a child of the talentReviewMeetingTemplates resource and provides all the display option preferences that are configured in the template. -
DisplayReligiousAffltn: string
Title:
Religion
Maximum Length:30
Default Value:N
Indicates if religious affiliation of the member of the review population needs to be shown. -
DisplayRiskOfLoss: string
Title:
Risk of Loss
Maximum Length:30
Default Value:N
Indicates if risk of loss rating needs to available during the talent review. -
FilterBusinessunit: string
Title:
Business Unit
Maximum Length:30
Indicates if the review population can be filtered by their business unit. -
FilterCompetency: string
Title:
Competency
Maximum Length:30
Default Value:N
Indicates if the review population can be filtered by their competency. -
FilterDepartment: string
Title:
Department
Maximum Length:30
Indicates if the review population can be filtered by their department. -
FilterJobFamily: string
Title:
Job Family
Maximum Length:30
Default Value:N
Indicates if the review population can be filtered by their job family. -
FilterJobFunction: string
Title:
Job Function
Maximum Length:30
Default Value:N
Indicates if the review population can be filtered by their job function. -
FilterJobgrade: string
Title:
Grade
Maximum Length:30
Default Value:N
Indicates if the review population can be filtered by their job grade. -
FilterJobroleAssgn: string
Title:
Job
Maximum Length:30
Default Value:N
Indicates if the review population can be filtered by their job role assignment. -
FilterLevel: string
Title:
Subordinate Level
Maximum Length:30
Default Value:N
Indicates if the review population can be filtered by the subordinate level. -
FilterLocation: string
Title:
Location
Maximum Length:30
Default Value:N
Indicates if the review population can be filtered by their location. -
FilterMgmtLevel: string
Title:
Management Level
Maximum Length:30
Default Value:N
Indicates if the review population can be filtered by the management level. -
FilterOrgHierarchy: string
Title:
Manager
Maximum Length:30
Default Value:N
Indicates if the review population can be filtered by the organization hierarchy. -
FilterProficiency: string
Title:
Proficiency
Maximum Length:30
Default Value:N
Indicates if the review population can be filtered by their proficiency. -
FilterReviewersNParticipants: string
Title:
Reviewers and Participants
Maximum Length:30
Default Value:N
Indicates if all the direct and indirect reports of the reviewers and participants who are members of the review population need to be shown. -
FilterSuccessionPlan: string
Maximum Length:
30
Default Value:N
Indicates if succession plan filter can be displayed in the template. -
FilterTalentPool: string
Maximum Length:
30
Default Value:N
Indicates if talent pool filter can be displayed in the template. -
IncludeMatrixMgmt: string
Title:
Include matrix managers as reviewers
Maximum Length:20
Indicates if matrix managers can be added as reviewers for the talent review meeting. -
IncludeSuccessionPlans: string
Title:
Succession plan details
Maximum Length:30
Default Value:N
Indicates if succession plans can be added to the talent review meeting. -
IncludeTalentPools: string
Title:
Include talent pools
Maximum Length:30
Indicates if talent pools can be added to the talent review meeting. -
InUse: string
Read Only:
true
Maximum Length:255
Indicates if the talent review meeting template has been used to configure talent review meetings. -
IolDsplyOptnPreference: string
Title:
Preferred Display Option
Maximum Length:30
Display option preference for the Impact of Loss rating. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date the talent review meeting template was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who last updated the talent review meeting template. -
LastUpdatedByPersonName: string
Read Only:
true
Maximum Length:255
Name of the person who last updated the talent review meeting template. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MaximumMarkersAllowed: integer
(int32)
Title:
Maximum Records Allowed
Default Value:500
Maximum number of members for the talent review meeting. -
metricConfigs: array
Metric Configurations
Title:
Metric Configurations
The metricConfigs resource provides all the ratings that are included in the Talent Review template. -
MobilityDsplyOptnPreference: string
Title:
Preferred Display Option
Maximum Length:30
Display option preference for the Mobility rating. -
Name: string
Title:
Template Name
Maximum Length:240
Name of the talent review meeting template. -
OwnerId: integer
(int64)
Title:
Owner
Unique identifier for the owner of the talent review meeting template. -
OwnerName: string
Title:
Name
Read Only:true
Maximum Length:240
Name of the owner of the talent review meeting template. -
PopulationSizeForESS: integer
(int32)
Title:
Submission Process Threshold
The submission process threshold controls the scheduling of a process used to update ratings in employee profiles. -
QuestionnaireId: integer
(int64)
Unique identifier for the potential assessment questionnaire associated with the talent review meeting template.
-
RolDsplyOptnPreference: string
Title:
Preferred Display Option
Maximum Length:30
Display option preference for the Risk of Loss rating. -
TemplateStatusCode: string
Title:
Status
Maximum Length:30
Code that indicates the status of the talent review meeting template. -
TemplateStatusMeaning: string
Title:
Meaning
Read Only:true
Maximum Length:80
Status of the talent review meeting template. -
UseCompareFlag: boolean
Title:
Enable Compare
Maximum Length:30
Default Value:false
Indicates if participants can compare a member of the review population with other members or a job profile. -
UseHoldingAreaFlag: boolean
Title:
Enable Holding Area
Maximum Length:30
Default Value:false
Indicates if the holding area that shows members without ratings at the start of the meeting is displayed or not. -
UseNotesFlag: boolean
Title:
Add Notes
Maximum Length:30
Default Value:false
Indicates if facilitators and managers can add notes about the meeting or for any person in the review population. -
UseOrgchartFlag: boolean
Title:
Enable Organization Chart
Maximum Length:30
Default Value:false
Indicates if participants can view the organization chart of the organization being reviewed. -
UsePotAssessFlag: boolean
Title:
Enable Potential Assessment
Maximum Length:30
Default Value:false
Indicates if reviewers can answer potential assessment questions on the Prepare Review Content page. -
UseTasksFlag: boolean
Title:
Add Task
Maximum Length:30
Default Value:false
Indicates if facilitators and managers can add tasks for any person in the review population.
Nested Schema : Analytic Types
Type:
array
Title:
Analytic Types
The analyticTypes resource is a child of the talentReviewMeetingTemplates resource and provides all the analytic options that can be added for the box chart matrix.
Show Source
Nested Schema : Display Option Preferences
Type:
array
Title:
Display Option Preferences
The displayOptionPreferences resource is a child of the talentReviewMeetingTemplates resource and provides all the display option preferences that are configured in the template.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Metric Configurations
Type:
array
Title:
Metric Configurations
The metricConfigs resource provides all the ratings that are included in the Talent Review template.
Show Source
Nested 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
Nested Schema : talentReviewMeetingTemplates-dashboardTemplatesDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:30
-
__FLEX_Context_DisplayValue: string
Title:
Context Value
-
BusinessGroupId: integer
(int64)
Title:
Business Group
-
DashboardTemplateId: integer
(int64)
-
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 : 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 : talentReviewMeetingTemplates-metricConfigs-item-response
Type:
Show Source
object
-
ContentSectionName: string
Read Only:
true
Maximum Length:240
Display content section name. -
ContentTypeId: integer
(int64)
Unique identifier for the profile content type.
-
CreatedBy: string
Read Only:
true
Maximum Length:64
User who added the rating to the talent review meeting template. -
CreationDate: string
(date-time)
Read Only:
true
Date the rating was added to the talent review meeting template. -
DashboardColumnName: string
Maximum Length:
32
Talent review meeting dashboard column name corresponding to a particular rating. -
Label: string
Title:
Display Label
Maximum Length:240
Display label for the rating added to the talent review meeting template. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date the rating added to the talent review meeting template was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who last updated the rating added to the talent review meeting template. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MetricCode: string
Maximum Length:
240
Code for the rating added to the talent review meeting template. -
MetricId: integer
(int64)
Unique identifier for the rating added to the talent review meeting template.
-
RatingModel: string
Title:
Rating Model
Read Only:true
Maximum Length:240
Display rating model name. -
RatingModelId: integer
(int64)
Unique identifier for the rating model used for the rating included in the talent review meeting template.
-
RatingName: string
Read Only:
true
Maximum Length:255
Display rating name. -
ReadOnlyFlag: boolean
Maximum Length:
30
Indicates whether the rating can be edited or not. -
SectionId: integer
(int64)
Unique identifier for the content section of the rating.
-
UseAsAxisFlag: boolean
Title:
Use to Rate Review Population
Maximum Length:30
Indicates if the rating is used to rate the review population.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- analyticTypes
-
Parameters:
- talentReviewMeetingTemplatesUniqID:
$request.path.talentReviewMeetingTemplatesUniqID
The analyticTypes resource is a child of the talentReviewMeetingTemplates resource and provides all the analytic options that can be added for the box chart matrix. - talentReviewMeetingTemplatesUniqID:
- dashboardTemplatesDFF
-
Parameters:
- talentReviewMeetingTemplatesUniqID:
$request.path.talentReviewMeetingTemplatesUniqID
- talentReviewMeetingTemplatesUniqID:
- displayOptionPreferences
-
Parameters:
- talentReviewMeetingTemplatesUniqID:
$request.path.talentReviewMeetingTemplatesUniqID
The displayOptionPreferences resource is a child of the talentReviewMeetingTemplates resource and provides all the display option preferences that are configured in the template. - talentReviewMeetingTemplatesUniqID:
- metricConfigs
-
Parameters:
- talentReviewMeetingTemplatesUniqID:
$request.path.talentReviewMeetingTemplatesUniqID
The metricConfigs resource provides all the ratings that are included in the Talent Review template. - talentReviewMeetingTemplatesUniqID: