Get an education level section
get
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/educationLvlSections/{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=
-
talentPersonProfilesUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Talent Person Profiles resource and used to uniquely identify an instance of Talent Person Profiles. The client should not generate the hash key value. Instead, the client should query on the Talent Person Profiles collection resource in order to navigate to a specific instance of Talent Person Profiles 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 : talentPersonProfiles-educationLvlSections-item-response
Type:
Show Source
object
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
User who created the content section. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date and time when the content section was created. -
educationLvlItems: array
Education Level Items
Title:
Education Level Items
The educationLvlItems resource is the child of the educationLvlSections resource. It provides the list of education level items within an education level section for a person. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
Date and time when the content section was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
User who last updated the content 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 content section associated with the profile. -
SectionContext: string
Title:
Section Context
Maximum Length:300
Code of the content section. Valid values are defined in the profileTypeSectionsLOV. -
SectionId: integer
(int64)
Title:
Section ID
Unique identifier of the content section. -
SectionName: string
Title:
Section Name
Read Only:true
Maximum Length:240
Name of the section. Valid values are defined in the profileTypeSectionsLOV.
Nested Schema : Education Level Items
Type:
array
Title:
Education Level Items
The educationLvlItems resource is the child of the educationLvlSections resource. It provides the list of education level items within an education level section for a person.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : talentPersonProfiles-educationLvlSections-educationLvlItems-item-response
Type:
Show Source
object
-
AverageGrade: string
Title:
Average Grade
Maximum Length:240
Average grade achieved for the education level item. -
AwardingBody: string
Title:
Awarding Body
Maximum Length:240
Awarding body for the education level. -
Comments: string
(byte)
Title:
Comments
Comments on the education level. -
ContentItemId: integer
(int64)
Title:
Education Level
Unique identifier for the content item. -
Country: string
Title:
Country Code
Maximum Length:30
Country where education level is received. Valid values are defined in the HcmCountriesLOV. -
CountryMeaning: string
Title:
Territory Name
Read Only:true
Maximum Length:80
Country of the education level items. -
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the content item. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the content item was created. -
EducationalEstablishmentId: integer
(int64)
Title:
School
Name of the educational establishment. Valid values are defined in the contentItemsLOV. -
EducationLevel: string
Title:
Education Level
Education level of a person. -
EducationLevelCompleted: string
Title:
Completed
Maximum Length:30
Indicates whether the education level is completed. Valid values are Y and N. Valid values are defined in the commonLookupsLOV. -
EducationLevelId: integer
(int64)
Surrogate identifier for the person education level.
-
educationLvlItemsDFF: array
educationLvlItemsDFF
-
Establishment: string
Title:
School
Name of the educational establishment. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
Date and time when the content item was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who last updated the content item. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OtherEstablishment: string
Title:
School Name
Maximum Length:2000
Name of the other educational establishment. -
ProfileId: integer
(int64)
Unique identifier of the person profile.
-
ProjectedCompletionDate: string
(date)
Title:
Projected Completion Date
Date on which the education level item is projected to be complete. -
SectionId: integer
(int64)
Unique identifier of the profile content section.
-
Source: string
Title:
Source
Read Only:true
Maximum Length:255
Default Value:Talent Profile
Source of the educationLevel item. -
State: string
Title:
State Code
Maximum Length:360
State of the education level item. -
Title: string
Title:
Title
Maximum Length:240
Title of the education level.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : talentPersonProfiles-educationLvlSections-educationLvlItems-educationLvlItemsDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:80
-
__FLEX_Context_DisplayValue: string
Title:
Context Value
-
EducationLevelId: 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 : 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.
Links
- educationLvlItems
-
Parameters:
- ProfileSectionId6:
$request.path.ProfileSectionId6
- talentPersonProfilesUniqID:
$request.path.talentPersonProfilesUniqID
The educationLvlItems resource is the child of the educationLvlSections resource. It provides the list of education level items within an education level section for a person. - ProfileSectionId6:
- sectionContextLOV
-
The following properties are defined on the LOV link relation:
- Source Attribute: SectionContext; Target Attribute: SectionContext
- Display Attribute: SectionContext, Name