Get all my job applications in opportunity marketplace
get
/hcmRestApi/resources/11.13.18.05/recruitingMyJobApplications
Request
Query Parameters
-
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 the list of my job applications in opportunity marketplace using a unique ID.
Finder Variables- SubmissionId; integer; Job Application ID of the job application in opportunity marketplace.
- findMyJobApplications Finds the list of my job applications in opportunity marketplace.
Finder Variables- active; boolean; Active or inactive job applications in opportunity marketplace.
- PrimaryKey Finds the list of my job applications in opportunity marketplace using a unique ID.
-
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:- Action; string; Action performed on the job application in opportunity marketplace.
- ActionResponseMessage; string; Response message for a job application in opportunity marketplace.
- ActiveFlag; boolean; Indicates whether the job application is active in opportunity marketplace. Default value is 1.
- ConfirmedFlag; boolean; Indicates whether the job application is confirmed in opportunity marketplace. No default value.
- HiringManager; string; Hiring manager in opportunity marketplace.
- HiringManagerPersonId; string; Hiring manager person ID in opportunity marketplace.
- JobFunction; string; Job function of the employee in Opportunity Marketplace.
- OfferId; integer; Job offer ID in opportunity marketplace.
- Organization; string; Organization name in opportunity marketplace.
- OtherJobLocationCount; integer; Count of the other job locations in opportunity marketplace.
- PipelineRequisitionFlag; boolean; Indicates whether the job application is a pipeline job application. Default value in 0.
- PipelineSubmissionId; integer; Pipeline job application ID in opportunity marketplace.
- PreferredLanguage; string; Preferred language of the job application in opportunity marketplace.
- PrimaryJobLocation; string; Primary job location in opportunity marketplace.
- PrimaryWorkLocation; string; Primary work location in Opportunity Marketplace.
- ProposedStartDateLabelFlag; boolean; Indicates whether the proposed start date is displayed in opportunity marketplace. No default value
- RemoteOpportunity; string; Remote opportunity indicator in Opportunity Marketplace.
- RequisitionNumber; string; Job requisition number in opportunity marketplace.
- ShowJobActionFlag; boolean; Indicates whether the view job details action is displayed in opportunity marketplace. Default value is 1.
- ShowOfferActionFlag; boolean; Indicates whether the view offer action is displayed in opportunity marketplace. Default value is 0.
- ShowWithdrawActionFlag; boolean; Indicates whether the withdraw job application action is displayed in opportunity marketplace. Default value is 1.
- StartDate; string; Candidate start date in opportunity marketplace.
- Status; string; Job application status in opportunity marketplace.
- SubmissionDate; string; Job application submission date in opportunity marketplace.
- SubmissionId; integer; Job application ID in opportunity marketplace.
- Title; string; Job title in opportunity marketplace.
-
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:
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.
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 : recruitingMyJobApplications
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 : recruitingMyJobApplications-item-response
Type:
Show Source
object
-
Action: string
Title:
Action List
Action performed on the job application in opportunity marketplace. -
ActionResponseMessage: string
Title:
Action Response
Response message for a job application in opportunity marketplace. -
ActiveFlag: boolean
Title:
Job Active Flag
Indicates whether the job application is active in opportunity marketplace. Default value is 1. -
ConfirmedFlag: boolean
Title:
Job Confirmed Flag
Indicates whether the job application is confirmed in opportunity marketplace. No default value. -
HiringManager: string
Title:
Hiring Manager
Hiring manager in opportunity marketplace. -
HiringManagerPersonId: string
Title:
Hiring Manager ID
Hiring manager person ID in opportunity marketplace. -
JobFunction: string
Title:
Job Function
Maximum Length:255
Job function of the employee in Opportunity Marketplace. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OfferId: integer
Title:
Offer ID
Job offer ID in opportunity marketplace. -
Organization: string
Title:
Organization Name
Organization name in opportunity marketplace. -
OtherJobLocationCount: integer
Title:
Number of Locations
Count of the other job locations in opportunity marketplace. -
PipelineRequisitionFlag: boolean
Title:
Pipeline Requisition Flag
Indicates whether the job application is a pipeline job application. Default value in 0. -
PipelineSubmissionId: integer
Title:
Pipeline Job Submission ID
Pipeline job application ID in opportunity marketplace. -
PreferredLanguage: string
Title:
Job Preferred Language
Preferred language of the job application in opportunity marketplace. -
PrimaryJobLocation: string
Title:
Primary Job Location
Primary job location in opportunity marketplace. -
PrimaryWorkLocation: string
Title:
Primary Work Location
Maximum Length:255
Primary work location in Opportunity Marketplace. -
ProposedStartDateLabelFlag: boolean
Title:
Proposed Start Date
Indicates whether the proposed start date is displayed in opportunity marketplace. No default value -
RemoteOpportunity: string
Title:
Remote Opportunity
Maximum Length:255
Remote opportunity indicator in Opportunity Marketplace. -
RequisitionNumber: string
Title:
Requisition Number
Job requisition number in opportunity marketplace. -
ShowJobActionFlag: boolean
Title:
Job Action Flag
Indicates whether the view job details action is displayed in opportunity marketplace. Default value is 1. -
ShowOfferActionFlag: boolean
Title:
Offer Action Flag
Indicates whether the view offer action is displayed in opportunity marketplace. Default value is 0. -
ShowWithdrawActionFlag: boolean
Title:
Withdraw Flag
Indicates whether the withdraw job application action is displayed in opportunity marketplace. Default value is 1. -
StartDate: string
(date)
Title:
Start Date
Candidate start date in opportunity marketplace. -
Status: string
Title:
Application Status
Maximum Length:255
Job application status in opportunity marketplace. -
SubmissionDate: string
(date)
Title:
Application Date
Job application submission date in opportunity marketplace. -
SubmissionId: integer
Title:
Job Application ID
Job application ID in opportunity marketplace. -
SubmissionScheduledInterviews: array
Scheduled Interviews
Title:
Scheduled Interviews
The SubmissionScheduleInterviews resource is the child of the recruitingMyJobApplications resource in opportunity marketplace. It includes all the details about the interview schedule requests. -
Title: string
Title:
Requisition Title
Job title in opportunity marketplace. -
UnscheduledInterviewRequests: array
Unscheduled Job Interviews
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Scheduled Interviews
Type:
array
Title:
Scheduled Interviews
The SubmissionScheduleInterviews resource is the child of the recruitingMyJobApplications resource in opportunity marketplace. It includes all the details about the interview schedule requests.
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 : 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 : recruitingMyJobApplications-SubmissionScheduledInterviews-item-response
Type:
Show Source
object
-
EndDate: string
(date-time)
Title:
Interview End Date
Read Only:true
End date of the scheduled interview in opportunity marketplace. -
InterviewId: integer
(int64)
Title:
Interview ID
Interview ID in opportunity marketplace. -
IntrvwRequestsId: integer
(int64)
Title:
Interview Request ID
Interview request ID in opportunity marketplace. -
IsScheduled: string
Title:
Interview Scheduled
Read Only:true
Maximum Length:1
Interview scheduled in opportunity marketplace. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ScheduleInterviewId: integer
(int64)
Title:
Scheduled Interview ID
Read Only:true
Scheduled interview ID in opportunity marketplace. -
StartDate: string
(date-time)
Title:
Interview Start Date
Read Only:true
Start date of the interview in opportunity marketplace. -
SubmissionId: integer
(int64)
Title:
Interview Submission ID
Job application ID for the scheduled interview in opportunity marketplace.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : recruitingMyJobApplications-UnscheduledInterviewRequests-item-response
Type:
Show Source
object
-
InterviewId: integer
(int64)
Title:
Interview ID
Read Only:true
ID assigned to each unscheduled interview. -
IntrvwRequestsId: integer
(int64)
Title:
Interview Request ID
Read Only:true
ID assigned to each unscheduled interview request. -
IntrvwRschldCount: integer
(int32)
Title:
Number of Interview Reschedules
Read Only:true
Count of rescheduled interviews. -
IsRschldRqsted: string
Title:
Reschedule Requested Flag
Read Only:true
Maximum Length:1
Indicates if a reschedule of the interview is requested. -
IsSchedulable: string
Title:
Can Schedule
Read Only:true
Maximum Length:255
Indicates if the unscheduled interview can be scheduled. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ScheduleId: integer
(int64)
Title:
Interview Schedule ID
Read Only:true
Schedule ID assigned to each unscheduled interview request. -
SubmissionId: integer
(int64)
Title:
Interview Submission ID
Read Only:true
Job application ID assigned to each unscheduled interview request.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source