Jump to

• Request
• Response

Create a candidate

post

/hcmRestApi/resources/11.13.18.05/recruitingJobSiteCandidateDuplicates

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/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• Email: string
  Maximum Length: 255

  Email address of a candidate.

{
    "type":"object",
    "properties":{
        "Email":{
            "maxLength":"255",
            "type":"string",
            "description":"Email address of a 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 : recruitingJobSiteCandidateDuplicates-item-response

Type: object

Show Source

• CandidateNumber: string
  Read Only: true

  Candidate number of a candidate.
• CandidateType: string
  Read Only: true

  Maximum Length: 255

  Candidate type of a candidate.
• CreatedBy: string
  Read Only: true

  Maximum Length: 255

  User who created a candidate.
• CreationDate: string (date)
  Read Only: true

  Creation date of a candidate.
• Email: string
  Maximum Length: 255

  Email address of a candidate.
• FirstName: string
  Read Only: true

  Maximum Length: 255

  First name of a candidate.
• Honors: string
  Read Only: true

  Maximum Length: 255

  Honors of a candidate.
• KnownAs: string
  Read Only: true

  Maximum Length: 255

  Known as of a candidate.
• LastName: string
  Read Only: true

  Maximum Length: 255

  Last name of a candidate.
• LastUpdateDate: string (date)
  Read Only: true

  Date when a candidate was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 255

  Person who last updated a candidate.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MiddleNames: string
  Read Only: true

  Maximum Length: 255

  Middle names of a candidate.
• MilitaryRank: string
  Read Only: true

  Maximum Length: 255

  Military rank of a candidate.
• PersonId: string
  Read Only: true

  Maximum Length: 255

  Person identifier of a candidate.
• PreferredLanguage: string
  Read Only: true

  Maximum Length: 255

  Preferred language of a candidate.
• PreNameAdjunct: string
  Read Only: true

  Maximum Length: 255

  Forename of a candidate.
• PreviousLastName: string
  Read Only: true

  Maximum Length: 255

  Previous last name of a candidate.
• SourceMedium: string
  Read Only: true

  Maximum Length: 255

  Source medium of a candidate.
• SourceName: string
  Read Only: true

  Maximum Length: 255

  Source name of a candidate.
• Suffix: string
  Read Only: true

  Maximum Length: 255

  Suffix of a candidate.
• Title: string
  Read Only: true

  Maximum Length: 255

  Title of a candidate.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"255",
            "type":"string",
            "description":"Person who last updated a candidate.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CandidateType":{
            "maxLength":"255",
            "type":"string",
            "description":"Candidate type of a candidate.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Creation date of a candidate.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CandidateNumber":{
            "type":"string",
            "description":"Candidate number of a candidate.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PreNameAdjunct":{
            "maxLength":"255",
            "type":"string",
            "description":"Forename of a candidate.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"255",
            "type":"string",
            "description":"User who created a candidate.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Email":{
            "maxLength":"255",
            "type":"string",
            "description":"Email address of a candidate.",
            "nullable":true,
            "x-queryable":true
        },
        "Honors":{
            "maxLength":"255",
            "type":"string",
            "description":"Honors of a candidate.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FirstName":{
            "maxLength":"255",
            "type":"string",
            "description":"First name of a candidate.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PreviousLastName":{
            "maxLength":"255",
            "type":"string",
            "description":"Previous last name of a candidate.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Title":{
            "maxLength":"255",
            "type":"string",
            "description":"Title of a candidate.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "KnownAs":{
            "maxLength":"255",
            "type":"string",
            "description":"Known as of a candidate.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceMedium":{
            "maxLength":"255",
            "type":"string",
            "description":"Source medium of a candidate.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceName":{
            "maxLength":"255",
            "type":"string",
            "description":"Source name of a candidate.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Suffix":{
            "maxLength":"255",
            "type":"string",
            "description":"Suffix of a candidate.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PersonId":{
            "maxLength":"255",
            "type":"string",
            "description":"Person identifier of a candidate.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PreferredLanguage":{
            "maxLength":"255",
            "type":"string",
            "description":"Preferred language of a candidate.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastName":{
            "maxLength":"255",
            "type":"string",
            "description":"Last name of a candidate.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MiddleNames":{
            "maxLength":"255",
            "type":"string",
            "description":"Middle names of a candidate.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MilitaryRank":{
            "maxLength":"255",
            "type":"string",
            "description":"Military rank of a candidate.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when a candidate was last updated.",
            "format":"date",
            "nullable":true,
            "readOnly":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