Get all job application list items
get
/hcmRestApi/resources/11.13.18.05/recruitingRACItems/{SubscriberTypeCode}/child/jobApplicationList
Request
Path Parameters
-
SubscriberTypeCode(required): string
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 -
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 all job application lists by a primary key.
Finder Variables- ItemId; integer; Primary key and ItemId; integer; used to find all job application lists.
- PrimaryKey Finds all job application lists by a primary key.
-
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:- ActionDate; string; Action date of the job application activity item.
- Candidate; string; Name of the candidate the job application activity item relates to.
- CandidateNumber; string; Candidate number of the candidate associated with the activity item.
- CandidatePersonId; integer; Person identifier of the candidate associated with the activity item.
- DefaultAction; string; Default action of the job application activity item.
- DefaultActionName; string; Default action name of the job application activity item.
- HiringManager; string; Hiring manager name the job application activity item relates to.
- HiringManagerId; integer; Person identifier of the hiring manager associated with the activity item.
- ItemId; integer; Unique identifier of the job application activity item.
- ItemName; string; Name of the job application activity item.
- Priority; string; Job application activity item priority. It can be high or null.
- Recruiter; string; Recruiter name the job application activity item relates to.
- RecruiterId; integer; Person identifier of the recruiter associated with the activity item.
- RequisitionNumber; string; Requisition number the job application activity item relates to.
- RequisitionTitle; string; Requisition title the job application activity item relates to.
- RulePriorityCode; string; Rule priority code the job application activity relates to.
- Subject; string; Subject of the job application list.
- SubmissionId; integer; Submission ID the job application activity relates to.
- SubscriberLookupCode; string; Lookup code of the subscriber associated with the activity item.
- SubscriberLookupType; string; Lookup type of the subscriber associated with the activity item.
- SubscriberRuleCode; string; Subscriber rule code the job application activity item relates to.
- SubscriberTypeMeaning; string; Subscriber type meaning of the subscriber associated with the activity item.
-
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: string
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: string
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 : recruitingRACItems-jobApplicationList
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 : recruitingRACItems-jobApplicationList-item-response
Type:
Show Source
object
-
ActionDate: string
(date)
Title:
Date
Action date of the job application activity item. -
actions: array
Job Requisition Actions List
Title:
Job Requisition Actions List
The actions resource is the child of the recruitingRACItems resource. It provides a list of job requisition actions that a user can take based on the requisition activity item. -
Candidate: string
Title:
Candidate
Read Only:true
Maximum Length:240
Name of the candidate the job application activity item relates to. -
CandidateNumber: string
Title:
Candidate Number
Read Only:true
Maximum Length:30
Candidate number of the candidate associated with the activity item. -
CandidatePersonId: integer
(int64)
Title:
Candidate Name
Read Only:true
Person identifier of the candidate associated with the activity item. -
DefaultAction: string
Read Only:
true
Maximum Length:30
Default action of the job application activity item. -
DefaultActionName: string
Read Only:
true
Maximum Length:255
Default action name of the job application activity item. -
HiringManager: string
Title:
Hiring Manager
Read Only:true
Maximum Length:240
Hiring manager name the job application activity item relates to. -
HiringManagerId: integer
(int64)
Read Only:
true
Person identifier of the hiring manager associated with the activity item. -
ItemId: integer
(int64)
Unique identifier of the job application activity item.
-
ItemName: string
Title:
Activity
Read Only:true
Maximum Length:240
Name of the job application activity item. -
jobApplicationActionPreviews: array
Job Application Action Previews
Title:
Job Application Action Previews
The jobApplicationActionPreviews resource is the child of the recruitingRACItems resource. It provides the action preview for the selected action for job application item. -
jobApplicationPreviews: array
Job Application Preview
Title:
Job Application Preview
The jobApplicationPreviews resource is the child of the recruitingRACItems resource. It provide details about a job application item. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Priority: string
Title:
Priority
Read Only:true
Maximum Length:80
Job application activity item priority. It can be high or null. -
Recruiter: string
Title:
Name
Read Only:true
Maximum Length:240
Recruiter name the job application activity item relates to. -
RecruiterId: integer
(int64)
Read Only:
true
Person identifier of the recruiter associated with the activity item. -
RequisitionNumber: string
Title:
Requisition Number
Read Only:true
Maximum Length:240
Requisition number the job application activity item relates to. -
RequisitionTitle: string
Title:
Requisition
Read Only:true
Maximum Length:240
Requisition title the job application activity item relates to. -
RulePriorityCode: string
Read Only:
true
Maximum Length:30
Rule priority code the job application activity relates to. -
Subject: string
Maximum Length:
30
Subject of the job application list. -
SubmissionId: integer
(int64)
Read Only:
true
Submission ID the job application activity relates to. -
SubscriberLookupCode: string
Title:
Lookup Code
Read Only:true
Maximum Length:30
Lookup code of the subscriber associated with the activity item. -
SubscriberLookupType: string
Title:
Lookup Type
Read Only:true
Maximum Length:30
Lookup type of the subscriber associated with the activity item. -
SubscriberRuleCode: string
Read Only:
true
Maximum Length:30
Subscriber rule code the job application activity item relates to. -
SubscriberTypeMeaning: string
Title:
Meaning
Read Only:true
Maximum Length:80
Subscriber type meaning of the subscriber associated with the activity item.
Nested Schema : Job Requisition Actions List
Type:
array
Title:
Job Requisition Actions List
The actions resource is the child of the recruitingRACItems resource. It provides a list of job requisition actions that a user can take based on the requisition activity item.
Show Source
Nested Schema : Job Application Action Previews
Type:
array
Title:
Job Application Action Previews
The jobApplicationActionPreviews resource is the child of the recruitingRACItems resource. It provides the action preview for the selected action for job application item.
Show Source
Nested Schema : Job Application Preview
Type:
array
Title:
Job Application Preview
The jobApplicationPreviews resource is the child of the recruitingRACItems resource. It provide details about a job application item.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : recruitingRACItems-jobApplicationList-actions-item-response
Type:
Show Source
object
-
ActionCode: string
Maximum Length:
30
Action code the job requisition activity item relates to. -
ActionName: string
Read Only:
true
Maximum Length:255
Action name the job requisition activity item relates to. -
DefaultFlag: boolean
Maximum Length:
1
Indicates whether the job requisition action is the default action for the activity item. If an action is the default action for an activity item it's displayed in the action column in the activity list. -
links: array
Links
Title:
Links
The link relations associated with the resource instance.
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 : recruitingRACItems-jobApplicationList-jobApplicationActionPreviews-item-response
Type:
Show Source
object
-
ActiveOnAnotherRequisition: string
Read Only:
true
Maximum Length:255
Active on another requisition indicator displayed in the job application action preview. -
AreaCode: string
Read Only:
true
Maximum Length:30
Phone number area code of the candidate displayed in the job application action preview. -
CandidateLocation: string
Title:
Candidate Location
Read Only:true
Maximum Length:366
Candidate location of the candidate displayed in the job application action preview. -
CandidateName: string
Title:
Candidate Name
Read Only:true
Maximum Length:240
Name of the candidate displayed in the job application action preview. -
CandidateNumber: string
Title:
Candidate Number
Read Only:true
Maximum Length:30
Candidate number of the candidate displayed in the job application action preview. -
CandidateType: string
Title:
Candidate Type When Applying
Read Only:true
Maximum Length:80
Candidate type of the candidate displayed in the job application action preview. -
CountryCodeNumber: string
Read Only:
true
Maximum Length:30
Phone number country code of the candidate displayed in the job application action preview. -
CurrentPhaseId: integer
(int64)
Read Only:
true
Current phase identifier of the job application displayed in the job application action preview. -
DaysinStatus: integer
Title:
Days in Status
Read Only:true
Days in status count of the candidate displayed in the job application action preview. -
DisqualifiedFlag: boolean
Read Only:
true
Maximum Length:1
Indicates whether the candidate displayed in the job application action preview is disqualified. -
EmailAddress: string
Title:
Candidate Email
Read Only:true
Maximum Length:240
Email address of the candidate displayed in the job application action preview. -
InternalFlag: boolean
Read Only:
true
Maximum Length:1
Indicates whether the candidate displayed in the job application action preview is internal or external. -
ItemId: integer
(int64)
Read Only:
true
Unique identifier for the job application action activity item. -
LastContacted: integer
Title:
Last Contacted
Read Only:true
Date and time when the candidate was last contacted, displayed in the job application action preview. -
LastContactedMode: string
Read Only:
true
Maximum Length:255
Last contacted method for the candidate displayed in the job application action preview. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
NextInterviewDate: string
(date-time)
Title:
Most Recent Interview Date
Read Only:true
Next interview date for the candidate displayed in the job application action preview. -
ObjectId: integer
(int64)
Read Only:
true
Object identifier of the activity for the job application action preview. -
PersonId: integer
(int64)
Read Only:
true
Person identifier of the candidate displayed in the job application action preview. -
PhaseName: string
Title:
Job Application Status
Read Only:true
Maximum Length:240
Phase of the job application displayed in the job application action preview. -
PhoneNumber: string
Title:
Candidate Phone Number
Read Only:true
Maximum Length:60
Phone number of the candidate displayed in the job application action preview. -
PreScreeningTotalScore: integer
Read Only:
true
Prescreening question total score displayed in the candidate for job application action preview. -
ProcessId: integer
(int64)
Read Only:
true
Process identifier for the job application action preview. -
QstnrScore: number
Title:
Prescreening Score
Read Only:true
Prescreening question maximum possible score for the candidate displayed in the job application action preview. -
ReferredByAgentFlag: boolean
Read Only:
true
Maximum Length:255
Indicates whether the candidate is referred by an agent, displayed in the job application action preview. -
ReferredFlag: boolean
Read Only:
true
Maximum Length:255
Indicates whether the candidate is referred by an employee, displayed in the job application action preview. -
RequisitionId: integer
(int64)
Read Only:
true
Requisition identifier of the job requisition for the job application action preview. -
RequisitionNumber: string
Title:
Requisition Number
Read Only:true
Maximum Length:240
Requisition number of the job requisition displayed in the job application action preview. -
RequisitionTitle: string
Title:
Requisition Title
Read Only:true
Maximum Length:240
Requisition title of the job requisition displayed in the job application action preview. -
StateName: string
Read Only:
true
Maximum Length:240
State of the job application displayed in the job application action preview. -
Subject: string
Read Only:
true
Maximum Length:30
Subject associated with the job application action preview. -
SubjectType: string
Read Only:
true
Maximum Length:30
Subject type associated with the job application action preview. -
SubmissionId: integer
Read Only:
true
Submission ID for the job application action preview. -
SubscriberRuleCode: string
Read Only:
true
Maximum Length:256
Subscriber rule code for the job application action activity item. -
UpdatedExpirationDate: string
(date-time)
Title:
New Expiration Date
Read Only:true
Updated expiration date for the job application action activity item.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : recruitingRACItems-jobApplicationList-jobApplicationPreviews-item-response
Type:
Show Source
object
-
ActiveOnAnotherRequisition: string
Read Only:
true
Maximum Length:255
Active on another requisition indicator displayed in the job application preview. -
AreaCode: string
Read Only:
true
Maximum Length:30
Phone number area code of the candidate displayed in the job application preview. -
CandidateLocation: string
Title:
Candidate Location
Read Only:true
Maximum Length:366
Candidate location of the candidate displayed in the job application preview. -
CandidateName: string
Title:
Candidate Name
Read Only:true
Maximum Length:240
Name of the candidate displayed in the job application preview. -
CandidateNumber: string
Title:
Candidate Number
Read Only:true
Maximum Length:30
Candidate number of the candidate displayed in the job application preview. -
CandidateType: string
Title:
Candidate Type When Applying
Read Only:true
Maximum Length:80
Candidate type of the candidate displayed in the job application preview. For example, internal or external. -
CountryCodeNumber: string
Read Only:
true
Maximum Length:30
Phone number country code of the candidate displayed in the job application preview. -
DaysinStatus: integer
Title:
Days in Status
Read Only:true
Days in status count of the candidate displayed in the job application preview. -
DisqualifiedFlag: boolean
Read Only:
true
Maximum Length:1
Indicates whether the candidate displayed in the job application preview is disqualified or not. -
EmailAddress: string
Title:
Candidate Email
Read Only:true
Maximum Length:240
Email address of the candidate displayed in the job application preview. -
InternalFlag: boolean
Read Only:
true
Maximum Length:1
Indicates whether the candidate displayed in the job application preview is internal or external. -
LastContacted: integer
Title:
Last Contacted
Read Only:true
Last contacted day count for the candidate displayed in the job application preview. -
LastContactedMode: string
Read Only:
true
Maximum Length:255
Last contacted method for the candidate displayed in the job application preview. For example, email or phone call. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
NextInterviewDate: string
(date-time)
Title:
Most Recent Interview Date
Read Only:true
Next interview date for the candidate displayed in the job application preview. -
PersonId: integer
(int64)
Read Only:
true
Person ID of the candidate displayed in the job application preview. -
PhaseName: string
Title:
Job Application Status
Read Only:true
Maximum Length:240
Phase name of the job application displayed in the job application preview. -
PhoneNumber: string
Title:
Candidate Phone Number
Read Only:true
Maximum Length:60
Phone number of the candidate displayed in the job application preview. -
PreScreeningTotalScore: integer
(int64)
Read Only:
true
Prescreening question total score for the candidate displayed in the job application preview. -
QstnrScore: number
Title:
Prescreening Score
Read Only:true
Prescreening question maximum possible score for the candidate displayed in the job application preview. -
ReferredByAgentFlag: boolean
Read Only:
true
Maximum Length:255
Indicates whether the candidate displayed in job application preview is referred by an agent or not. -
ReferredFlag: boolean
Read Only:
true
Maximum Length:255
Indicates whether the candidate displayed in job application preview is referred by an employee or not. -
RequisitionId: integer
(int64)
Read Only:
true
Requisition ID of the job requisition displayed in the job application preview. -
RequisitionNumber: string
Title:
Requisition Number
Read Only:true
Maximum Length:240
Requisition number the job application preview relates to. -
RequisitionTitle: string
Title:
Requisition Title
Read Only:true
Maximum Length:240
Requisition title the job application preview relates to. -
StateName: string
Read Only:
true
Maximum Length:240
State name of the job application displayed in the job application preview. -
SubmissionId: integer
Read Only:
true
Submission ID of the job application displayed in the job application preview.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source