Get all job application action previews
get
/hcmRestApi/resources/11.13.18.05/recruitingRACItems/{SubscriberTypeCode}/child/jobApplicationList/{ItemId}/child/jobApplicationActionPreviews
Request
Path Parameters
-
ItemId(required): integer(int64)
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=
-
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 action previews by a primary key.
Finder Variables- ItemId; integer; Primary key and item ID used to find all job application action previews.
- PrimaryKey Finds all job application action previews 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:- ActiveOnAnotherRequisition; string; Active on another requisition indicator displayed in the job application action preview.
- AreaCode; string; Phone number area code of the candidate displayed in the job application action preview.
- CandidateLocation; string; Candidate location of the candidate displayed in the job application action preview.
- CandidateName; string; Name of the candidate displayed in the job application action preview.
- CandidateNumber; string; Candidate number of the candidate displayed in the job application action preview.
- CandidateType; string; Candidate type of the candidate displayed in the job application action preview.
- CountryCodeNumber; string; Phone number country code of the candidate displayed in the job application action preview.
- CurrentPhaseId; integer; Current phase identifier of the job application displayed in the job application action preview.
- DaysinStatus; integer; Days in status count of the candidate displayed in the job application action preview.
- DisqualifiedFlag; boolean; Indicates whether the candidate displayed in the job application action preview is disqualified.
- EmailAddress; string; Email address of the candidate displayed in the job application action preview.
- InternalFlag; boolean; Indicates whether the candidate displayed in the job application action preview is internal or external.
- ItemId; integer; Unique identifier for the job application action activity item.
- LastContacted; integer; Date and time when the candidate was last contacted, displayed in the job application action preview.
- LastContactedMode; string; Last contacted method for the candidate displayed in the job application action preview.
- NextInterviewDate; string; Next interview date for the candidate displayed in the job application action preview.
- ObjectId; integer; Object identifier of the activity for the job application action preview.
- PersonId; integer; Person identifier of the candidate displayed in the job application action preview.
- PhaseName; string; Phase of the job application displayed in the job application action preview.
- PhoneNumber; string; Phone number of the candidate displayed in the job application action preview.
- PreScreeningTotalScore; integer; Prescreening question total score displayed in the candidate for job application action preview.
- ProcessId; integer; Process identifier for the job application action preview.
- QstnrScore; number; Prescreening question maximum possible score for the candidate displayed in the job application action preview.
- ReferredByAgentFlag; boolean; Indicates whether the candidate is referred by an agent, displayed in the job application action preview.
- ReferredFlag; boolean; Indicates whether the candidate is referred by an employee, displayed in the job application action preview.
- RequisitionId; integer; Requisition identifier of the job requisition for the job application action preview.
- RequisitionNumber; string; Requisition number of the job requisition displayed in the job application action preview.
- RequisitionTitle; string; Requisition title of the job requisition displayed in the job application action preview.
- StateName; string; State of the job application displayed in the job application action preview.
- Subject; string; Subject associated with the job application action preview.
- SubjectType; string; Subject type associated with the job application action preview.
- SubmissionId; integer; Submission ID for the job application action preview.
- SubscriberRuleCode; string; Subscriber rule code for the job application action activity item.
- UpdatedExpirationDate; string; Updated expiration date for the job application action 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-jobApplicationActionPreviews
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-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 : 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.