work.lexical.rating Documentation (EN)

main record

A record representing a rating of a work.

Record Key tid Timestamp-based ID

Properties

action string at-uri Optional

AT URI of the action this rating is tied to.

maxLength: 2048 bytes

ratedAt string datetime Optional

When the rating was made. Optional; clients may inherit from the linked action if absent.

maxLength: 64 bytes

value integer Required

The rating value, from 0 to 10.

minimum: 0maximum: 10

work string at-uri Required

AT URI of the work being rated.

maxLength: 2048 bytes

View raw schema

{
  "key": "tid",
  "type": "record",
  "record": {
    "type": "object",
    "required": [
      "work",
      "value"
    ],
    "properties": {
      "work": {
        "type": "string",
        "format": "at-uri",
        "required": true,
        "maxLength": 2048,
        "description": "AT URI of the work being rated."
      },
      "value": {
        "type": "integer",
        "maximum": 10,
        "minimum": 0,
        "required": true,
        "description": "The rating value, from 0 to 10."
      },
      "action": {
        "type": "string",
        "format": "at-uri",
        "maxLength": 2048,
        "description": "AT URI of the action this rating is tied to."
      },
      "ratedAt": {
        "type": "string",
        "format": "datetime",
        "maxLength": 64,
        "description": "When the rating was made. Optional; clients may inherit from the linked action if absent."
      }
    }
  },
  "description": "A record representing a rating of a work."
}