Get a job offer on the HR side
get
/hcmRestApi/resources/11.13.18.05/recruitingUIHRJobOffers/{recruitingUIHRJobOffersUniqID}
Request
Path Parameters
-
recruitingUIHRJobOffersUniqID(required): string
This is the hash key of the attributes which make up the composite key--- OfferId, RequisitionId, State and SubmissionId ---for the Recruiting Job Offers in HR resource and used to uniquely identify an instance of Recruiting Job Offers in HR. The client should not generate the hash key value. Instead, the client should query on the Recruiting Job Offers in HR collection resource with a filter on the primary key values in order to navigate to a specific instance of Recruiting Job Offers in HR.
For example: recruitingUIHRJobOffers?q=OfferId=<value1>;RequisitionId=<value2>;State=<value3>;SubmissionId=<value4>
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
-
Effective-Of: string
This header accepts a string value. The string is a semi-colon separated list of
= . It is used to perform effective date range operations. The accepted parameters are RangeMode, RangeSpan, RangeStartDate, RangeEndDate, RangeStartSequence and RangeEndSequence. The parameter values are always strings. The possible values for RangeMode are SET_LOGICAL_START, SET_LOGICAL_END, END_DATE, SET_EFFECTIVE_START, SET_EFFECTIVE_END, REPLACE_CORRECTION, REPLACE_UPDATE, RECONCILE_CORRECTION, CORRECTION, RECONCILE_UPDATE, UPDATE, ZAP and DELETE_CHANGES. The possible values for RangeSpan are PHYSICAL_ROW_END_DATE and LOGICAL_ROW_END_DATE. The values for RangeStartDate and RangeEndDate have to be a string representation of a date in yyyy-MM-dd format. The value for RangeStartSequence and RangeEndSequence must be strings such that when parsed they yield positive integers. -
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 : recruitingUIHRJobOffers-item-response
Type:
Show Source
object-
AssignmentId: integer
(int64)
Title:
Assignment IDRead Only:trueAssignment ID in the job offer being previewed. -
BusinessGroupId: integer
(int64)
Read Only:
trueBusiness group identifier for job offers on the HR side. -
BusinessUnitId: integer
(int64)
Read Only:
trueBusiness unit identifier for job offers on the HR side. -
CandidateName: string
Title:
Candidate NameRead Only:trueMaximum Length:240Candidate name in the job offer being previewed. -
CandidateNumber: string
Title:
Candidate NumberRead Only:trueMaximum Length:30Candidate number in the job offer being previewed. -
CandidateType: string
Title:
Candidate TypeMaximum Length:255Candidate type in the job offer being previewed. -
Code: string
Read Only:
trueMaximum Length:30State Code of the HR job offer being previewed. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueJob offer creation date. -
EffectiveEndDate: string
(date)
Read Only:
trueEffective end date of the CandidatePEO. -
EffectiveEndDateAssignment: string
(date)
Read Only:
trueEffective end date of the assignment. -
EffectiveLatestChange: string
Title:
Effective Latest ChangeRead Only:trueMaximum Length:30Effective last change for the assignment. -
EffectiveSequence: integer
Title:
Effective SequenceRead Only:trueEffective sequence of the assignment. -
EffectiveStartDate: string
(date)
Read Only:
trueEffective start date of the CandidatePEO. -
EffectiveStartDateAssignment: string
(date)
Read Only:
trueEffective start date of the assignment. -
HireDate: string
(date)
Title:
Projected Start DateRead Only:trueHire date in the job offer being previewed. -
HiringManager: string
Title:
Hiring ManagerMaximum Length:255Hiring manager name in the job offer being previewed. -
HiringManagerId: integer
(int64)
Hiring manager ID in the job offer being previewed.
-
JobId: integer
(int64)
Read Only:
trueJob ID in the job offer being previewed. -
JobName: string
Title:
Job NameMaximum Length:255Job name in the job offer being previewed. -
LegalEmployer: string
Title:
Legal EmployerMaximum Length:255Legal employer name in the job offer being previewed. -
LegalEntityId: integer
(int64)
Read Only:
trueLegal entity ID in the job offer being previewed. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
LocationId: integer
(int64)
Read Only:
trueLocation ID in the job offer being previewed. -
Name: string
Title:
StateRead Only:trueMaximum Length:240State name in the job offer being previewed. -
ObjectStatus: string
Maximum Length:
30Default Value:ORA_ACTIVEObject status in the job offer being previewed. -
ObjectVersionNumber: integer
(int32)
Object version number in the job offer being previewed.
-
ObjectVersionNumberAssignment: integer
(int32)
Read Only:
trueObject version number for the assignment. -
ObjectVersionNumberCandidate: integer
(int32)
Read Only:
trueObject version number for the candidate. -
OfferId: integer
(int64)
Offer ID in the job offer being previewed.
-
OfferName: string
Maximum Length:
240Offer title in the job offer being previewed. -
OfferTitle: string
Title:
Offer NameMaximum Length:240Offer title in the job offer being previewed. -
OrganizationId: integer
(int64)
Read Only:
trueOrganization ID in the job offer being previewed. -
PersonId: integer
(int64)
Title:
Candidate NameRead Only:truePerson ID in the job offer being previewed. -
PersonNameId: integer
(int64)
Read Only:
truePerson name ID in the job offer being previewed. -
PositionId: integer
(int64)
Read Only:
truePosition ID in the job offer being previewed. -
PositionName: string
Title:
Position NameMaximum Length:255Position name in the job offer being previewed. -
PreselectHRActionId: integer
(int64)
Preselected HR action identifier of the job offers on the HR side.
-
Recruiter: string
Title:
RecruiterMaximum Length:255Recruiter name in the job offer being previewed. -
RecruiterId: integer
(int64)
Recruiter ID in the job offer being previewed.
-
RequisitionId: integer
(int64)
Read Only:
trueRequisition ID in the job offer being previewed. -
RequisitionNumber: string
Title:
Requisition NumberRead Only:trueMaximum Length:240Requisition number in the job offer being previewed. -
State: integer
(int64)
Title:
Offer StateRead Only:trueState code in the job offer being previewed. -
StateSort: string
Read Only:
trueMaximum Length:255Sorting the status of the job offer in the list. -
SubmissionId: integer
(int64)
Read Only:
trueSubmission ID in the job offer being previewed. -
Title: string
Title:
Requisition TitleRead Only:trueMaximum Length:240Requisition title of job offers on the HR side.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed 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.