Get all details of the offer letter for the internal candidate
get
/hcmRestApi/resources/11.13.18.05/recruitingUIICEOfferPreviews
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 a job offer using the offer identifier as the primary key.
Finder Variables- OfferId; integer; Identifier for an offer as the primary key.
- findByOfferId Finds an offer based on a offer identifier.
Finder Variables- OfferId; integer; Identifier for the offer.
- PrimaryKey Finds a job offer using the offer identifier as the 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:- ActionId; integer; Identifier of the action drop-down list on the offer page.
- BusinessUnitId; integer; Identifier of the business unit drop-down list on the offer page.
- CandidateName; string; Name of the candidate for the offer.
- CandidateOfferLetterContent; string; Candidate offer letter content in HTML format.
- CandidateVisibility; string; Visibility code used to derive the media links that are to be shown only for internal candidates.
- CategoryName; string; Category name used to fetch the candidate-facing attachments for internal candidates.
- Comments; string; Comments from candidates during offer decline.
- CountryCode; string; Country code for the country drop-down list on the offer page.
- EmailSignature; string; Email signature from candidates who accept an offer.
- EntityName; string; Entity name that fetches the candidate-facing attachments for internal candidates.
- LegalEntityId; integer; Legal entity identifier for the legal employer drop-down list on the offer page.
- OfferId; integer; Offer identifier as primary key to find the offer details.
- OfferLetterCategory; string; Filter to differentiate the offer letter extended to the internal candidate from other documents.
- OfferLetterEntity; string; Entity name that fetches the offer letter for internal candidates.
- OfferResponseResult; string; Response for post-action called during decline or accept.
- PersonId; integer; Person identifier for validating the email signature.
- PhaseId; integer; Phase identifier for the decline reasons fetched during phase.
- ProcessOfferId; integer; Indicates whether the offer is accepted or declined.
- ProposedWorkerType; string; Type identifier for worker type drop-down list on the offer page.
- ReasonId; integer; Reason selected by the candidate while declining an offer.
- RecruitingTypeCode; string; Recruiting type code for drop-down list on the offer page.
- RequisitionId; integer; Media links shown for this requisition.
- RequisitionNumber; string; Requisition number in the offer being previewed.
- Response; string; System response to calling the service that indicates whether a candidate accepted or declined the offer.
- ShowDeclineReasons; boolean; Indicates whether to display the decline reasons while declining the offer.
- Signature; string; First and last name entered as the signature when the candidate accepted an offer.
- StateId; integer; Unique identifier used to check whether the offer was extended or is still in a valid state for preview.
- SubmissionLanguageCode; string; Language code used during submission.
- SubsProcessTemplateId; integer; Template used to fetch the decline reasons.
- Title; string; Title of the job requisition in the offer being previewed.
- WithdrawnState; number; Identifier for the offer withdrawn state.
-
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 : recruitingUIICEOfferPreviews
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 : recruitingUIICEOfferPreviews-item-response
Type:
Show Source
object
-
ActionId: integer
(int64)
Read Only:
true
Identifier of the action drop-down list on the offer page. -
attachments: array
Attachments
Title:
Attachments
The attachments resource is used to view, create, and update attachments. -
BusinessUnitId: integer
(int64)
Read Only:
true
Identifier of the business unit drop-down list on the offer page. -
CandidateName: string
Read Only:
true
Maximum Length:240
Name of the candidate for the offer. -
candidateOfferLetter: array
Attachments
Title:
Attachments
The attachments resource is used to view, create, and update attachments. -
CandidateOfferLetterContent: string
Maximum Length:
255
Candidate offer letter content in HTML format. -
CandidateVisibility: string
Read Only:
true
Visibility code used to derive the media links that are to be shown only for internal candidates. -
CategoryName: string
Read Only:
true
Maximum Length:12
Category name used to fetch the candidate-facing attachments for internal candidates. -
Comments: string
Maximum Length:
255
Comments from candidates during offer decline. -
contacts: array
Job Offer Contact
Title:
Job Offer Contact
The contacts resource provides the contact information for the hiring manager and recruiter. -
CountryCode: string
Read Only:
true
Maximum Length:2
Country code for the country drop-down list on the offer page. -
EmailSignature: string
Maximum Length:
255
Email signature from candidates who accept an offer. -
EntityName: string
Read Only:
true
Maximum Length:21
Entity name that fetches the candidate-facing attachments for internal candidates. -
LegalEntityId: integer
(int64)
Read Only:
true
Legal entity identifier for the legal employer drop-down list on the offer page. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
mediaLinks: array
Recruiting Job Offer Media Links
Title:
Recruiting Job Offer Media Links
The mediaLinks resource provides the media links that are available for the requisition on which the job offer is created. -
offerDeclineReasons: array
Candidate Reasons to Decline the Job Offer
Title:
Candidate Reasons to Decline the Job Offer
The offerDeclineReasons resource is a child of the recruitingCEOfferDetails resource. It provides the reasons that the candidate can provide while declining the job offer. Note that the service endpoints in this resource category are only for Oracle internal use. -
OfferId: integer
Read Only:
true
Offer identifier as primary key to find the offer details. -
OfferLetterCategory: string
Read Only:
true
Maximum Length:12
Filter to differentiate the offer letter extended to the internal candidate from other documents. -
OfferLetterEntity: string
Read Only:
true
Maximum Length:21
Entity name that fetches the offer letter for internal candidates. -
OfferResponseResult: string
Maximum Length:
255
Response for post-action called during decline or accept. -
PersonId: integer
(int64)
Read Only:
true
Person identifier for validating the email signature. -
PhaseId: integer
(int64)
Read Only:
true
Phase identifier for the decline reasons fetched during phase. -
ProcessOfferId: integer
Indicates whether the offer is accepted or declined.
-
ProposedWorkerType: string
Read Only:
true
Maximum Length:30
Type identifier for worker type drop-down list on the offer page. -
ReasonId: integer
Reason selected by the candidate while declining an offer.
-
RecruitingTypeCode: string
Read Only:
true
Maximum Length:30
Recruiting type code for drop-down list on the offer page. -
RequisitionId: integer
(int64)
Read Only:
true
Media links shown for this requisition. -
RequisitionNumber: string
Read Only:
true
Maximum Length:240
Requisition number in the offer being previewed. -
Response: string
Maximum Length:
255
System response to calling the service that indicates whether a candidate accepted or declined the offer. -
ShowDeclineReasons: boolean
Indicates whether to display the decline reasons while declining the offer.
-
Signature: string
Maximum Length:
255
First and last name entered as the signature when the candidate accepted an offer. -
StateId: integer
(int64)
Read Only:
true
Unique identifier used to check whether the offer was extended or is still in a valid state for preview. -
SubmissionLanguageCode: string
Read Only:
true
Maximum Length:4
Language code used during submission. -
SubsProcessTemplateId: integer
(int64)
Read Only:
true
Template used to fetch the decline reasons. -
Title: string
Read Only:
true
Maximum Length:240
Title of the job requisition in the offer being previewed. -
WithdrawnState: number
Read Only:
true
Identifier for the offer withdrawn state.
Nested Schema : Attachments
Type:
array
Title:
Attachments
The attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : Attachments
Type:
array
Title:
Attachments
The attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : Job Offer Contact
Type:
array
Title:
Job Offer Contact
The contacts resource provides the contact information for the hiring manager and recruiter.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Recruiting Job Offer Media Links
Type:
array
Title:
Recruiting Job Offer Media Links
The mediaLinks resource provides the media links that are available for the requisition on which the job offer is created.
Show Source
Nested Schema : Candidate Reasons to Decline the Job Offer
Type:
array
Title:
Candidate Reasons to Decline the Job Offer
The offerDeclineReasons resource is a child of the recruitingCEOfferDetails resource. It provides the reasons that the candidate can provide while declining the job offer. Note that the service endpoints in this resource category are only for Oracle internal use.
Show Source
Nested Schema : recruitingUIICEOfferPreviews-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 : recruitingUIICEOfferPreviews-candidateOfferLetter-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 : recruitingUIICEOfferPreviews-contacts-item-response
Type:
Show Source
object
-
DisplayName: string
Read Only:
true
Maximum Length:255
Name of the hiring manager or recruiter. -
EmailAddress: string
Read Only:
true
Maximum Length:240
Email address of hiring manager or recruiter. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Memeber: string
Read Only:
true
Maximum Length:80
Indicates whether the record is for the hiring manager or the recruiter. -
ObjectId: integer
(int64)
Read Only:
true
Identifier used to retrieve contacts related to a specific offer. -
ObjectVersionNumber: integer
(int32)
Read Only:
true
Version of the record. -
PersonId: integer
(int64)
Read Only:
true
Person identifier that shows the image on the contact card. -
SearchPhoneNumber: string
Read Only:
true
Maximum Length:240
Phone number of the hiring manager or the recruiter. -
TeamMemberId: integer
(int64)
Read Only:
true
TeamMemberId used as the primary key to find contacts.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : recruitingUIICEOfferPreviews-mediaLinks-item-response
Type:
Show Source
object
-
Language: string
Read Only:
true
Maximum Length:4
Language in which media links are shown. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LookupCode: string
Read Only:
true
Maximum Length:30
Specifies whether an element is a video or an image. -
MediaLinkId: integer
(int64)
Read Only:
true
Primary key for media link. -
SequenceNumber: integer
(int32)
Read Only:
true
Sequence in which media links are displayed. -
ThumbnailURL: string
Read Only:
true
Maximum Length:1000
Image shown on the media link. -
Title: string
Read Only:
true
Maximum Length:240
Title of the media link. -
URL: string
Read Only:
true
Maximum Length:1000
URL played when the media link is selected. -
VisibilityCode: string
Read Only:
true
Maximum Length:30
Indicates whether the media link is for an internal or external candidate.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : recruitingUIICEOfferPreviews-offerDeclineReasons-item-response
Type:
Show Source
object
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ReasonId: integer
Read Only:
true
ID of the reason selected by candidates while declining the job offer. -
ReasonName: string
Read Only:
true
Maximum Length:512
Name of the reason selected by candidates while declining the job offer.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source