Jump to

• Request
• Response

Create a candidate certification

post

/hcmRestApi/resources/11.13.18.05/recruitingJobSiteCandidates/{CandidateNumber}/child/certifications

Request

Path Parameters

• CandidateNumber(required): string
  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.
• Upsert-Mode:
  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

• ActualCompletionDate: string (date)
  Title: Actual Completion Date

  Actual completion date of the candidate certification.
• CertificationId: integer (int64)
  Identifier of the candidate certification.
• CertificationName: string
  Title: License or Certificate

  Maximum Length: 240

  Certification name of the candidate certification.
• CertificationNumber: string
  Title: Certificate Number

  Maximum Length: 240

  Certification number of the candidate certification.
• CertificationURL: string
  Title: Certification URL

  Maximum Length: 2000

  Certification URL of the candidate certification.
• Comments: string (byte)
  Title: Comments

  Comments about the candidate certification.
• CompletedAmount: integer (int64)
  Title: Completed Amount

  Completed amount of the candidate certification.
• CompletedTrainingUnits: string
  Title: Training Completed Units

  Maximum Length: 240

  Completed training units of the candidate certification.
• ContentItemId: integer (int64)
  Title: License or Certificate

  Content item identifier of the candidate certification.
• CountryCode: string
  Title: Country

  Maximum Length: 30

  Country code of the candidate certification.
• EducationalEstablishment: string
  Title: Educational Establishment

  Maximum Length: 2000

  Educational establishment of the candidate certification.
• EducationalEstablishmentId: integer (int64)
  Title: Establishment

  Educational establishment identifier of the candidate certification.
• ExpirationDate: string (date)
  Title: Expiration Date

  Expiration date of the candidate certification.
• IssueDate: string (date)
  Title: Issue Date

  Issue date of the candidate certification.
• IssuedBy: string
  Title: Issued By

  Maximum Length: 240

  Entity who issued the candidate certification.
• LastRenewalDate: string (date)
  Title: Last Renewal Date

  Last renewal date of the candidate certification.
• OriginalIssueYear: integer (int64)
  Title: Original Issue Year

  Original issue year of the candidate certification.
• RenewalDate: string (date)
  Title: Renewal Date

  Renewal date of the candidate certification.
• RenewalInprogressFlag: boolean
  Title: Renewal In Progress

  Maximum Length: 30

  Indicates the renewal in progress indicator of the candidate certification.
• RenewalRequiredFlag: boolean
  Title: Renewal Required

  Maximum Length: 30

  Indicates whether the renewal indicator is required in the candidate certification.
• Restrictions: string (byte)
  Title: Restrictions

  Restrictions of the candidate certification.
• SectionId: integer (int64)
  Section identifier of the candidate certification.
• StateProvinceCode: string
  Title: State

  Maximum Length: 360

  State province code of the candidate certification.
• Status: string
  Title: Status

  Maximum Length: 30

  Status of the candidate certification.
• Title: string
  Title: Title

  Maximum Length: 240

  Title of the candidate certification.
• TotalAmount: integer (int64)
  Title: Total Amount

  Total amount of the candidate certification.
• VerifiedFlag: boolean
  Title: Verified

  Maximum Length: 30

  Indicates the verified indicator of the candidate education.

{
    "type":"object",
    "properties":{
        "RenewalRequiredFlag":{
            "title":"Renewal Required",
            "maxLength":"30",
            "type":"boolean",
            "description":"Indicates whether the renewal indicator is required in the candidate certification.",
            "nullable":true,
            "x-queryable":false
        },
        "OriginalIssueYear":{
            "title":"Original Issue Year",
            "type":"integer",
            "description":"Original issue year of the candidate certification.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "ContentItemId":{
            "title":"License or Certificate",
            "type":"integer",
            "description":"Content item identifier of the candidate certification.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "CompletedAmount":{
            "title":"Completed Amount",
            "type":"integer",
            "description":"Completed amount of the candidate certification.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "CountryCode":{
            "title":"Country",
            "maxLength":"30",
            "type":"string",
            "description":"Country code of the candidate certification.",
            "nullable":true
        },
        "CompletedTrainingUnits":{
            "title":"Training Completed Units",
            "maxLength":"240",
            "type":"string",
            "description":"Completed training units of the candidate certification.",
            "nullable":true,
            "x-queryable":false
        },
        "ActualCompletionDate":{
            "title":"Actual Completion Date",
            "type":"string",
            "description":"Actual completion date of the candidate certification.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "Restrictions":{
            "title":"Restrictions",
            "type":"string",
            "description":"Restrictions of the candidate certification.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "Status":{
            "title":"Status",
            "maxLength":"30",
            "type":"string",
            "description":"Status of the candidate certification.",
            "nullable":true,
            "x-queryable":false
        },
        "CertificationURL":{
            "title":"Certification URL",
            "maxLength":"2000",
            "type":"string",
            "description":"Certification URL of the candidate certification.",
            "nullable":true,
            "x-queryable":false
        },
        "VerifiedFlag":{
            "title":"Verified",
            "maxLength":"30",
            "type":"boolean",
            "description":"Indicates the verified indicator of the candidate education.",
            "nullable":true,
            "x-queryable":false
        },
        "RenewalInprogressFlag":{
            "title":"Renewal In Progress",
            "maxLength":"30",
            "type":"boolean",
            "description":"Indicates the renewal in progress indicator of the candidate certification.",
            "nullable":true,
            "x-queryable":false
        },
        "Comments":{
            "title":"Comments",
            "type":"string",
            "description":"Comments about the candidate certification.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "StateProvinceCode":{
            "title":"State",
            "maxLength":"360",
            "type":"string",
            "description":"State province code of the candidate certification.",
            "nullable":true
        },
        "IssueDate":{
            "title":"Issue Date",
            "type":"string",
            "description":"Issue date of the candidate certification.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "Title":{
            "title":"Title",
            "maxLength":"240",
            "type":"string",
            "description":"Title of the candidate certification.",
            "nullable":true,
            "x-queryable":false
        },
        "TotalAmount":{
            "title":"Total Amount",
            "type":"integer",
            "description":"Total amount of the candidate certification.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "LastRenewalDate":{
            "title":"Last Renewal Date",
            "type":"string",
            "description":"Last renewal date of the candidate certification.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "CertificationId":{
            "type":"integer",
            "description":"Identifier of the candidate certification.",
            "format":"int64",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "RenewalDate":{
            "title":"Renewal Date",
            "type":"string",
            "description":"Renewal date of the candidate certification.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "CertificationName":{
            "title":"License or Certificate",
            "maxLength":"240",
            "type":"string",
            "description":"Certification name of the candidate certification.",
            "nullable":true,
            "x-queryable":false
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"Expiration date of the candidate certification.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "EducationalEstablishment":{
            "title":"Educational Establishment",
            "maxLength":"2000",
            "type":"string",
            "description":"Educational establishment of the candidate certification.",
            "nullable":true,
            "x-queryable":false
        },
        "EducationalEstablishmentId":{
            "title":"Establishment",
            "type":"integer",
            "description":"Educational establishment identifier of the candidate certification.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "CertificationNumber":{
            "title":"Certificate Number",
            "maxLength":"240",
            "type":"string",
            "description":"Certification number of the candidate certification.",
            "nullable":true,
            "x-queryable":false
        },
        "IssuedBy":{
            "title":"Issued By",
            "maxLength":"240",
            "type":"string",
            "description":"Entity who issued the candidate certification.",
            "nullable":true,
            "x-queryable":false
        },
        "SectionId":{
            "type":"integer",
            "description":"Section identifier of the candidate certification.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        }
    }
}

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 : recruitingJobSiteCandidates-certifications-item-response

Type: object

Show Source

• ActualCompletionDate: string (date)
  Title: Actual Completion Date

  Actual completion date of the candidate certification.
• CertificationId: integer (int64)
  Identifier of the candidate certification.
• CertificationName: string
  Title: License or Certificate

  Maximum Length: 240

  Certification name of the candidate certification.
• CertificationNumber: string
  Title: Certificate Number

  Maximum Length: 240

  Certification number of the candidate certification.
• CertificationURL: string
  Title: Certification URL

  Maximum Length: 2000

  Certification URL of the candidate certification.
• Comments: string (byte)
  Title: Comments

  Comments about the candidate certification.
• CompletedAmount: integer (int64)
  Title: Completed Amount

  Completed amount of the candidate certification.
• CompletedTrainingUnits: string
  Title: Training Completed Units

  Maximum Length: 240

  Completed training units of the candidate certification.
• ContentItemId: integer (int64)
  Title: License or Certificate

  Content item identifier of the candidate certification.
• CountryCode: string
  Title: Country

  Maximum Length: 30

  Country code of the candidate certification.
• EducationalEstablishment: string
  Title: Educational Establishment

  Maximum Length: 2000

  Educational establishment of the candidate certification.
• EducationalEstablishmentId: integer (int64)
  Title: Establishment

  Educational establishment identifier of the candidate certification.
• ExpirationDate: string (date)
  Title: Expiration Date

  Expiration date of the candidate certification.
• IssueDate: string (date)
  Title: Issue Date

  Issue date of the candidate certification.
• IssuedBy: string
  Title: Issued By

  Maximum Length: 240

  Entity who issued the candidate certification.
• LastRenewalDate: string (date)
  Title: Last Renewal Date

  Last renewal date of the candidate certification.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OriginalIssueYear: integer (int64)
  Title: Original Issue Year

  Original issue year of the candidate certification.
• RenewalDate: string (date)
  Title: Renewal Date

  Renewal date of the candidate certification.
• RenewalInprogressFlag: boolean
  Title: Renewal In Progress

  Maximum Length: 30

  Indicates the renewal in progress indicator of the candidate certification.
• RenewalRequiredFlag: boolean
  Title: Renewal Required

  Maximum Length: 30

  Indicates whether the renewal indicator is required in the candidate certification.
• Restrictions: string (byte)
  Title: Restrictions

  Restrictions of the candidate certification.
• SectionId: integer (int64)
  Section identifier of the candidate certification.
• StateProvinceCode: string
  Title: State

  Maximum Length: 360

  State province code of the candidate certification.
• Status: string
  Title: Status

  Maximum Length: 30

  Status of the candidate certification.
• Title: string
  Title: Title

  Maximum Length: 240

  Title of the candidate certification.
• TotalAmount: integer (int64)
  Title: Total Amount

  Total amount of the candidate certification.
• VerifiedFlag: boolean
  Title: Verified

  Maximum Length: 30

  Indicates the verified indicator of the candidate education.

{
    "type":"object",
    "properties":{
        "RenewalRequiredFlag":{
            "title":"Renewal Required",
            "maxLength":"30",
            "type":"boolean",
            "description":"Indicates whether the renewal indicator is required in the candidate certification.",
            "nullable":true,
            "x-queryable":false
        },
        "OriginalIssueYear":{
            "title":"Original Issue Year",
            "type":"integer",
            "description":"Original issue year of the candidate certification.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "ContentItemId":{
            "title":"License or Certificate",
            "type":"integer",
            "description":"Content item identifier of the candidate certification.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "CompletedAmount":{
            "title":"Completed Amount",
            "type":"integer",
            "description":"Completed amount of the candidate certification.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CountryCode":{
            "title":"Country",
            "maxLength":"30",
            "type":"string",
            "description":"Country code of the candidate certification.",
            "nullable":true,
            "x-queryable":true
        },
        "CompletedTrainingUnits":{
            "title":"Training Completed Units",
            "maxLength":"240",
            "type":"string",
            "description":"Completed training units of the candidate certification.",
            "nullable":true,
            "x-queryable":false
        },
        "ActualCompletionDate":{
            "title":"Actual Completion Date",
            "type":"string",
            "description":"Actual completion date of the candidate certification.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "Restrictions":{
            "title":"Restrictions",
            "type":"string",
            "description":"Restrictions of the candidate certification.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "Status":{
            "title":"Status",
            "maxLength":"30",
            "type":"string",
            "description":"Status of the candidate certification.",
            "nullable":true,
            "x-queryable":false
        },
        "CertificationURL":{
            "title":"Certification URL",
            "maxLength":"2000",
            "type":"string",
            "description":"Certification URL of the candidate certification.",
            "nullable":true,
            "x-queryable":false
        },
        "VerifiedFlag":{
            "title":"Verified",
            "maxLength":"30",
            "type":"boolean",
            "description":"Indicates the verified indicator of the candidate education.",
            "nullable":true,
            "x-queryable":false
        },
        "RenewalInprogressFlag":{
            "title":"Renewal In Progress",
            "maxLength":"30",
            "type":"boolean",
            "description":"Indicates the renewal in progress indicator of the candidate certification.",
            "nullable":true,
            "x-queryable":false
        },
        "Comments":{
            "title":"Comments",
            "type":"string",
            "description":"Comments about the candidate certification.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "StateProvinceCode":{
            "title":"State",
            "maxLength":"360",
            "type":"string",
            "description":"State province code of the candidate certification.",
            "nullable":true,
            "x-queryable":true
        },
        "IssueDate":{
            "title":"Issue Date",
            "type":"string",
            "description":"Issue date of the candidate certification.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "Title":{
            "title":"Title",
            "maxLength":"240",
            "type":"string",
            "description":"Title of the candidate certification.",
            "nullable":true,
            "x-queryable":false
        },
        "TotalAmount":{
            "title":"Total Amount",
            "type":"integer",
            "description":"Total amount of the candidate certification.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "LastRenewalDate":{
            "title":"Last Renewal Date",
            "type":"string",
            "description":"Last renewal date of the candidate certification.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "CertificationId":{
            "type":"integer",
            "description":"Identifier of the candidate certification.",
            "format":"int64",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "RenewalDate":{
            "title":"Renewal Date",
            "type":"string",
            "description":"Renewal date of the candidate certification.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "CertificationName":{
            "title":"License or Certificate",
            "maxLength":"240",
            "type":"string",
            "description":"Certification name of the candidate certification.",
            "nullable":true,
            "x-queryable":false
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"Expiration date of the candidate certification.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "EducationalEstablishment":{
            "title":"Educational Establishment",
            "maxLength":"2000",
            "type":"string",
            "description":"Educational establishment of the candidate certification.",
            "nullable":true,
            "x-queryable":false
        },
        "EducationalEstablishmentId":{
            "title":"Establishment",
            "type":"integer",
            "description":"Educational establishment identifier of the candidate certification.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "CertificationNumber":{
            "title":"Certificate Number",
            "maxLength":"240",
            "type":"string",
            "description":"Certification number of the candidate certification.",
            "nullable":true,
            "x-queryable":false
        },
        "IssuedBy":{
            "title":"Issued By",
            "maxLength":"240",
            "type":"string",
            "description":"Entity who issued the candidate certification.",
            "nullable":true,
            "x-queryable":false
        },
        "SectionId":{
            "type":"integer",
            "description":"Section identifier of the candidate certification.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        }
    }
}

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