Get all job applications
get
/hcmRestApi/resources/11.13.18.05/recruitingCEJobApplications
Request
Query Parameters
-
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 -
finder: string
Used as a predefined finder to search the collection.
Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables- PrimaryKey Finds the job application using a unique ID
Finder Variables- CandidateNumber; string; Finds a job application using the candidate number
- RequisitionNumber; string; Finds a job application using the requisition number
- findByRequisitionNumber Finds all job applications using the requisition number.
Finder Variables- RequisitionNumber; string; Requisition number used to find a job application.
- findBySubmissionId Finds the job application using a unique ID
Finder Variables- SubmissionId; integer; Finds the job application using the job application ID.
- findConfirmedEligibleApplications Finds all confirmed eligible job applications using the person ID.
Finder Variables
- PrimaryKey Finds the job application using a unique ID
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
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 -
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2
You can use these queryable attributes to filter this collection resource using the q query parameter:- APPDraftId; integer; Unique identifier for each job application draft.
- Action; string; Action taken after each submission.
- ActiveFlag; boolean; Indicates if the submission is active.
- AssessmentsFlag; boolean; Indicates if assessments are required on each submission.
- CandidateNumber; string; Number assigned to each candidate who submits a job application.
- ConfirmedFlag; boolean; Indicates if the candidate is confirmed.
- CurrentPhaseId; integer; ID assigned to the current phase of the job submission.
- CurrentStateId; integer; ID assigned to the current state of the job submission.
- Email; string; Email of the candidate that submitted a job application.
- EsignDescriptionVersionId; integer; Version ID assigned to the electronic signature of the job application.
- FlowVersionId; integer; ID assigned to the job application work flow.
- JobLocation; integer; Job location of the candidate.
- JobLocationName; string; Name of the job location where the candidate submitted the application.
- JobTitle; string; Job title of the candidate.
- LegalDescriptionVersionId; integer; ID assigned to the version legal description of the submission.
- MiscAttachmentIds; string; IDs of the miscellaneous attachments uploaded by the candidate.
- Name; string; Name of the candidate that submitted a job application.
- OfferId; integer; ID of the job offer extended for a specific job application.
- PipelineRequisitionFlag; boolean; Indicates if the submission is a pipeline requisition.
- PipelineSubmissionId; integer; ID assigned to a pipeline job requisition submission.
- PreferredLanguage; string; Preferred language in which the job application was submitted.
- ReferralId; integer; ID assigned to each referral mentioned in the recruitingCEJobApplications.
- RemainingSubmissions; integer; Pending submission of the job application.
- RequisitionNumber; string; Number assigned to each job requisition.
- ShareId; integer; ID assigned to a shared job application.
- SiteNumber; string; Site number assigned to each submission.
- Status; string; Status of the job application submission.
- SubmissionDate; string; Date of submission of job application.
- SubmissionId; integer; ID assigned for each job application submitted.
- TaxCreditsFlag; boolean; Indicates if tax credits are required on each job application.
-
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
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 : recruitingCEJobApplications
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : recruitingCEJobApplications-item-response
Type:
Show Source
object
-
Action: string
Action taken after each submission.
-
ActiveFlag: boolean
Read Only:
true
Indicates if the submission is active. -
APPDraftId: integer
Unique identifier for each job application draft.
-
assessmentLinks: array
Assessment Links
Title:
Assessment Links
The assessmentLinks resource is a child of recruitingCEJobApplications. It provides the links to go to assessment partner sites. Note that the service endpoints in this resource category are only for Oracle internal use. -
AssessmentsFlag: boolean
Read Only:
true
Indicates if assessments are required on each submission. -
BackgroundCheckLinks: array
Background Check Links
Title:
Background Check Links
The backgroundCheckLinks resource is a child of recruitingCEJobApplications. It provides the links to go to background check partner sites. Note that the service endpoints in this resource category are only for Oracle internal use. -
CandidateNumber: string
Maximum Length:
255
Number assigned to each candidate who submits a job application. -
ConfirmedFlag: boolean
Maximum Length:
255
Indicates if the candidate is confirmed. -
CurrentPhaseId: integer
Read Only:
true
ID assigned to the current phase of the job submission. -
CurrentStateId: integer
Read Only:
true
ID assigned to the current state of the job submission. -
Email: string
Email of the candidate that submitted a job application.
-
EsignDescriptionVersionId: integer
Version ID assigned to the electronic signature of the job application.
-
FlowVersionId: integer
ID assigned to the job application work flow.
-
JobLocation: integer
Job location of the candidate.
-
JobLocationName: string
Read Only:
true
Name of the job location where the candidate submitted the application. -
JobTitle: string
Job title of the candidate.
-
LegalDescriptionVersionId: integer
ID assigned to the version legal description of the submission.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MiscAttachmentIds: string
IDs of the miscellaneous attachments uploaded by the candidate.
-
Name: string
Name of the candidate that submitted a job application.
-
OfferId: integer
Read Only:
true
ID of the job offer extended for a specific job application. -
PipelineRequisitionFlag: boolean
Read Only:
true
Indicates if the submission is a pipeline requisition. -
PipelineSubmissionId: integer
Read Only:
true
ID assigned to a pipeline job requisition submission. -
PreferredLanguage: string
Preferred language in which the job application was submitted.
-
preferredLocations: array
Preferred Job Locations
Title:
Preferred Job Locations
The preferredLocations resource is a child of recruitingCEJobApplications. It includes all the preferred locations of the job. Note that the service endpoints in this resource category are only for Oracle internal use. -
questionnaireResponses: array
Candidate Responses to Questions
Title:
Candidate Responses to Questions
The questionnaireResponses resource provides the details of responses provided by the candidate for a questionnaire. -
ReferralId: integer
ID assigned to each referral mentioned in the recruitingCEJobApplications.
-
regulatoryResponses: array
Recruiting Candidate Responses to Regulatory Questions
Title:
Recruiting Candidate Responses to Regulatory Questions
The recruitingCERegulatoryResponses resource includes the regulatory related response details. Note that the service endpoints in this resource category are only for Oracle internal use. -
RemainingSubmissions: integer
Pending submission of the job application.
-
RequisitionNumber: string
Number assigned to each job requisition.
-
ScheduleInterviews: array
Schedule Job Interviews
Title:
Schedule Job Interviews
The ScheduleInterviews resource is a child of recruitingCEJobApplications. It includes all details about the scheduled interviews. Note that the service endpoints in this resource category are only for Oracle internal use. -
secondarySubmissions: array
Secondary Job Submissions
Title:
Secondary Job Submissions
The secondaryrecruitingCEJobApplications resource includes all the secondary job applications. Note that the service endpoints in this resource category are only for Oracle internal use. - ShareId: integer
-
SiteNumber: string
Site number assigned to each submission.
-
Status: string
Status of the job application submission.
-
SubmissionDate: string
(date-time)
Date of submission of job application.
-
SubmissionId: integer
ID assigned for each job application submitted.
-
TaxCreditsFlag: boolean
Read Only:
true
Indicates if tax credits are required on each job application. -
UnscheduledInterviewRequests: array
Unscheduled Job Interviews
Title:
Unscheduled Job Interviews
The UnScheduleInterviewRequests resource is the child of the recruitingMyJobApplications resource in opportunity marketplace. It includes all the details about the unscheduled interview requests.
Nested Schema : Assessment Links
Type:
array
Title:
Assessment Links
The assessmentLinks resource is a child of recruitingCEJobApplications. It provides the links to go to assessment partner sites. Note that the service endpoints in this resource category are only for Oracle internal use.
Show Source
Nested Schema : Background Check Links
Type:
array
Title:
Background Check Links
The backgroundCheckLinks resource is a child of recruitingCEJobApplications. It provides the links to go to background check partner sites. Note that the service endpoints in this resource category are only for Oracle internal use.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Preferred Job Locations
Type:
array
Title:
Preferred Job Locations
The preferredLocations resource is a child of recruitingCEJobApplications. It includes all the preferred locations of the job. Note that the service endpoints in this resource category are only for Oracle internal use.
Show Source
Nested Schema : Candidate Responses to Questions
Type:
array
Title:
Candidate Responses to Questions
The questionnaireResponses resource provides the details of responses provided by the candidate for a questionnaire.
Show Source
Nested Schema : Recruiting Candidate Responses to Regulatory Questions
Type:
array
Title:
Recruiting Candidate Responses to Regulatory Questions
The recruitingCERegulatoryResponses resource includes the regulatory related response details. Note that the service endpoints in this resource category are only for Oracle internal use.
Show Source
Nested Schema : Schedule Job Interviews
Type:
array
Title:
Schedule Job Interviews
The ScheduleInterviews resource is a child of recruitingCEJobApplications. It includes all details about the scheduled interviews. Note that the service endpoints in this resource category are only for Oracle internal use.
Show Source
Nested Schema : Secondary Job Submissions
Type:
array
Title:
Secondary Job Submissions
The secondaryrecruitingCEJobApplications resource includes all the secondary job applications. Note that the service endpoints in this resource category are only for Oracle internal use.
Show Source
Nested Schema : Unscheduled Job Interviews
Type:
array
Title:
Unscheduled Job Interviews
The UnScheduleInterviewRequests resource is the child of the recruitingMyJobApplications resource in opportunity marketplace. It includes all the details about the unscheduled interview requests.
Show Source
Nested Schema : recruitingCEJobApplications-assessmentLinks-item-response
Type:
Show Source
object
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PartnerName: string
Partner name of the assessment link.
-
ProvisioningId: integer
Provisioning ID of the assessment link.
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 : recruitingCEJobApplications-BackgroundCheckLinks-item-response
Type:
Show Source
object
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PartnerName: string
Read Only:
true
Maximum Length:300
Partner name of the background check link. -
ProvisioningId: integer
Read Only:
true
Provisioning ID of the background check link.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : recruitingCEJobApplications-preferredLocations-item-response
Type:
Show Source
object
-
JaPreferredLocationId: integer
(int64)
ID assigned to the preferred location mentioned in the job application.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LocationId: integer
(int64)
ID assigned to the preferred location.
-
LocationType: string
Maximum Length:
1
Type of preferred location. -
SubmissionId: integer
(int64)
ID assigned to each submission of the preferred location.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : recruitingCEJobApplications-questionnaireResponses-item-response
Type:
Show Source
object
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
QstnrVersionNumber: integer
Version number of the questionnaire for which the responses are provided.
-
QuestionnaireId: integer
ID of the questionnaire for which the responses are provided
-
QuestionResponses: string
Responses provided by the candidate for the questionnaire.
-
Type: string
Type of the questionnaire for which the responses are provided.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : recruitingCEJobApplications-regulatoryResponses-item-response
Type:
Show Source
object
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
RegulatoryResponses: string
Response for a regulatory.
-
RequisitionNumber: string
Maximum Length:
255
A number specific to requisition. -
Status: string
Status of a regulatory response.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : recruitingCEJobApplications-ScheduleInterviews-item-response
Type:
Show Source
object
-
IntrvwRequestsId: integer
(int64)
ID assigned to each scheduled interview request.
-
IsReschedulable: string
Read Only:
true
Indicates if the interview is rescheduled. -
IsScheduled: string
Read Only:
true
Maximum Length:1
Indicates if the interview is scheduled. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ScheduleId: integer
(int64)
Read Only:
true
ID assigned to each interview schedule. -
ScheduleInterviewId: integer
(int64)
Read Only:
true
ID assigned to each scheduled interview. -
SubmissionId: integer
(int64)
ID assigned to the submission of the interview schedules.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : recruitingCEJobApplications-secondarySubmissions-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
Individual who created the secondary job application. -
CreationDate: string
(date-time)
Read Only:
true
Date of creation of the secondary job application. -
EsignDescriptionVersionId: integer
(int64)
ID assigned to the description of the electronic signature version for the secondary job application.
-
FlowId: integer
ID assigned to the work flow of the secondary job application.
-
FlowVersionId: integer
(int64)
ID assigned to the secondary job application work flow.
-
LastUpdateDate: string
(date-time)
Read Only:
true
Date of last update for the secondary job application. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
Last updated by information for the secondary job application. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
Last update login information for the secondary job application. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
SecFlowSubmDate: string
(date-time)
Date when the secondary job application workflow was submitted.
-
SecFlowTriggerDate: string
(date-time)
Date when the secondary job application workflow was triggered.
-
SecFlowTriggeredBy: string
Maximum Length:
64
Secondary workflow triggered by the secondary job application. -
SecondaryFlowId: integer
(int64)
ID assigned to the secondary job application workflow.
-
StatusCode: string
Maximum Length:
32
Code assigned to the status of the secondary job application. -
StepActionUsageId: integer
(int64)
ID assigned to the step action usage for the secondary job application.
-
SubmissionId: integer
(int64)
ID assigned to each secondary job application.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : recruitingCEJobApplications-UnscheduledInterviewRequests-item-response
Type:
Show Source
object
-
InterviewId: integer
(int64)
Title:
Interview ID
Read Only:true
ID assigned to each unscheduled interview. -
IntrvwRequestsId: integer
(int64)
Title:
Interview Request ID
Read Only:true
ID assigned to each unscheduled interview request. -
IntrvwRschldCount: integer
(int32)
Title:
Number of Interview Reschedules
Read Only:true
Count of rescheduled interviews. -
IsRschldRqsted: string
Title:
Reschedule Requested Flag
Read Only:true
Maximum Length:1
Indicates if a reschedule of the interview is requested. -
IsSchedulable: string
Title:
Can Schedule
Read Only:true
Maximum Length:255
Indicates if the unscheduled interview can be scheduled. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ScheduleId: integer
(int64)
Title:
Interview Schedule ID
Read Only:true
Schedule ID assigned to each unscheduled interview request. -
SubmissionId: integer
(int64)
Title:
Interview Submission ID
Read Only:true
Job application ID assigned to each unscheduled interview request.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source