Get a custom talent rating section for a profile
get
/hcmRestApi/resources/11.13.18.05/talentRatings/{talentRatingsUniqID}/child/userDefinedRatingSections/{ProfileSectionId}
Request
Path Parameters
-
ProfileSectionId(required): integer(int64)
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
-
talentRatingsUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Talent Ratings resource and used to uniquely identify an instance of Talent Ratings. The client should not generate the hash key value. Instead, the client should query on the Talent Ratings collection resource in order to navigate to a specific instance of Talent Ratings to get the hash key.
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 : talentRatings-userDefinedRatingSections-item-response
Type:
Show Source
object
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
User who created the user-defined talent rating section. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date and time when the user-defined talent rating section was created. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
Date and time when the user-defined talent rating section was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
User who last updated the user-defined talent rating section. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ProfileSectionId: integer
(int64)
Title:
Profile Section ID
Unique identifier of the user-defined talent rating section associated with the person profile. -
RatingModelCode: string
Title:
Rating Model Code
Read Only:true
Maximum Length:30
Code representing rating model associated with the user-defined talent rating section. -
RatingModelId: integer
(int64)
Title:
Rating Model ID
Read Only:true
Unique identifier of the rating model associated with the user-defined talent rating section. -
RatingModelName: string
Title:
Name
Read Only:true
Maximum Length:240
Name of the rating model associated with the user-defined talent rating section. -
SectionContext: string
Title:
Section Context
Maximum Length:300
Code representing the user-defined talent rating section. Valid values are defined in the profileTypeSectionsLOV. -
SectionId: integer
(int64)
Title:
Section ID
Unique identifier of the user-defined talent rating section. -
SectionName: string
Title:
Section Name
Read Only:true
Maximum Length:240
Name of the user-defined talent rating section. -
userDefinedRatings: array
User Defined Ratings
Title:
User Defined Ratings
The userDefinedRatings resource is the child of the talentRatings resource. It provides the list of talent rating items within the user-defined rating sections.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : User Defined Ratings
Type:
array
Title:
User Defined Ratings
The userDefinedRatings resource is the child of the talentRatings resource. It provides the list of talent rating items within the user-defined rating sections.
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 : talentRatings-userDefinedRatingSections-userDefinedRatings-item-response
Type:
Show Source
object
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
User who created the user-defined talent rating item. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date and time when the user-defined talent rating item was created. -
Description: string
(byte)
Title:
Comments
Description of the user-defined talent rating item. -
FromDate: string
(date)
Title:
From Date
Read Only:true
Date and time when the user-defined talent rating item becomes valid. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
Date and time when the user-defined talent rating item was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
User who last updated the user-defined talent rating item. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Name: string
Title:
Name
Read Only:true
Maximum Length:2000
Name of the user-defined talent rating item. -
NumericRating: number
Title:
Numeric Rating
Read Only:true
Numeric value of the rating level associated with the user-defined talent rating item. -
RatingId: integer
(int64)
Title:
Rating ID
Unique identifier of the user-defined talent rating item. -
RatingLevel: string
Title:
Name
Read Only:true
Maximum Length:2000
Name of the rating level associated with the custom talent rating item. -
RatingLevelCode: string
Title:
Rating Level Code
Maximum Length:30
Code representing rating level associated with the user-defined talent rating item. -
RatingLevelId: integer
(int64)
Title:
Rating Level ID
Unique identifier of the rating level associated with the user-defined talent rating item. -
RatingModelId: integer
(int64)
Title:
Talent Rating Model
Read Only:true
Unique identifier of the rating model associated with the user-defined talent rating item. -
Source: string
Title:
Source
Maximum Length:30
Indicates whether the source of the performance rating item is profile, talent review, or talent review meeting. Valid values are CUSTOMPROFILE, CUSTOMTR, or CUSTOMTRMP. -
SourceDescription: string
Title:
Source
Read Only:true
Maximum Length:4000
Source of the user-defined talent rating item. -
SourceKey: integer
(int64)
Read Only:
true
Unique identifier of the source where the custom talent rating item is used. -
SourceType: string
Maximum Length:
30
Code associated with source type of the user-defined talent rating item. -
SubmittedBy: string
Read Only:
true
Maximum Length:255
User who submitted the user-defined talent rating item. -
ToDate: string
(date)
Title:
End Date
Read Only:true
Date and time until which the user-defined talent rating item is valid.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- sectionContextLOV
-
The following properties are defined on the LOV link relation:
- Source Attribute: SectionContext; Target Attribute: SectionContext
- Display Attribute: SectionContext, SectionId
- userDefinedRatings
-
Parameters:
- ProfileSectionId:
$request.path.ProfileSectionId
- talentRatingsUniqID:
$request.path.talentRatingsUniqID
The userDefinedRatings resource is the child of the talentRatings resource. It provides the list of talent rating items within the user-defined rating sections. - ProfileSectionId: