Jump to

• Request
• Response

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

Request Body - application/vnd.oracle.adf.action+json ()

Root Schema : schema

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "requisitionIds":{
            "type":"array",
            "description":"Requisition numbers used to find job requisitions the candidate is applying to.",
            "nullable":true,
            "items":{
                "type":"number"
            }
        },
        "addedByContextType":{
            "type":"string",
            "description":"Added by context type of the prospect candidate.",
            "nullable":true
        },
        "personIds":{
            "type":"array",
            "description":"Person identifiers used to determine which candidates are prospect candidates.",
            "nullable":true,
            "items":{
                "type":"number"
            }
        },
        "contextId":{
            "type":"number",
            "description":"Context identifier of the prospect candidate.",
            "nullable":true
        }
    },
    "additionalProperties":false
}

Nested Schema : personIds

Type: array

Person identifiers used to determine which candidates are prospect candidates.

Show Source

• Array of: number

{
    "type":"array",
    "description":"Person identifiers used to determine which candidates are prospect candidates.",
    "nullable":true,
    "items":{
        "type":"number"
    }
}

Nested Schema : requisitionIds

Type: array

Requisition numbers used to find job requisitions the candidate is applying to.

Show Source

• Array of: number

{
    "type":"array",
    "description":"Requisition numbers used to find job requisitions the candidate is applying to.",
    "nullable":true,
    "items":{
        "type":"number"
    }
}

Back to Top

Response

Supported Media Types

• application/json
• application/vnd.oracle.adf.actionresult+json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : schema

Type: object

Show Source

• result(required): object result
  Additional Properties Allowed: additionalProperties

  Returns prospect candidates.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            },
            "description":"Returns prospect candidates."
        }
    },
    "additionalProperties":false
}

Nested Schema : result

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    },
    "description":"Returns prospect candidates."
}

Returns prospect candidates.

Back to Top