Jump to

• Request
• Response

Create a candidate during the job offer process

post

/hcmRestApi/resources/11.13.18.05/recruitingUIMergeJobOffers

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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• ActualTerminationDate: string (date)
  Actual termination date of the candidate.
• AssignmentName: string
  Maximum Length: 255

  Name of the assignment of the candidate.
• AssignmentNumber: string
  Maximum Length: 255

  Assignment number of the candidate.
• BusinessUnitName: string
  Maximum Length: 255

  Name of the business unit of the candidate.
• DateOfBirthMatch: string
  Indicates whether the date of birth matches the potential duplicate candidate.
• DateStart: string (date)
  Start date of the candidate.
• Department: string
  Maximum Length: 255

  Department of the candidate.
• DisplayName: string
  Maximum Length: 255

  Display name of the candidate.
• FirstName: string
  Maximum Length: 255

  First name of the candidate.
• LastName: string
  Maximum Length: 255

  Last name of the candidate.
• Location: string
  Maximum Length: 255

  Location of the candidate.
• NationalIdMatch: string
  Maximum Length: 255

  Indicates whether the national identifier matches the potential duplicate candidate.
• PersonId: integer
  Person identifier of the candidate.
• RehireReason: string
  Maximum Length: 255

  Reason for rehiring the candidate.
• RehireRecommendation: string
  Maximum Length: 255

  Recommendation to rehire the candidate.
• SubmissionId: integer
  Submission identifier of the newly created offer.

{
    "type":"object",
    "properties":{
        "NationalIdMatch":{
            "maxLength":255,
            "type":"string",
            "description":"Indicates whether the national identifier matches the potential duplicate candidate.",
            "nullable":true
        },
        "RehireReason":{
            "maxLength":255,
            "type":"string",
            "description":"Reason for rehiring the candidate.",
            "nullable":true
        },
        "FirstName":{
            "maxLength":255,
            "type":"string",
            "description":"First name of the candidate.",
            "nullable":true
        },
        "DateStart":{
            "type":"string",
            "description":"Start date of the candidate.",
            "format":"date",
            "nullable":true
        },
        "DateOfBirthMatch":{
            "type":"string",
            "description":"Indicates whether the date of birth matches the potential duplicate candidate.",
            "nullable":true
        },
        "ActualTerminationDate":{
            "type":"string",
            "description":"Actual termination date of the candidate.",
            "format":"date",
            "nullable":true
        },
        "Department":{
            "maxLength":255,
            "type":"string",
            "description":"Department of the candidate.",
            "nullable":true
        },
        "PersonId":{
            "type":"integer",
            "description":"Person identifier of the candidate.",
            "nullable":true
        },
        "AssignmentName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the assignment of the candidate.",
            "nullable":true
        },
        "DisplayName":{
            "maxLength":255,
            "type":"string",
            "description":"Display name of the candidate.",
            "nullable":true
        },
        "AssignmentNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Assignment number of the candidate.",
            "nullable":true
        },
        "SubmissionId":{
            "type":"integer",
            "description":"Submission identifier of the newly created offer.",
            "nullable":true
        },
        "RehireRecommendation":{
            "maxLength":255,
            "type":"string",
            "description":"Recommendation to rehire the candidate.",
            "nullable":true
        },
        "LastName":{
            "maxLength":255,
            "type":"string",
            "description":"Last name of the candidate.",
            "nullable":true
        },
        "BusinessUnitName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the business unit of the candidate.",
            "nullable":true
        },
        "Location":{
            "maxLength":255,
            "type":"string",
            "description":"Location of the candidate.",
            "nullable":true
        }
    }
}

Back to Top

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.

Body ()

Root Schema : recruitingUIMergeJobOffers-item-response

Type: object

Show Source

• ActualTerminationDate: string (date)
  Actual termination date of the candidate.
• AssignmentName: string
  Maximum Length: 255

  Name of the assignment of the candidate.
• AssignmentNumber: string
  Maximum Length: 255

  Assignment number of the candidate.
• BusinessUnitName: string
  Maximum Length: 255

  Name of the business unit of the candidate.
• DateOfBirthMatch: string
  Indicates whether the date of birth matches the potential duplicate candidate.
• DateStart: string (date)
  Start date of the candidate.
• Department: string
  Maximum Length: 255

  Department of the candidate.
• DisplayName: string
  Maximum Length: 255

  Display name of the candidate.
• FirstName: string
  Maximum Length: 255

  First name of the candidate.
• LastName: string
  Maximum Length: 255

  Last name of the candidate.
• LegalEntityName: string
  Read Only: true

  Maximum Length: 255

  Legal entity name of the candidate.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Location: string
  Maximum Length: 255

  Location of the candidate.
• NationalIdMatch: string
  Maximum Length: 255

  Indicates whether the national identifier matches the potential duplicate candidate.
• PersonId: integer
  Person identifier of the candidate.
• PersonType: string
  Read Only: true

  Maximum Length: 255

  Person type of the candidate.
• RehireReason: string
  Maximum Length: 255

  Reason for rehiring the candidate.
• RehireRecommendation: string
  Maximum Length: 255

  Recommendation to rehire the candidate.
• SubmissionId: integer
  Submission identifier of the newly created offer.

{
    "type":"object",
    "properties":{
        "NationalIdMatch":{
            "maxLength":255,
            "type":"string",
            "description":"Indicates whether the national identifier matches the potential duplicate candidate.",
            "nullable":true,
            "x-queryable":true
        },
        "RehireReason":{
            "maxLength":255,
            "type":"string",
            "description":"Reason for rehiring the candidate.",
            "nullable":true,
            "x-queryable":true
        },
        "FirstName":{
            "maxLength":255,
            "type":"string",
            "description":"First name of the candidate.",
            "nullable":true,
            "x-queryable":true
        },
        "DateStart":{
            "type":"string",
            "description":"Start date of the candidate.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "PersonType":{
            "maxLength":255,
            "type":"string",
            "description":"Person type of the candidate.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DateOfBirthMatch":{
            "type":"string",
            "description":"Indicates whether the date of birth matches the potential duplicate candidate.",
            "nullable":true,
            "x-queryable":true
        },
        "ActualTerminationDate":{
            "type":"string",
            "description":"Actual termination date of the candidate.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "Department":{
            "maxLength":255,
            "type":"string",
            "description":"Department of the candidate.",
            "nullable":true,
            "x-queryable":true
        },
        "PersonId":{
            "type":"integer",
            "description":"Person identifier of the candidate.",
            "nullable":true,
            "x-queryable":true
        },
        "AssignmentName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the assignment of the candidate.",
            "nullable":true,
            "x-queryable":true
        },
        "LegalEntityName":{
            "maxLength":255,
            "type":"string",
            "description":"Legal entity name of the candidate.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DisplayName":{
            "maxLength":255,
            "type":"string",
            "description":"Display name of the candidate.",
            "nullable":true,
            "x-queryable":true
        },
        "AssignmentNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Assignment number of the candidate.",
            "nullable":true,
            "x-queryable":true
        },
        "SubmissionId":{
            "type":"integer",
            "description":"Submission identifier of the newly created offer.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "RehireRecommendation":{
            "maxLength":255,
            "type":"string",
            "description":"Recommendation to rehire the candidate.",
            "nullable":true,
            "x-queryable":true
        },
        "LastName":{
            "maxLength":255,
            "type":"string",
            "description":"Last name of the candidate.",
            "nullable":true,
            "x-queryable":true
        },
        "BusinessUnitName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the business unit of the candidate.",
            "nullable":true,
            "x-queryable":true
        },
        "Location":{
            "maxLength":255,
            "type":"string",
            "description":"Location of the candidate.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top