Update a candidate work experience
patch
/hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/experience/{PreviousEmploymentId}
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=
-
PreviousEmploymentId(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
-
Achievements: string
(byte)
Title:
Achievements
Achievements in recruiting candidate experience. -
AdditionalInformation: string
(byte)
Title:
Additional Information
Additional Information in recruiting candidate experience. -
BusinessType: string
Title:
Type of Business
Maximum Length:240
Business type in recruiting candidate experience. -
CompanyURL: string
Title:
Company URL
Maximum Length:2000
Company URL in recruiting candidate experience. -
ContactSupervisorFlag: boolean
Title:
OK to Contact Supervisor
Maximum Length:30
Contact supervisor indicator in the recruiting candidate experience. -
CountryCode: string
Title:
Employer Country
Maximum Length:30
Country code number in recruiting candidate experience. -
CurrentJobFlag: boolean
Title:
Current Job
Maximum Length:30
Current job indicator in recruiting candidate experience. -
Department: string
Title:
Department or Division or Post
Maximum Length:240
Department in recruiting candidate experience. -
DirectReports: integer
(int64)
Title:
Direct Reports
Direct reports in recruiting candidate experience. -
EmployerCity: string
Title:
Employer City
Maximum Length:240
Employer city in recruiting candidate experience. -
EmployerCountryId: integer
(int64)
Title:
Employer Country
Employer country ID in recruiting candidate experience. -
EmployerName: string
Title:
Employer Name
Maximum Length:240
Employer name in recruiting candidate experience. -
EmployerPhone: string
Title:
Employer Phone
Maximum Length:240
Employer phone in recruiting candidate experience. -
EmployerStateId: integer
(int64)
Title:
Employer State or Province
Employer state ID in recruiting candidate experience. -
EndCompensation: number
Title:
Ending Compensation
End compensation in recruiting candidate experience. -
EndDate: string
(date)
Title:
End Date
End date in recruiting candidate experience. -
FullTimeCode: string
Title:
Part Time
Maximum Length:30
Full time code in recruiting candidate experience. -
InternalFlag: boolean
Title:
Internal
Maximum Length:30
Internal indicator in the recruiting candidate experience. -
JobFamilyId: integer
(int64)
Title:
Job Family
Job family ID in recruiting candidate experience. -
JobFunction: string
Title:
Job Function
Maximum Length:30
Job function in recruiting candidate experience. -
JobTitle: string
Title:
Job Title
Maximum Length:240
Job title in recruiting candidate experience. -
LeavingReason: string
(byte)
Title:
Reason for Leaving
Leaving reason in recruiting candidate experience. -
OtherCompensation: string
Title:
Other Compensation
Maximum Length:240
Other compensation in recruiting candidate experience. -
OtherJobFunction: string
Title:
Other Job Function
Maximum Length:240
Other job function in recruiting candidate experience. -
Responsibilities: string
(byte)
Title:
Responsibilities
Responsibilities in recruiting candidate experience. -
SectionId: integer
(int64)
Section ID in recruiting candidate experience.
-
StartCompensation: number
Title:
Starting Compensation
Start compensation in recruiting candidate experience. -
StartDate: string
(date)
Title:
Start Date
Start date in recruiting candidate experience. -
StartingPosition: string
Title:
Starting Position
Maximum Length:240
Starting position in recruiting candidate experience. -
StateProvinceCode: string
Title:
Employer State or Province
Maximum Length:360
State province code in recruiting candidate experience. -
SupervisorEmail: string
Title:
Supervisor Email
Maximum Length:240
Supervisor email in recruiting candidate experience. -
SupervisorName: string
Title:
Supervisor Name
Maximum Length:240
Supervisor name in recruiting candidate experience. -
SupervisorPhone: string
Title:
Supervisor Phone
Maximum Length:240
Supervisor phone in recruiting candidate experience. -
SupervisorTitle: string
Title:
Supervisor Title
Maximum Length:240
Supervisor title in recruiting candidate experience.
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-experience-item-response
Type:
Show Source
object
-
Achievements: string
(byte)
Title:
Achievements
Achievements in recruiting candidate experience. -
AdditionalInformation: string
(byte)
Title:
Additional Information
Additional Information in recruiting candidate experience. -
BusinessType: string
Title:
Type of Business
Maximum Length:240
Business type in recruiting candidate experience. -
CompanyURL: string
Title:
Company URL
Maximum Length:2000
Company URL in recruiting candidate experience. -
ContactSupervisorFlag: boolean
Title:
OK to Contact Supervisor
Maximum Length:30
Contact supervisor indicator in the recruiting candidate experience. -
CountryCode: string
Title:
Employer Country
Maximum Length:30
Country code number in recruiting candidate experience. -
CurrentJobFlag: boolean
Title:
Current Job
Maximum Length:30
Current job indicator in recruiting candidate experience. -
Department: string
Title:
Department or Division or Post
Maximum Length:240
Department in recruiting candidate experience. -
DirectReports: integer
(int64)
Title:
Direct Reports
Direct reports in recruiting candidate experience. -
EmployerCity: string
Title:
Employer City
Maximum Length:240
Employer city in recruiting candidate experience. -
EmployerCountryId: integer
(int64)
Title:
Employer Country
Employer country ID in recruiting candidate experience. -
EmployerName: string
Title:
Employer Name
Maximum Length:240
Employer name in recruiting candidate experience. -
EmployerPhone: string
Title:
Employer Phone
Maximum Length:240
Employer phone in recruiting candidate experience. -
EmployerStateId: integer
(int64)
Title:
Employer State or Province
Employer state ID in recruiting candidate experience. -
EndCompensation: number
Title:
Ending Compensation
End compensation in recruiting candidate experience. -
EndDate: string
(date)
Title:
End Date
End date in recruiting candidate experience. -
ExperienceInYears: number
Read Only:
true
Experience in years in recruiting candidate experience. -
FullTimeCode: string
Title:
Part Time
Maximum Length:30
Full time code in recruiting candidate experience. -
InternalFlag: boolean
Title:
Internal
Maximum Length:30
Internal indicator in the recruiting candidate experience. -
JobFamilyId: integer
(int64)
Title:
Job Family
Job family ID in recruiting candidate experience. -
JobFunction: string
Title:
Job Function
Maximum Length:30
Job function in recruiting candidate experience. -
JobTitle: string
Title:
Job Title
Maximum Length:240
Job title in recruiting candidate experience. -
LeavingReason: string
(byte)
Title:
Reason for Leaving
Leaving reason in recruiting candidate experience. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OtherCompensation: string
Title:
Other Compensation
Maximum Length:240
Other compensation in recruiting candidate experience. -
OtherJobFunction: string
Title:
Other Job Function
Maximum Length:240
Other job function in recruiting candidate experience. -
PreviousEmploymentId: integer
(int64)
Previous employment ID in recruiting candidate experience.
-
Responsibilities: string
(byte)
Title:
Responsibilities
Responsibilities in recruiting candidate experience. -
SectionId: integer
(int64)
Section ID in recruiting candidate experience.
-
StartCompensation: number
Title:
Starting Compensation
Start compensation in recruiting candidate experience. -
StartDate: string
(date)
Title:
Start Date
Start date in recruiting candidate experience. -
StartingPosition: string
Title:
Starting Position
Maximum Length:240
Starting position in recruiting candidate experience. -
StateProvinceCode: string
Title:
Employer State or Province
Maximum Length:360
State province code in recruiting candidate experience. -
SupervisorEmail: string
Title:
Supervisor Email
Maximum Length:240
Supervisor email in recruiting candidate experience. -
SupervisorName: string
Title:
Supervisor Name
Maximum Length:240
Supervisor name in recruiting candidate experience. -
SupervisorPhone: string
Title:
Supervisor Phone
Maximum Length:240
Supervisor phone in recruiting candidate experience. -
SupervisorTitle: string
Title:
Supervisor Title
Maximum Length:240
Supervisor title in recruiting candidate experience.
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 <describe action> by submitting a <method> request on the REST resource using cURL.
curl -i -u "<username>:<password>" -X PATCH -d <payload> http://<host>:<port>/hcmRestApi/resources/11.13.18.05/recruitingCandidates/187477/child/experience/ 300100176567882
Example of Payload
The following is an example of the payload.
{ "EmployerName": "Second Company New" }
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.
{ "PreviousEmploymentId": 300100176567882, "EmployerName": "Second Company New", "JobTitle": "Head Honcho", "StartDate": "2012-09-13", "EndDate": "2014-07-29", "CurrentJobFlag": false, "EmployerCountryId": 123, "EmployerCity": "Somewheresville", "FullTimeCode": "6782", "InternalFlag": false, "BusinessType": "Current Business", "EmployerPhone": "555-555-1234", "Department": "Marketing", "JobFamilyId": 78, "JobFunction": "Main function", "OtherJobFunction": "Additional Functions", "DirectReports": 4, "StartingPosition": "Task Conductor", "SupervisorName": "James Hopkins", "SupervisorTitle": "Sr.Task Conductor", "SupervisorEmail": "james.hopkins@oracle.com", "SupervisorPhone": "555-555-9876", "ContactSupervisorFlag": true, "StartCompensation": 75000, "EndCompensation": 78650, "OtherCompensation": "350", "CompanyURL": "https://www.oracle.com/index.html", "SectionId": 57, "EmployerStateId": 98, "ExperienceInYears": 1, "links": [ {...} ] }