Get details about all job applications

get

/hcmRestApi/resources/11.13.18.05/recruitingUIJobApplications

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 all job applications by primary key.
      Finder Variables
      • SubmissionId; integer; Primary key and job application identifiers used to find job applications.
    • findByRequisitionAndCandidateNumber Finds all job applications by requisition number and candidate number.
      Finder Variables
      • CandidateNumber; string; Candidate number used to find job applications.
      • RequisitionNumber; string; Requisition number used to find job applications.
    • findByRequisitionAndPersonId Finds all job applications by requisition identifier and person identifier.
      Finder Variables
      • PersonId; integer; Person identifier used to find job applications.
      • RequisitionId; integer; Requisition identifier used to find job applications.
    • findBySubmissionId Finds all job applications by job application identifier.
      Finder Variables
      • SubmissionId; integer; Job application identifier used to find job applications.
  • 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:
    • ActiveFlag; boolean; Active job application indicator.
    • ActiveOnAnotherRequisitionFlag; boolean; Job application active on another requisition indicator.
    • AgentFirstName; string; Agent first name.
    • AgentLastName; string; Agent last name.
    • AttachmentEntityName; string; Name of the entity to which an attachment is associated.
    • AverageFeedbackRating; number; Average feedback rating.
    • AverageRating; number; Average rating.
    • CandidateNumber; string; Candidate number.
    • CandidateWorkSummary; string; Candidate work summary.
    • CategoryCode; string; Category code.
    • ConfirmedFlag; boolean; Confirmed job application indicator.
    • CreationDate; string; Job application creation date.
    • CurrentPhaseId; integer; Current candidate selection process phase identifier.
    • CurrentPhaseName; string; Current candidate selection process phase name.
    • CurrentStateId; integer; Current candidate selection process state identifier.
    • CurrentStateName; string; Current candidate selection process state name.
    • DisqualifiedFlag; boolean; Disqualified job application indicator.
    • EmployeeDisplayName; string; Employee display name.
    • EmployerName; string; Employer name.
    • EndingPosition; string; Ending position.
    • FavoriteFlag; boolean; Favorite job application indicator.
    • FeedbackRatingCount; integer; Number of feedback ratings received for the job application.
    • FlowVersionId; integer; Application flow version identifier.
    • InteractionType; string; Interaction type.
    • InternalFlag; boolean; Internal job application indicator.
    • LastContacted; integer; Candidate last contacted date.
    • OfferId; integer; Job offer identifier.
    • PersonId; integer; Person identifier.
    • ProcessId; integer; Process identifier.
    • ProfileId; integer; Profile identifier.
    • ProspectId; integer; Identifier of the prospect associated with the application.
    • ProspectTypeCode; string; Prospect type code.
    • QstnrScore; number; Questionnaire score.
    • Rank; integer; Rank number.
    • RankedBy; string; Display name of user who ranked the job application.
    • ReappliedFlag; boolean; Reapplied indicator.
    • ReferralId; integer; Referral identifier.
    • ReferralResumeDatatypeCode; string; Datatype code for the referral resume.
    • ReferralResumeFileName; string; Value that indicates data type code of attachment.
    • ReferralResumePreviewURL; string; File name of the attachment.
    • RequisitionId; integer; URL of the attachment.
    • RequisitionNumber; string; Job requisition number.
    • RequisitionTitle; string; Job requisition title.
    • StartingPosition; string; Starting position.
    • SubmissionConfirmedDate; string; Job application confirmed date.
    • SubmissionDate; string; Job application submitted date.
    • SubmissionId; integer; Job application identifier.
    • SystemPersonType; string; System person type.
    • SystemPersonTypeName; string; System person type name.
    • Total; number; Total value associated with the job application.
    • isReferredByAgentFlag; boolean; Candidate referred by agent indicator.
    • isReferredByEmployeeFlag; boolean; Candidate referred by employee indicator.
  • 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 : recruitingUIJobApplications
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : recruitingUIJobApplications-item-response
Type: object
Show Source
Nested Schema : Candidate Attachments
Type: array
Title: Candidate Attachments
The InternalAttachments resource provides information about files attached by the recruiting team.
Show Source
Nested Schema : Candidate Attachments
Type: array
Title: Candidate Attachments
The InternalAttachments resource provides information about files attached by the recruiting team.
Show Source
Nested Schema : j_SubmissionExtraInfoCategory
Type: array
Show Source
  • Discriminator: CategoryCode
    Discriminator: { "propertyName":"CategoryCode", "mapping":{ "PER_EIT":"#/components/schemas/oracle_apps_flex_hcm_recruiting_hiring_submissions_core_submissionExtraInfoEFF_categories_view_j__SubmissionExtraInfoCategoryPerEitprivateVO-item-response" } }
Nested Schema : Job Application Preferred Locations
Type: array
Title: Job Application Preferred Locations
The preferredLocations resource is the child of the recruitingUIJobApplications resource and provides information about the candidate's preferred locations.
Show Source
Nested Schema : recruitingUIJobApplications-Attachments-item-response
Type: object
Show Source
Nested Schema : recruitingUIJobApplications-InternalAttachments-item-response
Type: object
Show Source
Nested Schema : Discriminator: CategoryCode
Type: object
Discriminator: CategoryCode

Discriminator Values

Match One Schema
Show Source
Nested Schema : oracle_apps_flex_hcm_recruiting_hiring_submissions_core_submissionExtraInfoEFF_categories_view_j__SubmissionExtraInfoCategoryPerEitprivateVO-item-response
Type: object
Show Source
Nested Schema : SubmissionExtraInfoContextORA_5FHRX_5FGB_5FSWC_5FINFOprivateVO
Type: array
Show Source
Nested Schema : SubmissionExtraInfoContextORA_5FHRX_5FGB_5FSWC_5FQUAL_5FINFOprivateVO
Type: array
Show Source
Nested Schema : SubmissionExtraInfoContextORA_5FIRC_5FCONTINGENT_5FTALENT_5FINFOprivateVO
Type: array
Show Source
Nested Schema : recruitingUIJobApplications-j_SubmissionExtraInfoCategory-SubmissionExtraInfoContextORA_5FHRX_5FGB_5FSWC_5FINFOprivateVO-item-response
Type: object
Show Source
Nested Schema : recruitingUIJobApplications-j_SubmissionExtraInfoCategory-SubmissionExtraInfoContextORA_5FHRX_5FGB_5FSWC_5FQUAL_5FINFOprivateVO-item-response
Type: object
Show Source
Nested Schema : recruitingUIJobApplications-j_SubmissionExtraInfoCategory-SubmissionExtraInfoContextORA_5FIRC_5FCONTINGENT_5FTALENT_5FINFOprivateVO-item-response
Type: object
Show Source
Nested Schema : recruitingUIJobApplications-PreferredLocations-item-response
Type: object
Show Source
Back to Top