Create a prospect candidate
post
/hcmRestApi/resources/11.13.18.05/recruitingUIProspects/action/createProspects
Creates a prospect candidate who's invited to apply to a job requisition.
Request
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.
Supported Media Types
- application/vnd.oracle.adf.action+json
Root Schema : schema
Type:
Show Source
object
-
addedByContextType: string
Added by context type of the prospect candidate.
-
contextId: number
Context identifier of the prospect candidate.
-
personIds: array
personIds
Person identifiers used to determine which candidates are prospect candidates.
-
requisitionIds: array
requisitionIds
Requisition numbers used to find job requisitions the candidate is applying to.
Nested Schema : personIds
Type:
array
Person identifiers used to determine which candidates are prospect candidates.
Show Source
Nested Schema : requisitionIds
Type:
array
Requisition numbers used to find job requisitions the candidate is applying to.
Show Source
Response
Supported Media Types
- application/json
- application/vnd.oracle.adf.actionresult+json
Default Response
The following table describes the default response for this task.
Root Schema : schema
Type:
Show Source
object
-
result(required): object
result
Additional Properties Allowed: additionalPropertiesReturns prospect candidates.
Nested Schema : result
Type:
object
Additional Properties Allowed
Show Source
Returns prospect candidates.