Create a candidate work experience
post
/hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/experience
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=
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-
Achievements: string
(byte)
Title:
AchievementsAchievements in recruiting candidate experience. -
AdditionalInformation: string
(byte)
Title:
Additional InformationAdditional Information in recruiting candidate experience. -
BusinessType: string
Title:
Type of BusinessMaximum Length:240Business type in recruiting candidate experience. -
CompanyURL: string
Title:
Company URLMaximum Length:2000Company URL in recruiting candidate experience. -
ContactSupervisorFlag: boolean
Title:
OK to Contact SupervisorMaximum Length:30Contact supervisor indicator in the recruiting candidate experience. -
CountryCode: string
Title:
Employer CountryMaximum Length:30Country code number in recruiting candidate experience. -
CurrentJobFlag: boolean
Title:
Current JobMaximum Length:30Current job indicator in recruiting candidate experience. -
Department: string
Title:
Department or Division or PostMaximum Length:240Department in recruiting candidate experience. -
DirectReports: integer
(int64)
Title:
Direct ReportsDirect reports in recruiting candidate experience. -
EmployerCity: string
Title:
Employer CityMaximum Length:240Employer city in recruiting candidate experience. -
EmployerCountryId: integer
(int64)
Title:
Employer CountryEmployer country ID in recruiting candidate experience. -
EmployerName: string
Title:
Employer NameMaximum Length:240Employer name in recruiting candidate experience. -
EmployerPhone: string
Title:
Employer PhoneMaximum Length:240Employer phone in recruiting candidate experience. -
EmployerStateId: integer
(int64)
Title:
Employer State or ProvinceEmployer state ID in recruiting candidate experience. -
EndCompensation: number
Title:
Ending CompensationEnd compensation in recruiting candidate experience. -
EndDate: string
(date)
Title:
End DateEnd date in recruiting candidate experience. -
FullTimeCode: string
Title:
Part TimeMaximum Length:30Full time code in recruiting candidate experience. -
InternalFlag: boolean
Title:
InternalMaximum Length:30Internal indicator in the recruiting candidate experience. -
JobFamilyId: integer
(int64)
Title:
Job FamilyJob family ID in recruiting candidate experience. -
JobFunction: string
Title:
Job FunctionMaximum Length:30Job function in recruiting candidate experience. -
JobTitle: string
Title:
Job TitleMaximum Length:240Job title in recruiting candidate experience. -
LeavingReason: string
(byte)
Title:
Reason for LeavingLeaving reason in recruiting candidate experience. -
OtherCompensation: string
Title:
Other CompensationMaximum Length:240Other compensation in recruiting candidate experience. -
OtherJobFunction: string
Title:
Other Job FunctionMaximum Length:240Other job function in recruiting candidate experience. -
PreviousEmploymentId: integer
(int64)
Previous employment ID in recruiting candidate experience.
-
Responsibilities: string
(byte)
Title:
ResponsibilitiesResponsibilities in recruiting candidate experience. -
SectionId: integer
(int64)
Section ID in recruiting candidate experience.
-
StartCompensation: number
Title:
Starting CompensationStart compensation in recruiting candidate experience. -
StartDate: string
(date)
Title:
Start DateStart date in recruiting candidate experience. -
StartingPosition: string
Title:
Starting PositionMaximum Length:240Starting position in recruiting candidate experience. -
StateProvinceCode: string
Title:
Employer State or ProvinceMaximum Length:360State province code in recruiting candidate experience. -
SupervisorEmail: string
Title:
Supervisor EmailMaximum Length:240Supervisor email in recruiting candidate experience. -
SupervisorName: string
Title:
Supervisor NameMaximum Length:240Supervisor name in recruiting candidate experience. -
SupervisorPhone: string
Title:
Supervisor PhoneMaximum Length:240Supervisor phone in recruiting candidate experience. -
SupervisorTitle: string
Title:
Supervisor TitleMaximum Length:240Supervisor 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:
AchievementsAchievements in recruiting candidate experience. -
AdditionalInformation: string
(byte)
Title:
Additional InformationAdditional Information in recruiting candidate experience. -
BusinessType: string
Title:
Type of BusinessMaximum Length:240Business type in recruiting candidate experience. -
CompanyURL: string
Title:
Company URLMaximum Length:2000Company URL in recruiting candidate experience. -
ContactSupervisorFlag: boolean
Title:
OK to Contact SupervisorMaximum Length:30Contact supervisor indicator in the recruiting candidate experience. -
CountryCode: string
Title:
Employer CountryMaximum Length:30Country code number in recruiting candidate experience. -
CurrentJobFlag: boolean
Title:
Current JobMaximum Length:30Current job indicator in recruiting candidate experience. -
Department: string
Title:
Department or Division or PostMaximum Length:240Department in recruiting candidate experience. -
DirectReports: integer
(int64)
Title:
Direct ReportsDirect reports in recruiting candidate experience. -
EmployerCity: string
Title:
Employer CityMaximum Length:240Employer city in recruiting candidate experience. -
EmployerCountryId: integer
(int64)
Title:
Employer CountryEmployer country ID in recruiting candidate experience. -
EmployerName: string
Title:
Employer NameMaximum Length:240Employer name in recruiting candidate experience. -
EmployerPhone: string
Title:
Employer PhoneMaximum Length:240Employer phone in recruiting candidate experience. -
EmployerStateId: integer
(int64)
Title:
Employer State or ProvinceEmployer state ID in recruiting candidate experience. -
EndCompensation: number
Title:
Ending CompensationEnd compensation in recruiting candidate experience. -
EndDate: string
(date)
Title:
End DateEnd date in recruiting candidate experience. -
ExperienceInYears: number
Read Only:
trueExperience in years in recruiting candidate experience. -
FullTimeCode: string
Title:
Part TimeMaximum Length:30Full time code in recruiting candidate experience. -
InternalFlag: boolean
Title:
InternalMaximum Length:30Internal indicator in the recruiting candidate experience. -
JobFamilyId: integer
(int64)
Title:
Job FamilyJob family ID in recruiting candidate experience. -
JobFunction: string
Title:
Job FunctionMaximum Length:30Job function in recruiting candidate experience. -
JobTitle: string
Title:
Job TitleMaximum Length:240Job title in recruiting candidate experience. -
LeavingReason: string
(byte)
Title:
Reason for LeavingLeaving reason in recruiting candidate experience. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
OtherCompensation: string
Title:
Other CompensationMaximum Length:240Other compensation in recruiting candidate experience. -
OtherJobFunction: string
Title:
Other Job FunctionMaximum Length:240Other job function in recruiting candidate experience. -
PreviousEmploymentId: integer
(int64)
Previous employment ID in recruiting candidate experience.
-
Responsibilities: string
(byte)
Title:
ResponsibilitiesResponsibilities in recruiting candidate experience. -
SectionId: integer
(int64)
Section ID in recruiting candidate experience.
-
StartCompensation: number
Title:
Starting CompensationStart compensation in recruiting candidate experience. -
StartDate: string
(date)
Title:
Start DateStart date in recruiting candidate experience. -
StartingPosition: string
Title:
Starting PositionMaximum Length:240Starting position in recruiting candidate experience. -
StateProvinceCode: string
Title:
Employer State or ProvinceMaximum Length:360State province code in recruiting candidate experience. -
SupervisorEmail: string
Title:
Supervisor EmailMaximum Length:240Supervisor email in recruiting candidate experience. -
SupervisorName: string
Title:
Supervisor NameMaximum Length:240Supervisor name in recruiting candidate experience. -
SupervisorPhone: string
Title:
Supervisor PhoneMaximum Length:240Supervisor phone in recruiting candidate experience. -
SupervisorTitle: string
Title:
Supervisor TitleMaximum Length:240Supervisor title in recruiting candidate experience.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed 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 create a candidate experience by submitting a POST request on the REST resource using cURL.
curl -i -u "<username>:<password>" -X POST -d <payload> http://host:port/hcmCoreApi/resources/11.13.18.05/recruitingCandidates/187477/child/experience
Example of Payload
The following is an example of the payload.
{
"EmployerName": "No Where and Company",
"JobTitle": "Senior Manager",
"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": "Director",
"SupervisorEmail": "james.hopkins@oracle.com",
"SupervisorPhone": "555-555-4321",
"ContactSupervisorFlag": true,
"StartCompensation": 75000,
"EndCompensation": 78650,
"OtherCompensation": 350,
"CompanyURL": "https://www.oracle.com/index.html",
"SectionId": 57,
"EmployerStateId": 98
}
Example of Response Header
The following is an example of the response header.
HTTP/1.1 200 OK Content-Type : application/octet-stream
Example of Response Body
The following example shows the contents of the response body in JSON format.
{
"PreviousEmploymentId": 300100176567882,
"EmployerName": "NoWhere and Company",
"JobTitle": "Senior Director",
"StartDate": "2012-09-13",
"EndDate": "2014-07-29",
"CurrentJobFlag": false,
"EmployerCountryId": 123,
"EmployerCity": "Emp city",
"FullTimeCode": "6782",
"InternalFlag": false,
"BusinessType": "Current Business",
"EmployerPhone": "789-23-1234",
"Department": "Marketing",
"JobFamilyId": 78,
"JobFunction": "Main function",
"OtherJobFunction": "Additional Functions",
"DirectReports": 4,
"StartingPosition": "Task Conductor",
"SupervisorName": "James Hopkins",
"SupervisorTitle": "Director",
"SupervisorEmail": "james.hopkins@oracle.com",
"SupervisorPhone": "432-10-9876",
"ContactSupervisorFlag": true,
"StartCompensation": 75000,
"EndCompensation": 78650,
"OtherCompensation": "350",
"CompanyURL": "https://www.oracle.com/index.html",
"SectionId": 57,
"EmployerStateId": 98,
"ExperienceInYears": null,
"links": [
{...}
]
}