Update a candidate licenses and certifications
patch
/hcmRestApi/resources/11.13.18.05/recruitingCandidates/{CandidateNumber}/child/licensesAndCertificates/{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: 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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object-
ActualCompletionDate: string
(date)
Title:
Actual Completion DateActual completion date in recruiting candidate licenses and certificates. -
CertificationName: string
Title:
License or CertificateMaximum Length:240Certification name in recruiting candidate licenses and certificates. -
CertificationNumber: string
Title:
Certificate NumberMaximum Length:240Certification number in recruiting candidate licenses and certificates. -
CertificationURL: string
Title:
Certification URLMaximum Length:2000Certification URL in recruiting candidate licenses and certificates. -
Comments: string
(byte)
Title:
CommentsComments in recruiting candidate licenses and certificates. -
CompletedAmount: integer
(int64)
Title:
Completed AmountCompleted amount in recruiting candidate licenses and certificates. -
CompletedTrainingUnits: string
Title:
Training Completed UnitsMaximum Length:240Completed training units in recruiting candidate licenses and certificates. -
ContentItemId: integer
(int64)
Title:
License or CertificateContent item ID in recruiting candidate licenses and certificates. -
CountryCode: string
Title:
CountryMaximum Length:30Country code number in recruiting candidate licenses and certificates. -
CountryId: integer
(int64)
Title:
CountryCountry ID in recruiting candidate licenses and certificates. -
EducationalEstablishment: string
Title:
Educational EstablishmentMaximum Length:2000Educational establishment in recruiting candidate licenses and certificates. -
EducationalEstablishmentId: integer
(int64)
Title:
EstablishmentEducational establishment ID in recruiting candidate licenses and certificates. -
ExpirationDate: string
(date)
Title:
Expiration DateExpiration date in recruiting candidate licenses and certificates. -
IssueDate: string
(date)
Title:
Issue DateIssue date in recruiting candidate licenses and certificates. -
IssuedBy: string
Title:
Issued ByMaximum Length:240Issued using in recruiting candidate licenses and certificates. -
LastRenewalDate: string
(date)
Title:
Last Renewal DateLast renewal date in recruiting candidate licenses and certificates. -
OriginalIssueYear: integer
(int64)
Title:
Original Issue YearOriginal issue year in recruiting candidate licenses and certificates. -
RenewalDate: string
(date)
Title:
Renewal DateRenewal date in recruiting candidate licenses and certificates. -
RenewalInprogressFlag: boolean
Title:
Renewal In ProgressMaximum Length:30Renewal in progress indicator in recruiting candidate licenses and certificates. -
RenewalRequiredFlag: boolean
Title:
Renewal RequiredMaximum Length:30Renewal required indicator in recruiting candidate licenses and certificates. -
Restrictions: string
(byte)
Title:
RestrictionsRestrictions in recruiting candidate licenses and certificates. -
SectionId: integer
(int64)
Section ID in recruiting candidate licenses and certificates.
-
StateProvinceCode: string
Title:
StateMaximum Length:360State province code in recruiting candidate licenses and certificates. -
StateProvinceId: integer
(int64)
Title:
StateState province ID in recruiting candidate licenses and certificates. -
Status: string
Title:
StatusMaximum Length:30Status in recruiting candidate licenses and certificates. -
Title: string
Title:
TitleMaximum Length:240Title in recruiting candidate licenses and certificates. -
TotalAmount: integer
(int64)
Title:
Total AmountTotal amount in recruiting candidate licenses and certificates. -
VerifiedFlag: boolean
Title:
VerifiedMaximum Length:30Verified indicator in recruiting candidate licenses and certificates.
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 : recruitingCandidates-licensesAndCertificates-item-response
Type:
Show Source
object-
ActualCompletionDate: string
(date)
Title:
Actual Completion DateActual completion date in recruiting candidate licenses and certificates. -
CertificationId: integer
(int64)
Certification ID in recruiting candidate licenses and certificates.
-
CertificationName: string
Title:
License or CertificateMaximum Length:240Certification name in recruiting candidate licenses and certificates. -
CertificationNumber: string
Title:
Certificate NumberMaximum Length:240Certification number in recruiting candidate licenses and certificates. -
CertificationURL: string
Title:
Certification URLMaximum Length:2000Certification URL in recruiting candidate licenses and certificates. -
Comments: string
(byte)
Title:
CommentsComments in recruiting candidate licenses and certificates. -
CompletedAmount: integer
(int64)
Title:
Completed AmountCompleted amount in recruiting candidate licenses and certificates. -
CompletedTrainingUnits: string
Title:
Training Completed UnitsMaximum Length:240Completed training units in recruiting candidate licenses and certificates. -
ContentItemId: integer
(int64)
Title:
License or CertificateContent item ID in recruiting candidate licenses and certificates. -
CountryCode: string
Title:
CountryMaximum Length:30Country code number in recruiting candidate licenses and certificates. -
CountryId: integer
(int64)
Title:
CountryCountry ID in recruiting candidate licenses and certificates. -
EducationalEstablishment: string
Title:
Educational EstablishmentMaximum Length:2000Educational establishment in recruiting candidate licenses and certificates. -
EducationalEstablishmentId: integer
(int64)
Title:
EstablishmentEducational establishment ID in recruiting candidate licenses and certificates. -
ExpirationDate: string
(date)
Title:
Expiration DateExpiration date in recruiting candidate licenses and certificates. -
IssueDate: string
(date)
Title:
Issue DateIssue date in recruiting candidate licenses and certificates. -
IssuedBy: string
Title:
Issued ByMaximum Length:240Issued using in recruiting candidate licenses and certificates. -
LastRenewalDate: string
(date)
Title:
Last Renewal DateLast renewal date in recruiting candidate licenses and certificates. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
OriginalIssueYear: integer
(int64)
Title:
Original Issue YearOriginal issue year in recruiting candidate licenses and certificates. -
RenewalDate: string
(date)
Title:
Renewal DateRenewal date in recruiting candidate licenses and certificates. -
RenewalInprogressFlag: boolean
Title:
Renewal In ProgressMaximum Length:30Renewal in progress indicator in recruiting candidate licenses and certificates. -
RenewalRequiredFlag: boolean
Title:
Renewal RequiredMaximum Length:30Renewal required indicator in recruiting candidate licenses and certificates. -
Restrictions: string
(byte)
Title:
RestrictionsRestrictions in recruiting candidate licenses and certificates. -
SectionId: integer
(int64)
Section ID in recruiting candidate licenses and certificates.
-
StateProvinceCode: string
Title:
StateMaximum Length:360State province code in recruiting candidate licenses and certificates. -
StateProvinceId: integer
(int64)
Title:
StateState province ID in recruiting candidate licenses and certificates. -
Status: string
Title:
StatusMaximum Length:30Status in recruiting candidate licenses and certificates. -
Title: string
Title:
TitleMaximum Length:240Title in recruiting candidate licenses and certificates. -
TotalAmount: integer
(int64)
Title:
Total AmountTotal amount in recruiting candidate licenses and certificates. -
VerifiedFlag: boolean
Title:
VerifiedMaximum Length:30Verified indicator in recruiting candidate licenses and certificates.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed 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.
Examples
The following example shows how to <describe action> by submitting a <method> request on the REST resource using cURL.
curl -i -u "<username>:<password>" -X PATCH -d <payload> http://<host>:<port>/hcmRestApi/resources/11.13.18.05/recruitingCandidates/187477/child/licensesAndCertificates/300100176592749
Example of Payload
The following is an example of the payload.
{
"RenewalInprogressFlag": false,
"IssueDate": "2010-09-09"
}Example of Response Header
The following is an example of the response header.
HTTP/1.1 200 OK Content-Type : application/vnd.oracle.adf.resourceitem+json
Example of Response Body
The following example shows the contents of the response body in JSON format.
{
"CertificationId": 300100176592749,
"RenewalInprogressFlag": false,
"IssueDate": "2010-09-09",
"TotalAmount": 100,
"CompletedAmount": 80,
"EducationalEstablishmentId": 43,
"EducationalEstablishment": "Institute for License Provider",
"RenewalDate": "2022-09-09",
"RenewalRequiredFlag": true,
"StateProvinceId": 45,
"Title": "My Great Certificate",
"CompletedTrainingUnits": "45",
"CertificationNumber": "L8712355E09",
"VerifiedFlag": true,
"CertificationName": "Your Awesome Award #2",
"ContentItemId": 67234,
"ExpirationDate": "2030-12-31",
"CountryId": 55,
"IssuedBy": "Institute Approved",
"LastRenewalDate": "2015-12-31",
"ActualCompletionDate": "2016-12-31",
"SectionId": 23,
"OriginalIssueYear": 2012,
"Status": "Approved",
"CertificationURL": "https://www.oracle.com",
"links": [
{...}
]
}