Get all job applications

get

/hcmRestApi/resources/11.13.18.05/recruitingCEJobApplications

Request

Query Parameters
  • 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).
  • 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
  • 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
    • 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.
    • 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
    • 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.
    • The resource item payload will be filtered in order to contain only data (no links section, for example).
    • 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
    • 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.
    • 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
    • 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".
    • 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 Top

    Response

    Supported Media Types

    Default Response

    The following table describes the default response for this task.
    Headers
    • 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".
    • 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.
    Body ()
    Root Schema : recruitingCEJobApplications
    Type: object
    Show Source
    Nested Schema : Items
    Type: array
    Title: Items
    The items in the collection.
    Show Source
    Nested Schema : recruitingCEJobApplications-item-response
    Type: object
    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-preferredLocations-item-response
    Type: object
    Show Source
    Nested Schema : recruitingCEJobApplications-questionnaireResponses-item-response
    Type: object
    Show Source
    Nested Schema : recruitingCEJobApplications-regulatoryResponses-item-response
    Type: object
    Show Source
    Nested Schema : recruitingCEJobApplications-ScheduleInterviews-item-response
    Type: object
    Show Source
    Nested Schema : recruitingCEJobApplications-secondarySubmissions-item-response
    Type: object
    Show Source
    Nested Schema : recruitingCEJobApplications-UnscheduledInterviewRequests-item-response
    Type: object
    Show Source
    Back to Top