Update a candidate education
patch
/hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/education/{EducationId}
Request
Path Parameters
-
CandidateNumber(required): string
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=
-
EducationId(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=
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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
AcademicStanding: string
Title:
Academic Standing
Maximum Length:30
Academic standing in recruiting candidate education. -
ActivitySummary: string
(byte)
Title:
Summary of Activities
Activity summary in recruiting candidate education. -
AreaOfStudy: string
Title:
Area of Study
Maximum Length:240
Area of study in recruiting candidate education. -
AverageGrade: string
Title:
Average Grade
Maximum Length:240
Average grade in recruiting candidate education. -
AwardingBody: string
Title:
Awarding Body
Maximum Length:240
Awarding body in recruiting candidate education. -
City: string
Title:
City
Maximum Length:240
City in recruiting candidate education. -
Comments: string
(byte)
Title:
Comments
Comments in recruiting candidate education. -
CompletedAmount: integer
(int64)
Title:
Completed Amount
Completed amount in recruiting candidate education. -
CompletedTraningUnits: string
Title:
Training Completed Units
Maximum Length:240
Completed training units in recruiting candidate education. -
ContentItemId: integer
(int64)
Title:
Degree
Content item ID in recruiting candidate education. -
CountryCode: string
Title:
Country
Maximum Length:30
Country code number in recruiting candidate education. -
CountryId: integer
(int64)
Title:
Country
Country ID in recruiting candidate education. -
DateAcquired: string
(date)
Title:
Date Acquired
Date acquired in recruiting candidate education. -
DegreeName: string
Title:
Degree
Maximum Length:240
Degree name in recruiting candidate education. -
Department: string
Title:
Faculty or Department
Maximum Length:240
Department in recruiting candidate education. -
Description: string
(byte)
Title:
Description
Description in recruiting candidate education. -
Duration: string
Title:
Duration
Maximum Length:240
Duration in recruiting candidate education. -
DurationUnits: string
Title:
Duration Units
Maximum Length:30
Duration units in recruiting candidate education. -
EducationalEstablishment: string
Title:
School Name
Maximum Length:2000
Education establishment in recruiting candidate education. -
EducationalEstablishmentId: integer
(int64)
Title:
School
Education establishment ID in recruiting candidate education. -
EducationLevel: string
Title:
Education Level
Maximum Length:30
Education level in recruiting candidate education. -
EducationURL: string
Title:
Education URL
Maximum Length:2000
Education URL in recruiting candidate education. -
Educator: string
Title:
Educator
Maximum Length:240
Educator in recruiting candidate education. -
EduLevelCompletedFlag: boolean
Title:
Education Level Completed
Maximum Length:30
Education level completed indicator in recruiting candidate education. -
EndDate: string
(date)
Title:
End Date
End date in recruiting candidate education. -
Fee: integer
(int64)
Title:
Fee
Fee in recruiting candidate education. -
FeeCurrency: string
Title:
Fee Currency
Maximum Length:30
Fee currency in recruiting candidate education. -
GPA: number
Title:
GPA
GPA in recruiting candidate education. -
GraduatedFlag: boolean
Title:
Graduated
Maximum Length:30
Graduated indicator in recruiting candidate education. -
HighestEduLevel: string
Title:
Highest Education Level
Maximum Length:30
Highest education level in recruiting candidate education. -
Major: string
Title:
Major
Maximum Length:240
Major in recruiting candidate education. -
Minor: string
Title:
Minor
Maximum Length:240
Minor in recruiting candidate education. -
PartTimeFlag: boolean
Title:
Part Time
Maximum Length:30
Part time indicator in recruiting candidate education. -
ProjectedCompletionDate: string
(date)
Title:
Projected Completion Date
Projected completion in recruiting candidate education. -
Reimbursements: string
(byte)
Title:
Reimbursement Arrangements
Reimbursements in recruiting candidate education. -
RequiredFlag: boolean
Title:
Required
Maximum Length:30
Required indicator in recruiting candidate education. -
SectionId: integer
(int64)
Section ID in recruiting candidate education.
-
StartDate: string
(date)
Title:
Start Date
Start date in recruiting candidate education. -
StateProvinceCode: string
Title:
State
Maximum Length:360
State province code in recruiting candidate education. -
StateProvinceId: integer
(int64)
Title:
State
State province ID in recruiting candidate education. -
Status: string
Title:
Status
Maximum Length:30
Status in recruiting candidate education. -
Title: string
Title:
Title
Maximum Length:240
Title in recruiting candidate education. -
TotalAmount: integer
(int64)
Title:
Total Amount
Total amount in recruiting candidate education. -
TrmnlDegDiscpFlag: boolean
Title:
Terminal Degree for Discipline
Maximum Length:30
Terminal degree discipline indicator indicating the last degree obtained in recruiting candidate education. -
TuitionMethod: string
Title:
Tuition Method
Maximum Length:30
Tuition method in recruiting candidate education. -
YearAcquired: integer
(int64)
Title:
Year Acquired
Year acquired in recruiting candidate education.
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 : recruitingCandidates-education-item-response
Type:
Show Source
object
-
AcademicStanding: string
Title:
Academic Standing
Maximum Length:30
Academic standing in recruiting candidate education. -
ActivitySummary: string
(byte)
Title:
Summary of Activities
Activity summary in recruiting candidate education. -
AreaOfStudy: string
Title:
Area of Study
Maximum Length:240
Area of study in recruiting candidate education. -
AverageGrade: string
Title:
Average Grade
Maximum Length:240
Average grade in recruiting candidate education. -
AwardingBody: string
Title:
Awarding Body
Maximum Length:240
Awarding body in recruiting candidate education. -
City: string
Title:
City
Maximum Length:240
City in recruiting candidate education. -
Comments: string
(byte)
Title:
Comments
Comments in recruiting candidate education. -
CompletedAmount: integer
(int64)
Title:
Completed Amount
Completed amount in recruiting candidate education. -
CompletedTraningUnits: string
Title:
Training Completed Units
Maximum Length:240
Completed training units in recruiting candidate education. -
ContentItemId: integer
(int64)
Title:
Degree
Content item ID in recruiting candidate education. -
CountryCode: string
Title:
Country
Maximum Length:30
Country code number in recruiting candidate education. -
CountryId: integer
(int64)
Title:
Country
Country ID in recruiting candidate education. -
DateAcquired: string
(date)
Title:
Date Acquired
Date acquired in recruiting candidate education. -
DegreeName: string
Title:
Degree
Maximum Length:240
Degree name in recruiting candidate education. -
Department: string
Title:
Faculty or Department
Maximum Length:240
Department in recruiting candidate education. -
Description: string
(byte)
Title:
Description
Description in recruiting candidate education. -
Duration: string
Title:
Duration
Maximum Length:240
Duration in recruiting candidate education. -
DurationUnits: string
Title:
Duration Units
Maximum Length:30
Duration units in recruiting candidate education. -
EducationalEstablishment: string
Title:
School Name
Maximum Length:2000
Education establishment in recruiting candidate education. -
EducationalEstablishmentId: integer
(int64)
Title:
School
Education establishment ID in recruiting candidate education. -
EducationId: integer
(int64)
Education ID in recruiting candidate education.
-
EducationLevel: string
Title:
Education Level
Maximum Length:30
Education level in recruiting candidate education. -
EducationURL: string
Title:
Education URL
Maximum Length:2000
Education URL in recruiting candidate education. -
Educator: string
Title:
Educator
Maximum Length:240
Educator in recruiting candidate education. -
EduLevelCompletedFlag: boolean
Title:
Education Level Completed
Maximum Length:30
Education level completed indicator in recruiting candidate education. -
EndDate: string
(date)
Title:
End Date
End date in recruiting candidate education. -
Fee: integer
(int64)
Title:
Fee
Fee in recruiting candidate education. -
FeeCurrency: string
Title:
Fee Currency
Maximum Length:30
Fee currency in recruiting candidate education. -
GPA: number
Title:
GPA
GPA in recruiting candidate education. -
GraduatedFlag: boolean
Title:
Graduated
Maximum Length:30
Graduated indicator in recruiting candidate education. -
HighestEduLevel: string
Title:
Highest Education Level
Maximum Length:30
Highest education level in recruiting candidate education. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Major: string
Title:
Major
Maximum Length:240
Major in recruiting candidate education. -
Minor: string
Title:
Minor
Maximum Length:240
Minor in recruiting candidate education. -
PartTimeFlag: boolean
Title:
Part Time
Maximum Length:30
Part time indicator in recruiting candidate education. -
ProjectedCompletionDate: string
(date)
Title:
Projected Completion Date
Projected completion in recruiting candidate education. -
Reimbursements: string
(byte)
Title:
Reimbursement Arrangements
Reimbursements in recruiting candidate education. -
RequiredFlag: boolean
Title:
Required
Maximum Length:30
Required indicator in recruiting candidate education. -
SectionId: integer
(int64)
Section ID in recruiting candidate education.
-
StartDate: string
(date)
Title:
Start Date
Start date in recruiting candidate education. -
StateProvinceCode: string
Title:
State
Maximum Length:360
State province code in recruiting candidate education. -
StateProvinceId: integer
(int64)
Title:
State
State province ID in recruiting candidate education. -
Status: string
Title:
Status
Maximum Length:30
Status in recruiting candidate education. -
Title: string
Title:
Title
Maximum Length:240
Title in recruiting candidate education. -
TotalAmount: integer
(int64)
Title:
Total Amount
Total amount in recruiting candidate education. -
TrmnlDegDiscpFlag: boolean
Title:
Terminal Degree for Discipline
Maximum Length:30
Terminal degree discipline indicator indicating the last degree obtained in recruiting candidate education. -
TuitionMethod: string
Title:
Tuition Method
Maximum Length:30
Tuition method in recruiting candidate education. -
YearAcquired: integer
(int64)
Title:
Year Acquired
Year acquired in recruiting candidate education.
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.
Examples
The following example shows how to update an educational detail for a candidate by submitting a PATCH request on the REST resource using cURL.
curl -i -u "<username>:<password>" -H "Content-Type: application/json" -X PATCH -d <payload> http://host:port/hcmCoreApi/resources/11.13.18.05/recruitingCandidates/187477/child/education/300100176567878
Example of Payload
The following is an example of the payload.
{ "AreaOfStudy": "Engineering & Technology", "AverageGrade": "A+" }
Example of Response Header
The following is an example of the response header.
HTTP/1.1 200 OK Content-Type : application/vnd.oracle.adf.resourceitem+json
Example of Response Body
The following example shows the contents of the response body in JSON format.
{ "EducationId": 300100176567878, "AcademicStanding": "Excellent", "AreaOfStudy": "Engineering & Technology", "AverageGrade": "A+", "AwardingBody": "University of California", "City": "Redwood city", "CompletedTraningUnits": "55", "CompletedAmount": 99, "ContentItemId": 52892, "CountryId": 89, "DateAcquired": "2000-01-01", "DegreeName": "Degree", "Department": "Engineering and Technology", "Duration": "48 months", "DurationUnits": "48 months", "EduLevelCompletedFlag": false, "EducationLevel": "Top", "EducationURL": "https://www.oracle.com/index.html", "EducationalEstablishment": "My university", "EducationalEstablishmentId": 34543, "Educator": "Professor", "EndDate": "2004-04-04", "Fee": 200000, "FeeCurrency": "once", "GPA": 5, "GraduatedFlag": true, "HighestEduLevel": "top", "Major": "Science", "Minor": "Management", "PartTimeFlag": false, "ProjectedCompletionDate": "2004-02-02", "RequiredFlag": true, "SectionId": 45, "StartDate": "2005-05-05", "StateProvinceId": 12, "Status": "33", "Title": "Somewhere High School - #1", "TotalAmount": 35, "TrmnlDegDiscpFlag": true, "TuitionMethod": "Scholarsip", "YearAcquired": 2004, "links": [ {...} ] }