Post all the candidate previous experience items.
post
/hcmRestApi/resources/11.13.18.05/recruitingCECandidatePreviousExpItems
Request
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:
Achievements
Achievements mentioned in the candidate previous experience items. -
AdditionalInformation: string
(byte)
Title:
Additional Information
Additional information in the candidate previous experience items. -
BusinessType: string
Title:
Type of Business
Maximum Length:240
Business type in the candidate previous experience items. -
CompanyURL: string
Title:
Company URL
Maximum Length:2000
Company URL in the candidate previous experience items. -
ContactSupervisorFlag: boolean
Title:
OK to Contact Supervisor
Maximum Length:30
Indicates that the supervisor needs to be contacted. -
CountryCode: string
Title:
Employer Country
Maximum Length:30
Country code in the candidate previous experience items. -
CurrentJobFlag: boolean
Title:
Current Job
Maximum Length:30
Indicates that it's the current job of the candidate. -
Department: string
Title:
Department or Division or Post
Maximum Length:240
Department in the candidate previous experience items. -
DirectReports: integer
(int64)
Title:
Direct Reports
Direct Reports in candidate previous experience items. -
EmployerCity: string
Title:
Employer City
Maximum Length:240
Employer city in the candidate previous experience items. -
EmployerCountryId: integer
(int64)
Title:
Employer Country
Employer country ID in the candidate previous experience items. -
EmployerName: string
Title:
Employer Name
Maximum Length:240
Employer name in the candidate previous experience items. -
EmployerPhone: string
Title:
Employer Phone
Maximum Length:240
Employer phone in the candidate previous experience items. -
EmployerStateId: integer
(int64)
Title:
Employer State or Province
Employer state ID in the candidate previous experience items. -
EndCompensation: number
Title:
Ending Compensation
End compensation in the candidate previous experience items. -
EndDate: string
(date)
Title:
End Date
End date in the candidate previous experience items. -
FlowVersionId: integer
Flow version ID in the candidate previous experience items.
-
FullTimeCode: string
Title:
Part Time
Maximum Length:30
Indicates if the previous experience was a full time job. -
InternalFlag: boolean
Title:
Internal
Maximum Length:30
Indicates if the previous experience was an internal job. -
JobFamilyId: integer
(int64)
Title:
Job Family
Job family Id in the candidate previous experience items. -
JobFunction: string
Title:
Job Function
Maximum Length:30
Job function in the candidate previous experience items. -
JobTitle: string
Title:
Job Title
Maximum Length:240
Job title in the candidate previous experience items. -
LeavingReason: string
(byte)
Title:
Reason for Leaving
Reason for leaving the previous job. -
OtherCompensation: string
Title:
Other Compensation
Maximum Length:240
Other compensation in the candidate previous experience items. -
OtherJobFunction: string
Title:
Other Job Function
Maximum Length:240
Other job function in the candidate previous experience items. -
PreviousEmploymentId: integer
(int64)
Previous employment ID in the candidate previous experience items.
-
Responsibilities: string
(byte)
Title:
Responsibilities
Responsibilities in the candidate previous experience items. -
SectionId: integer
(int64)
Section ID in candidate previous experience items.
-
StartCompensation: number
Title:
Starting Compensation
Start compensation in candidate previous experience items. -
StartDate: string
(date)
Title:
Start Date
Start date in candidate previous experience items. -
StartingPosition: string
Title:
Starting Position
Maximum Length:240
Starting position in the candidate previous experience items. -
StateProvinceCode: string
Title:
Employer State or Province
Maximum Length:360
State province code in the candidate previous experience items. -
SubmissionId: integer
Submission ID in the candidate previous experience items.
-
SupervisorEmail: string
Title:
Supervisor Email
Maximum Length:240
Supervisor email in the candidate previous experience items. -
SupervisorName: string
Title:
Supervisor Name
Maximum Length:240
Supervisor name in the candidate previous experience items. -
SupervisorPhone: string
Title:
Supervisor Phone
Maximum Length:240
Supervisor phone in the candidate previous experience items. -
SupervisorTitle: string
Title:
Supervisor Title
Maximum Length:240
Supervisor title in the candidate previous experience items.
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 : recruitingCECandidatePreviousExpItems-item-response
Type:
Show Source
object
-
Achievements: string
(byte)
Title:
Achievements
Achievements mentioned in the candidate previous experience items. -
AdditionalInformation: string
(byte)
Title:
Additional Information
Additional information in the candidate previous experience items. -
BusinessType: string
Title:
Type of Business
Maximum Length:240
Business type in the candidate previous experience items. -
CompanyURL: string
Title:
Company URL
Maximum Length:2000
Company URL in the candidate previous experience items. -
ContactSupervisorFlag: boolean
Title:
OK to Contact Supervisor
Maximum Length:30
Indicates that the supervisor needs to be contacted. -
CountryCode: string
Title:
Employer Country
Maximum Length:30
Country code in the candidate previous experience items. -
CurrentJobFlag: boolean
Title:
Current Job
Maximum Length:30
Indicates that it's the current job of the candidate. -
Department: string
Title:
Department or Division or Post
Maximum Length:240
Department in the candidate previous experience items. -
DirectReports: integer
(int64)
Title:
Direct Reports
Direct Reports in candidate previous experience items. -
EmployerCity: string
Title:
Employer City
Maximum Length:240
Employer city in the candidate previous experience items. -
EmployerCountryId: integer
(int64)
Title:
Employer Country
Employer country ID in the candidate previous experience items. -
EmployerName: string
Title:
Employer Name
Maximum Length:240
Employer name in the candidate previous experience items. -
EmployerPhone: string
Title:
Employer Phone
Maximum Length:240
Employer phone in the candidate previous experience items. -
EmployerStateId: integer
(int64)
Title:
Employer State or Province
Employer state ID in the candidate previous experience items. -
EndCompensation: number
Title:
Ending Compensation
End compensation in the candidate previous experience items. -
EndDate: string
(date)
Title:
End Date
End date in the candidate previous experience items. -
FlowVersionId: integer
Flow version ID in the candidate previous experience items.
-
FullTimeCode: string
Title:
Part Time
Maximum Length:30
Indicates if the previous experience was a full time job. -
InternalFlag: boolean
Title:
Internal
Maximum Length:30
Indicates if the previous experience was an internal job. -
JobFamilyId: integer
(int64)
Title:
Job Family
Job family Id in the candidate previous experience items. -
JobFunction: string
Title:
Job Function
Maximum Length:30
Job function in the candidate previous experience items. -
JobTitle: string
Title:
Job Title
Maximum Length:240
Job title in the candidate previous experience items. -
LeavingReason: string
(byte)
Title:
Reason for Leaving
Reason for leaving the previous job. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OtherCompensation: string
Title:
Other Compensation
Maximum Length:240
Other compensation in the candidate previous experience items. -
OtherJobFunction: string
Title:
Other Job Function
Maximum Length:240
Other job function in the candidate previous experience items. -
PreviousEmploymentId: integer
(int64)
Previous employment ID in the candidate previous experience items.
-
Responsibilities: string
(byte)
Title:
Responsibilities
Responsibilities in the candidate previous experience items. -
SectionId: integer
(int64)
Section ID in candidate previous experience items.
-
StartCompensation: number
Title:
Starting Compensation
Start compensation in candidate previous experience items. -
StartDate: string
(date)
Title:
Start Date
Start date in candidate previous experience items. -
StartingPosition: string
Title:
Starting Position
Maximum Length:240
Starting position in the candidate previous experience items. -
StateProvinceCode: string
Title:
Employer State or Province
Maximum Length:360
State province code in the candidate previous experience items. -
SubmissionId: integer
Submission ID in the candidate previous experience items.
-
SupervisorEmail: string
Title:
Supervisor Email
Maximum Length:240
Supervisor email in the candidate previous experience items. -
SupervisorName: string
Title:
Supervisor Name
Maximum Length:240
Supervisor name in the candidate previous experience items. -
SupervisorPhone: string
Title:
Supervisor Phone
Maximum Length:240
Supervisor phone in the candidate previous experience items. -
SupervisorTitle: string
Title:
Supervisor Title
Maximum Length:240
Supervisor title in the candidate previous experience items.
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.