Create a candidate

post

/hcmRestApi/resources/11.13.18.05/recruitingJobSiteCandidates

Request

Header Parameters
  • 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".
  • 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.
  • 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
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
  • Additional source tracking information of a candidate.
  • Addresses of the Candidates
    Title: Addresses of the Candidates
    The addresses resource is a child of the recruitingJobSiteCandidates resource. It provides details about the addresses of the candidates. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
  • Attachments of the Candidates
    Title: Attachments of the Candidates
    The attachments resource is a child of the recruitingJobSiteCandidates resource. It provides details about the documents attached by the candidates. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
  • Extra Information of the Candidates
    Title: Extra Information of the Candidates
    The candidateExtraInformation resource is a child of the recruitingJobSiteCandidates resource. It provides extra information about the candidates. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
  • Certifications of the Candidates
    Title: Certifications of the Candidates
    The certifications resource is a child of the recruitingJobSiteCandidates resource. It provides details about the certifications of the candidates. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
  • Person who created the candidate.
  • Creation date of the candidate.
  • Date of birth of the candidate.
  • Education of the Candidates
    Title: Education of the Candidates
    The educations resource is a child of the recruitingJobSiteCandidates resource. It provides details about the education of the candidates. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
  • Maximum Length: 240
    Email of the candidate.
  • Maximum Length: 150
    First name of the candidate.
  • Maximum Length: 80
    Honors of the candidate.
  • Maximum Length: 80
    Known as attribute of the candidate.
  • Languages of the Candidates
    Title: Languages of the Candidates
    The languages resource is a child of the recruitingJobSiteCandidates resource. It provides details about the languages of the candidates. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
  • Maximum Length: 150
    Last name of the candidate.
  • Last update date of the candidate.
  • Person who last updated the candidate.
  • Maximum Length: 80
    Middle names of the candidate.
  • Maximum Length: 80
    Military rank of the candidate.
  • National Identifiers of the Candidates
    Title: National Identifiers of the Candidates
    The nationalIdentifiers resource is a child of the recruitingJobSiteCandidates resource. It provides details about the national identifiers of the candidates. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
  • Phone Numbers of the Candidates
    Title: Phone Numbers of the Candidates
    The phones resource is a child of the recruitingJobSiteCandidates resource. It provides details about the phone numbers of candidates. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
  • Maximum Length: 4
    Preferred language of the candidate.
  • Maximum Length: 255
    Preferred time zone of the candidate.
  • Maximum Length: 150
    Previous name adjunct of the candidate.
  • Previous Employments of the Candidates
    Title: Previous Employments of the Candidates
    The previousEmployments resource is a child of the recruitingJobSiteCandidates resource. It provides details about the work experience of the candidates. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
  • Maximum Length: 150
    Previous last name of the candidate.
  • Skills of the Candidates
    Title: Skills of the Candidates
    The skills resource is a child of the recruitingJobSiteCandidates resource. It provides details about the skills of the candidates. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
  • Maximum Length: 80
    Suffix of the candidate.
  • Maximum Length: 30
    Title of the candidate.
  • Work Preferences of the Candidates
    Title: Work Preferences of the Candidates
    The workPreferences resource is a child of the recruitingJobSiteCandidates resource. It provides details about the work preferences of the candidates. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
Nested Schema : Addresses of the Candidates
Type: array
Title: Addresses of the Candidates
The addresses resource is a child of the recruitingJobSiteCandidates resource. It provides details about the addresses of the candidates. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
Show Source
Nested Schema : Attachments of the Candidates
Type: array
Title: Attachments of the Candidates
The attachments resource is a child of the recruitingJobSiteCandidates resource. It provides details about the documents attached by the candidates. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
Show Source
Nested Schema : Extra Information of the Candidates
Type: array
Title: Extra Information of the Candidates
The candidateExtraInformation resource is a child of the recruitingJobSiteCandidates resource. It provides extra information about the candidates. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
Show Source
Nested Schema : Certifications of the Candidates
Type: array
Title: Certifications of the Candidates
The certifications resource is a child of the recruitingJobSiteCandidates resource. It provides details about the certifications of the candidates. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
Show Source
Nested Schema : Education of the Candidates
Type: array
Title: Education of the Candidates
The educations resource is a child of the recruitingJobSiteCandidates resource. It provides details about the education of the candidates. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
Show Source
Nested Schema : Languages of the Candidates
Type: array
Title: Languages of the Candidates
The languages resource is a child of the recruitingJobSiteCandidates resource. It provides details about the languages of the candidates. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
Show Source
Nested Schema : National Identifiers of the Candidates
Type: array
Title: National Identifiers of the Candidates
The nationalIdentifiers resource is a child of the recruitingJobSiteCandidates resource. It provides details about the national identifiers of the candidates. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
Show Source
Nested Schema : Phone Numbers of the Candidates
Type: array
Title: Phone Numbers of the Candidates
The phones resource is a child of the recruitingJobSiteCandidates resource. It provides details about the phone numbers of candidates. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
Show Source
Nested Schema : Previous Employments of the Candidates
Type: array
Title: Previous Employments of the Candidates
The previousEmployments resource is a child of the recruitingJobSiteCandidates resource. It provides details about the work experience of the candidates. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
Show Source
Nested Schema : Skills of the Candidates
Type: array
Title: Skills of the Candidates
The skills resource is a child of the recruitingJobSiteCandidates resource. It provides details about the skills of the candidates. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
Show Source
Nested Schema : Work Preferences of the Candidates
Type: array
Title: Work Preferences of the Candidates
The workPreferences resource is a child of the recruitingJobSiteCandidates resource. It provides details about the work preferences of the candidates. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
Show Source
Nested Schema : recruitingJobSiteCandidates-addresses-item-post-request
Type: object
Show Source
Nested Schema : recruitingJobSiteCandidates-attachments-item-post-request
Type: object
Show Source
Nested Schema : schema
Type: object
Show Source
  • Maximum Length: 255
    Candidate number of the candidate extra information.
  • Maximum Length: 255
    Context code of the candidate extra information.
  • Maximum Length: 255
    Context link of the candidate extra information.
  • Data identifier of the candidate extra information.
  • Extra Information Rows of the Candidates
    Title: Extra Information Rows of the Candidates
    The dataRows resource is a child of the recruitingJobSiteCandidates resource. It provides rows containing extra information about the candidates. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
Nested Schema : Extra Information Rows of the Candidates
Type: array
Title: Extra Information Rows of the Candidates
The dataRows resource is a child of the recruitingJobSiteCandidates resource. It provides rows containing extra information about the candidates. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
Show Source
Nested Schema : recruitingJobSiteCandidates-candidateExtraInformation-dataRows-item-post-request
Type: object
Show Source
  • Extra Information Attributes of the Candidates
    Title: Extra Information Attributes of the Candidates
    The attributes resource is a child of the recruitingJobSiteCandidates resource. It provides row attributes containing extra information about the candidates. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
  • Maximum Length: 255
    Context row identifier of the candidate extra information data rows.
  • Maximum Length: 255
    Context row link of the candidate extra information data rows.
  • Data identifier of the candidate extra information data rows.
  • Data row identifier of the candidate extra information data rows.
  • Maximum Length: 255
    Row action that needs to be performed on the candidate extra information data rows.
Nested Schema : Extra Information Attributes of the Candidates
Type: array
Title: Extra Information Attributes of the Candidates
The attributes resource is a child of the recruitingJobSiteCandidates resource. It provides row attributes containing extra information about the candidates. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
Show Source
Nested Schema : schema
Type: object
Show Source
Nested Schema : schema
Type: object
Show Source
Nested Schema : schema
Type: object
Show Source
Nested Schema : recruitingJobSiteCandidates-languages-item-post-request
Type: object
Show Source
Nested Schema : recruitingJobSiteCandidates-nationalIdentifiers-item-post-request
Type: object
Show Source
Nested Schema : schema
Type: object
Show Source
Nested Schema : schema
Type: object
Show Source
Nested Schema : recruitingJobSiteCandidates-skills-item-post-request
Type: object
Show Source
Nested Schema : recruitingJobSiteCandidates-workPreferences-item-post-request
Type: object
Show Source
Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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.
Body ()
Root Schema : recruitingJobSiteCandidates-item-response
Type: object
Show Source
Nested Schema : Addresses of the Candidates
Type: array
Title: Addresses of the Candidates
The addresses resource is a child of the recruitingJobSiteCandidates resource. It provides details about the addresses of the candidates. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
Show Source
Nested Schema : Attachments of the Candidates
Type: array
Title: Attachments of the Candidates
The attachments resource is a child of the recruitingJobSiteCandidates resource. It provides details about the documents attached by the candidates. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
Show Source
Nested Schema : Extra Information of the Candidates
Type: array
Title: Extra Information of the Candidates
The candidateExtraInformation resource is a child of the recruitingJobSiteCandidates resource. It provides extra information about the candidates. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
Show Source
Nested Schema : Certifications of the Candidates
Type: array
Title: Certifications of the Candidates
The certifications resource is a child of the recruitingJobSiteCandidates resource. It provides details about the certifications of the candidates. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
Show Source
Nested Schema : Education of the Candidates
Type: array
Title: Education of the Candidates
The educations resource is a child of the recruitingJobSiteCandidates resource. It provides details about the education of the candidates. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
Show Source
Nested Schema : Languages of the Candidates
Type: array
Title: Languages of the Candidates
The languages resource is a child of the recruitingJobSiteCandidates resource. It provides details about the languages of the candidates. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
Show Source
Nested Schema : National Identifiers of the Candidates
Type: array
Title: National Identifiers of the Candidates
The nationalIdentifiers resource is a child of the recruitingJobSiteCandidates resource. It provides details about the national identifiers of the candidates. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
Show Source
Nested Schema : Phone Numbers of the Candidates
Type: array
Title: Phone Numbers of the Candidates
The phones resource is a child of the recruitingJobSiteCandidates resource. It provides details about the phone numbers of candidates. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
Show Source
Nested Schema : Previous Employments of the Candidates
Type: array
Title: Previous Employments of the Candidates
The previousEmployments resource is a child of the recruitingJobSiteCandidates resource. It provides details about the work experience of the candidates. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
Show Source
Nested Schema : Skills of the Candidates
Type: array
Title: Skills of the Candidates
The skills resource is a child of the recruitingJobSiteCandidates resource. It provides details about the skills of the candidates. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
Show Source
Nested Schema : Work Preferences of the Candidates
Type: array
Title: Work Preferences of the Candidates
The workPreferences resource is a child of the recruitingJobSiteCandidates resource. It provides details about the work preferences of the candidates. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
Show Source
Nested Schema : recruitingJobSiteCandidates-addresses-item-response
Type: object
Show Source
Nested Schema : recruitingJobSiteCandidates-attachments-item-response
Type: object
Show Source
Nested Schema : recruitingJobSiteCandidates-candidateExtraInformation-item-response
Type: object
Show Source
Nested Schema : Extra Information Rows of the Candidates
Type: array
Title: Extra Information Rows of the Candidates
The dataRows resource is a child of the recruitingJobSiteCandidates resource. It provides rows containing extra information about the candidates. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
Show Source
Nested Schema : recruitingJobSiteCandidates-candidateExtraInformation-dataRows-item-response
Type: object
Show Source
  • Extra Information Attributes of the Candidates
    Title: Extra Information Attributes of the Candidates
    The attributes resource is a child of the recruitingJobSiteCandidates resource. It provides row attributes containing extra information about the candidates. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
  • Maximum Length: 255
    Context row identifier of the candidate extra information data rows.
  • Data identifier of the candidate extra information data rows.
  • Data row identifier of the candidate extra information data rows.
  • Links
  • Maximum Length: 255
    Row action that needs to be performed on the candidate extra information data rows.
Nested Schema : Extra Information Attributes of the Candidates
Type: array
Title: Extra Information Attributes of the Candidates
The attributes resource is a child of the recruitingJobSiteCandidates resource. It provides row attributes containing extra information about the candidates. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
Show Source
Nested Schema : recruitingJobSiteCandidates-candidateExtraInformation-dataRows-attributes-item-response
Type: object
Show Source
Nested Schema : recruitingJobSiteCandidates-certifications-item-response
Type: object
Show Source
Nested Schema : recruitingJobSiteCandidates-educations-item-response
Type: object
Show Source
Nested Schema : recruitingJobSiteCandidates-languages-item-response
Type: object
Show Source
Nested Schema : recruitingJobSiteCandidates-nationalIdentifiers-item-response
Type: object
Show Source
Nested Schema : recruitingJobSiteCandidates-phones-item-response
Type: object
Show Source
Nested Schema : recruitingJobSiteCandidates-previousEmployments-item-response
Type: object
Show Source
Nested Schema : recruitingJobSiteCandidates-skills-item-response
Type: object
Show Source
Nested Schema : recruitingJobSiteCandidates-workPreferences-item-response
Type: object
Show Source
Back to Top