Skip to main content

BookMetadataContextDto

Book metadata context for template evaluation.

Contains book metadata fields in a flat structure suitable for template access via metadata.* syntax.

authors object[]

Structured author information

  • Array [
  • namestringrequired

    Author name

    Example: Oda Eiichiro
    rolestring | nullnullable

    Role (e.g., "author", "artist", "editor")

    Example: author
    sortNamestring | nullnullable

    Sort name (e.g., "Lastname, Firstname")

    Example: Oda, Eiichiro
  • ]
  • authorsJsonLockboolean

    Whether authors_json is locked

    awards object[]

    Awards information

  • Array [
  • categorystring | nullnullable

    Award category (optional)

    Example: Best Novel
    namestringrequired

    Award name

    Example: Hugo Award
    wonboolean | nullnullable

    Whether the book won (vs nominated)

    Example: true
    yearinteger,null<int32>nullable

    Year awarded (optional)

    Example: 2015
  • ]
  • awardsJsonLockboolean

    Whether awards_json is locked

    blackAndWhiteboolean | nullnullable

    Whether the book is black and white

    Example: false
    blackAndWhiteLockboolean

    Whether black_and_white is locked

    bookTypestring | nullnullable

    Book type classification

    Example: novel
    bookTypeLockboolean

    Whether book_type is locked

    countinteger,null<int32>nullable

    Total count in series

    Example: 4
    countLockboolean

    Whether count is locked

    coverLockboolean

    Whether cover is locked

    customMetadataLockboolean

    Whether custom_metadata is locked

    dayinteger,null<int32>nullable

    Publication day (1-31)

    Example: 15
    dayLockboolean

    Whether day is locked

    editionstring | nullnullable

    Edition information

    Example: First Edition
    editionLockboolean

    Whether edition is locked

    externalLinks object[]

    External links for this book

  • Array [
  • externalIdstring | nullnullable

    External ID on the source (optional)

    Example: 123
    sourcestringrequired

    Source name (e.g., "mangadex", "myanimelist")

    Example: mangadex
    urlstringrequired

    URL to the external resource

    Example: https://mangadex.org/title/123
  • ]
  • formatDetailstring | nullnullable

    Format detail (e.g., "Trade Paperback")

    Example: Trade Paperback
    formatDetailLockboolean

    Whether format_detail is locked

    genrestring | nullnullable

    Genre (ComicInfo-style single genre field)

    Example: Science Fiction
    genreLockboolean

    Whether genre is locked

    genresstring[]

    Genre names for this book

    Example: ["Science Fiction","Adventure"]
    imprintstring | nullnullable

    Imprint (sub-publisher)

    Example: Broadway Books
    imprintLockboolean

    Whether imprint is locked

    isbnsstring | nullnullable

    ISBN(s)

    Example: 978-0553418026
    isbnsLockboolean

    Whether isbns is locked

    languageIsostring | nullnullable

    Language code (ISO format)

    Example: en
    languageIsoLockboolean

    Whether language_iso is locked

    mangaboolean | nullnullable

    Whether the book is manga format

    Example: false
    mangaLockboolean

    Whether manga is locked

    monthinteger,null<int32>nullable

    Publication month (1-12)

    Example: 2
    monthLockboolean

    Whether month is locked

    numbernumber,null<double>nullable

    Book number (e.g., issue/chapter number)

    Example: 1
    numberLockboolean

    Whether number is locked

    originalTitlestring | nullnullable

    Original title (for translated works)

    Example: 火星の人
    originalTitleLockboolean

    Whether original_title is locked

    originalYearinteger,null<int32>nullable

    Original publication year

    Example: 2011
    originalYearLockboolean

    Whether original_year is locked

    publisherstring | nullnullable

    Publisher name

    Example: Crown Publishing
    publisherLockboolean

    Whether publisher is locked

    seriesPositionnumber,null<double>nullable

    Position in a series

    Example: 1
    seriesPositionLockboolean

    Whether series_position is locked

    seriesTotalinteger,null<int32>nullable

    Total number of books in the series

    Example: 3
    seriesTotalLockboolean

    Whether series_total is locked

    subjectsstring[]

    Subject/topic tags

    Example: ["Science Fiction","Space Exploration"]
    subjectsLockboolean

    Whether subjects are locked

    subtitlestring | nullnullable

    Book subtitle

    Example: A Novel
    subtitleLockboolean

    Whether subtitle is locked

    summarystring | nullnullable

    Book summary/description

    Example: Astronaut Mark Watney is stranded on Mars...
    summaryLockboolean

    Whether summary is locked

    tagsstring[]

    Tag names for this book

    Example: ["mars","survival","space"]
    titlestring | nullnullable

    Book title

    Example: The Martian
    titleLockboolean

    Whether title is locked

    titleSortstring | nullnullable

    Custom sort name

    Example: Martian, The
    titleSortLockboolean

    Whether title_sort is locked

    translatorstring | nullnullable

    Translator name

    Example: John Smith
    translatorLockboolean

    Whether translator is locked

    volumeinteger,null<int32>nullable

    Volume number

    Example: 1
    volumeLockboolean

    Whether volume is locked

    yearinteger,null<int32>nullable

    Publication year

    Example: 2011
    yearLockboolean

    Whether year is locked

    BookMetadataContextDto
    {
    "authors": [
    {
    "name": "Oda Eiichiro",
    "role": "author",
    "sortName": "Oda, Eiichiro"
    }
    ],
    "authorsJsonLock": true,
    "awards": [
    {
    "category": "Best Novel",
    "name": "Hugo Award",
    "won": true,
    "year": 2015
    }
    ],
    "awardsJsonLock": true,
    "blackAndWhite": false,
    "blackAndWhiteLock": true,
    "bookType": "novel",
    "bookTypeLock": true,
    "count": 4,
    "countLock": true,
    "coverLock": true,
    "customMetadataLock": true,
    "day": 15,
    "dayLock": true,
    "edition": "First Edition",
    "editionLock": true,
    "externalLinks": [
    {
    "externalId": "123",
    "source": "mangadex",
    "url": "https://mangadex.org/title/123"
    }
    ],
    "formatDetail": "Trade Paperback",
    "formatDetailLock": true,
    "genre": "Science Fiction",
    "genreLock": true,
    "genres": [
    "Science Fiction",
    "Adventure"
    ],
    "imprint": "Broadway Books",
    "imprintLock": true,
    "isbns": "978-0553418026",
    "isbnsLock": true,
    "languageIso": "en",
    "languageIsoLock": true,
    "manga": false,
    "mangaLock": true,
    "month": 2,
    "monthLock": true,
    "number": 1,
    "numberLock": true,
    "originalTitle": "火星の人",
    "originalTitleLock": true,
    "originalYear": 2011,
    "originalYearLock": true,
    "publisher": "Crown Publishing",
    "publisherLock": true,
    "seriesPosition": 1,
    "seriesPositionLock": true,
    "seriesTotal": 3,
    "seriesTotalLock": true,
    "subjects": [
    "Science Fiction",
    "Space Exploration"
    ],
    "subjectsLock": true,
    "subtitle": "A Novel",
    "subtitleLock": true,
    "summary": "Astronaut Mark Watney is stranded on Mars...",
    "summaryLock": true,
    "tags": [
    "mars",
    "survival",
    "space"
    ],
    "title": "The Martian",
    "titleLock": true,
    "titleSort": "Martian, The",
    "titleSortLock": true,
    "translator": "John Smith",
    "translatorLock": true,
    "volume": 1,
    "volumeLock": true,
    "year": 2011,
    "yearLock": true
    }