Create a learning item rating
post
/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/selectedCourseOfferings/{selectedCourseOfferingsUniqID}/child/learningItemRatingDetails
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.
-
selectedCourseOfferingsUniqID(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.
-
Upsert-Mode:
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
Root Schema : schema
Type:
Show Source
object
-
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
Rating of the learner on the learning item. -
ratingByPersonId: integer
(int64)
Title:
Rated by Person ID
Rated by person identifier. -
ratingByPersonImageURL: string
Title:
Rated by Person Image URL
Rated by person image URL. -
ratingComment: string
Title:
Rating Comment
Maximum Length:4000
Comment of the learner while rating the learning item. -
ratingId: integer
(int64)
Title:
Rating ID
Unique identifier of the rating on the learning item. -
ratingNumber: string
Title:
Rating Number
Maximum Length:30
Friendly number identifying the rating on 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-selectedCourseOfferings-learningItemRatingDetails-ratedByPersonDetails-item-post-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(required):
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(required):
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-selectedCourseOfferings-learningItemRatingDetails-item-response
Type:
Show Source
object
-
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
Rating of the learner on the learning item. -
ratingByPersonDisplayName: string
Title:
Rated By
Read Only:true
Maximum Length:240
Rated by person display name. -
ratingByPersonId: integer
(int64)
Title:
Rated by Person ID
Rated by person identifier. -
ratingByPersonImageURL: string
Title:
Rated by Person Image URL
Rated by person image URL. -
ratingByPersonNumber: string
Title:
Rated by Person Number
Read Only:true
Maximum Length:30
Rated by person number. -
ratingComment: string
Title:
Rating Comment
Maximum Length:4000
Comment of the learner while rating the learning item. -
ratingDate: string
(date-time)
Title:
Rated on Date
Read Only:true
Date of the rating on the learning item. -
ratingId: integer
(int64)
Title:
Rating ID
Unique identifier of the rating on the learning item. -
ratingNumber: string
Title:
Rating Number
Maximum Length:30
Friendly number identifying the rating on the learning item. -
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-selectedCourseOfferings-learningItemRatingDetails-ratedByPersonDetails-item-response
Type:
Show Source
object
-
assignmentName: string
Read Only:
true
Maximum Length:80
Work assignment name for the learning item rater. -
businessUnitId: integer
(int64)
Title:
Business Unit ID
Read Only:true
Assigner business unit identifier -
businessUnitName: string
Title:
Business Unit
Read Only:true
Maximum Length:240
Assigner business unit name. -
departmentId: integer
(int64)
Title:
Department ID
Read Only:true
Assigner department identifier -
departmentName: string
Title:
Department
Read Only:true
Maximum Length:240
Assigner department name. -
jobId: integer
(int64)
Title:
Job ID
Read Only:true
Assigner job identifier -
jobName: string
Title:
Job
Read Only:true
Maximum Length:240
Assigner job name. -
legalEmployerId: integer
(int64)
Title:
Legal Employer ID
Read Only:true
Assigner legal employer identifier -
legalEmployerName: string
Title:
Legal Employer
Read Only:true
Maximum Length:240
Assigner legal employer name. -
lineManagerDisplayName: string
Title:
Line Manager
Read Only:true
Maximum Length:240
Assigner line manager display name. -
lineManagerId: integer
(int64)
Title:
Line Manager ID
Read Only:true
Assigner line manager identifier -
lineManagerNumber: string
Title:
Line Manager Number
Read Only:true
Maximum Length:30
Assigner line manager number. -
lineManagerPrimaryEmailAddress: string
Title:
Line Manager Primary Email Address
Read Only:true
Maximum Length:240
Assigner line manager primary email address. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
locationId: integer
(int64)
Title:
Location ID
Read Only:true
Assigner location identifier -
locationName: string
Title:
Location Name
Read Only:true
Maximum Length:240
Assigner location name. -
personId: integer
(int64)
Read Only:
true
Assigner person identifier. -
positionId: integer
(int64)
Title:
Position ID
Read Only:true
Assigner position identifier -
positionName: string
Title:
Position
Read Only:true
Maximum Length:240
Assigner position name. -
primaryEmailAddress: string
Read Only:
true
Maximum Length:240
Assigner primary email address. -
primaryPhoneNumber: string
Read Only:
true
Maximum Length:60
Primary phone number for the learning item rater.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- ratedByPersonDetails
-
Parameters:
- learnerLearningRecordsUniqID:
$request.path.learnerLearningRecordsUniqID
- learningItemRatingDetailsUniqID7:
$request.path.learningItemRatingDetailsUniqID7
- selectedCourseOfferingsUniqID2:
$request.path.selectedCourseOfferingsUniqID2
The personDetalis resource provides details about the person associated with the learning item. - learnerLearningRecordsUniqID: