Create a candidate
post
/hcmRestApi/resources/11.13.18.05/recruitingJobSiteCandidates
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
-
AdditionalSourceInformation: string
Additional source tracking information of a candidate.
-
addresses: array
Addresses of the Candidates
Title:
Addresses of the Candidates
The addresses resource is a child of the recruitingJobSiteCandidates resource. It provides details about the addresses of the candidates. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners. -
attachments: array
Attachments of the Candidates
Title:
Attachments of the Candidates
The attachments resource is a child of the recruitingJobSiteCandidates resource. It provides details about the documents attached by the candidates. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners. -
candidateExtraInformation: array
Extra Information of the Candidates
Title:
Extra Information of the Candidates
The candidateExtraInformation resource is a child of the recruitingJobSiteCandidates resource. It provides extra information about the candidates. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners. -
certifications: array
Certifications of the Candidates
Title:
Certifications of the Candidates
The certifications resource is a child of the recruitingJobSiteCandidates resource. It provides details about the certifications of the candidates. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners. -
CreatedBy: string
Person who created the candidate.
-
CreationDate: string
(date-time)
Creation date of the candidate.
-
DateOfBirth: string
(date)
Date of birth of the candidate.
-
educations: array
Education of the Candidates
Title:
Education of the Candidates
The educations resource is a child of the recruitingJobSiteCandidates resource. It provides details about the education of the candidates. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners. -
Email: string
Maximum Length:
240
Email of the candidate. -
FirstName: string
Maximum Length:
150
First name of the candidate. -
Honors: string
Maximum Length:
80
Honors of the candidate. -
KnownAs: string
Maximum Length:
80
Known as attribute of the candidate. -
languages: array
Languages of the Candidates
Title:
Languages of the Candidates
The languages resource is a child of the recruitingJobSiteCandidates resource. It provides details about the languages of the candidates. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners. -
LastName: string
Maximum Length:
150
Last name of the candidate. -
LastUpdateDate: string
(date-time)
Last update date of the candidate.
-
LastUpdatedBy: string
Person who last updated the candidate.
-
MiddleNames: string
Maximum Length:
80
Middle names of the candidate. -
MilitaryRank: string
Maximum Length:
80
Military rank of the candidate. -
nationalIdentifiers: array
National Identifiers of the Candidates
Title:
National Identifiers of the Candidates
The nationalIdentifiers resource is a child of the recruitingJobSiteCandidates resource. It provides details about the national identifiers of the candidates. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners. -
phones: array
Phone Numbers of the Candidates
Title:
Phone Numbers of the Candidates
The phones resource is a child of the recruitingJobSiteCandidates resource. It provides details about the phone numbers of candidates. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners. -
PreferredLanguage: string
Maximum Length:
4
Preferred language of the candidate. -
PreferredTimezone: string
Maximum Length:
255
Preferred time zone of the candidate. -
PreNameAdjunct: string
Maximum Length:
150
Previous name adjunct of the candidate. -
previousEmployments: array
Previous Employments of the Candidates
Title:
Previous Employments of the Candidates
The previousEmployments resource is a child of the recruitingJobSiteCandidates resource. It provides details about the work experience of the candidates. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners. -
PreviousLastName: string
Maximum Length:
150
Previous last name of the candidate. -
skills: array
Skills of the Candidates
Title:
Skills of the Candidates
The skills resource is a child of the recruitingJobSiteCandidates resource. It provides details about the skills of the candidates. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners. -
Suffix: string
Maximum Length:
80
Suffix of the candidate. -
Title: string
Maximum Length:
30
Title of the candidate. -
workPreferences: array
Work Preferences of the Candidates
Title:
Work Preferences of the Candidates
The workPreferences resource is a child of the recruitingJobSiteCandidates resource. It provides details about the work preferences of the candidates. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
Nested Schema : Addresses of the Candidates
Type:
array
Title:
Addresses of the Candidates
The addresses resource is a child of the recruitingJobSiteCandidates resource. It provides details about the addresses of the candidates. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
Show Source
Nested Schema : Attachments of the Candidates
Type:
array
Title:
Attachments of the Candidates
The attachments resource is a child of the recruitingJobSiteCandidates resource. It provides details about the documents attached by the candidates. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
Show Source
Nested Schema : Extra Information of the Candidates
Type:
array
Title:
Extra Information of the Candidates
The candidateExtraInformation resource is a child of the recruitingJobSiteCandidates resource. It provides extra information about the candidates. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
Show Source
Nested Schema : Certifications of the Candidates
Type:
array
Title:
Certifications of the Candidates
The certifications resource is a child of the recruitingJobSiteCandidates resource. It provides details about the certifications of the candidates. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
Show Source
Nested Schema : Education of the Candidates
Type:
array
Title:
Education of the Candidates
The educations resource is a child of the recruitingJobSiteCandidates resource. It provides details about the education of the candidates. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
Show Source
Nested Schema : Languages of the Candidates
Type:
array
Title:
Languages of the Candidates
The languages resource is a child of the recruitingJobSiteCandidates resource. It provides details about the languages of the candidates. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
Show Source
Nested Schema : National Identifiers of the Candidates
Type:
array
Title:
National Identifiers of the Candidates
The nationalIdentifiers resource is a child of the recruitingJobSiteCandidates resource. It provides details about the national identifiers of the candidates. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
Show Source
Nested Schema : Phone Numbers of the Candidates
Type:
array
Title:
Phone Numbers of the Candidates
The phones resource is a child of the recruitingJobSiteCandidates resource. It provides details about the phone numbers of candidates. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
Show Source
Nested Schema : Previous Employments of the Candidates
Type:
array
Title:
Previous Employments of the Candidates
The previousEmployments resource is a child of the recruitingJobSiteCandidates resource. It provides details about the work experience of the candidates. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
Show Source
Nested Schema : Skills of the Candidates
Type:
array
Title:
Skills of the Candidates
The skills resource is a child of the recruitingJobSiteCandidates resource. It provides details about the skills of the candidates. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
Show Source
Nested Schema : Work Preferences of the Candidates
Type:
array
Title:
Work Preferences of the Candidates
The workPreferences resource is a child of the recruitingJobSiteCandidates resource. It provides details about the work preferences of the candidates. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
Show Source
Nested Schema : recruitingJobSiteCandidates-addresses-item-post-request
Type:
Show Source
object
-
AddlAddressAttribute1: string
Maximum Length:
150
Additional address attribute 1 of the candidate address. -
AddlAddressAttribute2: string
Maximum Length:
150
Additional address attribute 2 of the candidate address. -
AddlAddressAttribute3: string
Maximum Length:
150
Additional address attribute 3 of the candidate address. -
AddlAddressAttribute4: string
Maximum Length:
150
Additional address attribute 4 of the candidate address. -
AddlAddressAttribute5: string
Maximum Length:
150
Additional address attribute 5 of the candidate address. -
AddressLine1: string
Maximum Length:
240
Address line 1 of the candidates address. -
AddressLine2: string
Maximum Length:
240
Address line 2 of the candidates address. -
AddressLine3: string
Maximum Length:
240
Address line 3 of the candidates address. -
Building: string
Maximum Length:
240
Building of the candidate address. -
City: string
Maximum Length:
60
City of the candidate address. -
Country: string
Maximum Length:
60
Country of the candidate address. -
FloorNumber: string
Maximum Length:
40
Floor number of the candidate address. -
LongPostalCode: string
Maximum Length:
30
Long postal code of the candidate address. -
PostalCode: string
Maximum Length:
30
Postal code of the candidate address. -
Region1: string
Maximum Length:
120
Region 1 of the candidate address. -
Region2: string
Maximum Length:
120
Region 2 of the candidate address. -
Region3: string
Maximum Length:
120
Region 3 of the candidate address.
Nested Schema : recruitingJobSiteCandidates-attachments-item-post-request
Type:
Show Source
object
-
Attachment: string
Information of the candidate attachment.
-
CandidateNumber: string
Candidate number of the candidate attachment.
-
Category: string
Maximum Length:
30
Category of the candidate attachment. -
Description: string
Maximum Length:
255
Description of the candidate attachment. -
FileContents: string
File contents of the candidate attachment.
-
Id: string
Maximum Length:
255
Identifier of the candidate attachment. -
MimeType: string
Mime type of the candidate attachment.
-
SourceAttachmentId: integer
Source attachment identifier of the candidate attachment.
-
Title: string
Maximum Length:
80
Title of the candidate attachment. -
Type: string
Type of the candidate attachment.
Nested Schema : schema
Type:
Show Source
object
-
CandidateNumber: string
Maximum Length:
255
Candidate number of the candidate extra information. -
ContextCode: string
Maximum Length:
255
Context code of the candidate extra information. -
ContextLink: string
Maximum Length:
255
Context link of the candidate extra information. -
DataId: integer
Data identifier of the candidate extra information.
-
dataRows: array
Extra Information Rows of the Candidates
Title:
Extra Information Rows of the Candidates
The dataRows resource is a child of the recruitingJobSiteCandidates resource. It provides rows containing extra information about the candidates. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
Nested Schema : Extra Information Rows of the Candidates
Type:
array
Title:
Extra Information Rows of the Candidates
The dataRows resource is a child of the recruitingJobSiteCandidates resource. It provides rows containing extra information about the candidates. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
Show Source
Nested Schema : recruitingJobSiteCandidates-candidateExtraInformation-dataRows-item-post-request
Type:
Show Source
object
-
attributes: array
Extra Information Attributes of the Candidates
Title:
Extra Information Attributes of the Candidates
The attributes resource is a child of the recruitingJobSiteCandidates resource. It provides row attributes containing extra information about the candidates. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners. -
ContextRowId: string
Maximum Length:
255
Context row identifier of the candidate extra information data rows. -
ContextRowLink: string
Maximum Length:
255
Context row link of the candidate extra information data rows. -
DataId: integer
Data identifier of the candidate extra information data rows.
-
DataRowId: integer
Data row identifier of the candidate extra information data rows.
-
RowAction: string
Maximum Length:
255
Row action that needs to be performed on the candidate extra information data rows.
Nested Schema : Extra Information Attributes of the Candidates
Type:
array
Title:
Extra Information Attributes of the Candidates
The attributes resource is a child of the recruitingJobSiteCandidates resource. It provides row attributes containing extra information about the candidates. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
Show Source
Nested Schema : schema
Type:
Show Source
object
-
AttributeId: integer
Attribute identifier of the candidate extra information data row attribute.
-
DataRowId: integer
Data row identifier of the candidate extra information data row attribute.
-
Name: string
Name of the candidate extra information data row attribute.
-
Value: string
Value of the candidate extra information data row attribute.
Nested Schema : schema
Type:
Show Source
object
-
ActualCompletionDate: string
(date)
Title:
Actual Completion Date
Actual completion date of the candidate certification. -
CertificationId: integer
(int64)
Identifier of the candidate certification.
-
CertificationName: string
Title:
License or Certificate
Maximum Length:240
Certification name of the candidate certification. -
CertificationNumber: string
Title:
Certificate Number
Maximum Length:240
Certification number of the candidate certification. -
CertificationURL: string
Title:
Certification URL
Maximum Length:2000
Certification URL of the candidate certification. -
Comments: string
(byte)
Title:
Comments
Comments about the candidate certification. -
CompletedAmount: integer
(int64)
Title:
Completed Amount
Completed amount of the candidate certification. -
CompletedTrainingUnits: string
Title:
Training Completed Units
Maximum Length:240
Completed training units of the candidate certification. -
ContentItemId: integer
(int64)
Title:
License or Certificate
Content item identifier of the candidate certification. -
CountryCode: string
Title:
Country
Maximum Length:30
Country code of the candidate certification. -
EducationalEstablishment: string
Title:
Educational Establishment
Maximum Length:2000
Educational establishment of the candidate certification. -
EducationalEstablishmentId: integer
(int64)
Title:
Establishment
Educational establishment identifier of the candidate certification. -
ExpirationDate: string
(date)
Title:
Expiration Date
Expiration date of the candidate certification. -
IssueDate: string
(date)
Title:
Issue Date
Issue date of the candidate certification. -
IssuedBy: string
Title:
Issued By
Maximum Length:240
Entity who issued the candidate certification. -
LastRenewalDate: string
(date)
Title:
Last Renewal Date
Last renewal date of the candidate certification. -
OriginalIssueYear: integer
(int64)
Title:
Original Issue Year
Original issue year of the candidate certification. -
RenewalDate: string
(date)
Title:
Renewal Date
Renewal date of the candidate certification. -
RenewalInprogressFlag: boolean
Title:
Renewal In Progress
Maximum Length:30
Indicates the renewal in progress indicator of the candidate certification. -
RenewalRequiredFlag: boolean
Title:
Renewal Required
Maximum Length:30
Indicates whether the renewal indicator is required in the candidate certification. -
Restrictions: string
(byte)
Title:
Restrictions
Restrictions of the candidate certification. -
SectionId: integer
(int64)
Section identifier of the candidate certification.
-
StateProvinceCode: string
Title:
State
Maximum Length:360
State province code of the candidate certification. -
Status: string
Title:
Status
Maximum Length:30
Status of the candidate certification. -
Title: string
Title:
Title
Maximum Length:240
Title of the candidate certification. -
TotalAmount: integer
(int64)
Title:
Total Amount
Total amount of the candidate certification. -
VerifiedFlag: boolean
Title:
Verified
Maximum Length:30
Indicates the verified indicator of the candidate education.
Nested Schema : schema
Type:
Show Source
object
-
AcademicStanding: string
Title:
Academic Standing
Maximum Length:30
Academic standing of the candidate education. -
ActivitySummary: string
(byte)
Title:
Summary of Activities
Activity summary of the candidate education. -
AreaOfStudy: string
Title:
Area of Study
Maximum Length:240
Area of study of the candidate education. -
AverageGrade: string
Title:
Average Grade
Maximum Length:240
Average grade of the candidate education. -
AwardingBody: string
Title:
Awarding Body
Maximum Length:240
Awarding body of the candidate education. -
City: string
Title:
City
Maximum Length:240
CIty of the candidate education. -
Comments: string
(byte)
Title:
Comments
Comments of the candidate education. -
CompletedAmount: integer
(int64)
Title:
Completed Amount
Completed amount of the candidate education. -
CompletedTraningUnits: string
Title:
Training Completed Units
Maximum Length:240
Completed training units of the candidate education. -
ContentItemId: integer
(int64)
Title:
Degree
Content item identifier of the candidate education. -
CountryCode: string
Title:
Country
Maximum Length:30
Country code of the candidate education. -
DateAcquired: string
(date)
Title:
Date Acquired
Date acquired of the candidate education. -
DegreeName: string
Title:
Degree
Maximum Length:240
Degree name of the candidate education. -
Department: string
Title:
Faculty or Department
Maximum Length:240
Department of the candidate education. -
Description: string
(byte)
Title:
Description
Description of the candidate education. -
Duration: string
Title:
Duration
Maximum Length:240
Duration of the candidate education. -
DurationUnits: string
Title:
Duration Units
Maximum Length:30
Duration units of the candidate education. -
EducationalEstablishment: string
Title:
School Name
Maximum Length:2000
Educational establishment of the candidate education. -
EducationalEstablishmentId: integer
(int64)
Title:
School
Educational establishment identifier of the candidate education. -
EducationId: integer
(int64)
Education identifier of the candidate education.
-
EducationLevel: string
Title:
Education Level
Maximum Length:30
Education level of the candidate education. -
EducationURL: string
Title:
Education URL
Maximum Length:2000
Education URL of the candidate education. -
Educator: string
Title:
Educator
Maximum Length:240
Educator of the candidate education. -
EduLevelCompletedFlag: boolean
Title:
Education Level Completed
Maximum Length:30
Education level completed indicator of the candidate education. -
EndDate: string
(date)
Title:
End Date
End date of the candidate education. -
Fee: integer
(int64)
Title:
Fee
Fee of the candidate education. -
FeeCurrency: string
Title:
Fee Currency
Maximum Length:30
Fee currency of the candidate education. -
GPA: number
Title:
GPA
GPA of the candidate education. -
GraduatedFlag: boolean
Title:
Graduated
Maximum Length:30
Graduated indicator of the candidate education. -
HighestEduLevel: string
Title:
Highest Education Level
Maximum Length:30
Highest education level of the candidate education. -
Major: string
Title:
Major
Maximum Length:240
Major of the candidate education. -
Minor: string
Title:
Minor
Maximum Length:240
Minor of the candidate education. -
PartTimeFlag: boolean
Title:
Part Time
Maximum Length:30
Part time indicator of the candidate education. -
ProjectedCompletionDate: string
(date)
Title:
Projected Completion Date
Projected completion date of the candidate education. -
Reimbursements: string
(byte)
Title:
Reimbursement Arrangements
Reimbursements of the candidate education. -
RequiredFlag: boolean
Title:
Required
Maximum Length:30
Indicates whether the education is required in the candidate education. -
SectionId: integer
(int64)
Section identifier of the candidate education.
-
StartDate: string
(date)
Title:
Start Date
Start date of the candidate education. -
StateProvinceCode: string
Title:
State
Maximum Length:360
State province code of the candidate education. -
Status: string
Title:
Status
Maximum Length:30
Status of the candidate education. -
Title: string
Title:
Title
Maximum Length:240
Title of the candidate education. -
TotalAmount: integer
(int64)
Title:
Total Amount
Total amount of the candidate education. -
TrmnlDegDiscpFlag: boolean
Title:
Terminal Degree for Discipline
Maximum Length:30
Terminal degree discipline indicator of the candidate education. -
TuitionMethod: string
Title:
Tuition Method
Maximum Length:30
Tuition method of the candidate education. -
YearAcquired: integer
(int64)
Title:
Year Acquired
Year acquired of the candidate education.
Nested Schema : recruitingJobSiteCandidates-languages-item-post-request
Type:
Show Source
object
-
AbleToTeachFlag: boolean
Title:
Able to Teach
Maximum Length:30
Indicates whether the candidate can teach in the candidate language. -
AbleToTranslateFlag: boolean
Title:
Able to Translate
Maximum Length:30
Indicates whether the candidate can translate in the candidate language. -
Comments: string
(byte)
Title:
Comments
Comments in candidate language. -
ContentItemId: integer
(int64)
Title:
Language
Content item identifier in candidate language. -
EvaluatedOn: string
(date)
Title:
Evaluated On
Evaluated on in candidate language. -
EvaluationLocation: string
Title:
Evaluation Location
Maximum Length:240
Evaluation location in candidate language. -
Language: string
Maximum Length:
240
Language in candidate language. -
LanguageId: integer
(int64)
Language identifier in candidate language.
-
NativeSpeakerFlag: boolean
Title:
Native
Maximum Length:30
Indicates whether the candidate is a native speaker in the candidate language. -
ReadingLevelId: integer
(int64)
Title:
Reading
Reading level identifier in candidate language. -
ReadingModelId: integer
(int64)
Title:
Reading Rating Model
Reading model identifier in candidate language. -
SectionId: integer
(int64)
Section identifier in candidate language.
-
SpeakingLevelId: integer
(int64)
Title:
Speaking
Speaking level identifier in candidate language. -
SpeakingModelId: integer
(int64)
Title:
Speaking Rating Model
Speaking model identifier in candidate language. -
WritingLevelId: integer
(int64)
Title:
Writing
Writing level identifier in candidate language. -
WritingModelId: integer
(int64)
Title:
Writing Rating Model
Writing model identifier in candidate language.
Nested Schema : recruitingJobSiteCandidates-nationalIdentifiers-item-post-request
Type:
Show Source
object
-
ExpirationDate: string
(date)
Title:
Expiration Date
Expiration date of the candidate national identifier. -
IssueDate: string
(date)
Title:
Issue Date
Issue date of the candidate national identifier. -
LegislationCode: string
Title:
Country
Maximum Length:30
Legislation code of the candidate national identifier. -
NationalIdentifierNumber: string
Title:
National ID
Maximum Length:30
National identifier number of the candidate national identifier. -
NationalIdentifierType: string
Title:
National ID Type
Maximum Length:30
National identifier type of the candidate national identifier. -
PlaceOfIssue: string
Title:
Place of Issue
Maximum Length:30
Place of issue of the candidate national identifier.
Nested Schema : schema
Type:
Show Source
object
-
AreaCode: string
Maximum Length:
30
Area code of the candidate phone. -
CountryCodeNumber: string
Maximum Length:
30
Country code number of the candidate phone. -
CreatedBy: string
Person who created the candidate phone.
-
CreationDate: string
(date-time)
Creation date of the candidate phone.
-
LastUpdateDate: string
(date-time)
Last update date of the candidate phone.
-
LastUpdatedBy: string
Last updated by of the candidate phone.
-
LegislationCode: string
Maximum Length:
4
Legislation code of the candidate phone. -
PhoneId: string
Phone identifier of the candidate phone.
-
PhoneNumber: string
Maximum Length:
60
Phone number of the candidate phone.
Nested Schema : schema
Type:
Show Source
object
-
Achievements: string
(byte)
Title:
Achievements
Achievements of the candidate previous employment. -
AdditionalInformation: string
(byte)
Title:
Additional Information
Additional Information of the candidate previous employment. -
BusinessType: string
Title:
Type of Business
Maximum Length:240
Business type of the candidate previous employment. -
CompanyURL: string
Title:
Company URL
Maximum Length:2000
Company URL of the candidate previous employment. -
ContactSupervisorFlag: boolean
Title:
OK to Contact Supervisor
Maximum Length:30
Contact supervisor indicator in the candidate experience. -
CountryCode: string
Title:
Employer Country
Maximum Length:30
Country code number of the candidate previous employment. -
CurrentJobFlag: boolean
Title:
Current Job
Maximum Length:30
Indicates whether the job is the current job of the candidate in the previous employment. -
Department: string
Title:
Department or Division or Post
Maximum Length:240
Department of the candidate previous employment. -
DirectReports: integer
(int64)
Title:
Direct Reports
Direct reports of the candidate previous employment. -
EmployerCity: string
Title:
Employer City
Maximum Length:240
Employer city of the candidate previous employment. -
EmployerName: string
Title:
Employer Name
Maximum Length:240
Employer name of the candidate previous employment. -
EmployerPhone: string
Title:
Employer Phone
Maximum Length:240
Employer phone of the candidate previous employment. -
EndCompensation: number
Title:
Ending Compensation
End compensation of the candidate previous employment. -
EndDate: string
(date)
Title:
End Date
End date of the candidate previous employment. -
FullTimeCode: string
Title:
Part Time
Maximum Length:30
Full time code of the candidate previous employment. -
InternalFlag: boolean
Title:
Internal
Maximum Length:30
Indicates whether the job is internal in the candidate previous employment. -
JobFamilyId: integer
(int64)
Title:
Job Family
Job family identifier of the candidate previous employment. -
JobFunction: string
Title:
Job Function
Maximum Length:30
Job function of the candidate previous employment. -
JobTitle: string
Title:
Job Title
Maximum Length:240
Job title of the candidate previous employment. -
LeavingReason: string
(byte)
Title:
Reason for Leaving
Leaving reason of the candidate previous employment. -
OtherCompensation: string
Title:
Other Compensation
Maximum Length:240
Other compensation of the candidate previous employment. -
OtherJobFunction: string
Title:
Other Job Function
Maximum Length:240
Other job function of the candidate previous employment. -
PreviousEmploymentId: integer
(int64)
Previous employment identifier of the candidate previous employment.
-
Responsibilities: string
(byte)
Title:
Responsibilities
Responsibilities of the candidate previous employment. -
SectionId: integer
(int64)
Section identifier of the candidate previous employment.
-
StartCompensation: number
Title:
Starting Compensation
Start compensation of the candidate previous employment. -
StartDate: string
(date)
Title:
Start Date
Start date of the candidate previous employment. -
StartingPosition: string
Title:
Starting Position
Maximum Length:240
Starting position of the candidate previous employment. -
StateProvinceCode: string
Title:
Employer State or Province
Maximum Length:360
State province code of the candidate previous employment. -
SupervisorEmail: string
Title:
Supervisor Email
Maximum Length:240
Supervisor email of the candidate previous employment. -
SupervisorName: string
Title:
Supervisor Name
Maximum Length:240
Supervisor name of the candidate previous employment. -
SupervisorPhone: string
Title:
Supervisor Phone
Maximum Length:240
Supervisor phone of the candidate previous employment. -
SupervisorTitle: string
Title:
Supervisor Title
Maximum Length:240
Supervisor title of the candidate previous employment.
Nested Schema : recruitingJobSiteCandidates-skills-item-post-request
Type:
Show Source
object
-
Comments: string
(byte)
Title:
Comments
Comments of a candidate skill. -
DateAchieved: string
(date)
Title:
Date Achieved
Date when the candidate skill was achieved. -
Description: string
(byte)
Title:
Description
Description of a candidate skill. -
ProjectName: string
Title:
Project Name or Activities
Maximum Length:2000
Project name of a candidate skill. -
SectionId: integer
(int64)
Section identifier of the candidate skills.
-
Skill: string
Title:
Skill
Maximum Length:240
Description of a candidate skill. -
SkillId: integer
(int64)
Identifier of a candidate skill.
-
Speciality: string
Title:
Skill Type
Maximum Length:30
Specialty or skill type of a candidate skill. -
YearsOfExperience: integer
(int64)
Title:
Years of Experience
Years of experience of a candidate skill.
Nested Schema : recruitingJobSiteCandidates-workPreferences-item-post-request
Type:
Show Source
object
-
AllLocationsFlag: boolean
Title:
All Locations
Maximum Length:30
Indicates whether all locations are included in the candidate work preferences. -
Comments: string
(byte)
Title:
Comments
Comments of the candidate work preferences. -
ContentItemId: integer
(int64)
Content item identifier of the candidate work preferences.
-
CurrencyCode: string
Title:
Currency Code
Maximum Length:30
Currency code of the candidate work preferences. -
DateFrom: string
(date)
Date from of the candidate work preferences.
-
DateTo: string
(date)
Date to of the candidate work preferences.
-
ExcludedLocationFourId: integer
(int64)
Title:
Fourth Excluded Location
Excluded location four identifier of the candidate work preferences. -
ExcludedLocationOneId: integer
(int64)
Title:
First Excluded Location
Excluded location one identifier of the candidate work preferences. -
ExcludedLocationThreeId: integer
(int64)
Title:
Third Excluded Location
Excluded location three identifier of the candidate work preferences. -
ExcludedLocationTwoId: integer
(int64)
Title:
Second Excluded Location
Excluded location two identifier of the candidate work preferences. -
FlexibleWorkFlag: boolean
Title:
Work a Flexible Schedule
Maximum Length:30
Indicates whether flexible work is required in the candidate work preferences. -
FullTimeEquivalent: number
Title:
Full Time Equivalent
Full time equivalent of the candidate work preferences. -
IntlTravelFlag: boolean
Title:
Travel Internationally
Maximum Length:30
Indicates whether international travel is in the candidate work preferences. -
IntlTravelFrequency: string
Title:
International Travel Frequency
Maximum Length:30
International travel frequency of the candidate work preferences. -
IntlTravelRequiredFlag: boolean
Title:
International Travel Required
Maximum Length:30
Indicates whether international travel is required in the candidate work preferences. -
MinimumPay: integer
(int64)
Title:
Minimum Pay
Minimum pay of the candidate work preferences. -
NatTravelFlag: boolean
Title:
Travel Domestically
Maximum Length:30
Indicates whether domestic travel is in the candidate work preferences. -
NatTravelFrequency: string
Title:
Domestic Travel Frequency
Maximum Length:30
National travel frequency of the candidate work preferences. -
NatTravelRequiredFlag: boolean
Title:
Travel Required
Maximum Length:30
Indicates whether domestic travel is required in the candidate work preferences. -
PartAssignFlag: boolean
Title:
Consider Part Time Work
Maximum Length:30
Part assign indicator of the candidate work preferences. -
PayFrequency: string
Title:
Pay Frequency
Maximum Length:30
Pay frequency of the candidate work preferences. -
PayRange: string
Title:
Pay Range
Maximum Length:30
Pay range of the candidate work preferences. -
PreferredLocationFourId: integer
(int64)
Title:
Fourth Preferred Location
Preferred location four identifier of the candidate work preferences. -
PreferredLocationOneId: integer
(int64)
Title:
First Preferred Location
Preferred location one identifier of the candidate work preferences. -
PreferredLocationThreeId: integer
(int64)
Title:
Third Preferred Location
Preferred location three identifier of the candidate work preferences. -
PreferredLocationTwoId: integer
(int64)
Title:
Second Preferred Location
Preferred location two identifier of the candidate work preferences. -
RelocateDuration: integer
(int64)
Title:
Length of Willing to Relocate
Relocate duration of the candidate work preferences. -
RelocateFlag: boolean
Title:
Willing to Relocate
Maximum Length:30
Indicates whether relocation is possible in the candidate work preferences. -
RelocationReason: string
Title:
Relocation Reason
Maximum Length:240
Relocation reason of the candidate work preferences. -
SectionId: integer
(int64)
Section identifier of the candidate work preferences.
-
TempAssignFlag: boolean
Title:
Consider Temporary Assignment
Maximum Length:30
Indicates whether temporary assignment is in the candidate work preferences. -
WorkDays: string
Title:
Workdays
Maximum Length:30
Workdays of the candidate work preferences. -
WorkHours: string
Title:
Work Hours
Maximum Length:30
Work hours of the candidate work preferences. -
WorkMonths: integer
(int64)
Title:
Work Duration Months
Work months of the candidate work preferences. -
WorkPreferenceId: integer
(int64)
Work preference identifier of the candidate work preferences.
-
WorkYears: integer
(int64)
Title:
Work Duration Years
Work years of the candidate work preferences.
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-item-response
Type:
Show Source
object
-
AdditionalSourceInformation: string
Additional source tracking information of a candidate.
-
addresses: array
Addresses of the Candidates
Title:
Addresses of the Candidates
The addresses resource is a child of the recruitingJobSiteCandidates resource. It provides details about the addresses of the candidates. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners. -
attachments: array
Attachments of the Candidates
Title:
Attachments of the Candidates
The attachments resource is a child of the recruitingJobSiteCandidates resource. It provides details about the documents attached by the candidates. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners. -
candidateExtraInformation: array
Extra Information of the Candidates
Title:
Extra Information of the Candidates
The candidateExtraInformation resource is a child of the recruitingJobSiteCandidates resource. It provides extra information about the candidates. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners. -
CandidateNumber: string
Read Only:
true
Maximum Length:255
Candidate number of the candidate. -
CandidateType: string
Read Only:
true
Candidate type of the candidate. -
certifications: array
Certifications of the Candidates
Title:
Certifications of the Candidates
The certifications resource is a child of the recruitingJobSiteCandidates resource. It provides details about the certifications of the candidates. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners. -
CreatedBy: string
Person who created the candidate.
-
CreationDate: string
(date-time)
Creation date of the candidate.
-
DateOfBirth: string
(date)
Date of birth of the candidate.
-
DeletionQualifier: string
Read Only:
true
Maximum Length:255
Deletion qualifier of the candidate. -
educations: array
Education of the Candidates
Title:
Education of the Candidates
The educations resource is a child of the recruitingJobSiteCandidates resource. It provides details about the education of the candidates. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners. -
Email: string
Maximum Length:
240
Email of the candidate. -
FirstName: string
Maximum Length:
150
First name of the candidate. -
Honors: string
Maximum Length:
80
Honors of the candidate. -
KnownAs: string
Maximum Length:
80
Known as attribute of the candidate. -
languages: array
Languages of the Candidates
Title:
Languages of the Candidates
The languages resource is a child of the recruitingJobSiteCandidates resource. It provides details about the languages of the candidates. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners. -
LastName: string
Maximum Length:
150
Last name of the candidate. -
LastUpdateDate: string
(date-time)
Last update date of the candidate.
-
LastUpdatedBy: string
Person who last updated the candidate.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MiddleNames: string
Maximum Length:
80
Middle names of the candidate. -
MilitaryRank: string
Maximum Length:
80
Military rank of the candidate. -
nationalIdentifiers: array
National Identifiers of the Candidates
Title:
National Identifiers of the Candidates
The nationalIdentifiers resource is a child of the recruitingJobSiteCandidates resource. It provides details about the national identifiers of the candidates. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners. -
ObjectStatus: string
Read Only:
true
Maximum Length:255
Object status of the candidate. -
phones: array
Phone Numbers of the Candidates
Title:
Phone Numbers of the Candidates
The phones resource is a child of the recruitingJobSiteCandidates resource. It provides details about the phone numbers of candidates. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners. -
PreferredLanguage: string
Maximum Length:
4
Preferred language of the candidate. -
PreferredTimezone: string
Maximum Length:
255
Preferred time zone of the candidate. -
PreNameAdjunct: string
Maximum Length:
150
Previous name adjunct of the candidate. -
previousEmployments: array
Previous Employments of the Candidates
Title:
Previous Employments of the Candidates
The previousEmployments resource is a child of the recruitingJobSiteCandidates resource. It provides details about the work experience of the candidates. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners. -
PreviousLastName: string
Maximum Length:
150
Previous last name of the candidate. -
skills: array
Skills of the Candidates
Title:
Skills of the Candidates
The skills resource is a child of the recruitingJobSiteCandidates resource. It provides details about the skills of the candidates. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners. -
SourceMedium: string
Read Only:
true
Maximum Length:32
Source medium of the candidate. -
SourceName: string
Read Only:
true
Maximum Length:2000
Source name of the candidate. -
Suffix: string
Maximum Length:
80
Suffix of the candidate. -
Title: string
Maximum Length:
30
Title of the candidate. -
workPreferences: array
Work Preferences of the Candidates
Title:
Work Preferences of the Candidates
The workPreferences resource is a child of the recruitingJobSiteCandidates resource. It provides details about the work preferences of the candidates. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
Nested Schema : Addresses of the Candidates
Type:
array
Title:
Addresses of the Candidates
The addresses resource is a child of the recruitingJobSiteCandidates resource. It provides details about the addresses of the candidates. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
Show Source
Nested Schema : Attachments of the Candidates
Type:
array
Title:
Attachments of the Candidates
The attachments resource is a child of the recruitingJobSiteCandidates resource. It provides details about the documents attached by the candidates. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
Show Source
Nested Schema : Extra Information of the Candidates
Type:
array
Title:
Extra Information of the Candidates
The candidateExtraInformation resource is a child of the recruitingJobSiteCandidates resource. It provides extra information about the candidates. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
Show Source
Nested Schema : Certifications of the Candidates
Type:
array
Title:
Certifications of the Candidates
The certifications resource is a child of the recruitingJobSiteCandidates resource. It provides details about the certifications of the candidates. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
Show Source
Nested Schema : Education of the Candidates
Type:
array
Title:
Education of the Candidates
The educations resource is a child of the recruitingJobSiteCandidates resource. It provides details about the education of the candidates. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
Show Source
Nested Schema : Languages of the Candidates
Type:
array
Title:
Languages of the Candidates
The languages resource is a child of the recruitingJobSiteCandidates resource. It provides details about the languages of the candidates. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : National Identifiers of the Candidates
Type:
array
Title:
National Identifiers of the Candidates
The nationalIdentifiers resource is a child of the recruitingJobSiteCandidates resource. It provides details about the national identifiers of the candidates. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
Show Source
Nested Schema : Phone Numbers of the Candidates
Type:
array
Title:
Phone Numbers of the Candidates
The phones resource is a child of the recruitingJobSiteCandidates resource. It provides details about the phone numbers of candidates. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
Show Source
Nested Schema : Previous Employments of the Candidates
Type:
array
Title:
Previous Employments of the Candidates
The previousEmployments resource is a child of the recruitingJobSiteCandidates resource. It provides details about the work experience of the candidates. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
Show Source
Nested Schema : Skills of the Candidates
Type:
array
Title:
Skills of the Candidates
The skills resource is a child of the recruitingJobSiteCandidates resource. It provides details about the skills of the candidates. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
Show Source
Nested Schema : Work Preferences of the Candidates
Type:
array
Title:
Work Preferences of the Candidates
The workPreferences resource is a child of the recruitingJobSiteCandidates resource. It provides details about the work preferences of the candidates. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
Show Source
Nested Schema : recruitingJobSiteCandidates-addresses-item-response
Type:
Show Source
object
-
AddlAddressAttribute1: string
Maximum Length:
150
Additional address attribute 1 of the candidate address. -
AddlAddressAttribute2: string
Maximum Length:
150
Additional address attribute 2 of the candidate address. -
AddlAddressAttribute3: string
Maximum Length:
150
Additional address attribute 3 of the candidate address. -
AddlAddressAttribute4: string
Maximum Length:
150
Additional address attribute 4 of the candidate address. -
AddlAddressAttribute5: string
Maximum Length:
150
Additional address attribute 5 of the candidate address. -
AddressId: string
Read Only:
true
Identifier of the candidate address. -
AddressLine1: string
Maximum Length:
240
Address line 1 of the candidates address. -
AddressLine2: string
Maximum Length:
240
Address line 2 of the candidates address. -
AddressLine3: string
Maximum Length:
240
Address line 3 of the candidates address. -
Building: string
Maximum Length:
240
Building of the candidate address. -
City: string
Maximum Length:
60
City of the candidate address. -
Country: string
Maximum Length:
60
Country of the candidate address. -
CreatedBy: string
Read Only:
true
Person who created the candidate address. -
CreationDate: string
(date-time)
Read Only:
true
Creation date of the candidate address. -
FloorNumber: string
Maximum Length:
40
Floor number of the candidate address. -
LastUpdateDate: string
(date-time)
Read Only:
true
Last update date of the candidate address. -
LastUpdatedBy: string
Read Only:
true
Person who last updated the candidate address. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LongPostalCode: string
Maximum Length:
30
Long postal code of the candidate address. -
PostalCode: string
Maximum Length:
30
Postal code of the candidate address. -
Region1: string
Maximum Length:
120
Region 1 of the candidate address. -
Region2: string
Maximum Length:
120
Region 2 of the candidate address. -
Region3: string
Maximum Length:
120
Region 3 of the candidate address.
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.
Nested Schema : recruitingJobSiteCandidates-attachments-item-response
Type:
Show Source
object
-
Attachment: string
Information of the candidate attachment.
-
CandidateNumber: string
Candidate number of the candidate attachment.
-
Category: string
Maximum Length:
30
Category of the candidate attachment. -
Description: string
Maximum Length:
255
Description of the candidate attachment. -
FileContents: string
File contents of the candidate attachment.
-
Id: string
Maximum Length:
255
Identifier of the candidate attachment. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MimeType: string
Mime type of the candidate attachment.
-
SourceAttachmentId: integer
Source attachment identifier of the candidate attachment.
-
Title: string
Maximum Length:
80
Title of the candidate attachment. -
Type: string
Type of the candidate attachment.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : recruitingJobSiteCandidates-candidateExtraInformation-item-response
Type:
Show Source
object
-
CandidateNumber: string
Maximum Length:
255
Candidate number of the candidate extra information. -
ContextCode: string
Maximum Length:
255
Context code of the candidate extra information. -
ContextLink: string
Maximum Length:
255
Context link of the candidate extra information. -
DataId: integer
Data identifier of the candidate extra information.
-
dataRows: array
Extra Information Rows of the Candidates
Title:
Extra Information Rows of the Candidates
The dataRows resource is a child of the recruitingJobSiteCandidates resource. It provides rows containing extra information about the candidates. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners. -
links: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : Extra Information Rows of the Candidates
Type:
array
Title:
Extra Information Rows of the Candidates
The dataRows resource is a child of the recruitingJobSiteCandidates resource. It provides rows containing extra information about the candidates. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : recruitingJobSiteCandidates-candidateExtraInformation-dataRows-item-response
Type:
Show Source
object
-
attributes: array
Extra Information Attributes of the Candidates
Title:
Extra Information Attributes of the Candidates
The attributes resource is a child of the recruitingJobSiteCandidates resource. It provides row attributes containing extra information about the candidates. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners. -
ContextRowId: string
Maximum Length:
255
Context row identifier of the candidate extra information data rows. -
ContextRowLink: string
Maximum Length:
255
Context row link of the candidate extra information data rows. -
DataId: integer
Data identifier of the candidate extra information data rows.
-
DataRowId: integer
Data row identifier of the candidate extra information data rows.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
RowAction: string
Maximum Length:
255
Row action that needs to be performed on the candidate extra information data rows.
Nested Schema : Extra Information Attributes of the Candidates
Type:
array
Title:
Extra Information Attributes of the Candidates
The attributes resource is a child of the recruitingJobSiteCandidates resource. It provides row attributes containing extra information about the candidates. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : recruitingJobSiteCandidates-candidateExtraInformation-dataRows-attributes-item-response
Type:
Show Source
object
-
AttributeId: integer
Attribute identifier of the candidate extra information data row attribute.
-
DataRowId: integer
Data row identifier of the candidate extra information data row attribute.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Name: string
Name of the candidate extra information data row attribute.
-
Value: string
Value of the candidate extra information data row attribute.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : recruitingJobSiteCandidates-certifications-item-response
Type:
Show Source
object
-
ActualCompletionDate: string
(date)
Title:
Actual Completion Date
Actual completion date of the candidate certification. -
CertificationId: integer
(int64)
Identifier of the candidate certification.
-
CertificationName: string
Title:
License or Certificate
Maximum Length:240
Certification name of the candidate certification. -
CertificationNumber: string
Title:
Certificate Number
Maximum Length:240
Certification number of the candidate certification. -
CertificationURL: string
Title:
Certification URL
Maximum Length:2000
Certification URL of the candidate certification. -
Comments: string
(byte)
Title:
Comments
Comments about the candidate certification. -
CompletedAmount: integer
(int64)
Title:
Completed Amount
Completed amount of the candidate certification. -
CompletedTrainingUnits: string
Title:
Training Completed Units
Maximum Length:240
Completed training units of the candidate certification. -
ContentItemId: integer
(int64)
Title:
License or Certificate
Content item identifier of the candidate certification. -
CountryCode: string
Title:
Country
Maximum Length:30
Country code of the candidate certification. -
EducationalEstablishment: string
Title:
Educational Establishment
Maximum Length:2000
Educational establishment of the candidate certification. -
EducationalEstablishmentId: integer
(int64)
Title:
Establishment
Educational establishment identifier of the candidate certification. -
ExpirationDate: string
(date)
Title:
Expiration Date
Expiration date of the candidate certification. -
IssueDate: string
(date)
Title:
Issue Date
Issue date of the candidate certification. -
IssuedBy: string
Title:
Issued By
Maximum Length:240
Entity who issued the candidate certification. -
LastRenewalDate: string
(date)
Title:
Last Renewal Date
Last renewal date of the candidate certification. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OriginalIssueYear: integer
(int64)
Title:
Original Issue Year
Original issue year of the candidate certification. -
RenewalDate: string
(date)
Title:
Renewal Date
Renewal date of the candidate certification. -
RenewalInprogressFlag: boolean
Title:
Renewal In Progress
Maximum Length:30
Indicates the renewal in progress indicator of the candidate certification. -
RenewalRequiredFlag: boolean
Title:
Renewal Required
Maximum Length:30
Indicates whether the renewal indicator is required in the candidate certification. -
Restrictions: string
(byte)
Title:
Restrictions
Restrictions of the candidate certification. -
SectionId: integer
(int64)
Section identifier of the candidate certification.
-
StateProvinceCode: string
Title:
State
Maximum Length:360
State province code of the candidate certification. -
Status: string
Title:
Status
Maximum Length:30
Status of the candidate certification. -
Title: string
Title:
Title
Maximum Length:240
Title of the candidate certification. -
TotalAmount: integer
(int64)
Title:
Total Amount
Total amount of the candidate certification. -
VerifiedFlag: boolean
Title:
Verified
Maximum Length:30
Indicates the verified indicator of the candidate education.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : recruitingJobSiteCandidates-educations-item-response
Type:
Show Source
object
-
AcademicStanding: string
Title:
Academic Standing
Maximum Length:30
Academic standing of the candidate education. -
ActivitySummary: string
(byte)
Title:
Summary of Activities
Activity summary of the candidate education. -
AreaOfStudy: string
Title:
Area of Study
Maximum Length:240
Area of study of the candidate education. -
AverageGrade: string
Title:
Average Grade
Maximum Length:240
Average grade of the candidate education. -
AwardingBody: string
Title:
Awarding Body
Maximum Length:240
Awarding body of the candidate education. -
City: string
Title:
City
Maximum Length:240
CIty of the candidate education. -
Comments: string
(byte)
Title:
Comments
Comments of the candidate education. -
CompletedAmount: integer
(int64)
Title:
Completed Amount
Completed amount of the candidate education. -
CompletedTraningUnits: string
Title:
Training Completed Units
Maximum Length:240
Completed training units of the candidate education. -
ContentItemId: integer
(int64)
Title:
Degree
Content item identifier of the candidate education. -
CountryCode: string
Title:
Country
Maximum Length:30
Country code of the candidate education. -
DateAcquired: string
(date)
Title:
Date Acquired
Date acquired of the candidate education. -
DegreeName: string
Title:
Degree
Maximum Length:240
Degree name of the candidate education. -
Department: string
Title:
Faculty or Department
Maximum Length:240
Department of the candidate education. -
Description: string
(byte)
Title:
Description
Description of the candidate education. -
Duration: string
Title:
Duration
Maximum Length:240
Duration of the candidate education. -
DurationUnits: string
Title:
Duration Units
Maximum Length:30
Duration units of the candidate education. -
EducationalEstablishment: string
Title:
School Name
Maximum Length:2000
Educational establishment of the candidate education. -
EducationalEstablishmentId: integer
(int64)
Title:
School
Educational establishment identifier of the candidate education. -
EducationId: integer
(int64)
Education identifier of the candidate education.
-
EducationLevel: string
Title:
Education Level
Maximum Length:30
Education level of the candidate education. -
EducationURL: string
Title:
Education URL
Maximum Length:2000
Education URL of the candidate education. -
Educator: string
Title:
Educator
Maximum Length:240
Educator of the candidate education. -
EduLevelCompletedFlag: boolean
Title:
Education Level Completed
Maximum Length:30
Education level completed indicator of the candidate education. -
EndDate: string
(date)
Title:
End Date
End date of the candidate education. -
Fee: integer
(int64)
Title:
Fee
Fee of the candidate education. -
FeeCurrency: string
Title:
Fee Currency
Maximum Length:30
Fee currency of the candidate education. -
GPA: number
Title:
GPA
GPA of the candidate education. -
GraduatedFlag: boolean
Title:
Graduated
Maximum Length:30
Graduated indicator of the candidate education. -
HighestEduLevel: string
Title:
Highest Education Level
Maximum Length:30
Highest education level of the candidate education. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Major: string
Title:
Major
Maximum Length:240
Major of the candidate education. -
Minor: string
Title:
Minor
Maximum Length:240
Minor of the candidate education. -
PartTimeFlag: boolean
Title:
Part Time
Maximum Length:30
Part time indicator of the candidate education. -
ProjectedCompletionDate: string
(date)
Title:
Projected Completion Date
Projected completion date of the candidate education. -
Reimbursements: string
(byte)
Title:
Reimbursement Arrangements
Reimbursements of the candidate education. -
RequiredFlag: boolean
Title:
Required
Maximum Length:30
Indicates whether the education is required in the candidate education. -
SectionId: integer
(int64)
Section identifier of the candidate education.
-
StartDate: string
(date)
Title:
Start Date
Start date of the candidate education. -
StateProvinceCode: string
Title:
State
Maximum Length:360
State province code of the candidate education. -
Status: string
Title:
Status
Maximum Length:30
Status of the candidate education. -
Title: string
Title:
Title
Maximum Length:240
Title of the candidate education. -
TotalAmount: integer
(int64)
Title:
Total Amount
Total amount of the candidate education. -
TrmnlDegDiscpFlag: boolean
Title:
Terminal Degree for Discipline
Maximum Length:30
Terminal degree discipline indicator of the candidate education. -
TuitionMethod: string
Title:
Tuition Method
Maximum Length:30
Tuition method of the candidate education. -
YearAcquired: integer
(int64)
Title:
Year Acquired
Year acquired of the candidate education.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : recruitingJobSiteCandidates-languages-item-response
Type:
Show Source
object
-
AbleToTeachFlag: boolean
Title:
Able to Teach
Maximum Length:30
Indicates whether the candidate can teach in the candidate language. -
AbleToTranslateFlag: boolean
Title:
Able to Translate
Maximum Length:30
Indicates whether the candidate can translate in the candidate language. -
Comments: string
(byte)
Title:
Comments
Comments in candidate language. -
ContentItemId: integer
(int64)
Title:
Language
Content item identifier in candidate language. -
EvaluatedOn: string
(date)
Title:
Evaluated On
Evaluated on in candidate language. -
EvaluationLocation: string
Title:
Evaluation Location
Maximum Length:240
Evaluation location in candidate language. -
Language: string
Maximum Length:
240
Language in candidate language. -
LanguageId: integer
(int64)
Language identifier in candidate language.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
NativeSpeakerFlag: boolean
Title:
Native
Maximum Length:30
Indicates whether the candidate is a native speaker in the candidate language. -
ReadingLevelId: integer
(int64)
Title:
Reading
Reading level identifier in candidate language. -
ReadingModelId: integer
(int64)
Title:
Reading Rating Model
Reading model identifier in candidate language. -
SectionId: integer
(int64)
Section identifier in candidate language.
-
SpeakingLevelId: integer
(int64)
Title:
Speaking
Speaking level identifier in candidate language. -
SpeakingModelId: integer
(int64)
Title:
Speaking Rating Model
Speaking model identifier in candidate language. -
WritingLevelId: integer
(int64)
Title:
Writing
Writing level identifier in candidate language. -
WritingModelId: integer
(int64)
Title:
Writing Rating Model
Writing model identifier in candidate language.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : recruitingJobSiteCandidates-nationalIdentifiers-item-response
Type:
Show Source
object
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
Person who created the candidate national identifier. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Creation date of the candidate national identifier. -
ExpirationDate: string
(date)
Title:
Expiration Date
Expiration date of the candidate national identifier. -
IssueDate: string
(date)
Title:
Issue Date
Issue date of the candidate national identifier. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
Last update date of the candidate national identifier. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
Person who last updated the candidate national identifier. -
LegislationCode: string
Title:
Country
Maximum Length:30
Legislation code of the candidate national identifier. -
LegislationName: string
Title:
Country
Read Only:true
Maximum Length:80
Legislation name of the candidate national identifier. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
NationalIdentifierId: integer
(int64)
Title:
National Identifier ID
Read Only:true
National identifier ID of the candidate national identifier. -
NationalIdentifierNumber: string
Title:
National ID
Maximum Length:30
National identifier number of the candidate national identifier. -
NationalIdentifierType: string
Title:
National ID Type
Maximum Length:30
National identifier type of the candidate national identifier. -
NationalIdentifierTypeMeaning: string
Title:
National ID Type
Read Only:true
Maximum Length:80
National identifier type meaning of the candidate national identifier. -
PlaceOfIssue: string
Title:
Place of Issue
Maximum Length:30
Place of issue of the candidate national identifier.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : recruitingJobSiteCandidates-phones-item-response
Type:
Show Source
object
-
AreaCode: string
Maximum Length:
30
Area code of the candidate phone. -
CountryCodeNumber: string
Maximum Length:
30
Country code number of the candidate phone. -
CreatedBy: string
Person who created the candidate phone.
-
CreationDate: string
(date-time)
Creation date of the candidate phone.
-
LastUpdateDate: string
(date-time)
Last update date of the candidate phone.
-
LastUpdatedBy: string
Last updated by of the candidate phone.
-
LegislationCode: string
Maximum Length:
4
Legislation code of the candidate phone. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PhoneId: string
Phone identifier of the candidate phone.
-
PhoneNumber: string
Maximum Length:
60
Phone number of the candidate phone.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : recruitingJobSiteCandidates-previousEmployments-item-response
Type:
Show Source
object
-
Achievements: string
(byte)
Title:
Achievements
Achievements of the candidate previous employment. -
AdditionalInformation: string
(byte)
Title:
Additional Information
Additional Information of the candidate previous employment. -
BusinessType: string
Title:
Type of Business
Maximum Length:240
Business type of the candidate previous employment. -
CompanyURL: string
Title:
Company URL
Maximum Length:2000
Company URL of the candidate previous employment. -
ContactSupervisorFlag: boolean
Title:
OK to Contact Supervisor
Maximum Length:30
Contact supervisor indicator in the candidate experience. -
CountryCode: string
Title:
Employer Country
Maximum Length:30
Country code number of the candidate previous employment. -
CurrentJobFlag: boolean
Title:
Current Job
Maximum Length:30
Indicates whether the job is the current job of the candidate in the previous employment. -
Department: string
Title:
Department or Division or Post
Maximum Length:240
Department of the candidate previous employment. -
DirectReports: integer
(int64)
Title:
Direct Reports
Direct reports of the candidate previous employment. -
EmployerCity: string
Title:
Employer City
Maximum Length:240
Employer city of the candidate previous employment. -
EmployerName: string
Title:
Employer Name
Maximum Length:240
Employer name of the candidate previous employment. -
EmployerPhone: string
Title:
Employer Phone
Maximum Length:240
Employer phone of the candidate previous employment. -
EndCompensation: number
Title:
Ending Compensation
End compensation of the candidate previous employment. -
EndDate: string
(date)
Title:
End Date
End date of the candidate previous employment. -
ExperienceInYears: number
Read Only:
true
Experience in years of the candidate previous employment. -
FullTimeCode: string
Title:
Part Time
Maximum Length:30
Full time code of the candidate previous employment. -
InternalFlag: boolean
Title:
Internal
Maximum Length:30
Indicates whether the job is internal in the candidate previous employment. -
JobFamilyId: integer
(int64)
Title:
Job Family
Job family identifier of the candidate previous employment. -
JobFunction: string
Title:
Job Function
Maximum Length:30
Job function of the candidate previous employment. -
JobTitle: string
Title:
Job Title
Maximum Length:240
Job title of the candidate previous employment. -
LeavingReason: string
(byte)
Title:
Reason for Leaving
Leaving reason of the candidate previous employment. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OtherCompensation: string
Title:
Other Compensation
Maximum Length:240
Other compensation of the candidate previous employment. -
OtherJobFunction: string
Title:
Other Job Function
Maximum Length:240
Other job function of the candidate previous employment. -
PreviousEmploymentId: integer
(int64)
Previous employment identifier of the candidate previous employment.
-
Responsibilities: string
(byte)
Title:
Responsibilities
Responsibilities of the candidate previous employment. -
SectionId: integer
(int64)
Section identifier of the candidate previous employment.
-
StartCompensation: number
Title:
Starting Compensation
Start compensation of the candidate previous employment. -
StartDate: string
(date)
Title:
Start Date
Start date of the candidate previous employment. -
StartingPosition: string
Title:
Starting Position
Maximum Length:240
Starting position of the candidate previous employment. -
StateProvinceCode: string
Title:
Employer State or Province
Maximum Length:360
State province code of the candidate previous employment. -
SupervisorEmail: string
Title:
Supervisor Email
Maximum Length:240
Supervisor email of the candidate previous employment. -
SupervisorName: string
Title:
Supervisor Name
Maximum Length:240
Supervisor name of the candidate previous employment. -
SupervisorPhone: string
Title:
Supervisor Phone
Maximum Length:240
Supervisor phone of the candidate previous employment. -
SupervisorTitle: string
Title:
Supervisor Title
Maximum Length:240
Supervisor title of the candidate previous employment.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : recruitingJobSiteCandidates-skills-item-response
Type:
Show Source
object
-
Comments: string
(byte)
Title:
Comments
Comments of a candidate skill. -
DateAchieved: string
(date)
Title:
Date Achieved
Date when the candidate skill was achieved. -
Description: string
(byte)
Title:
Description
Description of a candidate skill. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ProjectName: string
Title:
Project Name or Activities
Maximum Length:2000
Project name of a candidate skill. -
SectionId: integer
(int64)
Section identifier of the candidate skills.
-
Skill: string
Title:
Skill
Maximum Length:240
Description of a candidate skill. -
SkillId: integer
(int64)
Identifier of a candidate skill.
-
Speciality: string
Title:
Skill Type
Maximum Length:30
Specialty or skill type of a candidate skill. -
YearsOfExperience: integer
(int64)
Title:
Years of Experience
Years of experience of a candidate skill.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : recruitingJobSiteCandidates-workPreferences-item-response
Type:
Show Source
object
-
AllLocationsFlag: boolean
Title:
All Locations
Maximum Length:30
Indicates whether all locations are included in the candidate work preferences. -
Comments: string
(byte)
Title:
Comments
Comments of the candidate work preferences. -
ContentItemId: integer
(int64)
Content item identifier of the candidate work preferences.
-
CurrencyCode: string
Title:
Currency Code
Maximum Length:30
Currency code of the candidate work preferences. -
DateFrom: string
(date)
Date from of the candidate work preferences.
-
DateTo: string
(date)
Date to of the candidate work preferences.
-
ExcludedLocationFourId: integer
(int64)
Title:
Fourth Excluded Location
Excluded location four identifier of the candidate work preferences. -
ExcludedLocationOneId: integer
(int64)
Title:
First Excluded Location
Excluded location one identifier of the candidate work preferences. -
ExcludedLocationThreeId: integer
(int64)
Title:
Third Excluded Location
Excluded location three identifier of the candidate work preferences. -
ExcludedLocationTwoId: integer
(int64)
Title:
Second Excluded Location
Excluded location two identifier of the candidate work preferences. -
FlexibleWorkFlag: boolean
Title:
Work a Flexible Schedule
Maximum Length:30
Indicates whether flexible work is required in the candidate work preferences. -
FullTimeEquivalent: number
Title:
Full Time Equivalent
Full time equivalent of the candidate work preferences. -
IntlTravelFlag: boolean
Title:
Travel Internationally
Maximum Length:30
Indicates whether international travel is in the candidate work preferences. -
IntlTravelFrequency: string
Title:
International Travel Frequency
Maximum Length:30
International travel frequency of the candidate work preferences. -
IntlTravelRequiredFlag: boolean
Title:
International Travel Required
Maximum Length:30
Indicates whether international travel is required in the candidate work preferences. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MinimumPay: integer
(int64)
Title:
Minimum Pay
Minimum pay of the candidate work preferences. -
NatTravelFlag: boolean
Title:
Travel Domestically
Maximum Length:30
Indicates whether domestic travel is in the candidate work preferences. -
NatTravelFrequency: string
Title:
Domestic Travel Frequency
Maximum Length:30
National travel frequency of the candidate work preferences. -
NatTravelRequiredFlag: boolean
Title:
Travel Required
Maximum Length:30
Indicates whether domestic travel is required in the candidate work preferences. -
PartAssignFlag: boolean
Title:
Consider Part Time Work
Maximum Length:30
Part assign indicator of the candidate work preferences. -
PayFrequency: string
Title:
Pay Frequency
Maximum Length:30
Pay frequency of the candidate work preferences. -
PayRange: string
Title:
Pay Range
Maximum Length:30
Pay range of the candidate work preferences. -
PreferredLocationFourId: integer
(int64)
Title:
Fourth Preferred Location
Preferred location four identifier of the candidate work preferences. -
PreferredLocationOneId: integer
(int64)
Title:
First Preferred Location
Preferred location one identifier of the candidate work preferences. -
PreferredLocationThreeId: integer
(int64)
Title:
Third Preferred Location
Preferred location three identifier of the candidate work preferences. -
PreferredLocationTwoId: integer
(int64)
Title:
Second Preferred Location
Preferred location two identifier of the candidate work preferences. -
RelocateDuration: integer
(int64)
Title:
Length of Willing to Relocate
Relocate duration of the candidate work preferences. -
RelocateFlag: boolean
Title:
Willing to Relocate
Maximum Length:30
Indicates whether relocation is possible in the candidate work preferences. -
RelocationReason: string
Title:
Relocation Reason
Maximum Length:240
Relocation reason of the candidate work preferences. -
SectionId: integer
(int64)
Section identifier of the candidate work preferences.
-
TempAssignFlag: boolean
Title:
Consider Temporary Assignment
Maximum Length:30
Indicates whether temporary assignment is in the candidate work preferences. -
WorkDays: string
Title:
Workdays
Maximum Length:30
Workdays of the candidate work preferences. -
WorkHours: string
Title:
Work Hours
Maximum Length:30
Work hours of the candidate work preferences. -
WorkMonths: integer
(int64)
Title:
Work Duration Months
Work months of the candidate work preferences. -
WorkPreferenceId: integer
(int64)
Work preference identifier of the candidate work preferences.
-
WorkYears: integer
(int64)
Title:
Work Duration Years
Work years of the candidate work preferences.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- addresses
-
Operation: /hcmRestApi/resources/11.13.18.05/recruitingJobSiteCandidates/{CandidateNumber}/child/addressesParameters:
- CandidateNumber:
$request.path.CandidateNumber
The addresses resource is a child of the recruitingJobSiteCandidates resource. It provides details about the addresses of the candidates. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners. - CandidateNumber:
- attachments
-
Operation: /hcmRestApi/resources/11.13.18.05/recruitingJobSiteCandidates/{CandidateNumber}/child/attachmentsParameters:
- CandidateNumber:
$request.path.CandidateNumber
The attachments resource is a child of the recruitingJobSiteCandidates resource. It provides details about the documents attached by the candidates. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners. - CandidateNumber:
- candidateExtraInformation
-
Parameters:
- CandidateNumber:
$request.path.CandidateNumber
The candidateExtraInformation resource is a child of the recruitingJobSiteCandidates resource. It provides extra information about the candidates. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners. - CandidateNumber:
- certifications
-
Operation: /hcmRestApi/resources/11.13.18.05/recruitingJobSiteCandidates/{CandidateNumber}/child/certificationsParameters:
- CandidateNumber:
$request.path.CandidateNumber
The certifications resource is a child of the recruitingJobSiteCandidates resource. It provides details about the certifications of the candidates. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners. - CandidateNumber:
- educations
-
Operation: /hcmRestApi/resources/11.13.18.05/recruitingJobSiteCandidates/{CandidateNumber}/child/educationsParameters:
- CandidateNumber:
$request.path.CandidateNumber
The educations resource is a child of the recruitingJobSiteCandidates resource. It provides details about the education of the candidates. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners. - CandidateNumber:
- languages
-
Operation: /hcmRestApi/resources/11.13.18.05/recruitingJobSiteCandidates/{CandidateNumber}/child/languagesParameters:
- CandidateNumber:
$request.path.CandidateNumber
The languages resource is a child of the recruitingJobSiteCandidates resource. It provides details about the languages of the candidates. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners. - CandidateNumber:
- nationalIdentifiers
-
Parameters:
- CandidateNumber:
$request.path.CandidateNumber
The nationalIdentifiers resource is a child of the recruitingJobSiteCandidates resource. It provides details about the national identifiers of the candidates. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners. - CandidateNumber:
- phones
-
Operation: /hcmRestApi/resources/11.13.18.05/recruitingJobSiteCandidates/{CandidateNumber}/child/phonesParameters:
- CandidateNumber:
$request.path.CandidateNumber
The phones resource is a child of the recruitingJobSiteCandidates resource. It provides details about the phone numbers of candidates. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners. - CandidateNumber:
- previousEmployments
-
Parameters:
- CandidateNumber:
$request.path.CandidateNumber
The previousEmployments resource is a child of the recruitingJobSiteCandidates resource. It provides details about the work experience of the candidates. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners. - CandidateNumber:
- skills
-
Operation: /hcmRestApi/resources/11.13.18.05/recruitingJobSiteCandidates/{CandidateNumber}/child/skillsParameters:
- CandidateNumber:
$request.path.CandidateNumber
The skills resource is a child of the recruitingJobSiteCandidates resource. It provides details about the skills of the candidates. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners. - CandidateNumber:
- workPreferences
-
Parameters:
- CandidateNumber:
$request.path.CandidateNumber
The workPreferences resource is a child of the recruitingJobSiteCandidates resource. It provides details about the work preferences of the candidates. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners. - CandidateNumber: