Create data for a job offer
post
/hcmRestApi/resources/11.13.18.05/recruitingUICreateOrUpdateJobOffers
Request
Header Parameters
-
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.
-
Upsert-Mode: string
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object-
AcceptedDate: string
(date-time)
Date when the job offer was accepted.
-
AcceptedOnBehalfById: integer
Identifier of the person who accepted the job offer on behalf of the candidate.
-
AcceptedOnBehalfDate: string
(date-time)
Date when the person accepted the job offer on behalf of the candidate.
-
additionalInformationDetails: array
additionalInformationDetails
-
Additionaltextone: string
Title:
First Additional TextFirst additional information text field. -
Additionaltexttwo: string
Title:
Second Additional TextSecond additional information text field. -
AssignmentContractId: integer
Assignment contract identifier in the job offer being created or updated.
-
AssignmentId: integer
Assignment identifier of the job offer being created or updated.
-
AssignmentOfferId: integer
Offer assignment identifier of the job offer being created or updated.
-
AssignmentPositionId: integer
Assignment position identifier of the job offer being created or updated.
-
BusinessGroupId: integer
Business group identifier of the job offer being created or updated.
-
BusinessUnitId: integer
Business unit identifier of the job offer being created or updated.
-
CandidateNumber: string
Maximum Length:
255Candidate number of the candidate for which the job offer is being created or updated. -
candidateOfferLetter: array
Attachments
Title:
AttachmentsThe attachments resource is used to view, create, and update attachments. -
CandidateType: string
Maximum Length:
255Candidate type of the candidate for which the job offer is being created or updated. -
CategoryCandidate: string
Maximum Length:
255Category of the candidate for which the job offer is being created or updated. -
Code: string
Maximum Length:
255Code of the job offer being created or updated. -
collaborators: array
Recruiting Job Offer Collaborators
Title:
Recruiting Job Offer CollaboratorsThe collaborators resource provides details about the collaborators of a job offer. -
Comments: string
Maximum Length:
255Comments of the job offer being created or updated. -
CountryCode: string
Maximum Length:
255Country code of the job offer being created or updated. -
CurrentPhaseId: integer
Current phase identifier of the job offer being created or updated.
-
CurrentStateId: integer
Current state identifier of the job offer being created or updated.
-
DepartmentId: integer
Department identifier of the job offer being created or updated.
-
Description: string
Maximum Length:
255Description of the job offer being created or updated. -
EffectiveEndDate: string
(date)
Effective end date of the job offer being created or updated.
-
EffectiveStartDate: string
(date)
Effective start date of the job offer being created or updated.
-
EsignatureInstructions: string
(byte)
E signature instructions in the job offer being created or updated.
-
ExpirationDate: string
(date-time)
Title:
Expiration DateExpiration date of the job offer being created or updated. -
FullPartTime: string
Maximum Length:
255Full time or part time attribute of the job offer being created or updated. -
GradeId: integer
Grade identifier of the job offer being created or updated.
-
HandoffHRScenarioId: integer
Handoff HR scenario identifier for the job offer being created or updated.
-
HiringManagerAssignmentId: integer
Title:
Hiring ManagerHiring manager assignment identifier of the job offer being created or updated. -
HiringManagerId: integer
Hiring manager identifier of the job offer being created or updated.
-
HiringManagerPersonNumber: string
Maximum Length:
255Hiring manager number of the job offer being created or updated. -
internalAttachments: array
Attachments
Title:
AttachmentsThe attachments resource is used to view, create, and update attachments. -
JobId: integer
Job identifier of the job offer being created or updated.
-
LegalEmployerId: integer
Legal employer identifier of the job offer being created or updated.
-
LegalEntityId: integer
Legal entity identifier of the job offer being created or updated.
-
LocationId: integer
Location identifier of the job offer being created or updated.
-
MergedStatus: string
Maximum Length:
255Merge status of the duplicate offer. -
Name: string
Maximum Length:
255Name of the job offer being created or updated. -
ObjectStatus: string
Maximum Length:
255Object status of the job offer being created or updated. -
offerAttachments: array
Attachments
Title:
AttachmentsThe attachments resource is used to view, create, and update attachments. -
OfferComments: string
Title:
Offer CommentsOffer comments of the job offer being created or updated. -
OfferId: integer
Offer identifier of the job offer being created or updated.
-
offerIdToUpdate: integer
Offer identifier to update of the job offer being created or updated.
-
OfferLetterCustomized: string
Maximum Length:
255Modified offer letter in the job offer being created or updated. -
OfferLetterLayoutId: integer
Title:
Offer Letter TemplateOffer letter layout identifier in the job offer being created or updated. -
OfferLetterLayoutName: string
Maximum Length:
255Offer letter layout name in the job offer being created or updated. -
OfferMode: string
Maximum Length:
255Offer mode of the job offer being created or updated. -
OfferName: string
Maximum Length:
255Offer object status of the job offer being created or updated. -
OfferObjectStatus: string
Maximum Length:
255Offer name of the job offer being created or updated. -
ParentAssignmentId: integer
Parent offer assignment identifier.
-
ParentOfferId: integer
Parent offer identifier of the job offer being created or updated.
-
PersonId: integer
Person identifier of the job offer being created or updated.
-
PersonStartDate: string
(date)
Effective start date of the person for whom the job offer is being created or updated.
-
PhaseId: integer
Phase identifier of the job offer being created or updated.
-
PositionId: integer
Position identifier of the job offer being created or updated.
-
PreselectedHRActionId: integer
Preselected HR action identifier for the job offer being created or updated.
-
PreselectedHRActiontypeCode: string
Maximum Length:
255Preselected HR action type code for the job offer being created or updated. -
ProjectedStartDate: string
(date)
Projected start date of the job offer being created or updated.
-
RecruiterAssignmentId: integer
Title:
RecruiterRecruiter assignment identifier of the job offer being created or updated. -
RecruiterId: integer
Recruiter identifier of the job offer being created or updated.
-
RecruitingTypeCode: string
Maximum Length:
255Recruiting type of the job offer being created or updated. -
RedraftCount: integer
Redraft count of the job offer being created or updated.
-
RegularTemporary: string
Maximum Length:
255Regular or temporary attribute of the job offer being created or updated. -
RequisitionCurrentPhaseId: integer
Requisition current phase identifier of the job offer being created or updated.
-
RequisitionCurrentStateId: integer
Requisition current state identifier of the job offer being created or updated.
-
RequisitionId: integer
Requisition identifier of the job offer being created or updated.
-
RequisitionNumber: string
Maximum Length:
255Requisition number of the job offer being created or updated. -
SiteNumber: string
Maximum Length:
255Site number of the job offer being created or updated. -
StateId: integer
State identifier of the job offer being created or updated.
-
StatePostProcessStatus: string
Maximum Length:
255State post process status of the job offer being created or updated. -
SubmissionId: integer
Submission identifier of the job offer being created or updated.
-
SubmissionInternalValue: string
Maximum Length:
255Submission internal value of the job offer being created or updated. -
SubmissionLanguageCode: string
Title:
Candidate Preferred LanguageMaximum Length:255Submission language code of the job offer being created or updated. -
VisitedSections: string
Maximum Length:
4000Sections visited while creating the offer. -
WithdrawnRejectedDate: string
(date-time)
Date when candidate is withdrawn or rejected in the job offer being created or updated.
-
WorkerTypeCode: string
Maximum Length:
255Worker type code of the job offer being created or updated. -
WorkTermsAssignmentId: integer
Work term assignment identifier for the job offer being created or updated.
Nested Schema : Attachments
Type:
arrayTitle:
AttachmentsThe attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : Recruiting Job Offer Collaborators
Type:
arrayTitle:
Recruiting Job Offer CollaboratorsThe collaborators resource provides details about the collaborators of a job offer.
Show Source
Nested Schema : Attachments
Type:
arrayTitle:
AttachmentsThe attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : Attachments
Type:
arrayTitle:
AttachmentsThe attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : schema
Type:
Show Source
object-
__FLEX_Context: string
Title:
Context SegmentMaximum Length:150Context Segment -
__FLEX_Context_DisplayValue: string
Title:
Context SegmentContext Segment -
OfferId: integer
(int64)
Nested Schema : schema
Type:
Show Source
object-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker IdAttribute provided for the exclusive use by the Attachment UI components to assist in uploading files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document IdThe unique identifier of the attached document. -
CategoryName: string
Title:
CategoryMaximum Length:30The category of the attachment. - ContentRepositoryFileShared: boolean
-
DatatypeCode: string
Title:
TypeMaximum Length:30Default Value:FILEA value that indicates the data type. -
Description: string
Title:
DescriptionMaximum Length:255The description of the attachment. -
DmDocumentId: string
Maximum Length:
255The document ID from which the attachment is created. -
DmFolderPath: string
Title:
Dm Folder PathMaximum Length:1000The folder path from which the attachment is created. -
DmVersionNumber: string
Maximum Length:
255The document version number from which the attachment is created. -
DownloadInfo: string
Title:
DownloadInfoJSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status CodeThe error code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status MessageThe error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration DateThe expiration date of the contents in the attachment. -
FileContents: string
(byte)
Title:
File ContentsThe contents of the attachment. -
FileName: string
Title:
File NameMaximum Length:2048The file name of the attachment. -
FileUrl: string
Title:
File UrlThe URI of the file. -
PostProcessingAction: string
Title:
PostProcessingActionThe name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
TitleThe title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content TypeThe content type of the attachment. -
UploadedFileLength: integer
Title:
File SizeThe size of the attachment file. -
UploadedFileName: string
Title:
Uploaded File NameThe name to assign to a new attachment file. -
UploadedText: string
Title:
Uploaded TextThe text content for a new text attachment. -
Uri: string
Title:
UriMaximum Length:4000The URI of a Topology Manager type attachment. -
Url: string
Title:
UrlMaximum Length:4000The URL of a web page type attachment.
Nested Schema : schema
Type:
Show Source
object-
AssignmentId: integer
(int64)
Assignment identifier for the collaborators.
-
CollaboratorRespTypeCode: string
Maximum Length:
30Responsibility type code for the collaborators. -
MemberTypeCode: string
Maximum Length:
30Member type code for the collaborators. -
ObjectId: integer
(int64)
Object identifier for the collaborators.
-
ObjectType: string
Maximum Length:
30Object type for the collaborators. -
ObjectVersionNumber: integer
(int32)
Object version number for the collaborators.
-
PersonId: integer
(int64)
Person identifier for the collaborators.
-
TeamMemberId: integer
(int64)
Team member identifier for the collaborators.
Nested Schema : recruitingUICreateOrUpdateJobOffers-internalAttachments-item-post-request
Type:
Show Source
object-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker IdAttribute provided for the exclusive use by the Attachment UI components to assist in uploading files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document IdThe unique identifier of the attached document. -
CategoryName: string
Title:
CategoryMaximum Length:30The category of the attachment. - ContentRepositoryFileShared: boolean
-
DatatypeCode: string
Title:
TypeMaximum Length:30Default Value:FILEA value that indicates the data type. -
Description: string
Title:
DescriptionMaximum Length:255The description of the attachment. -
DmDocumentId: string
Maximum Length:
255The document ID from which the attachment is created. -
DmFolderPath: string
Title:
Dm Folder PathMaximum Length:1000The folder path from which the attachment is created. -
DmVersionNumber: string
Maximum Length:
255The document version number from which the attachment is created. -
DownloadInfo: string
Title:
DownloadInfoJSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status CodeThe error code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status MessageThe error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration DateThe expiration date of the contents in the attachment. -
FileContents: string
(byte)
Title:
File ContentsThe contents of the attachment. -
FileName: string
Title:
File NameMaximum Length:2048The file name of the attachment. -
FileUrl: string
Title:
File UrlThe URI of the file. -
PostProcessingAction: string
Title:
PostProcessingActionThe name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
TitleThe title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content TypeThe content type of the attachment. -
UploadedFileLength: integer
Title:
File SizeThe size of the attachment file. -
UploadedFileName: string
Title:
Uploaded File NameThe name to assign to a new attachment file. -
UploadedText: string
Title:
Uploaded TextThe text content for a new text attachment. -
Uri: string
Title:
UriMaximum Length:4000The URI of a Topology Manager type attachment. -
Url: string
Title:
UrlMaximum Length:4000The URL of a web page type attachment.
Nested Schema : schema
Type:
Show Source
object-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker IdAttribute provided for the exclusive use by the Attachment UI components to assist in uploading files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document IdThe unique identifier of the attached document. -
CategoryName: string
Title:
CategoryMaximum Length:30The category of the attachment. - ContentRepositoryFileShared: boolean
-
DatatypeCode: string
Title:
TypeMaximum Length:30Default Value:FILEA value that indicates the data type. -
Description: string
Title:
DescriptionMaximum Length:255The description of the attachment. -
DmDocumentId: string
Maximum Length:
255The document ID from which the attachment is created. -
DmFolderPath: string
Title:
Dm Folder PathMaximum Length:1000The folder path from which the attachment is created. -
DmVersionNumber: string
Maximum Length:
255The document version number from which the attachment is created. -
DownloadInfo: string
Title:
DownloadInfoJSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status CodeThe error code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status MessageThe error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration DateThe expiration date of the contents in the attachment. -
FileContents: string
(byte)
Title:
File ContentsThe contents of the attachment. -
FileName: string
Title:
File NameMaximum Length:2048The file name of the attachment. -
FileUrl: string
Title:
File UrlThe URI of the file. -
PostProcessingAction: string
Title:
PostProcessingActionThe name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
TitleThe title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content TypeThe content type of the attachment. -
UploadedFileLength: integer
Title:
File SizeThe size of the attachment file. -
UploadedFileName: string
Title:
Uploaded File NameThe name to assign to a new attachment file. -
UploadedText: string
Title:
Uploaded TextThe text content for a new text attachment. -
Uri: string
Title:
UriMaximum Length:4000The URI of a Topology Manager type attachment. -
Url: string
Title:
UrlMaximum Length:4000The URL of a web page type attachment.
Response
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 : recruitingUICreateOrUpdateJobOffers-item-response
Type:
Show Source
object-
AcceptedDate: string
(date-time)
Date when the job offer was accepted.
-
AcceptedOnBehalfById: integer
Identifier of the person who accepted the job offer on behalf of the candidate.
-
AcceptedOnBehalfDate: string
(date-time)
Date when the person accepted the job offer on behalf of the candidate.
-
additionalInformationDetails: array
additionalInformationDetails
-
Additionaltextone: string
Title:
First Additional TextFirst additional information text field. -
Additionaltexttwo: string
Title:
Second Additional TextSecond additional information text field. -
AsgActionCode: string
Read Only:
trueMaximum Length:255Assignment action code for the job offer being created or updated. -
AssignmentContractId: integer
Assignment contract identifier in the job offer being created or updated.
-
AssignmentId: integer
Assignment identifier of the job offer being created or updated.
-
AssignmentOfferId: integer
Offer assignment identifier of the job offer being created or updated.
-
AssignmentPositionId: integer
Assignment position identifier of the job offer being created or updated.
-
BusinessGroupId: integer
Business group identifier of the job offer being created or updated.
-
BusinessUnitId: integer
Business unit identifier of the job offer being created or updated.
-
CandidateName: string
Read Only:
trueMaximum Length:255Candidate name for which the job offer is being created or updated. -
CandidateNumber: string
Maximum Length:
255Candidate number of the candidate for which the job offer is being created or updated. -
candidateOfferLetter: array
Attachments
Title:
AttachmentsThe attachments resource is used to view, create, and update attachments. -
CandidateType: string
Maximum Length:
255Candidate type of the candidate for which the job offer is being created or updated. -
CanUpdateCandidateJobOfferLetter: string
Read Only:
trueMaximum Length:255Flag to check if user has download to update offer letter of the job offer being created or updated. -
CategoryCandidate: string
Maximum Length:
255Category of the candidate for which the job offer is being created or updated. -
Code: string
Maximum Length:
255Code of the job offer being created or updated. -
collaborators: array
Recruiting Job Offer Collaborators
Title:
Recruiting Job Offer CollaboratorsThe collaborators resource provides details about the collaborators of a job offer. -
Comments: string
Maximum Length:
255Comments of the job offer being created or updated. -
CountryCode: string
Maximum Length:
255Country code of the job offer being created or updated. -
CurrentPhaseId: integer
Current phase identifier of the job offer being created or updated.
-
CurrentStateId: integer
Current state identifier of the job offer being created or updated.
-
DepartmentId: integer
Department identifier of the job offer being created or updated.
-
Description: string
Maximum Length:
255Description of the job offer being created or updated. -
EffectiveEndDate: string
(date)
Effective end date of the job offer being created or updated.
-
EffectiveStartDate: string
(date)
Effective start date of the job offer being created or updated.
-
EsignatureInstructions: string
(byte)
E signature instructions in the job offer being created or updated.
-
ExpirationDate: string
(date-time)
Title:
Expiration DateExpiration date of the job offer being created or updated. -
FullPartTime: string
Maximum Length:
255Full time or part time attribute of the job offer being created or updated. -
GradeId: integer
Grade identifier of the job offer being created or updated.
-
HandoffHRScenarioId: integer
Handoff HR scenario identifier for the job offer being created or updated.
-
HiringManagerAssignmentId: integer
Title:
Hiring ManagerHiring manager assignment identifier of the job offer being created or updated. -
HiringManagerId: integer
Hiring manager identifier of the job offer being created or updated.
-
HiringManagerPersonNumber: string
Maximum Length:
255Hiring manager number of the job offer being created or updated. -
internalAttachments: array
Attachments
Title:
AttachmentsThe attachments resource is used to view, create, and update attachments. -
JobId: integer
Job identifier of the job offer being created or updated.
-
LegalEmployerId: integer
Legal employer identifier of the job offer being created or updated.
-
LegalEntityId: integer
Legal entity identifier of the job offer being created or updated.
-
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
LocationId: integer
Location identifier of the job offer being created or updated.
-
MergedStatus: string
Maximum Length:
255Merge status of the duplicate offer. -
Name: string
Maximum Length:
255Name of the job offer being created or updated. -
ObjectStatus: string
Maximum Length:
255Object status of the job offer being created or updated. -
offerAttachments: array
Attachments
Title:
AttachmentsThe attachments resource is used to view, create, and update attachments. -
OfferComments: string
Title:
Offer CommentsOffer comments of the job offer being created or updated. -
OfferId: integer
Offer identifier of the job offer being created or updated.
-
offerIdToUpdate: integer
Offer identifier to update of the job offer being created or updated.
-
OfferLetterCustomized: string
Maximum Length:
255Modified offer letter in the job offer being created or updated. -
OfferLetterLayoutId: integer
Title:
Offer Letter TemplateOffer letter layout identifier in the job offer being created or updated. -
OfferLetterLayoutName: string
Maximum Length:
255Offer letter layout name in the job offer being created or updated. -
OfferMode: string
Maximum Length:
255Offer mode of the job offer being created or updated. -
OfferName: string
Maximum Length:
255Offer object status of the job offer being created or updated. -
OfferObjectStatus: string
Maximum Length:
255Offer name of the job offer being created or updated. -
ParentAssignmentId: integer
Parent offer assignment identifier.
-
ParentOfferId: integer
Parent offer identifier of the job offer being created or updated.
-
PersonId: integer
Person identifier of the job offer being created or updated.
-
PersonStartDate: string
(date)
Effective start date of the person for whom the job offer is being created or updated.
-
PhaseId: integer
Phase identifier of the job offer being created or updated.
-
PositionId: integer
Position identifier of the job offer being created or updated.
-
PreselectedHRActionId: integer
Preselected HR action identifier for the job offer being created or updated.
-
PreselectedHRActiontypeCode: string
Maximum Length:
255Preselected HR action type code for the job offer being created or updated. -
ProjectedStartDate: string
(date)
Projected start date of the job offer being created or updated.
-
RecruiterAssignmentId: integer
Title:
RecruiterRecruiter assignment identifier of the job offer being created or updated. -
RecruiterId: integer
Recruiter identifier of the job offer being created or updated.
-
RecruitingTypeCode: string
Maximum Length:
255Recruiting type of the job offer being created or updated. -
RedraftCount: integer
Redraft count of the job offer being created or updated.
-
RegularTemporary: string
Maximum Length:
255Regular or temporary attribute of the job offer being created or updated. -
RequisitionCurrentPhaseId: integer
Requisition current phase identifier of the job offer being created or updated.
-
RequisitionCurrentStateId: integer
Requisition current state identifier of the job offer being created or updated.
-
RequisitionHiringManagerAsmtId: integer
Read Only:
trueRequisition hiring manager assignment identifier for the job offer being created or updated. -
RequisitionHiringManagerId: integer
Read Only:
trueRequisition hiring manager identifier for the job offer being created or updated. -
RequisitionId: integer
Requisition identifier of the job offer being created or updated.
-
RequisitionNumber: string
Maximum Length:
255Requisition number of the job offer being created or updated. -
RequisitionTitle: string
Read Only:
trueMaximum Length:255Requisition title of the job offer being created or updated. -
SiteNumber: string
Maximum Length:
255Site number of the job offer being created or updated. -
StateId: integer
State identifier of the job offer being created or updated.
-
StatePostProcessStatus: string
Maximum Length:
255State post process status of the job offer being created or updated. -
SubmissionId: integer
Submission identifier of the job offer being created or updated.
-
SubmissionInternalValue: string
Maximum Length:
255Submission internal value of the job offer being created or updated. -
SubmissionLanguage: string
Read Only:
trueMaximum Length:255Submission language of the job offer being created or updated. -
SubmissionLanguageCode: string
Title:
Candidate Preferred LanguageMaximum Length:255Submission language code of the job offer being created or updated. -
VisitedSections: string
Maximum Length:
4000Sections visited while creating the offer. -
WithdrawnRejectedDate: string
(date-time)
Date when candidate is withdrawn or rejected in the job offer being created or updated.
-
WorkerTypeCode: string
Maximum Length:
255Worker type code of the job offer being created or updated. -
WorkTermsAssignmentId: integer
Work term assignment identifier for the job offer being created or updated.
Nested Schema : Attachments
Type:
arrayTitle:
AttachmentsThe attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : Recruiting Job Offer Collaborators
Type:
arrayTitle:
Recruiting Job Offer CollaboratorsThe collaborators resource provides details about the collaborators of a job offer.
Show Source
Nested Schema : Attachments
Type:
arrayTitle:
AttachmentsThe attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Attachments
Type:
arrayTitle:
AttachmentsThe attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : recruitingUICreateOrUpdateJobOffers-additionalInformationDetails-item-response
Type:
Show Source
object-
__FLEX_Context: string
Title:
Context SegmentMaximum Length:150Context Segment -
__FLEX_Context_DisplayValue: string
Title:
Context SegmentContext Segment -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
OfferId: integer
(int64)
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.
Nested Schema : recruitingUICreateOrUpdateJobOffers-candidateOfferLetter-item-response
Type:
Show Source
object-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker IdAttribute provided for the exclusive use by the Attachment UI components to assist in uploading files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document IdThe unique identifier of the attached document. -
CategoryName: string
Title:
CategoryMaximum Length:30The category of the attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:255The user who created the record. -
CreatedByUserName: string
Title:
Created By User NameRead Only:trueThe user name who created the record. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueThe date when the record was created. -
DatatypeCode: string
Title:
TypeMaximum Length:30Default Value:FILEA value that indicates the data type. -
Description: string
Title:
DescriptionMaximum Length:255The description of the attachment. -
DmDocumentId: string
Maximum Length:
255The document ID from which the attachment is created. -
DmFolderPath: string
Title:
Dm Folder PathMaximum Length:1000The folder path from which the attachment is created. -
DmVersionNumber: string
Maximum Length:
255The document version number from which the attachment is created. -
DownloadInfo: string
Title:
DownloadInfoJSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status CodeThe error code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status MessageThe error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration DateThe expiration date of the contents in the attachment. -
FileContents: string
(byte)
Title:
File ContentsThe contents of the attachment. -
FileName: string
Title:
File NameMaximum Length:2048The file name of the attachment. -
FileUrl: string
Title:
File UrlThe URI of the file. -
FileWebImage: string
(byte)
Title:
File Web ImageRead Only:trueThe base64 encoded image of the file displayed in .png format if the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update DateRead Only:trueThe date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:255The user who last updated the record. -
LastUpdatedByUserName: string
Title:
Last Updated By UserRead Only:trueThe user name who last updated the record. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
PostProcessingAction: string
Title:
PostProcessingActionThe name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
TitleThe title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content TypeThe content type of the attachment. -
UploadedFileLength: integer
Title:
File SizeThe size of the attachment file. -
UploadedFileName: string
Title:
Uploaded File NameThe name to assign to a new attachment file. -
UploadedText: string
Title:
Uploaded TextThe text content for a new text attachment. -
Uri: string
Title:
UriMaximum Length:4000The URI of a Topology Manager type attachment. -
Url: string
Title:
UrlMaximum Length:4000The URL of a web page type attachment. -
UserName: string
Title:
User NameRead Only:trueMaximum Length:255The login credentials of the user who created the attachment.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : recruitingUICreateOrUpdateJobOffers-collaborators-item-response
Type:
Show Source
object-
AssignmentId: integer
(int64)
Assignment identifier for the collaborators.
-
AssignmentName: string
Read Only:
trueMaximum Length:255Assignment name for the collaborators. -
CollaboratorName: string
Read Only:
trueMaximum Length:255Collaborator name for the collaborators. -
CollaboratorRespTypeCode: string
Maximum Length:
30Responsibility type code for the collaborators. -
CollaboratorTypeName: string
Title:
CollaboratorRead Only:trueMaximum Length:255Collaborator type name for the collaborators. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MemberTypeCode: string
Maximum Length:
30Member type code for the collaborators. -
ObjectId: integer
(int64)
Object identifier for the collaborators.
-
ObjectType: string
Maximum Length:
30Object type for the collaborators. -
ObjectVersionNumber: integer
(int32)
Object version number for the collaborators.
-
PersonId: integer
(int64)
Person identifier for the collaborators.
-
TeamMemberId: integer
(int64)
Team member identifier for the collaborators.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : recruitingUICreateOrUpdateJobOffers-internalAttachments-item-response
Type:
Show Source
object-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker IdAttribute provided for the exclusive use by the Attachment UI components to assist in uploading files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document IdThe unique identifier of the attached document. -
CategoryName: string
Title:
CategoryMaximum Length:30The category of the attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:255The user who created the record. -
CreatedByUserName: string
Title:
Created By User NameRead Only:trueThe user name who created the record. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueThe date when the record was created. -
DatatypeCode: string
Title:
TypeMaximum Length:30Default Value:FILEA value that indicates the data type. -
Description: string
Title:
DescriptionMaximum Length:255The description of the attachment. -
DmDocumentId: string
Maximum Length:
255The document ID from which the attachment is created. -
DmFolderPath: string
Title:
Dm Folder PathMaximum Length:1000The folder path from which the attachment is created. -
DmVersionNumber: string
Maximum Length:
255The document version number from which the attachment is created. -
DownloadInfo: string
Title:
DownloadInfoJSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status CodeThe error code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status MessageThe error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration DateThe expiration date of the contents in the attachment. -
FileContents: string
(byte)
Title:
File ContentsThe contents of the attachment. -
FileName: string
Title:
File NameMaximum Length:2048The file name of the attachment. -
FileUrl: string
Title:
File UrlThe URI of the file. -
FileWebImage: string
(byte)
Title:
File Web ImageRead Only:trueThe base64 encoded image of the file displayed in .png format if the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update DateRead Only:trueThe date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:255The user who last updated the record. -
LastUpdatedByUserName: string
Title:
Last Updated By UserRead Only:trueThe user name who last updated the record. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
PostProcessingAction: string
Title:
PostProcessingActionThe name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
TitleThe title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content TypeThe content type of the attachment. -
UploadedFileLength: integer
Title:
File SizeThe size of the attachment file. -
UploadedFileName: string
Title:
Uploaded File NameThe name to assign to a new attachment file. -
UploadedText: string
Title:
Uploaded TextThe text content for a new text attachment. -
Uri: string
Title:
UriMaximum Length:4000The URI of a Topology Manager type attachment. -
Url: string
Title:
UrlMaximum Length:4000The URL of a web page type attachment. -
UserName: string
Title:
User NameRead Only:trueMaximum Length:255The login credentials of the user who created the attachment.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : recruitingUICreateOrUpdateJobOffers-offerAttachments-item-response
Type:
Show Source
object-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker IdAttribute provided for the exclusive use by the Attachment UI components to assist in uploading files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document IdThe unique identifier of the attached document. -
CategoryName: string
Title:
CategoryMaximum Length:30The category of the attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:255The user who created the record. -
CreatedByUserName: string
Title:
Created By User NameRead Only:trueThe user name who created the record. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueThe date when the record was created. -
DatatypeCode: string
Title:
TypeMaximum Length:30Default Value:FILEA value that indicates the data type. -
Description: string
Title:
DescriptionMaximum Length:255The description of the attachment. -
DmDocumentId: string
Maximum Length:
255The document ID from which the attachment is created. -
DmFolderPath: string
Title:
Dm Folder PathMaximum Length:1000The folder path from which the attachment is created. -
DmVersionNumber: string
Maximum Length:
255The document version number from which the attachment is created. -
DownloadInfo: string
Title:
DownloadInfoJSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status CodeThe error code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status MessageThe error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration DateThe expiration date of the contents in the attachment. -
FileContents: string
(byte)
Title:
File ContentsThe contents of the attachment. -
FileName: string
Title:
File NameMaximum Length:2048The file name of the attachment. -
FileUrl: string
Title:
File UrlThe URI of the file. -
FileWebImage: string
(byte)
Title:
File Web ImageRead Only:trueThe base64 encoded image of the file displayed in .png format if the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update DateRead Only:trueThe date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:255The user who last updated the record. -
LastUpdatedByUserName: string
Title:
Last Updated By UserRead Only:trueThe user name who last updated the record. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
PostProcessingAction: string
Title:
PostProcessingActionThe name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
TitleThe title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content TypeThe content type of the attachment. -
UploadedFileLength: integer
Title:
File SizeThe size of the attachment file. -
UploadedFileName: string
Title:
Uploaded File NameThe name to assign to a new attachment file. -
UploadedText: string
Title:
Uploaded TextThe text content for a new text attachment. -
Uri: string
Title:
UriMaximum Length:4000The URI of a Topology Manager type attachment. -
Url: string
Title:
UrlMaximum Length:4000The URL of a web page type attachment. -
UserName: string
Title:
User NameRead Only:trueMaximum Length:255The login credentials of the user who created the attachment.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Links
- OfferLetterLayoutIdVA
-
Parameters:
- finder:
findByWord%3BDescriptionTypeCode%3DORA_OFFER_LETTER_TEMPLATE
The following properties are defined on the LOV link relation:- Source Attribute: OfferLetterLayoutId; Target Attribute: ItemDescriptionId
- Display Attribute: Name
- finder:
- additionalInformationDetails
-
Parameters:
- OfferId:
$request.path.OfferId
- OfferId:
- candidateOfferLetter
-
Parameters:
- OfferId:
$request.path.OfferId
The attachments resource is used to view, create, and update attachments. - OfferId:
- collaborators
-
Operation: /hcmRestApi/resources/11.13.18.05/recruitingUICreateOrUpdateJobOffers/{OfferId}/child/collaboratorsParameters:
- OfferId:
$request.path.OfferId
The collaborators resource provides details about the collaborators of a job offer. - OfferId:
- internalAttachments
-
Parameters:
- OfferId:
$request.path.OfferId
The attachments resource is used to view, create, and update attachments. - OfferId:
- offerAttachments
-
Parameters:
- OfferId:
$request.path.OfferId
The attachments resource is used to view, create, and update attachments. - OfferId: