Jump to

• Request
• Response

Create a candidate duplicate check result

post

/hcmRestApi/resources/11.13.18.05/recruitingCandidateDuplicates/{DupChkLogId}/child/duplicateCheckResults

Request

Path Parameters

• DupChkLogId(required): integer
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=

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

{
    "type":"object",
    "properties":{
    }
}

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 : recruitingCandidateDuplicates-duplicateCheckResults-item-response

Type: object

Show Source

• DobMatch: string
  Read Only: true

  Maximum Length: 255

  Indicates if there is a match between the date of birth of the candidate for which the duplicate check is performed and the date of birth of the candidate retrieved as a potential duplicate.
• DupChkLogId: integer
  Read Only: true

  Unique identifier for the candidate duplicate check.
• DupChkResultId: integer
  Read Only: true

  Unique identifier for the candidate duplicate check result.
• DupPersonId: integer
  Read Only: true

  Person identifier of the candidate retrieved as part of the duplicate check.
• DupPersonName: string
  Read Only: true

  Maximum Length: 255

  Name of the candidate retrieved as part of the duplicate check.
• DupPersonType: string
  Read Only: true

  Maximum Length: 255

  Person type code of the duplicate candidate retrieved as part of the duplicate check.
• DupPersonTypeMeaning: string
  Read Only: true

  Maximum Length: 255

  Person type meaning of the duplicate candidate retrieved as part of the duplicate check.
• GroupCode: string
  Read Only: true

  Maximum Length: 255

  Group code obtained for the candidate duplicate check.
• links: array Links
  Title: Links

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

  Maximum Length: 255

  Match score obtained for the candidate duplicate check.
• MatchScoreName: string
  Read Only: true

  Maximum Length: 255

  Match score name obtained for the candidate duplicate check.
• NidMatch: string
  Read Only: true

  Maximum Length: 255

  Indicates if there is a match between the national identifier of the candidate for which the duplicate check is performed and the national identifier of the candidate retrieved as a potential duplicate.
• PersonId: integer
  Read Only: true

  Person ID of the candidate for which the duplicate check is performed.

{
    "type":"object",
    "properties":{
        "MatchScore":{
            "maxLength":255,
            "type":"string",
            "description":"Match score obtained for the candidate duplicate check.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "NidMatch":{
            "maxLength":255,
            "type":"string",
            "description":"Indicates if there is a match between the national identifier of the candidate for which the duplicate check is performed and the national identifier of the candidate retrieved as a potential duplicate.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DobMatch":{
            "maxLength":255,
            "type":"string",
            "description":"Indicates if there is a match between the date of birth of the candidate for which the duplicate check is performed and the date of birth of the candidate retrieved as a potential duplicate.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DupChkLogId":{
            "type":"integer",
            "description":"Unique identifier for the candidate duplicate check.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "GroupCode":{
            "maxLength":255,
            "type":"string",
            "description":"Group code obtained for the candidate duplicate check.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DupPersonId":{
            "type":"integer",
            "description":"Person identifier of the candidate retrieved as part of the duplicate check.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MatchScoreName":{
            "maxLength":255,
            "type":"string",
            "description":"Match score name obtained for the candidate duplicate check.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DupPersonName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the candidate retrieved as part of the duplicate check.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PersonId":{
            "type":"integer",
            "description":"Person ID of the candidate for which the duplicate check is performed.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DupPersonTypeMeaning":{
            "maxLength":255,
            "type":"string",
            "description":"Person type meaning of the duplicate candidate retrieved as part of the duplicate check.",
            "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"
            }
        },
        "DupChkResultId":{
            "type":"integer",
            "description":"Unique identifier for the candidate duplicate check result.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DupPersonType":{
            "maxLength":255,
            "type":"string",
            "description":"Person type code of the duplicate candidate retrieved as part of the duplicate check.",
            "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