Get a job application for recruiting
get
/hcmRestApi/resources/11.13.18.05/recruitingJobApplications/{JobApplicationId}
Request
Path Parameters
-
JobApplicationId(required): integer(int64)
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
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.
There's no request body for this operation.
Back to TopResponse
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 : recruitingJobApplications-item-response
Type:
Show Source
object
-
AppliedToOtherJobs: string
Read Only:
true
Maximum Length:255
Indicates if the candidate has applied to other jobs. -
ApplyFlowVersionId: integer
(int64)
A unique ID for each job application flow.
-
attachments: array
Attachments
Title:
Attachments
The attachments resource is used to view, create, and update attachments. -
CandidateName: string
Title:
Name
Read Only:true
Maximum Length:240
Name of the candidate in the job application. -
CandidatePersonId: integer
(int64)
ID assigned to the candidate who applied for the job.
-
ConfirmedByPersonId: integer
(int64)
ID assigned to the person who has confirmed the job application.
-
ConfirmedDate: string
(date-time)
Date when the job application changed from Unconfirmed to Confirmed.
-
ConfirmedFlag: boolean
Maximum Length:
1
Default Value:false
Indicates confirmation of the job application. -
CreatedBy: string
Read Only:
true
Maximum Length:64
Name of the person who created the job application. -
CreationDate: string
(date-time)
Read Only:
true
Date of creation of the job application. -
DisqualifiedFlag: boolean
Maximum Length:
1
Default Value:false
Indicates that the candidate is disqualified. -
education: array
Education Details
Title:
Education Details
The education resource is a child of recruitingJobApplications. It includes the educational related details in the job application. -
EsignDescriptionVersionId: integer
(int64)
ID assigned to each electronic signature of the candidate.
-
experience: array
Experience Details
Title:
Experience Details
The experience resource is a child of recruitingJobApplications. It includes the experience related details in the job application. -
HiringManagerId: integer
(int64)
Read Only:
true
Hiring manager ID for a job application. -
InternalFlag: boolean
Maximum Length:
1
Indicates that it's an internal job application. -
JobApplicationDate: string
(date-time)
Title:
Application Created Date
Read Only:true
Date of the job application. -
JobApplicationId: integer
(int64)
Unique ID of job application.
-
LanguageCode: string
Title:
Job Application Language
Maximum Length:4
Code assigned for each language. -
languages: array
Language Information
Title:
Language Information
The languages resource is a child of recruitingJobApplications. It includes the candidates language related details in the job application. -
LastModifiedDate: string
(date-time)
Title:
Application Last Modified Date
Read Only:true
Date when the application was last modified. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date when the application was last updated -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
Name of individual who last updated the job application. -
LegalDescriptionVersionId: integer
(int64)
ID for legal description.
-
licensesAndCertificates: array
Licenses and Certificates of the Candidates
Title:
Licenses and Certificates of the Candidates
The licensesAndCertificates resource is a child of recruitingJobApplications. It includes the licenses and certificate details of the candidate. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PhaseId: integer
(int64)
Title:
Phase
ID for phase of job application. -
PhaseName: string
Read Only:
true
Maximum Length:240
Name of each phase of the job application. -
ProcessId: integer
(int64)
Process ID of an application.
-
ProfileId: integer
(int64)
Profile ID of an application.
-
PublicStateId: integer
(int64)
Public state ID of an application.
-
PublicStateName: string
Read Only:
true
Maximum Length:240
Name of the public state of a job application. -
RecruiterId: integer
(int64)
Read Only:
true
Recruiter ID for a job application. -
RequisitionId: integer
(int64)
Requisition ID for a job application.
-
RequisitionIdRest: integer
(int64)
Read Only:
true
Requisition ID 1 for a job application. -
RequisitionNumber: string
Read Only:
true
Maximum Length:240
Requisition number of the job application. -
RequisitionUsageCode: string
Read Only:
true
Maximum Length:30
Default Value:ORA_REQUISITION
Requisition usage code for a job application. -
SiteNumber: string
Maximum Length:
240
Site number of a job application. -
StateId: integer
(int64)
Title:
State
State ID for a job application. -
StateName: string
Read Only:
true
Maximum Length:240
Name of the state of a job application. -
workPreferences: array
Recruiting Work Preferences
Title:
Recruiting Work Preferences
The workPreferences resource is a child of recruitingJobApplications. It includes the work preferences of the candidate.
Nested Schema : Attachments
Type:
array
Title:
Attachments
The attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : Education Details
Type:
array
Title:
Education Details
The education resource is a child of recruitingJobApplications. It includes the educational related details in the job application.
Show Source
Nested Schema : Experience Details
Type:
array
Title:
Experience Details
The experience resource is a child of recruitingJobApplications. It includes the experience related details in the job application.
Show Source
Nested Schema : Language Information
Type:
array
Title:
Language Information
The languages resource is a child of recruitingJobApplications. It includes the candidates language related details in the job application.
Show Source
Nested Schema : Licenses and Certificates of the Candidates
Type:
array
Title:
Licenses and Certificates of the Candidates
The licensesAndCertificates resource is a child of recruitingJobApplications. It includes the licenses and certificate details of the candidate.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Recruiting Work Preferences
Type:
array
Title:
Recruiting Work Preferences
The workPreferences resource is a child of recruitingJobApplications. It includes the work preferences of the candidate.
Show Source
Nested Schema : recruitingJobApplications-attachments-item-response
Type:
Show Source
object
-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker Id
Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document Id
The unique identifier of the attached document. -
CategoryName: string
Title:
Category
Maximum Length:30
The category of the attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:255
The user who created the record. -
CreatedByUserName: string
Title:
Created By User Name
Read Only:true
The user name who created the record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the record was created. -
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
A value that indicates the data type. -
Description: string
Title:
Description
Maximum Length:255
The description of the attachment. -
DmDocumentId: string
Maximum Length:
255
The document ID from which the attachment is created. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
The folder path from which the attachment is created. -
DmVersionNumber: string
Maximum Length:
255
The document version number from which the attachment is created. -
DownloadInfo: string
Title:
DownloadInfo
JSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status Code
The error code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status Message
The error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
The expiration date of the contents in the attachment. -
FileContents: string
(byte)
Title:
File Contents
The contents of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
The file name of the attachment. -
FileUrl: string
Title:
File Url
The URI of the file. -
FileWebImage: string
(byte)
Title:
File Web Image
Read Only:true
The base64 encoded image of the file displayed in .png format if the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
The date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:255
The user who last updated the record. -
LastUpdatedByUserName: string
Title:
Last Updated By User
Read Only:true
The user name who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PostProcessingAction: string
Title:
PostProcessingAction
The name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
Title
The title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
The content type of the attachment. -
UploadedFileLength: integer
Title:
File Size
The size of the attachment file. -
UploadedFileName: string
Title:
Uploaded File Name
The name to assign to a new attachment file. -
UploadedText: string
Title:
Uploaded Text
The text content for a new text attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
The URI of a Topology Manager type attachment. -
Url: string
Title:
Url
Maximum Length:4000
The URL of a web page type attachment. -
UserName: string
Title:
User Name
Read Only:true
Maximum Length:255
The login credentials of the user who created the attachment.
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 : recruitingJobApplications-education-item-response
Type:
Show Source
object
-
AcademicStanding: string
Title:
Academic Standing
Maximum Length:30
Educational academic standing of the candidate. -
ActivitySummary: string
(byte)
Title:
Summary of Activities
Educational activity summary of the candidate. -
AreaOfStudy: string
Title:
Area of Study
Maximum Length:240
Educational area of study of the candidate. -
AverageGrade: string
Title:
Average Grade
Maximum Length:240
Educational average grade of the candidate. -
AwardingBody: string
Title:
Awarding Body
Maximum Length:240
Institution awarding the academic grade. -
City: string
Title:
City
Maximum Length:240
City of education of the candidate. -
Comments: string
(byte)
Title:
Comments
Comments on education. -
CompletedAmount: integer
(int64)
Title:
Completed Amount
Percentage of completion of education. -
CompletedTraningUnits: string
Title:
Training Completed Units
Maximum Length:240
Number of training units completed by the candidate. -
ContentItemId: integer
(int64)
Title:
Degree
ID assigned to each item of education. -
CountryId: integer
(int64)
Title:
Country
ID assigned to the country where the education was completed. -
DateAcquired: string
(date)
Title:
Date Acquired
Date when the educational degree was acquired. -
DegreeName: string
Title:
Degree
Maximum Length:240
Name of the acquired degree -
Department: string
Title:
Faculty or Department
Maximum Length:240
Department of education. -
Description: string
(byte)
Title:
Description
Description of education. -
Duration: string
Title:
Duration
Maximum Length:240
Duration of education. -
DurationUnits: string
Title:
Duration Units
Maximum Length:30
Duration units of education. -
EducationalEstablishment: string
Title:
School Name
Maximum Length:2000
Name of the educational establishment in education. -
EducationalEstablishmentId: integer
(int64)
Title:
School
ID assigned to the educational establishment. -
EducationId: integer
(int64)
ID assigned to the education of the candidate.
-
EducationLevel: string
Title:
Education Level
Maximum Length:30
Level of education acquired by the candidate. -
EducationURL: string
Title:
Education URL
Maximum Length:2000
URL of education. -
Educator: string
Title:
Educator
Maximum Length:240
Name of the educator. -
EduLevelCompletedFlag: boolean
Title:
Education Level Completed
Maximum Length:30
Indicates if the educational level is completed. -
EndDate: string
(date)
Title:
End Date
End date of an education. -
Fee: integer
(int64)
Title:
Fee
Educational fees. -
FeeCurrency: string
Title:
Fee Currency
Maximum Length:30
Currency of the fees in education. -
GPA: number
Title:
GPA
GPA acquired in education. -
GraduatedFlag: boolean
Title:
Graduated
Maximum Length:30
Indicated if the candidate is a graduate. -
HighestEduLevel: string
Title:
Highest Education Level
Maximum Length:30
Highest level of education acquired by the candidate. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Major: string
Title:
Major
Maximum Length:240
Major subject in education. -
Minor: string
Title:
Minor
Maximum Length:240
Minor subject in education. -
PartTimeFlag: boolean
Title:
Part Time
Maximum Length:30
Indicates if the course completed by the candidate is part time. -
ProjectedCompletionDate: string
(date)
Title:
Projected Completion Date
Projected date of completion of education. -
Reimbursements: string
(byte)
Title:
Reimbursement Arrangements
Reimbursements claimed by the candidate for their education. -
RequiredFlag: boolean
Title:
Required
Maximum Length:30
Indicates the educational qualification is mandatory to be mentioned. -
SectionId: integer
(int64)
ID assigned to each educational section.
-
StartDate: string
(date)
Title:
Start Date
Start date of an education. -
StateProvinceId: integer
(int64)
Title:
State
ID assigned to the state or province where the education was availed. -
Status: string
Title:
Status
Maximum Length:30
Status of the education. -
Title: string
Title:
Title
Maximum Length:240
Title of the education. -
TotalAmount: integer
(int64)
Title:
Total Amount
Total amount spent on the education. -
TrmnlDegDiscpFlag: boolean
Title:
Terminal Degree for Discipline
Maximum Length:30
Indicates whether the education item is a terminal degree for the discipline. -
TuitionMethod: string
Title:
Tuition Method
Maximum Length:30
Method of tuition availed. -
YearAcquired: integer
(int64)
Title:
Year Acquired
Year when the degree was attained.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : recruitingJobApplications-experience-item-response
Type:
Show Source
object
-
Achievements: string
(byte)
Title:
Achievements
Achievements made in -
AdditionalInformation: string
(byte)
Title:
Additional Information
Additional information about previous work experience. -
BusinessType: string
Title:
Type of Business
Maximum Length:240
Type of business of the company the candidate worked for. -
CompanyURL: string
Title:
Company URL
Maximum Length:2000
URL of the company. -
ContactSupervisorFlag: boolean
Title:
OK to Contact Supervisor
Maximum Length:30
Indicates if it's the supervisor of the candidate who can be contacted. -
CurrentJobFlag: boolean
Title:
Current Job
Maximum Length:30
Indicates if it's the candidate's current job. -
Department: string
Title:
Department or Division or Post
Maximum Length:240
Name of the department the candidate worked in. -
DirectReports: integer
(int64)
Title:
Direct Reports
Details of the direct reports. -
EmployerCity: string
Title:
Employer City
Maximum Length:240
City of previous employment. -
EmployerCountryId: integer
(int64)
Title:
Employer Country
ID assigned to the country where the candidate was employed. -
EmployerName: string
Title:
Employer Name
Maximum Length:240
Name of the employer. -
EmployerPhone: string
Title:
Employer Phone
Maximum Length:240
Phone of the employer. -
EmployerStateId: integer
(int64)
Title:
Employer State or Province
State ID of the employer. -
EndCompensation: number
Title:
Ending Compensation
Compensation last drawn by the candidate. -
EndDate: string
(date)
Title:
End Date
End date of previous employment. -
ExperienceInYears: number
Read Only:
true
Experience with the previous employer in years. -
FullTimeCode: string
Title:
Part Time
Maximum Length:30
Code assigned for full time employment. -
InternalFlag: boolean
Title:
Internal
Maximum Length:30
Indicates if the job application is internal. -
JobFamilyId: integer
(int64)
Title:
Job Family
ID assigned to the previous job family. -
JobFunction: string
Title:
Job Function
Maximum Length:30
Function of the previous job. -
JobTitle: string
Title:
Job Title
Maximum Length:240
Title held in the previous job. -
LeavingReason: string
(byte)
Title:
Reason for Leaving
Reason to leave the previous job. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OtherCompensation: string
Title:
Other Compensation
Maximum Length:240
Additional compensation availed from previous job. -
OtherJobFunction: string
Title:
Other Job Function
Maximum Length:240
Additional functions assigned in the previous job. -
PreviousEmploymentId: integer
(int64)
ID assigned to the previous employer.
-
Responsibilities: string
(byte)
Title:
Responsibilities
Responsibilities undertaken in the previous job. -
SectionId: integer
(int64)
ID assigned to each section in previous work experience.
-
StartCompensation: number
Title:
Starting Compensation
Compensation drawn at the beginning of previous job. -
StartDate: string
(date)
Title:
Start Date
Start date of the previous job. -
StartingPosition: string
Title:
Starting Position
Maximum Length:240
Position held in the previous job. -
SupervisorEmail: string
Title:
Supervisor Email
Maximum Length:240
Email of the supervisor who can be contacted. -
SupervisorName: string
Title:
Supervisor Name
Maximum Length:240
Name of the supervisor in the previous job. -
SupervisorPhone: string
Title:
Supervisor Phone
Maximum Length:240
Phone number of the supervisor in the previous job. -
SupervisorTitle: string
Title:
Supervisor Title
Maximum Length:240
Title of the supervisor in the previous job.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : recruitingJobApplications-languages-item-response
Type:
Show Source
object
-
AbleToTeachFlag: boolean
Title:
Able to Teach
Maximum Length:30
Indicates if the candidate can teach the language. -
AbleToTranslateFlag: boolean
Title:
Able to Translate
Maximum Length:30
Indicates if the candidate can translate the language. -
Comments: string
(byte)
Title:
Comments
Additional comments about the knowledge in language. -
ContentItemId: integer
(int64)
Title:
Language
ID assigned to each item in the languages section. -
EvaluatedOn: string
(date)
Title:
Evaluated On
Specifics on which the language proficiency of the candidate is evaluated. -
EvaluationLocation: string
Title:
Evaluation Location
Maximum Length:240
Location where the language evaluation was conducted. -
Language: string
Maximum Length:
240
Language name. -
LanguageId: integer
(int64)
ID assigned each language known to the candidate.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
NativeSpeakerFlag: boolean
Title:
Native
Maximum Length:30
Indicates if the candidate is a native speaker of the language. -
ReadingLevelId: integer
(int64)
Title:
Reading
ID assigned to the language reading level of the candidate. -
ReadingModelId: integer
(int64)
Title:
Reading Rating Model
ID assigned to the language reading mode. -
SectionId: integer
(int64)
ID assigned to each section of language.
-
SpeakingLevelId: integer
(int64)
Title:
Speaking
ID assigned to the language speaking level of the candidate. -
SpeakingModelId: integer
(int64)
Title:
Speaking Rating Model
ID assigned to the language speaking mode. -
WritingLevelId: integer
(int64)
Title:
Writing
ID assigned to the language writing level of the candidates. -
WritingModelId: integer
(int64)
Title:
Writing Rating Model
ID assigned to the language writing mode.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : recruitingJobApplications-licensesAndCertificates-item-response
Type:
Show Source
object
-
ActualCompletionDate: string
(date)
Title:
Actual Completion Date
Actual completion date of the course. -
CertificationId: integer
(int64)
ID assigned to the licenses or certifications acquired by the candidate.
-
CertificationName: string
Title:
License or Certificate
Maximum Length:240
Name of the licenses or certifications acquired by the candidate. -
CertificationNumber: string
Title:
Certificate Number
Maximum Length:240
Number of the licenses or certifications acquired by the candidate. -
CertificationURL: string
Title:
Certification URL
Maximum Length:2000
URL of the licenses or certifications acquired by the candidate. -
Comments: string
(byte)
Title:
Comments
Additional comments on the licenses and certifications acquired by the candidate. -
CompletedAmount: integer
(int64)
Title:
Completed Amount
Percentage of completion of the course. -
CompletedTrainingUnits: string
Title:
Training Completed Units
Maximum Length:240
Completed training units of the course. -
ContentItemId: integer
(int64)
Title:
License or Certificate
ID assigned to each item in the licenses and certificates section. -
CountryId: integer
(int64)
Title:
Country
ID assigned to the country where the course was done. -
EducationalEstablishment: string
Title:
Educational Establishment
Maximum Length:2000
Name of the educational establishment that conducted the course. -
EducationalEstablishmentId: integer
(int64)
Title:
Establishment
ID assigned to the educational establishment that conducted the course. -
ExpirationDate: string
(date)
Title:
Expiration Date
Expiration date of the licenses and certificates held by the candidate. -
IssueDate: string
(date)
Title:
Issue Date
Date when the licenses and certificates were issued. -
IssuedBy: string
Title:
Issued By
Maximum Length:240
Authority issuing the licenses and certificates. -
LastRenewalDate: string
(date)
Title:
Last Renewal Date
Last date when the licenses and certificates were renewed. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OriginalIssueYear: integer
(int64)
Title:
Original Issue Year
Year when the licenses and certificates were originally issues. -
RenewalDate: string
(date)
Title:
Renewal Date
Renewal date for the licenses and certificates. -
RenewalInprogressFlag: boolean
Title:
Renewal In Progress
Maximum Length:30
Indicates if the licenses and certificates renewal is in progress. -
RenewalRequiredFlag: boolean
Title:
Renewal Required
Maximum Length:30
Indicates if the licenses and certificates must be renewed. -
Restrictions: string
(byte)
Title:
Restrictions
Restrictions associated with the licenses and certificates. -
SectionId: integer
(int64)
ID assigned to each section of the licenses and certificates.
-
StateProvinceId: integer
(int64)
Title:
State
ID assigned to the state or province where the licenses and certificates were issues. -
Status: string
Title:
Status
Maximum Length:30
Status of the licenses and certifications. -
Title: string
Title:
Title
Maximum Length:240
Title of the licenses and certifications. -
TotalAmount: integer
(int64)
Title:
Total Amount
Total cost incurred for the licenses and certifications. -
VerifiedFlag: boolean
Title:
Verified
Maximum Length:30
Indicates that the licenses and certificates are verified.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : recruitingJobApplications-workPreferences-item-response
Type:
Show Source
object
-
AllLocationsFlag: boolean
Title:
All Locations
Maximum Length:30
Indicates candidate is ready to work from any location. -
Comments: string
(byte)
Title:
Comments
Additional comments for work preferences. -
ContentItemId: integer
(int64)
ID assigned to each content item of work preference.
-
CurrencyCode: string
Title:
Currency Code
Maximum Length:30
Currency code of the preferred location. -
DateFrom: string
(date)
Start date of the work preference.
-
DateTo: string
(date)
End date of the work preference.
-
ExcludedLocationFourId: integer
(int64)
Title:
Fourth Excluded Location
ID for the fourth option for excluded location. -
ExcludedLocationOneId: integer
(int64)
Title:
First Excluded Location
ID for the first option for excluded location. -
ExcludedLocationThreeId: integer
(int64)
Title:
Third Excluded Location
ID for the third option for excluded location. -
ExcludedLocationTwoId: integer
(int64)
Title:
Second Excluded Location
ID for the second option for excluded location. -
FlexibleWorkFlag: boolean
Title:
Work a Flexible Schedule
Maximum Length:30
Indicates if flexible work option is available for the job. -
FullTimeEquivalent: number
Title:
Full Time Equivalent
Indicates if full time is required. -
IntlTravelFlag: boolean
Title:
Travel Internationally
Maximum Length:30
Indicates if international travel is required for the job. -
IntlTravelFrequency: string
Title:
International Travel Frequency
Maximum Length:30
Frequency of the international travel. -
IntlTravelRequiredFlag: boolean
Title:
International Travel Required
Maximum Length:30
Indicates if international travel is mandatory for the job. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MinimumPay: integer
(int64)
Title:
Minimum Pay
Minimum pay allocated to the job. -
NatTravelFlag: boolean
Title:
Travel Domestically
Maximum Length:30
Indicates if domestic travel is required for the job. -
NatTravelFrequency: string
Title:
Domestic Travel Frequency
Maximum Length:30
Frequency of the domestic travel. -
NatTravelRequiredFlag: boolean
Title:
Travel Required
Maximum Length:30
Indicates if domestic travel is mandatory for the job. -
PartAssignFlag: boolean
Title:
Consider Part Time Work
Maximum Length:30
Indicates if the candidate has opted for a part time job assignment. -
PayFrequency: string
Title:
Pay Frequency
Maximum Length:30
Frequency of payment for the part time assignment. -
PayRange: string
Title:
Pay Range
Maximum Length:30
Candidate's pay range. -
PreferredLocationFourId: integer
(int64)
Title:
Fourth Preferred Location
Fourth option for the preferred location. -
PreferredLocationOneId: integer
(int64)
Title:
First Preferred Location
First option for the preferred location. -
PreferredLocationThreeId: integer
(int64)
Title:
Third Preferred Location
Third option for the preferred location -
PreferredLocationTwoId: integer
(int64)
Title:
Second Preferred Location
Second option for the preferred location. -
RelocateDuration: integer
(int64)
Title:
Length of Willing to Relocate
Duration for which candidate wants to be relocated. -
RelocateFlag: boolean
Title:
Willing to Relocate
Maximum Length:30
Indicates that candidate has opted for relocation. -
RelocationReason: string
Title:
Relocation Reason
Maximum Length:240
Reason why the candidate has opted for relocation. -
SectionId: integer
(int64)
ID assigned to each section of work preferences.
-
TempAssignFlag: boolean
Title:
Consider Temporary Assignment
Maximum Length:30
Indicates if the job assignment is for a temporary period. -
WorkDays: string
Title:
Work Days
Maximum Length:30
Number of work days for the temporary work period. -
WorkHours: string
Title:
Work Hours
Maximum Length:30
Number of work hours for the temporary work period. -
WorkMonths: integer
(int64)
Title:
Work Duration Months
Number of work months for the temporary work period. -
WorkPreferenceId: integer
(int64)
ID assigned to the candidate's work preference.
-
WorkYears: integer
(int64)
Title:
Work Duration Years
Number of work years for the temporary work period.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- attachments
-
Operation: /hcmRestApi/resources/11.13.18.05/recruitingJobApplications/{JobApplicationId}/child/attachmentsParameters:
- JobApplicationId:
$request.path.JobApplicationId
The attachments resource is used to view, create, and update attachments. - JobApplicationId:
- confirm
-
Operation: /hcmRestApi/resources/11.13.18.05/recruitingJobApplications/{JobApplicationId}/action/confirmParameters:
- JobApplicationId:
$request.path.JobApplicationId
Action That Allows a Member of the Hiring Team to Confirm a Job Application on Behalf of a Candidate - JobApplicationId:
- education
-
Operation: /hcmRestApi/resources/11.13.18.05/recruitingJobApplications/{JobApplicationId}/child/educationParameters:
- JobApplicationId:
$request.path.JobApplicationId
The education resource is a child of recruitingJobApplications. It includes the educational related details in the job application. - JobApplicationId:
- experience
-
Operation: /hcmRestApi/resources/11.13.18.05/recruitingJobApplications/{JobApplicationId}/child/experienceParameters:
- JobApplicationId:
$request.path.JobApplicationId
The experience resource is a child of recruitingJobApplications. It includes the experience related details in the job application. - JobApplicationId:
- jobRequisitionsLOV
-
The following properties are defined on the LOV link relation:
- Source Attribute: RequisitionId; Target Attribute: RequisitionId
- Display Attribute: RequisitionId
- languages
-
Operation: /hcmRestApi/resources/11.13.18.05/recruitingJobApplications/{JobApplicationId}/child/languagesParameters:
- JobApplicationId:
$request.path.JobApplicationId
The languages resource is a child of recruitingJobApplications. It includes the candidates language related details in the job application. - JobApplicationId:
- licensesAndCertificates
-
Parameters:
- JobApplicationId:
$request.path.JobApplicationId
The licensesAndCertificates resource is a child of recruitingJobApplications. It includes the licenses and certificate details of the candidate. - JobApplicationId:
- move
-
Operation: /hcmRestApi/resources/11.13.18.05/recruitingJobApplications/{JobApplicationId}/action/moveParameters:
- JobApplicationId:
$request.path.JobApplicationId
Action That Allows a Member of the Hiring Team to Move an Application to a Specific Phase and State - JobApplicationId:
- sendConfirmationRequest
-
Parameters:
- JobApplicationId:
$request.path.JobApplicationId
Action That Allows a Member of the Hiring Team to Resend a Notification to a Candidate Requesting Them to Confirm Their Job Application - JobApplicationId:
- withdraw
-
Operation: /hcmRestApi/resources/11.13.18.05/recruitingJobApplications/{JobApplicationId}/action/withdrawParameters:
- JobApplicationId:
$request.path.JobApplicationId
Action That Allows a Member of the Hiring Team to Withdraw a Job Application on Behalf of the Candidate - JobApplicationId:
- workPreferences
-
Operation: /hcmRestApi/resources/11.13.18.05/recruitingJobApplications/{JobApplicationId}/child/workPreferencesParameters:
- JobApplicationId:
$request.path.JobApplicationId
The workPreferences resource is a child of recruitingJobApplications. It includes the work preferences of the candidate. - JobApplicationId: