Update a candidate previous employment
patch
/hcmRestApi/resources/11.13.18.05/recruitingJobSiteCandidates/{CandidateNumber}/child/previousEmployments/{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: string
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: string
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:
AchievementsAchievements of the candidate previous employment. -
AdditionalInformation: string
(byte)
Title:
Additional InformationAdditional Information of the candidate previous employment. -
BusinessType: string
Title:
Type of BusinessMaximum Length:240Business type of the candidate previous employment. -
CompanyURL: string
Title:
Company URLMaximum Length:2000Company URL of the candidate previous employment. -
ContactSupervisorFlag: boolean
Title:
OK to Contact SupervisorMaximum Length:30Contact supervisor indicator in the candidate experience. -
CountryCode: string
Title:
Employer CountryMaximum Length:30Country code number of the candidate previous employment. -
CurrentJobFlag: boolean
Title:
Current JobMaximum Length:30Indicates whether the job is the current job of the candidate in the previous employment. -
Department: string
Title:
Department or Division or PostMaximum Length:240Department of the candidate previous employment. -
DirectReports: integer
(int64)
Title:
Direct ReportsDirect reports of the candidate previous employment. -
EmployerCity: string
Title:
Employer CityMaximum Length:240Employer city of the candidate previous employment. -
EmployerName: string
Title:
Employer NameMaximum Length:240Employer name of the candidate previous employment. -
EmployerPhone: string
Title:
Employer PhoneMaximum Length:240Employer phone of the candidate previous employment. -
EndCompensation: number
Title:
Ending CompensationEnd compensation of the candidate previous employment. -
EndDate: string
(date)
Title:
End DateEnd date of the candidate previous employment. -
FullTimeCode: string
Title:
Part TimeMaximum Length:30Full time code of the candidate previous employment. -
InternalFlag: boolean
Title:
InternalMaximum Length:30Indicates whether the job is internal in the candidate previous employment. -
JobFamilyId: integer
(int64)
Title:
Job FamilyJob family identifier of the candidate previous employment. -
JobFunction: string
Title:
Job FunctionMaximum Length:30Job function of the candidate previous employment. -
JobTitle: string
Title:
Job TitleMaximum Length:240Job title of the candidate previous employment. -
LeavingReason: string
(byte)
Title:
Reason for LeavingLeaving reason of the candidate previous employment. -
OtherCompensation: string
Title:
Other CompensationMaximum Length:240Other compensation of the candidate previous employment. -
OtherJobFunction: string
Title:
Other Job FunctionMaximum Length:240Other job function of the candidate previous employment. -
Responsibilities: string
(byte)
Title:
ResponsibilitiesResponsibilities of the candidate previous employment. -
SectionId: integer
(int64)
Section identifier of the candidate previous employment.
-
StartCompensation: number
Title:
Starting CompensationStart compensation of the candidate previous employment. -
StartDate: string
(date)
Title:
Start DateStart date of the candidate previous employment. -
StartingPosition: string
Title:
Starting PositionMaximum Length:240Starting position of the candidate previous employment. -
StateProvinceCode: string
Title:
Employer State or ProvinceMaximum Length:360State province code of the candidate previous employment. -
SupervisorEmail: string
Title:
Supervisor EmailMaximum Length:240Supervisor email of the candidate previous employment. -
SupervisorName: string
Title:
Supervisor NameMaximum Length:240Supervisor name of the candidate previous employment. -
SupervisorPhone: string
Title:
Supervisor PhoneMaximum Length:240Supervisor phone of the candidate previous employment. -
SupervisorTitle: string
Title:
Supervisor TitleMaximum Length:240Supervisor title of the candidate previous employment.
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 : recruitingJobSiteCandidates-previousEmployments-item-response
Type:
Show Source
object-
Achievements: string
(byte)
Title:
AchievementsAchievements of the candidate previous employment. -
AdditionalInformation: string
(byte)
Title:
Additional InformationAdditional Information of the candidate previous employment. -
BusinessType: string
Title:
Type of BusinessMaximum Length:240Business type of the candidate previous employment. -
CompanyURL: string
Title:
Company URLMaximum Length:2000Company URL of the candidate previous employment. -
ContactSupervisorFlag: boolean
Title:
OK to Contact SupervisorMaximum Length:30Contact supervisor indicator in the candidate experience. -
CountryCode: string
Title:
Employer CountryMaximum Length:30Country code number of the candidate previous employment. -
CurrentJobFlag: boolean
Title:
Current JobMaximum Length:30Indicates whether the job is the current job of the candidate in the previous employment. -
Department: string
Title:
Department or Division or PostMaximum Length:240Department of the candidate previous employment. -
DirectReports: integer
(int64)
Title:
Direct ReportsDirect reports of the candidate previous employment. -
EmployerCity: string
Title:
Employer CityMaximum Length:240Employer city of the candidate previous employment. -
EmployerName: string
Title:
Employer NameMaximum Length:240Employer name of the candidate previous employment. -
EmployerPhone: string
Title:
Employer PhoneMaximum Length:240Employer phone of the candidate previous employment. -
EndCompensation: number
Title:
Ending CompensationEnd compensation of the candidate previous employment. -
EndDate: string
(date)
Title:
End DateEnd date of the candidate previous employment. -
ExperienceInYears: number
Read Only:
trueExperience in years of the candidate previous employment. -
FullTimeCode: string
Title:
Part TimeMaximum Length:30Full time code of the candidate previous employment. -
InternalFlag: boolean
Title:
InternalMaximum Length:30Indicates whether the job is internal in the candidate previous employment. -
JobFamilyId: integer
(int64)
Title:
Job FamilyJob family identifier of the candidate previous employment. -
JobFunction: string
Title:
Job FunctionMaximum Length:30Job function of the candidate previous employment. -
JobTitle: string
Title:
Job TitleMaximum Length:240Job title of the candidate previous employment. -
LeavingReason: string
(byte)
Title:
Reason for LeavingLeaving reason of the candidate previous employment. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
OtherCompensation: string
Title:
Other CompensationMaximum Length:240Other compensation of the candidate previous employment. -
OtherJobFunction: string
Title:
Other Job FunctionMaximum Length:240Other job function of the candidate previous employment. -
PreviousEmploymentId: integer
(int64)
Previous employment identifier of the candidate previous employment.
-
Responsibilities: string
(byte)
Title:
ResponsibilitiesResponsibilities of the candidate previous employment. -
SectionId: integer
(int64)
Section identifier of the candidate previous employment.
-
StartCompensation: number
Title:
Starting CompensationStart compensation of the candidate previous employment. -
StartDate: string
(date)
Title:
Start DateStart date of the candidate previous employment. -
StartingPosition: string
Title:
Starting PositionMaximum Length:240Starting position of the candidate previous employment. -
StateProvinceCode: string
Title:
Employer State or ProvinceMaximum Length:360State province code of the candidate previous employment. -
SupervisorEmail: string
Title:
Supervisor EmailMaximum Length:240Supervisor email of the candidate previous employment. -
SupervisorName: string
Title:
Supervisor NameMaximum Length:240Supervisor name of the candidate previous employment. -
SupervisorPhone: string
Title:
Supervisor PhoneMaximum Length:240Supervisor phone of the candidate previous employment. -
SupervisorTitle: string
Title:
Supervisor TitleMaximum Length:240Supervisor title of the candidate previous employment.
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.