Get all talent review meeting templates

get

/hcmRestApi/resources/11.13.18.05/talentReviewMeetingTemplates

Request

Query Parameters
  • 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).
  • 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
  • Used as a predefined finder to search the collection.

    Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    The following are the available finder names and corresponding finder variables

    • PrimaryKey Finds a talent review meeting template that matches the primary key criteria specified.
      Finder Variables
      • BusinessGroupId; integer; Unique identifier for the business group for which the talent review meeting template will be used.
      • DashboardTemplateId; integer; Unique identifier for the talent review meeting template.
  • This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
  • 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
  • Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
  • This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY

    Format: ?q=expression1;expression2

    You can use these queryable attributes to filter this collection resource using the q query parameter:
    • BusinessGroupId; integer; Unique identifier for the business group for which the talent review meeting template will be used.
    • ColorJobroleAssgn; string; Color code for job role assignment.
    • ColorLocation; string; Color code for location.
    • ColorOrgHierarchy; string; Color code for organization hierarchy.
    • CreateGoalsFlag; boolean; Indicates if goals can be added to members of the review population.
    • CreatedBy; string; User who created the talent review meeting template.
    • CreationDate; string; Date the talent review meeting template was created.
    • DashboardTemplateId; integer; Unique identifier for the talent review meeting template.
    • DisplayAge; string; Indicates if age of the member of the review population needs to be shown.
    • DisplayComments; string; Indicates if comments needs to be shown.
    • DisplayEthnicity; string; Indicates if ethnicity of the member of the review population needs to be shown.
    • DisplayGender; string; Indicates if gender of the member of the review population needs to be shown.
    • DisplayImpactOfLoss; string; Indicates if impact of loss rating needs to available during the talent review.
    • DisplayMobility; string; Indicates if mobility rating needs to available during the talent review.
    • DisplayReligiousAffltn; string; Indicates if religious affiliation of the member of the review population needs to be shown.
    • DisplayRiskOfLoss; string; Indicates if risk of loss rating needs to available during the talent review.
    • FilterBusinessunit; string; Indicates if the review population can be filtered by their business unit.
    • FilterCompetency; string; Indicates if the review population can be filtered by their competency.
    • FilterDepartment; string; Indicates if the review population can be filtered by their department.
    • FilterJobFamily; string; Indicates if the review population can be filtered by their job family.
    • FilterJobFunction; string; Indicates if the review population can be filtered by their job function.
    • FilterJobgrade; string; Indicates if the review population can be filtered by their job grade.
    • FilterJobroleAssgn; string; Indicates if the review population can be filtered by their job role assignment.
    • FilterLevel; string; Indicates if the review population can be filtered by the subordinate level.
    • FilterLocation; string; Indicates if the review population can be filtered by their location.
    • FilterMgmtLevel; string; Indicates if the review population can be filtered by the management level.
    • FilterOrgHierarchy; string; Indicates if the review population can be filtered by the organization hierarchy.
    • FilterProficiency; string; Indicates if the review population can be filtered by their proficiency.
    • FilterReviewersNParticipants; string; 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; Indicates if succession plan filter can be displayed in the template.
    • FilterTalentPool; string; Indicates if talent pool filter can be displayed in the template.
    • IncludeMatrixMgmt; string; Indicates if matrix managers can be added as reviewers for the talent review meeting.
    • IncludeSuccessionPlans; string; Indicates if succession plans can be added to the talent review meeting.
    • IncludeTalentPools; string; Indicates if talent pools can be added to the talent review meeting.
    • IolDsplyOptnPreference; string; Display option preference for the Impact of Loss rating.
    • LastUpdateDate; string; Date the talent review meeting template was last updated.
    • LastUpdatedBy; string; User who last updated the talent review meeting template.
    • MaximumMarkersAllowed; integer; Maximum number of members for the talent review meeting.
    • MobilityDsplyOptnPreference; string; Display option preference for the Mobility rating.
    • Name; string; Name of the talent review meeting template.
    • OwnerId; integer; Unique identifier for the owner of the talent review meeting template.
    • OwnerName; string; Name of the owner of the talent review meeting template.
    • PopulationSizeForESS; integer; The submission process threshold controls the scheduling of a process used to update ratings in employee profiles.
    • QuestionnaireId; integer; Unique identifier for the potential assessment questionnaire associated with the talent review meeting template.
    • RolDsplyOptnPreference; string; Display option preference for the Risk of Loss rating.
    • TemplateStatusCode; string; Code that indicates the status of the talent review meeting template.
    • TemplateStatusMeaning; string; Status of the talent review meeting template.
    • UseCompareFlag; boolean; Indicates if participants can compare a member of the review population with other members or a job profile.
    • UseHoldingAreaFlag; boolean; Indicates if the holding area that shows members without ratings at the start of the meeting is displayed or not.
    • UseNotesFlag; boolean; Indicates if facilitators and managers can add notes about the meeting or for any person in the review population.
    • UseOrgchartFlag; boolean; Indicates if participants can view the organization chart of the organization being reviewed.
    • UsePotAssessFlag; boolean; Indicates if reviewers can answer potential assessment questions on the Prepare Review Content page.
    • UseTasksFlag; boolean; Indicates if facilitators and managers can add tasks for any person in the review population.
  • The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
  • 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".
  • 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 Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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.
Body ()
Root Schema : talentReviewMeetingTemplates
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : talentReviewMeetingTemplates-item-response
Type: object
Show Source
  • 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.
  • Title: Business Group
    Unique identifier for the business group for which the talent review meeting template will be used.
  • Title: Job
    Maximum Length: 30
    Default Value: N
    Color code for job role assignment.
  • Title: Location
    Maximum Length: 30
    Default Value: N
    Color code for location.
  • Title: Manager
    Maximum Length: 30
    Default Value: N
    Color code for organization hierarchy.
  • Read Only: true
    Maximum Length: 64
    User who created the talent review meeting template.
  • Title: Add Goal
    Maximum Length: 30
    Default Value: false
    Indicates if goals can be added to members of the review population.
  • Read Only: true
    Date the talent review meeting template was created.
  • Unique identifier for the talent review meeting template.
  • Title: Age
    Maximum Length: 30
    Default Value: N
    Indicates if age of the member of the review population needs to be shown.
  • Title: Notes
    Maximum Length: 30
    Default Value: N
    Indicates if comments needs to be shown.
  • Title: Ethnicity
    Maximum Length: 30
    Default Value: N
    Indicates if ethnicity of the member of the review population needs to be shown.
  • Title: Gender
    Maximum Length: 30
    Default Value: N
    Indicates if gender of the member of the review population needs to be shown.
  • Title: Impact of Loss
    Maximum Length: 30
    Default Value: N
    Indicates if impact of loss rating needs to available during the talent review.
  • Title: Mobility
    Maximum Length: 30
    Default Value: N
    Indicates if mobility rating needs to available during the talent review.
  • 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.
  • Title: Religion
    Maximum Length: 30
    Default Value: N
    Indicates if religious affiliation of the member of the review population needs to be shown.
  • Title: Risk of Loss
    Maximum Length: 30
    Default Value: N
    Indicates if risk of loss rating needs to available during the talent review.
  • Title: Business Unit
    Maximum Length: 30
    Indicates if the review population can be filtered by their business unit.
  • Title: Competency
    Maximum Length: 30
    Default Value: N
    Indicates if the review population can be filtered by their competency.
  • Title: Department
    Maximum Length: 30
    Indicates if the review population can be filtered by their department.
  • Title: Job Family
    Maximum Length: 30
    Default Value: N
    Indicates if the review population can be filtered by their job family.
  • Title: Job Function
    Maximum Length: 30
    Default Value: N
    Indicates if the review population can be filtered by their job function.
  • Title: Grade
    Maximum Length: 30
    Default Value: N
    Indicates if the review population can be filtered by their job grade.
  • Title: Job
    Maximum Length: 30
    Default Value: N
    Indicates if the review population can be filtered by their job role assignment.
  • Title: Subordinate Level
    Maximum Length: 30
    Default Value: N
    Indicates if the review population can be filtered by the subordinate level.
  • Title: Location
    Maximum Length: 30
    Default Value: N
    Indicates if the review population can be filtered by their location.
  • Title: Management Level
    Maximum Length: 30
    Default Value: N
    Indicates if the review population can be filtered by the management level.
  • Title: Manager
    Maximum Length: 30
    Default Value: N
    Indicates if the review population can be filtered by the organization hierarchy.
  • Title: Proficiency
    Maximum Length: 30
    Default Value: N
    Indicates if the review population can be filtered by their proficiency.
  • 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.
  • Maximum Length: 30
    Default Value: N
    Indicates if succession plan filter can be displayed in the template.
  • Maximum Length: 30
    Default Value: N
    Indicates if talent pool filter can be displayed in the template.
  • Title: Include matrix managers as reviewers
    Maximum Length: 20
    Indicates if matrix managers can be added as reviewers for the talent review meeting.
  • Title: Succession plan details
    Maximum Length: 30
    Default Value: N
    Indicates if succession plans can be added to the talent review meeting.
  • Title: Include talent pools
    Maximum Length: 30
    Indicates if talent pools can be added to the talent review meeting.
  • Read Only: true
    Maximum Length: 255
    Indicates if the talent review meeting template has been used to configure talent review meetings.
  • Title: Preferred Display Option
    Maximum Length: 30
    Display option preference for the Impact of Loss rating.
  • Read Only: true
    Date the talent review meeting template was last updated.
  • Read Only: true
    Maximum Length: 64
    User who last updated the talent review meeting template.
  • Links
  • Title: Maximum Records Allowed
    Default Value: 500
    Maximum number of members for the talent review meeting.
  • Metric Configurations
    Title: Metric Configurations
    The metricConfigs resource provides all the ratings that are included in the Talent Review template.
  • Title: Preferred Display Option
    Maximum Length: 30
    Display option preference for the Mobility rating.
  • Title: Template Name
    Maximum Length: 240
    Name of the talent review meeting template.
  • Title: Owner
    Unique identifier for the owner of the talent review meeting template.
  • Title: Name
    Read Only: true
    Maximum Length: 240
    Name of the owner of the talent review meeting template.
  • The submission process threshold controls the scheduling of a process used to update ratings in employee profiles.
  • Unique identifier for the potential assessment questionnaire associated with the talent review meeting template.
  • Title: Preferred Display Option
    Maximum Length: 30
    Display option preference for the Risk of Loss rating.
  • Title: Status
    Maximum Length: 30
    Code that indicates the status of the talent review meeting template.
  • Title: Meaning
    Read Only: true
    Maximum Length: 80
    Status of the talent review meeting template.
  • 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.
  • 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.
  • 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.
  • Title: Enable Organization Chart
    Maximum Length: 30
    Default Value: false
    Indicates if participants can view the organization chart of the organization being reviewed.
  • Title: Enable Potential Assessment
    Maximum Length: 30
    Default Value: false
    Indicates if reviewers can answer potential assessment questions on the Prepare Review Content page.
  • 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 : 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: object
Show Source
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 : talentReviewMeetingTemplates-analyticTypes-boxLabels-item-response
Type: object
Show Source
Nested Schema : talentReviewMeetingTemplates-analyticTypes-boxRatings-item-response
Type: object
Show Source
Nested Schema : talentReviewMeetingTemplates-displayOptionPreferences-item-response
Type: object
Show Source
Nested Schema : talentReviewMeetingTemplates-metricConfigs-item-response
Type: object
Show Source
Back to Top