Jump to

• Request
• Response

Submit details of all the certifications

post

/hcmRestApi/resources/11.13.18.05/recruitingCECandidateCertificationItems

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

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

  Actual completion date of the certifications done by the candidate.
• CertificationId: integer (int64)
  Certification ID of the certification.
• CertificationName: string
  Title: License or Certificate

  Maximum Length: 240

  Name of the certification.
• CertificationNumber: string
  Title: Certificate Number

  Maximum Length: 240

  Number assigned to the certification.
• CertificationURL: string
  Title: Certification URL

  Maximum Length: 2000

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

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

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

  Maximum Length: 240

  Number of training units completed for the certification.
• ContentItemId: integer (int64)
  Title: License or Certificate

  Unique identifier assigned to each content item.
• CountryCode: string
  Title: Country

  Maximum Length: 30

  Country Code specified in the certification
• CountryId: integer (int64)
  Title: Country

  Country ID specified in the certification.
• EducationalEstablishment: string
  Title: Educational Establishment

  Maximum Length: 2000

  Educational establishment that issued the certification.
• EducationalEstablishmentId: integer (int64)
  Title: Establishment

  Unique identifier assigned to the educational establishment.
• ExpirationDate: string (date)
  Title: Expiration Date

  Expiration date of the certification.
• FlowVersionId: integer
  This gives the Service Metadata
• IssueDate: string (date)
  Title: Issue Date

  Date on which the certification was issued
• IssuedBy: string
  Title: Issued By

  Maximum Length: 240

  Name of the authority that issued the certification.
• LastRenewalDate: string (date)
  Title: Last Renewal Date

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

  Year when the certification was issued.
• RenewalDate: string (date)
  Title: Renewal Date

  Date on which the certification was renewed.
• RenewalInprogressFlag: boolean
  Title: Renewal In Progress

  Maximum Length: 30

  Indicator to show that the renewal of the certification is in progress.
• RenewalRequiredFlag: boolean
  Title: Renewal Required

  Maximum Length: 30

  Indicator to show that the certification needs to be renewed.
• Restrictions: string (byte)
  Title: Restrictions

  Restrictions for the certification.
• SectionId: integer (int64)
  Section ID specified in the certification.
• StateProvinceCode: string
  Title: State

  Maximum Length: 360

  State Province Code specified in the certification.
• StateProvinceId: integer (int64)
  Title: State

  State Province ID specified in the certification.
• Status: string
  Title: Status

  Maximum Length: 30

  Indicates the status of the certification item
• SubmissionId: string
  Unique ID for each candidate's submitted requests
• Title: string
  Title: Title

  Maximum Length: 240

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

  Total amount paid for the certification.
• VerifiedFlag: boolean
  Title: Verified

  Maximum Length: 30

  Indicator to show that the certification is verified.

{
    "type":"object",
    "properties":{
        "ActualCompletionDate":{
            "title":"Actual Completion Date",
            "type":"string",
            "description":"Actual completion date of the certifications done by the candidate.",
            "format":"date",
            "nullable":true
        },
        "CertificationId":{
            "type":"integer",
            "description":"Certification ID of the certification.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "CertificationName":{
            "title":"License or Certificate",
            "maxLength":240,
            "type":"string",
            "description":"Name of the certification.",
            "nullable":true
        },
        "CertificationNumber":{
            "title":"Certificate Number",
            "maxLength":240,
            "type":"string",
            "description":"Number assigned to the certification.",
            "nullable":true
        },
        "CertificationURL":{
            "title":"Certification URL",
            "maxLength":2000,
            "type":"string",
            "description":"URL of the certification.",
            "nullable":true
        },
        "Comments":{
            "title":"Comments",
            "type":"string",
            "description":"Comments for the certification.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "CompletedAmount":{
            "title":"Completed Amount",
            "type":"integer",
            "description":"Completed amount of the certification.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "CompletedTrainingUnits":{
            "title":"Training Completed Units",
            "maxLength":240,
            "type":"string",
            "description":"Number of training units completed for the certification.",
            "nullable":true
        },
        "ContentItemId":{
            "title":"License or Certificate",
            "type":"integer",
            "description":"Unique identifier assigned to each content item.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "CountryCode":{
            "title":"Country",
            "maxLength":30,
            "type":"string",
            "description":"Country Code specified in the certification",
            "nullable":true
        },
        "CountryId":{
            "title":"Country",
            "type":"integer",
            "description":"Country ID specified in the certification.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "EducationalEstablishment":{
            "title":"Educational Establishment",
            "maxLength":2000,
            "type":"string",
            "description":"Educational establishment that issued the certification.",
            "nullable":true
        },
        "EducationalEstablishmentId":{
            "title":"Establishment",
            "type":"integer",
            "description":"Unique identifier assigned to the educational establishment.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"Expiration date of the certification.",
            "format":"date",
            "nullable":true
        },
        "FlowVersionId":{
            "type":"integer",
            "description":"This gives the Service Metadata",
            "nullable":true
        },
        "IssueDate":{
            "title":"Issue Date",
            "type":"string",
            "description":"Date on which the certification was issued",
            "format":"date",
            "nullable":true
        },
        "IssuedBy":{
            "title":"Issued By",
            "maxLength":240,
            "type":"string",
            "description":"Name of the authority that issued the certification.",
            "nullable":true
        },
        "LastRenewalDate":{
            "title":"Last Renewal Date",
            "type":"string",
            "description":"Last date for renewal of the certification.",
            "format":"date",
            "nullable":true
        },
        "OriginalIssueYear":{
            "title":"Original Issue Year",
            "type":"integer",
            "description":"Year when the certification was issued.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "RenewalDate":{
            "title":"Renewal Date",
            "type":"string",
            "description":"Date on which the certification was renewed.",
            "format":"date",
            "nullable":true
        },
        "RenewalInprogressFlag":{
            "title":"Renewal In Progress",
            "maxLength":30,
            "type":"boolean",
            "description":"Indicator to show that the renewal of the certification is in progress.",
            "nullable":true
        },
        "RenewalRequiredFlag":{
            "title":"Renewal Required",
            "maxLength":30,
            "type":"boolean",
            "description":"Indicator to show that the certification needs to be renewed.",
            "nullable":true
        },
        "Restrictions":{
            "title":"Restrictions",
            "type":"string",
            "description":"Restrictions for the certification.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "SectionId":{
            "type":"integer",
            "description":"Section ID specified in the certification.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "StateProvinceCode":{
            "title":"State",
            "maxLength":360,
            "type":"string",
            "description":"State Province Code specified in the certification.",
            "nullable":true
        },
        "StateProvinceId":{
            "title":"State",
            "type":"integer",
            "description":"State Province ID specified in the certification.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "Status":{
            "title":"Status",
            "maxLength":30,
            "type":"string",
            "description":"Indicates the status of the certification item",
            "nullable":true
        },
        "SubmissionId":{
            "type":"string",
            "description":"Unique ID for each candidate's submitted requests",
            "nullable":true
        },
        "Title":{
            "title":"Title",
            "maxLength":240,
            "type":"string",
            "description":"Title of the certification item",
            "nullable":true
        },
        "TotalAmount":{
            "title":"Total Amount",
            "type":"integer",
            "description":"Total amount paid for the certification.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "VerifiedFlag":{
            "title":"Verified",
            "maxLength":30,
            "type":"boolean",
            "description":"Indicator to show that the certification is verified.",
            "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 : recruitingCECandidateCertificationItems-item-response

Type: object

Show Source

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

  Actual completion date of the certifications done by the candidate.
• CertificationId: integer (int64)
  Certification ID of the certification.
• CertificationName: string
  Title: License or Certificate

  Maximum Length: 240

  Name of the certification.
• CertificationNumber: string
  Title: Certificate Number

  Maximum Length: 240

  Number assigned to the certification.
• CertificationURL: string
  Title: Certification URL

  Maximum Length: 2000

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

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

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

  Maximum Length: 240

  Number of training units completed for the certification.
• ContentItemId: integer (int64)
  Title: License or Certificate

  Unique identifier assigned to each content item.
• CountryCode: string
  Title: Country

  Maximum Length: 30

  Country Code specified in the certification
• CountryId: integer (int64)
  Title: Country

  Country ID specified in the certification.
• EducationalEstablishment: string
  Title: Educational Establishment

  Maximum Length: 2000

  Educational establishment that issued the certification.
• EducationalEstablishmentId: integer (int64)
  Title: Establishment

  Unique identifier assigned to the educational establishment.
• ExpirationDate: string (date)
  Title: Expiration Date

  Expiration date of the certification.
• FlowVersionId: integer
  This gives the Service Metadata
• IssueDate: string (date)
  Title: Issue Date

  Date on which the certification was issued
• IssuedBy: string
  Title: Issued By

  Maximum Length: 240

  Name of the authority that issued the certification.
• LastRenewalDate: string (date)
  Title: Last Renewal Date

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

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

  Year when the certification was issued.
• RenewalDate: string (date)
  Title: Renewal Date

  Date on which the certification was renewed.
• RenewalInprogressFlag: boolean
  Title: Renewal In Progress

  Maximum Length: 30

  Indicator to show that the renewal of the certification is in progress.
• RenewalRequiredFlag: boolean
  Title: Renewal Required

  Maximum Length: 30

  Indicator to show that the certification needs to be renewed.
• Restrictions: string (byte)
  Title: Restrictions

  Restrictions for the certification.
• SectionId: integer (int64)
  Section ID specified in the certification.
• StateProvinceCode: string
  Title: State

  Maximum Length: 360

  State Province Code specified in the certification.
• StateProvinceId: integer (int64)
  Title: State

  State Province ID specified in the certification.
• Status: string
  Title: Status

  Maximum Length: 30

  Indicates the status of the certification item
• SubmissionId: string
  Unique ID for each candidate's submitted requests
• Title: string
  Title: Title

  Maximum Length: 240

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

  Total amount paid for the certification.
• VerifiedFlag: boolean
  Title: Verified

  Maximum Length: 30

  Indicator to show that the certification is verified.

{
    "type":"object",
    "properties":{
        "ActualCompletionDate":{
            "title":"Actual Completion Date",
            "type":"string",
            "description":"Actual completion date of the certifications done by the candidate.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "CertificationId":{
            "type":"integer",
            "description":"Certification ID of the certification.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CertificationName":{
            "title":"License or Certificate",
            "maxLength":240,
            "type":"string",
            "description":"Name of the certification.",
            "nullable":true,
            "x-queryable":true
        },
        "CertificationNumber":{
            "title":"Certificate Number",
            "maxLength":240,
            "type":"string",
            "description":"Number assigned to the certification.",
            "nullable":true,
            "x-queryable":true
        },
        "CertificationURL":{
            "title":"Certification URL",
            "maxLength":2000,
            "type":"string",
            "description":"URL of the certification.",
            "nullable":true,
            "x-queryable":true
        },
        "Comments":{
            "title":"Comments",
            "type":"string",
            "description":"Comments for the certification.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "CompletedAmount":{
            "title":"Completed Amount",
            "type":"integer",
            "description":"Completed amount of the certification.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CompletedTrainingUnits":{
            "title":"Training Completed Units",
            "maxLength":240,
            "type":"string",
            "description":"Number of training units completed for the certification.",
            "nullable":true,
            "x-queryable":true
        },
        "ContentItemId":{
            "title":"License or Certificate",
            "type":"integer",
            "description":"Unique identifier assigned to each content item.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CountryCode":{
            "title":"Country",
            "maxLength":30,
            "type":"string",
            "description":"Country Code specified in the certification",
            "nullable":true,
            "x-queryable":true
        },
        "CountryId":{
            "title":"Country",
            "type":"integer",
            "description":"Country ID specified in the certification.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "EducationalEstablishment":{
            "title":"Educational Establishment",
            "maxLength":2000,
            "type":"string",
            "description":"Educational establishment that issued the certification.",
            "nullable":true,
            "x-queryable":true
        },
        "EducationalEstablishmentId":{
            "title":"Establishment",
            "type":"integer",
            "description":"Unique identifier assigned to the educational establishment.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"Expiration date of the certification.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "FlowVersionId":{
            "type":"integer",
            "description":"This gives the Service Metadata",
            "nullable":true,
            "x-queryable":true
        },
        "IssueDate":{
            "title":"Issue Date",
            "type":"string",
            "description":"Date on which the certification was issued",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "IssuedBy":{
            "title":"Issued By",
            "maxLength":240,
            "type":"string",
            "description":"Name of the authority that issued the certification.",
            "nullable":true,
            "x-queryable":true
        },
        "LastRenewalDate":{
            "title":"Last Renewal Date",
            "type":"string",
            "description":"Last date for renewal of the certification.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "OriginalIssueYear":{
            "title":"Original Issue Year",
            "type":"integer",
            "description":"Year when the certification was issued.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RenewalDate":{
            "title":"Renewal Date",
            "type":"string",
            "description":"Date on which the certification was renewed.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "RenewalInprogressFlag":{
            "title":"Renewal In Progress",
            "maxLength":30,
            "type":"boolean",
            "description":"Indicator to show that the renewal of the certification is in progress.",
            "nullable":true,
            "x-queryable":true
        },
        "RenewalRequiredFlag":{
            "title":"Renewal Required",
            "maxLength":30,
            "type":"boolean",
            "description":"Indicator to show that the certification needs to be renewed.",
            "nullable":true,
            "x-queryable":true
        },
        "Restrictions":{
            "title":"Restrictions",
            "type":"string",
            "description":"Restrictions for the certification.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "SectionId":{
            "type":"integer",
            "description":"Section ID specified in the certification.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "StateProvinceCode":{
            "title":"State",
            "maxLength":360,
            "type":"string",
            "description":"State Province Code specified in the certification.",
            "nullable":true,
            "x-queryable":true
        },
        "StateProvinceId":{
            "title":"State",
            "type":"integer",
            "description":"State Province ID specified in the certification.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Status":{
            "title":"Status",
            "maxLength":30,
            "type":"string",
            "description":"Indicates the status of the certification item",
            "nullable":true,
            "x-queryable":true
        },
        "SubmissionId":{
            "type":"string",
            "description":"Unique ID for each candidate's submitted requests",
            "nullable":true,
            "x-queryable":true
        },
        "Title":{
            "title":"Title",
            "maxLength":240,
            "type":"string",
            "description":"Title of the certification item",
            "nullable":true,
            "x-queryable":true
        },
        "TotalAmount":{
            "title":"Total Amount",
            "type":"integer",
            "description":"Total amount paid for the certification.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "VerifiedFlag":{
            "title":"Verified",
            "maxLength":30,
            "type":"boolean",
            "description":"Indicator to show that the certification is verified.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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