work.lexical.work.identifier Documentation (EN)

main record

A record asserting a mapping between a work and an external identifier.

Record Key any Any valid record key

Properties

provider string Required

The identifier provider (e.g. 'imdb', 'wikidata', 'tmdb').

maxLength: 128 bytesmaxGraphemes: 128 graphemes

Known values: imdb, wikidata, tmdb, letterboxd

providerValue string Required

The identifier value assigned by the provider.

maxLength: 256 bytesmaxGraphemes: 256 graphemes

url string uri Optional

The provider's canonical URL for this identifier.

maxLength: 2048 bytes

work string at-uri Required

AT URI of the work being identified.

maxLength: 2048 bytes

View raw schema

{
  "key": "any",
  "type": "record",
  "record": {
    "type": "object",
    "required": [
      "work",
      "provider",
      "providerValue"
    ],
    "properties": {
      "url": {
        "type": "string",
        "format": "uri",
        "maxLength": 2048,
        "description": "The provider's canonical URL for this identifier."
      },
      "work": {
        "type": "string",
        "format": "at-uri",
        "required": true,
        "maxLength": 2048,
        "description": "AT URI of the work being identified."
      },
      "provider": {
        "type": "string",
        "required": true,
        "maxLength": 128,
        "description": "The identifier provider (e.g. 'imdb', 'wikidata', 'tmdb').",
        "knownValues": [
          "imdb",
          "wikidata",
          "tmdb",
          "letterboxd"
        ],
        "maxGraphemes": 128
      },
      "providerValue": {
        "type": "string",
        "required": true,
        "maxLength": 256,
        "description": "The identifier value assigned by the provider.",
        "maxGraphemes": 256
      }
    }
  },
  "description": "A record asserting a mapping between a work and an external identifier."
}