Submit a patch for the certification.
patch
/hcmRestApi/resources/11.13.18.05/recruitingCECandidateCertificationItems/{CertificationId}
Request
Path Parameters
-
CertificationId(required): integer(int64)
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
Root Schema : schema
Type:
Show Source
object
-
ActualCompletionDate: string
(date)
Title:
Actual Completion Date
Actual completion date of the certifications done by the candidate. -
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.
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 : recruitingCECandidateCertificationItems-item-response
Type:
Show Source
object
-
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.
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.