xyz.opnshelf.list.item Documentation (EN)

main record

A media item in a list for OpnShelf

Record Key tid Timestamp-based ID

Properties

createdAt string datetime Required

Record creation timestamp

episodeNumber integer Optional

Episode number for episode items

listRkey string Required

Rkey of the parent list

mediaId string Required

TMDB movie ID or show ID

mediaType string Required

Media type

Allowed: movie, show, season, episode

notes string Optional

Optional user notes about the media in this list

seasonNumber integer Optional

Season number for season/episode items

View raw schema

{
  "key": "tid",
  "type": "record",
  "record": {
    "type": "object",
    "required": [
      "listRkey",
      "mediaType",
      "mediaId",
      "createdAt"
    ],
    "properties": {
      "notes": {
        "type": "string",
        "description": "Optional user notes about the media in this list"
      },
      "mediaId": {
        "type": "string",
        "description": "TMDB movie ID or show ID"
      },
      "listRkey": {
        "type": "string",
        "description": "Rkey of the parent list"
      },
      "createdAt": {
        "type": "string",
        "format": "datetime",
        "description": "Record creation timestamp"
      },
      "mediaType": {
        "enum": [
          "movie",
          "show",
          "season",
          "episode"
        ],
        "type": "string",
        "description": "Media type"
      },
      "seasonNumber": {
        "type": "integer",
        "description": "Season number for season/episode items"
      },
      "episodeNumber": {
        "type": "integer",
        "description": "Episode number for episode items"
      }
    }
  },
  "description": "A media item in a list for OpnShelf"
}