Create a candidate duplicate check
post
/hcmRestApi/resources/11.13.18.05/recruitingCandidateDuplicates
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
Root Schema : schema
Type:
Show Source
object
-
DupChkLogId: integer
Unique identifier for the candidate duplicate check.
-
DupStrength: string
Match score obtained for the candidate duplicate check.
-
DupStrengthCount: integer
Number of duplicate candidates that have the highest match score.
-
PersonId: integer
Person ID of the candidate for which a duplicate candidate check was done.
-
PhaseId: integer
Phase ID when the candidate duplicate check was automatically triggered.
-
RequestedBy: string
User who initiated the candidate duplicate check.
-
RequestedOn: string
Date and time when the candidate duplicate check was initiated.
-
StateId: integer
State ID when the candidate duplicate check was automatically triggered.
-
SubmissionId: integer
Job application ID for which a candidate duplicate check was automatically triggered.
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.
Root Schema : recruitingCandidateDuplicates-item-response
Type:
Show Source
object
-
DupChkLogId: integer
Unique identifier for the candidate duplicate check.
-
DupStrength: string
Match score obtained for the candidate duplicate check.
-
DupStrengthCount: integer
Number of duplicate candidates that have the highest match score.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PersonId: integer
Person ID of the candidate for which a duplicate candidate check was done.
-
PhaseId: integer
Phase ID when the candidate duplicate check was automatically triggered.
-
RequestedBy: string
User who initiated the candidate duplicate check.
-
RequestedOn: string
Date and time when the candidate duplicate check was initiated.
-
StateId: integer
State ID when the candidate duplicate check was automatically triggered.
-
SubmissionId: integer
Job application ID for which a candidate duplicate check was automatically triggered.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.