Create an area of study item
post
/hcmRestApi/resources/11.13.18.05/talentPersonProfiles/{talentPersonProfilesUniqID}/child/areaOfStudySections/{ProfileSectionId}/child/areaOfStudyItems
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.
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.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
AreaOfStudy: string
Title:
Area of Study
Maximum Length:240
Area of Study of a person. -
AreaOfStudyId: integer
(int64)
Surrogate identifier for the person area of study.
-
areaOfStudyItemsDFF: array
areaOfStudyItemsDFF
-
AverageGrade: string
Title:
Grade
Maximum Length:240
Average grade achieved for the area of study item. -
DateAcquired: string
(date)
Title:
Date Acquired
Date on which the area of study item was acquired. -
ProfileId(required): integer
(int64)
Unique identifier of the person profile.
-
SectionId: integer
(int64)
Unique identifier of the profile content section.
Nested Schema : talentPersonProfiles-areaOfStudySections-areaOfStudyItems-areaOfStudyItemsDFF-item-post-request
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:80
-
__FLEX_Context_DisplayValue: string
Title:
Context Value
-
AreaOfStudyId: integer
(int64)
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 : talentPersonProfiles-areaOfStudySections-areaOfStudyItems-item-response
Type:
Show Source
object
-
AreaOfStudy: string
Title:
Area of Study
Maximum Length:240
Area of Study of a person. -
AreaOfStudyId: integer
(int64)
Surrogate identifier for the person area of study.
-
areaOfStudyItemsDFF: array
areaOfStudyItemsDFF
-
AverageGrade: string
Title:
Grade
Maximum Length:240
Average grade achieved for the area of study item. -
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the area of study item. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the area of study item was created. -
DateAcquired: string
(date)
Title:
Date Acquired
Date on which the area of study item was acquired. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
Date and time when the area of study item was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who last updated the area of study item. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ProfileId: integer
(int64)
Unique identifier of the person profile.
-
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 areaOfStudy item.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : talentPersonProfiles-areaOfStudySections-areaOfStudyItems-areaOfStudyItemsDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Value
Maximum Length:80
-
__FLEX_Context_DisplayValue: string
Title:
Context Value
-
AreaOfStudyId: 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
- areaOfStudyItemsDFF
-
Parameters:
- AreaOfStudyId:
$request.path.AreaOfStudyId
- ProfileSectionId2:
$request.path.ProfileSectionId2
- talentPersonProfilesUniqID:
$request.path.talentPersonProfilesUniqID
- AreaOfStudyId: