Recruiting Job Offer Previews
recruitingUIJobOfferPreviews Based on latest (2026.09)
Create, change, delete and look up Recruiting Job Offer Previews, with candidate e sign letters, candidate e signed letters and candidate offer letter.
- Operations
- GET (list)GET (one)POST (create)PATCH (update)DELETE
- Record key
OfferId- Required on create
- none marked
- At a glance
- 17 fields1 finders5 children1 file/large text fields
Try it
Only attributes Oracle marks as searchable are offered.
GET /hcmRestApi/resources/11.13.18.05/recruitingUIJobOfferPreviews?fields=BipPreview,CandidateEsignCategory,CandidateEsignedCategory,CandidateVisibility,CategoryName&limit=25&onlyData=true
{
"items": [
{
"BipPreview": "<string, max 255>",
"CandidateEsignCategory": "<string, max 255>",
"CandidateEsignedCategory": "<string, max 255>",
"CandidateVisibility": "<string, max 255>",
"CategoryName": "<string, max 255>"
}
],
"count": 25,
"hasMore": true,
"limit": 25,
"offset": 0
}Shapes and placeholders, not real data. Replace https://<your-pod> and the login with your own: this site never sees them. Based on Oracle's latest (2026.09) REST specification.
Fields 17
| Attribute | Type | Use |
|---|---|---|
BipPreview | text · max 255 | Optional on createUpdatableSearchable |
CandidateEsignCategory | text · max 255 | Optional on createUpdatableSearchable |
CandidateEsignedCategory | text · max 255 | Optional on createUpdatableSearchable |
CandidateVisibility | text · max 255 | Optional on createUpdatableSearchable |
CategoryName | text · max 255 | Optional on createUpdatableSearchable |
CurrentStateId | number | Optional on createUpdatableSearchable |
EntityName | text · max 255 | Optional on createUpdatableSearchable |
ExternalLink | text | Optional on createUpdatableSearchable |
FileContents | text | Optional on createUpdatableSearchable |
OfferAvailable | text | Optional on createUpdatableSearchable |
OfferId | number | Optional on createUpdatableSearchable |
OfferLetterCategory | text · max 255 | Optional on createUpdatableSearchable |
OfferLetterEntity | text · max 255 | Optional on createUpdatableSearchable |
OfferName | text | Optional on createUpdatableSearchable |
ReportContent | text · max 255 | Optional on createUpdatableSearchable |
RequisitionId | number | Optional on createUpdatableSearchable |
SubmissionLanguageCode | text · max 255 | Optional on createUpdatableSearchable |
Names, types, labels and flags from Oracle's REST specification (latest (2026.09)). Flexfield and custom attributes vary by pod: check /describe for yours.
Finders 1
Predefined searches: ?finder=Name;variable=value,variable2=value2. Pick one in Try it to build the call.
findByOfferId·OfferId
Check a payload
Checked in your browser only; nothing you paste is sent anywhere. Checks names and flags, not values.
Children 5
Child resources sit under one record: /hcmRestApi/resources/11.13.18.05/recruitingUIJobOfferPreviews/{OfferId}/child/<name>. Add them to a GET with expand.
attachmentsGET · POST · PATCH · DELETE Attachments · 32 fieldsAsyncTrackerIdAttachedDocumentIdCategoryNameContentRepositoryFileSharedCreatedByCreatedByUserNameCreationDateDatatypeCodeDescriptionDmDocumentIdDmFolderPathDmVersionNumberDownloadInfoErrorStatusCodeErrorStatusMessageExpirationDateFileContentsFileNameFileUrlFileWebImageLastUpdateDateLastUpdatedByLastUpdatedByUserNamePostProcessingActionTitleUploadedFileContentTypeUploadedFileLengthUploadedFileNameUploadedTextUriUrlUserNamecandidateESignLettersGET Candidate Attachments · 33 fieldsAsyncTrackerIdAttachedDocumentIdCategoryNameContentRepositoryFileSharedCreatedByCreatedByUserNameCreationDateDatatypeCodeDescriptionDmDocumentIdDmFolderPathDmVersionNumberDocumentPreviewURLDownloadInfoErrorStatusCodeErrorStatusMessageExpirationDateFileContentsFileNameFileUrlFileWebImageLastUpdateDateLastUpdatedByLastUpdatedByUserNamePostProcessingActionTitleUploadedFileContentTypeUploadedFileLengthUploadedFileNameUploadedTextUriUrlUserNamecandidateESignedLettersGET Candidate Attachments · 33 fieldsAsyncTrackerIdAttachedDocumentIdCategoryNameContentRepositoryFileSharedCreatedByCreatedByUserNameCreationDateDatatypeCodeDescriptionDmDocumentIdDmFolderPathDmVersionNumberDocumentPreviewURLDownloadInfoErrorStatusCodeErrorStatusMessageExpirationDateFileContentsFileNameFileUrlFileWebImageLastUpdateDateLastUpdatedByLastUpdatedByUserNamePostProcessingActionTitleUploadedFileContentTypeUploadedFileLengthUploadedFileNameUploadedTextUriUrlUserNamecandidateOfferLetterGET · POST · PATCH · DELETE Attachments · 32 fieldsAsyncTrackerIdAttachedDocumentIdCategoryNameContentRepositoryFileSharedCreatedByCreatedByUserNameCreationDateDatatypeCodeDescriptionDmDocumentIdDmFolderPathDmVersionNumberDownloadInfoErrorStatusCodeErrorStatusMessageExpirationDateFileContentsFileNameFileUrlFileWebImageLastUpdateDateLastUpdatedByLastUpdatedByUserNamePostProcessingActionTitleUploadedFileContentTypeUploadedFileLengthUploadedFileNameUploadedTextUriUrlUserNamemediaLinksGET · POST · PATCH · DELETE Recruiting Job Offer Media Links · 8 fieldsLanguageLookupCodeMediaLinkIdSequenceNumberThumbnailURLTitleURLVisibilityCode
Use in AI Agent Studio
- Point a Business Object or REST tool at
/hcmRestApi/resources/11.13.18.05/recruitingUIJobOfferPreviewsand ask only for the fields the agent needs withfields=. Big responses cost tokens and slow the agent. - Prefer a finder such as
findByOfferIdfor the agent's main search: its variables become clean tool parameters. - Narrow with
q=on searchable fields and a smalllimit; for a count usetotalResults=true&limit=1. - Call once and pass the result on to later steps rather than calling the same endpoint again.
- This resource can change data. Put a human approval step before any create, update, delete or action call.
More in For Builders.
Pitfalls
- Attribute names are case-sensitive in
q,fieldsand bodies:BipPreview, notbippreview. - A list returns 25 rows unless you set
limit; readhasMoreand moveoffsetto page through. - Text fields have maximum lengths (shown in the field table). Longer values are rejected.