Update a candidate certification
patch
/hcmRestApi/resources/11.13.18.05/recruitingJobSiteCandidates/{CandidateNumber}/child/certifications/{CertificationId}
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=
-
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 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.
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 : recruitingJobSiteCandidates-certifications-item-response
Type:
Show Source
object
-
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.
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.