Jump to

• Request
• Response

Create a rating

post

/hcmRestApi/resources/11.13.18.05/learnerLearningRecords/{learnerLearningRecordsUniqID}/child/completionDetails/{completionDetailsUniqID}/child/primarySelectedCourseOffering/{otherSelectedCourseOfferingsUniqID}/child/learningItemRatingDetails

Request

Path Parameters

• completionDetailsUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Completion Details resource and used to uniquely identify an instance of Completion Details. The client should not generate the hash key value. Instead, the client should query on the Completion Details collection resource in order to navigate to a specific instance of Completion Details to get the hash key.
• 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.
• otherSelectedCourseOfferingsUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Other Selected Course Offerings resource and used to uniquely identify an instance of Other Selected Course Offerings. The client should not generate the hash key value. Instead, the client should query on the Other Selected Course Offerings collection resource in order to navigate to a specific instance of Other Selected Course Offerings to get the hash key.

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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• 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.
• 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.

{
    "type":"object",
    "properties":{
        "ratingId":{
            "title":"Rating ID",
            "type":"integer",
            "description":"Unique identifier for the rating on the learning item.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "rating":{
            "title":"Rating",
            "type":"number",
            "description":"The rating given on the learning item.",
            "nullable":true
        },
        "ratingComment":{
            "title":"Rating Comment",
            "maxLength":"4000",
            "type":"string",
            "description":"Comment made by the learner while rating the learning item.",
            "nullable":true
        },
        "ratingByPersonImageURL":{
            "title":"Rated by Person Image URL",
            "type":"string",
            "description":"Image URL of the person who rated the learning item.",
            "nullable":true
        },
        "ratingNumber":{
            "title":"Rating Number",
            "maxLength":"30",
            "type":"string",
            "description":"Friendly number identifying the learning item rating.",
            "nullable":true
        },
        "ratingStatus":{
            "title":"Rating Status",
            "maxLength":"30",
            "type":"string",
            "description":"Status of the rating on the learning item.",
            "nullable":true
        },
        "ratingByPersonId":{
            "title":"Rated by Person ID",
            "type":"integer",
            "description":"Identifier of the person who rated the learning item.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "ratedByPersonDetails":{
            "title":"User Access Person Details",
            "type":"array",
            "description":"The personDetalis resource provides details about the person associated with the learning item.",
            "items":{
                "$ref":"#/components/schemas/learnerLearningRecords-completionDetails-primarySelectedCourseOffering-learningItemRatingDetails-ratedByPersonDetails-item-post-request"
            }
        }
    }
}

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

• Array of: object learnerLearningRecords-completionDetails-primarySelectedCourseOffering-learningItemRatingDetails-ratedByPersonDetails-item-post-request

{
    "title":"User Access Person Details",
    "type":"array",
    "description":"The personDetalis resource provides details about the person associated with the learning item.",
    "items":{
        "$ref":"#/components/schemas/learnerLearningRecords-completionDetails-primarySelectedCourseOffering-learningItemRatingDetails-ratedByPersonDetails-item-post-request"
    }
}

Nested Schema : learnerLearningRecords-completionDetails-primarySelectedCourseOffering-learningItemRatingDetails-ratedByPersonDetails-item-post-request

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

Back to Top

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.

Body ()

Root Schema : learnerLearningRecords-completionDetails-primarySelectedCourseOffering-learningItemRatingDetails-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "ratingDate":{
            "title":"Rated on Date",
            "type":"string",
            "description":"Date the rating was made on the learning item.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ratingByPersonDisplayName":{
            "title":"Rated By",
            "maxLength":"240",
            "type":"string",
            "description":"Display name for the person who rated the learning item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ratingByPersonNumber":{
            "title":"Rated by Person Number",
            "maxLength":"30",
            "type":"string",
            "description":"Person number of the person who rated the learning item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ratingId":{
            "title":"Rating ID",
            "type":"integer",
            "description":"Unique identifier for the rating on the learning item.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "rating":{
            "title":"Rating",
            "type":"number",
            "description":"The rating given on the learning item.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ratingComment":{
            "title":"Rating Comment",
            "maxLength":"4000",
            "type":"string",
            "description":"Comment made by the learner while rating the learning item.",
            "nullable":true,
            "x-queryable":true
        },
        "ratingByPersonImageURL":{
            "title":"Rated by Person Image URL",
            "type":"string",
            "description":"Image URL of the person who rated the learning item.",
            "nullable":true,
            "x-queryable":true
        },
        "ratingNumber":{
            "title":"Rating Number",
            "maxLength":"30",
            "type":"string",
            "description":"Friendly number identifying the learning item rating.",
            "nullable":true,
            "x-queryable":true
        },
        "ratingStatus":{
            "title":"Rating Status",
            "maxLength":"30",
            "type":"string",
            "description":"Status of the rating on the learning item.",
            "nullable":true,
            "x-queryable":true
        },
        "ratingByPersonId":{
            "title":"Rated by Person ID",
            "type":"integer",
            "description":"Identifier of the person who rated the learning item.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ratedByPersonDetails":{
            "title":"User Access Person Details",
            "type":"array",
            "description":"The personDetalis resource provides details about the person associated with the learning item.",
            "items":{
                "$ref":"#/components/schemas/learnerLearningRecords-completionDetails-primarySelectedCourseOffering-learningItemRatingDetails-ratedByPersonDetails-item-response"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

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

• Array of: object learnerLearningRecords-completionDetails-primarySelectedCourseOffering-learningItemRatingDetails-ratedByPersonDetails-item-response

{
    "title":"User Access Person Details",
    "type":"array",
    "description":"The personDetalis resource provides details about the person associated with the learning item.",
    "items":{
        "$ref":"#/components/schemas/learnerLearningRecords-completionDetails-primarySelectedCourseOffering-learningItemRatingDetails-ratedByPersonDetails-item-response"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Nested Schema : learnerLearningRecords-completionDetails-primarySelectedCourseOffering-learningItemRatingDetails-ratedByPersonDetails-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "departmentName":{
            "title":"Department",
            "maxLength":"240",
            "type":"string",
            "description":"Person's department name.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "jobName":{
            "title":"Job",
            "maxLength":"240",
            "type":"string",
            "description":"Person's job name.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "businessUnitName":{
            "title":"Business Unit",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the person's business unit.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "locationName":{
            "title":"Location Name",
            "maxLength":"240",
            "type":"string",
            "description":"Person's location name.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "lineManagerDisplayName":{
            "title":"Line Manager",
            "maxLength":"240",
            "type":"string",
            "description":"Display name for the person's line manager.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "legalEmployerId":{
            "title":"Legal Employer ID",
            "type":"integer",
            "description":"Identifier for the person's legal employer.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "departmentId":{
            "title":"Department ID",
            "type":"integer",
            "description":"Person's department.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "primaryPhoneNumber":{
            "maxLength":"60",
            "type":"string",
            "description":"Person's primary phone number.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "lineManagerId":{
            "title":"Line Manager ID",
            "type":"integer",
            "description":"Identifier for the person's line manager.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "lineManagerPrimaryEmailAddress":{
            "title":"Line Manager Primary Email Address",
            "maxLength":"240",
            "type":"string",
            "description":"Primary email address for the person's line manager.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "businessUnitId":{
            "title":"Business Unit ID",
            "type":"integer",
            "description":"Unique identifier for the person's business unit.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "primaryEmailAddress":{
            "maxLength":"240",
            "type":"string",
            "description":"Person's primary email address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "positionName":{
            "title":"Position",
            "maxLength":"240",
            "type":"string",
            "description":"Person's position name.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "jobId":{
            "title":"Job ID",
            "type":"integer",
            "description":"Person's job identifier.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "positionId":{
            "title":"Position ID",
            "type":"integer",
            "description":"Unique identifier for the person's position.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "legalEmployerName":{
            "title":"Legal Employer",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the person's legal employer.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "locationId":{
            "title":"Location ID",
            "type":"integer",
            "description":"Person's location identifier.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "lineManagerNumber":{
            "title":"Line Manager Number",
            "maxLength":"30",
            "type":"string",
            "description":"Number for the person's line manager.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "personId":{
            "type":"integer",
            "description":"Identifier of the person who's the publisher.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "assignmentName":{
            "maxLength":"80",
            "type":"string",
            "description":"Person's work assignment name.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Links

ratedByPersonDetails

Parameters:

• completionDetailsUniqID: $request.path.completionDetailsUniqID
• learnerLearningRecordsUniqID: $request.path.learnerLearningRecordsUniqID
• learningItemRatingDetailsUniqID100: $request.path.learningItemRatingDetailsUniqID100
• otherSelectedCourseOfferingsUniqID102: $request.path.otherSelectedCourseOfferingsUniqID102

Back to Top