Get all job applications for recruiting

get

/hcmRestApi/resources/11.13.18.05/recruitingJobApplications

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 by a primary key
      Finder Variables
      • JobApplicationId; integer; Finds the job application using a primary key and an application ID
    • findByRequisitionNumberAndEmailAddress Finds all job applications by requisition number and email address.
      Finder Variables
      • EmailAddress; string; Email address used to find job applications.
      • RequisitionNumber; string; Requisition number 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:
    • CandidateName; string; Name of the candidate in the job application.
    • CandidatePersonId; integer; ID assigned to the candidate who applied for the job.
    • ConfirmedFlag; boolean; Indicates confirmation of the job application.
    • CreatedBy; string; Name of the person who created the job application.
    • CreationDate; string; Date of creation of the job application.
    • DisqualifiedFlag; boolean; Indicates that the candidate is disqualified.
    • HiringManagerId; integer; Hiring manager ID for a job application.
    • InternalFlag; boolean; Indicates that it's an internal job application.
    • JobApplicationDate; string; Date of the job application.
    • JobApplicationId; integer; Unique ID of job application.
    • LanguageCode; string; Code assigned for each language.
    • LastModifiedDate; string; Date when the application was last modified.
    • LastUpdateDate; string; Date when the application was last updated
    • LastUpdatedBy; string; Name of individual who last updated the job application.
    • PhaseId; integer; ID for phase of job application.
    • PhaseName; string; Name of each phase of the job application.
    • ProfileId; integer; Profile ID of an application.
    • PublicStateId; integer; Public state ID of an application.
    • PublicStateName; string; Name of the public state of a job application.
    • RecruiterId; integer; Recruiter ID for a job application.
    • RequisitionId; integer; Requisition ID for a job application.
    • RequisitionIdRest; integer; Requisition ID 1 for a job application.
    • RequisitionNumber; string; Requisition number of the job application.
    • RequisitionUsageCode; string; Requisition usage code for a job application.
    • StateId; integer; State ID for a job application.
    • StateName; string; Name of the state of a 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 : recruitingJobApplications
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : recruitingJobApplications-item-response
Type: object
Show Source
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 : 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: object
Show Source
Nested Schema : recruitingJobApplications-education-item-response
Type: object
Show Source
Nested Schema : recruitingJobApplications-experience-item-response
Type: object
Show Source
Nested Schema : recruitingJobApplications-languages-item-response
Type: object
Show Source
Nested Schema : recruitingJobApplications-licensesAndCertificates-item-response
Type: object
Show Source
Nested Schema : recruitingJobApplications-workPreferences-item-response
Type: object
Show Source
Back to Top