Get a job offer
get
/hcmRestApi/resources/11.13.18.05/recruitingUIJobOffers/{recruitingUIJobOffersUniqID}
Request
Path Parameters
-
recruitingUIJobOffersUniqID(required): string
This is the hash key of the attributes which make up the composite key--- OfferId, RequisitionId and State ---for the Job Offer Lists resource and used to uniquely identify an instance of Job Offer Lists. The client should not generate the hash key value. Instead, the client should query on the Job Offer Lists collection resource with a filter on the primary key values in order to navigate to a specific instance of Job Offer Lists.
For example: recruitingUIJobOffers?q=OfferId=<value1>;RequisitionId=<value2>;State=<value3>
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 -
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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
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 : recruitingUIJobOffers-item-response
Type:
Show Source
object
-
AcceptFlag: boolean
Read Only:
true
Indicates whether the action to accept a job offer is enabled or not. -
Action: string
Read Only:
true
Maximum Length:255
Action performed on the selected job offer. -
AssignmentId: integer
(int64)
Title:
Assignment ID
Read Only:true
Assignment ID in the job offer being previewed. -
BusinessUnit: string
Title:
Business Unit
Maximum Length:255
Business unit in the job offer being previewed. -
BusinessUnitId: integer
(int64)
Read Only:
true
Business unit ID in the job offer being previewed. -
CancelFlag: boolean
Read Only:
true
Indicates whether the cancel action on the job offer is enabled or not. -
CandidateName: string
Title:
Candidate Name
Read Only:true
Maximum Length:240
Candidate name in the job offer being previewed. -
CandidateNumber: string
Title:
Candidate Number
Read Only:true
Maximum Length:30
Candidate number in the job offer being previewed. -
CandidateType: string
Title:
Candidate Type
Maximum Length:255
Candidate type in the job offer being previewed. -
Code: string
Read Only:
true
Maximum Length:30
Code in the job offer being previewed. -
CreationDate: string
(date)
Title:
Offer Creation Date
Read Only:true
Job offer creation date. -
CsdFlag: boolean
Read Only:
true
Indicates whether the action to change the start date is enabled or not. -
Department: string
Title:
Department
Maximum Length:255
Department name in the job offer being previewed. -
EditFlag: boolean
Read Only:
true
Indicates whether the action to edit the job offer is enabled or not. -
EffectiveEndDate: string
(date)
Read Only:
true
Effective end date of the CandidatePEO. -
EffectiveEndDateAsmt: string
(date)
Read Only:
true
Effective end date of the assignment. -
EffectiveLatestChange: string
Title:
Effective Latest Change
Read Only:true
Maximum Length:30
Effective last change for the assignment. -
EffectiveSequence: integer
Title:
Effective Sequence
Read Only:true
Effective sequence of the assignment. -
EffectiveStartDate: string
(date)
Read Only:
true
Effective start date of the CandidatePEO. -
EffectiveStartDateAsmt: string
(date)
Read Only:
true
Effective start date of the assignment. -
ExtendFlag: boolean
Read Only:
true
Indicates whether the action to extend a job offer is enabled or not. -
HireDate: string
(date)
Title:
Projected Start Date
Read Only:true
Hire date in the job offer being previewed. -
HiringManager: string
Title:
Hiring Manager
Maximum Length:255
Hiring manager name in the job offer being previewed. -
HiringManagerId: integer
(int64)
Hiring manager ID in the job offer being previewed.
-
JobCode: string
Title:
Job Code
Maximum Length:255
Job code in the job offer being previewed. -
JobId: integer
(int64)
Read Only:
true
Job ID in the job offer being previewed. -
JobName: string
Title:
Job Name
Maximum Length:255
Job name in the job offer being previewed. -
LegalEmployer: string
Title:
Legal Employer
Maximum Length:255
Legal employer name in the job offer being previewed. -
LegalEntityId: integer
(int64)
Read Only:
true
Legal entity ID in the job offer being previewed. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LocationId: integer
(int64)
Read Only:
true
Location ID in the job offer being previewed. -
MoveFlag: boolean
Read Only:
true
Indicates whether the action to move the job offer is enabled or not. -
MoveToHRFlag: boolean
Read Only:
true
Indicates whether the action to move the job offer to HR is enabled or not. -
Name: string
Read Only:
true
Maximum Length:240
State name in the job offer being previewed. -
ObjectStatus: string
Maximum Length:
30
Default Value:ORA_ACTIVE
Object status in the job offer being previewed. -
ObjectVersionNumber: integer
(int32)
Object version number in the job offer being previewed.
-
ObjectVersionNumberAsmt: integer
(int32)
Read Only:
true
Object version number for the assignment. -
ObjectVersionNumberCand: integer
(int32)
Read Only:
true
Object version number for the candidate. -
OfferId: integer
(int64)
Offer ID in the job offer being previewed.
-
OfferTitle: string
Title:
Offer Name
Maximum Length:240
Offer title in the job offer being previewed. -
OrganizationId: integer
(int64)
Read Only:
true
Organization ID in the job offer being previewed. -
PersonId: integer
(int64)
Title:
Candidate Name
Read Only:true
Person ID in the job offer being previewed. -
PersonNameId: integer
(int64)
Read Only:
true
Person name ID in the job offer being previewed. -
PositionCode: string
Title:
Position Code
Maximum Length:255
Position code in the job offer being previewed. -
PositionId: integer
(int64)
Read Only:
true
Position ID in the job offer being previewed. -
PositionName: string
Maximum Length:
255
Position name in the job offer being previewed. -
Recruiter: string
Title:
Recruiter
Maximum Length:255
Recruiter name in the job offer being previewed. -
RecruiterId: integer
(int64)
Recruiter ID in the job offer being previewed.
-
RedraftFlag: boolean
Read Only:
true
Indicates whether the action to redraft the job offer is enabled or not. -
RejectFlag: boolean
Read Only:
true
Indicates whether the action to reject the job offer is enabled or not. -
RequisitionId: integer
(int64)
Read Only:
true
Requisition ID in the job offer being previewed. -
RequisitionNumber: string
Title:
Requisition Number
Read Only:true
Maximum Length:240
Requisition number in the job offer being previewed. -
State: integer
(int64)
Title:
Offer State
Read Only:true
State code in the job offer being previewed. -
StateSort: string
Read Only:
true
Maximum Length:255
Sorting the status of the job offer in the list. -
SubmissionId: integer
(int64)
Read Only:
true
Submission ID in the job offer being previewed. -
WithdrawFlag: boolean
Read Only:
true
Indicates whether the action to withdraw the job offer is enabled or not. -
WorkLocationCity: string
Title:
Work Location City
Maximum Length:255
Work location city in the job offer being previewed. -
WorkLocationCountry: string
Title:
Work Location Country
Maximum Length:255
Work location country in the job offer being previewed. -
WorkLocationName: string
Title:
Work Location
Maximum Length:255
Work location name in the job offer being previewed.
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.