Get a job offer
get
/hcmRestApi/resources/11.13.18.05/recruitingJobOffers/{recruitingJobOffersUniqID}
Request
Path Parameters
-
recruitingJobOffersUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Recruiting Job Offers resource and used to uniquely identify an instance of Recruiting Job Offers. The client should not generate the hash key value. Instead, the client should query on the Recruiting Job Offers collection resource in order to navigate to a specific instance of Recruiting Job Offers to get the hash key.
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:
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:
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 : recruitingJobOffers-item-response
Type:
Show Source
object
-
AcceptedOnBehalfDate: string
(date-time)
Date when the job offer was accepted on behalf of the candidate.
-
AcceptedOnBehalfFlag: boolean
Maximum Length:
1
Indicates if the offer was accepted on behalf of the candidate. -
AcceptedOnBehalfPersonId: integer
(int64)
ID assigned to the individual who accepted the job offer on behalf of the candidate.
-
AdditionalTextOne: string
(byte)
Additional text one.
-
AdditionalTextTwo: string
(byte)
Additional text two.
-
AssignmentOfferId: integer
(int64)
ID assigned to the assignment offer.
-
attachments: array
Attachments
Title:
Attachments
The attachments resource is used to view, create, and update attachments. -
CandidatePersonId: integer
(int64)
Read Only:
true
Person ID assigned to the candidate. -
collaborators: array
Collaborators
Title:
Collaborators
The collaborators resource includes all details about the collaborators who create and manage the job offers. -
Comments: string
Title:
Comments
Maximum Length:1000
Additional comments about the job offer. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
Name of the person who created the job offer. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date when the job offer was created. -
Description: string
(byte)
Title:
Recipient Message
Description of the job offer. -
EsignatureInstructions: string
(byte)
Instructions for the candidate's electronic signature.
-
ExpirationDate: string
(date-time)
Read Only:
true
Date when the job offer will expire. -
HireDate: string
(date)
Title:
Projected Start Date
Read Only:true
Date of hiring the candidate. -
HiringManagerAssignmentId: integer
(int64)
Read Only:
true
ID given to the assignment of the hiring manager. -
HiringManagerId: integer
(int64)
ID assigned to the hiring manager.
-
JobApplicationId: integer
(int64)
ID assigned for each job application.
-
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
Date when the job offer was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
Person who last updated the job offer. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
offerDFF: array
offerDFF
-
OfferId: integer
(int64)
ID assigned to each job offer.
-
OfferLetterLayoutId: integer
(int64)
ID assigned to each offer letter layout.
-
OfferName: string
Maximum Length:
240
Name for each job offer. -
PhaseId: integer
(int64)
Read Only:
true
ID assigned to each phase of the job offer. -
PhaseName: string
Read Only:
true
Maximum Length:240
Name of each phase of the job offer. -
RecruiterAssignmentId: integer
(int64)
Read Only:
true
ID assigned to each assignment given to a recruiter. -
RecruiterId: integer
(int64)
ID assigned to each recruiter.
-
RequisitionId: integer
(int64)
Read Only:
true
ID assigned to each requisition. -
StateId: integer
(int64)
Read Only:
true
ID assigned to each state of recruitment. -
StateName: string
Read Only:
true
Maximum Length:240
Name for each state of recruitment.
Nested Schema : Attachments
Type:
array
Title:
Attachments
The attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : Collaborators
Type:
array
Title:
Collaborators
The collaborators resource includes all details about the collaborators who create and manage the job offers.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : recruitingJobOffers-attachments-item-response
Type:
Show Source
object
-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker Id
Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document Id
The unique identifier of the attached document. -
CategoryName: string
Title:
Category
Maximum Length:30
The category of the attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:255
The user who created the record. -
CreatedByUserName: string
Title:
Created By User Name
Read Only:true
The user name who created the record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the record was created. -
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
A value that indicates the data type. -
Description: string
Title:
Description
Maximum Length:255
The description of the attachment. -
DmDocumentId: string
Maximum Length:
255
The document ID from which the attachment is created. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
The folder path from which the attachment is created. -
DmVersionNumber: string
Maximum Length:
255
The document version number from which the attachment is created. -
DownloadInfo: string
Title:
DownloadInfo
JSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status Code
The error code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status Message
The error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
The expiration date of the contents in the attachment. -
FileContents: string
(byte)
Title:
File Contents
The contents of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
The file name of the attachment. -
FileUrl: string
Title:
File Url
The URI of the file. -
FileWebImage: string
(byte)
Title:
File Web Image
Read Only:true
The base64 encoded image of the file displayed in .png format if the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
The date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:255
The user who last updated the record. -
LastUpdatedByUserName: string
Title:
Last Updated By User
Read Only:true
The user name who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PostProcessingAction: string
Title:
PostProcessingAction
The name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
Title
The title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
The content type of the attachment. -
UploadedFileLength: integer
Title:
File Size
The size of the attachment file. -
UploadedFileName: string
Title:
Uploaded File Name
The name to assign to a new attachment file. -
UploadedText: string
Title:
Uploaded Text
The text content for a new text attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
The URI of a Topology Manager type attachment. -
Url: string
Title:
Url
Maximum Length:4000
The URL of a web page type attachment. -
UserName: string
Title:
User Name
Read Only:true
Maximum Length:255
The login credentials of the user who created the attachment.
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 : recruitingJobOffers-collaborators-item-response
Type:
Show Source
object
-
CollaboratorAssignmentId: integer
(int64)
Read Only:
true
ID for each assignment given to the collaborator. -
CollaboratorId: integer
(int64)
ID for each collaborator.
-
CreatedBy: string
Read Only:
true
Maximum Length:64
Name of the collaborator who created the job offer. -
CreationDate: string
(date-time)
Read Only:
true
Date when the job offer was created by the collaborator. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date when the job offer was last updated by the collaborator. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
Collaborator who last updated the job offer. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PersonId: integer
(int64)
Read Only:
true
Person ID assigned to each collaborator.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : recruitingJobOffers-offerDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:150
-
__FLEX_Context_DisplayValue: string
Title:
Context Segment
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OfferId: integer
(int64)
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- attachments
-
Operation: /hcmRestApi/resources/11.13.18.05/recruitingJobOffers/{recruitingJobOffersUniqID}/child/attachmentsParameters:
- recruitingJobOffersUniqID:
$request.path.recruitingJobOffersUniqID
The attachments resource is used to view, create, and update attachments. - recruitingJobOffersUniqID:
- collaborators
-
Parameters:
- recruitingJobOffersUniqID:
$request.path.recruitingJobOffersUniqID
The collaborators resource includes all details about the collaborators who create and manage the job offers. - recruitingJobOffersUniqID:
- jobRequisitionsLOV
-
The following properties are defined on the LOV link relation:
- Source Attribute: RequisitionId; Target Attribute: RequisitionId
- Display Attribute: RequisitionId
- offerDFF
-
Operation: /hcmRestApi/resources/11.13.18.05/recruitingJobOffers/{recruitingJobOffersUniqID}/child/offerDFFParameters:
- recruitingJobOffersUniqID:
$request.path.recruitingJobOffersUniqID
- recruitingJobOffersUniqID:
- recruitingContentLibraryItemsLOV
-
The following properties are defined on the LOV link relation:
- Source Attribute: OfferLetterLayoutId; Target Attribute: ItemDescriptionId
- Display Attribute: ItemDescriptionId