Update a rating
patch
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/learningItemRatingDetails/{learningItemRatingDetailsUniqID}
Request
Path Parameters
-
learnerLearningRecordsUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Learner Learning Records resource and used to uniquely identify an instance of Learner Learning Records. The client should not generate the hash key value. Instead, the client should query on the Learner Learning Records collection resource in order to navigate to a specific instance of Learner Learning Records to get the hash key.
-
learningItemRatingDetailsUniqID(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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
dataSecurityPrivilege: string
Data security privilege, such as Learner or Learner Manager. It's the intent and permissions for the user accessing the learning assignment. Valid values are defined in the DataSecurityPrivilegeLOV list.
-
ratedByPersonDetails: array
User Access Person Details
Title:
User Access Person Details
The personDetalis resource provides details about the person associated with the learning item. -
rating: number
Title:
Rating
The rating given on the learning item. -
ratingByPersonId: integer
(int64)
Title:
Rated by Person ID
Identifier of the person who rated the learning item. -
ratingByPersonImageURL: string
Title:
Rated by Person Image URL
Image URL of the person who rated the learning item. -
ratingComment: string
Title:
Rating Comment
Maximum Length:4000
Comment made by the learner while rating the learning item. -
ratingStatus: string
Title:
Rating Status
Maximum Length:30
Status of the rating on the learning item.
Nested Schema : User Access Person Details
Type:
array
Title:
User Access Person Details
The personDetalis resource provides details about the person associated with the learning item.
Show Source
Nested Schema : learnerLearningRecords-learningItemRatingDetails-ratedByPersonDetails-item-patch-request
Type:
Show Source
object
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 : learnerLearningRecords-learningItemRatingDetails-item-response
Type:
Show Source
object
-
dataSecurityPrivilege: string
Data security privilege, such as Learner or Learner Manager. It's the intent and permissions for the user accessing the learning assignment. Valid values are defined in the DataSecurityPrivilegeLOV list.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ratedByPersonDetails: array
User Access Person Details
Title:
User Access Person Details
The personDetalis resource provides details about the person associated with the learning item. -
rating: number
Title:
Rating
The rating given on the learning item. -
ratingByPersonDisplayName: string
Title:
Rated By
Read Only:true
Maximum Length:240
Display name for the person who rated the learning item. -
ratingByPersonId: integer
(int64)
Title:
Rated by Person ID
Identifier of the person who rated the learning item. -
ratingByPersonImageURL: string
Title:
Rated by Person Image URL
Image URL of the person who rated the learning item. -
ratingByPersonNumber: string
Title:
Rated by Person Number
Read Only:true
Maximum Length:30
Person number of the person who rated the learning item. -
ratingComment: string
Title:
Rating Comment
Maximum Length:4000
Comment made by the learner while rating the learning item. -
ratingDate: string
(date-time)
Title:
Rated on Date
Read Only:true
Date the rating was made on the learning item. -
ratingId: integer
(int64)
Title:
Rating ID
Unique identifier for the rating on the learning item. -
ratingNumber: string
Title:
Rating Number
Maximum Length:30
Friendly number identifying the learning item rating. -
ratingStatus: string
Title:
Rating Status
Maximum Length:30
Status of the rating on the learning item.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : User Access Person Details
Type:
array
Title:
User Access Person Details
The personDetalis resource provides details about the person associated with the learning item.
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.
Nested Schema : learnerLearningRecords-learningItemRatingDetails-ratedByPersonDetails-item-response
Type:
Show Source
object
-
assignmentName: string
Read Only:
true
Maximum Length:80
Person's work assignment name. -
businessUnitId: integer
(int64)
Title:
Business Unit ID
Read Only:true
Unique identifier for the person's business unit. -
businessUnitName: string
Title:
Business Unit
Read Only:true
Maximum Length:240
Name of the person's business unit. -
departmentId: integer
(int64)
Title:
Department ID
Read Only:true
Person's department. -
departmentName: string
Title:
Department
Read Only:true
Maximum Length:240
Person's department name. -
jobId: integer
(int64)
Title:
Job ID
Read Only:true
Person's job identifier. -
jobName: string
Title:
Job
Read Only:true
Maximum Length:240
Person's job name. -
legalEmployerId: integer
(int64)
Title:
Legal Employer ID
Read Only:true
Identifier for the person's legal employer. -
legalEmployerName: string
Title:
Legal Employer
Read Only:true
Maximum Length:240
Name of the person's legal employer. -
lineManagerDisplayName: string
Title:
Line Manager
Read Only:true
Maximum Length:240
Display name for the person's line manager. -
lineManagerId: integer
(int64)
Title:
Line Manager ID
Read Only:true
Identifier for the person's line manager. -
lineManagerNumber: string
Title:
Line Manager Number
Read Only:true
Maximum Length:30
Number for the person's line manager. -
lineManagerPrimaryEmailAddress: string
Title:
Line Manager Primary Email Address
Read Only:true
Maximum Length:240
Primary email address for the person's line manager. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
locationId: integer
(int64)
Title:
Location ID
Read Only:true
Person's location identifier. -
locationName: string
Title:
Location Name
Read Only:true
Maximum Length:240
Person's location name. -
personId: integer
(int64)
Read Only:
true
Identifier of the person who's the publisher. -
positionId: integer
(int64)
Title:
Position ID
Read Only:true
Unique identifier for the person's position. -
positionName: string
Title:
Position
Read Only:true
Maximum Length:240
Person's position name. -
primaryEmailAddress: string
Read Only:
true
Maximum Length:240
Person's primary email address. -
primaryPhoneNumber: string
Read Only:
true
Maximum Length:60
Person's primary phone number.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- ratedByPersonDetails
-
Parameters:
- learnerLearningRecordsUniqID:
$request.path.learnerLearningRecordsUniqID
- learningItemRatingDetailsUniqID2:
$request.path.learningItemRatingDetailsUniqID2
- learnerLearningRecordsUniqID: