Skip to content

Toggle field locks for metadata

PUT
/api/v1/books/metadata/toggle-field-locks
curl --request PUT \
--url http://127.0.0.1:58259/api/v1/books/metadata/toggle-field-locks \
--header 'Content-Type: application/json' \
--data '{ "bookIds": [ 1 ], "fieldActions": { "additionalProperty": "example" } }'

Toggle field locks for book metadata. Requires metadata edit permission or admin.

Media type application/json

Toggle field locks request

object
bookIds
Array<integer>
fieldActions
object
key
additional properties
string
Example generated
{
"bookIds": [
1
],
"fieldActions": {
"additionalProperty": "example"
}
}

Field locks toggled successfully

Media type */*
Array<object>
object
bookId
integer format: int64
title
string
subtitle
string
publisher
string
publishedDate
string format: date
description
string
seriesName
string
seriesNumber
number format: float
seriesTotal
integer format: int32
isbn13
string
isbn10
string
pageCount
integer format: int32
language
string
narrator
string
abridged
boolean
audiobookMetadata
object
durationSeconds
integer format: int64
bitrate
integer format: int32
sampleRate
integer format: int32
channels
integer format: int32
codec
string
chapterCount
integer format: int32
chapters
Array<object>
object
index
integer format: int32
title
string
startTimeMs
integer format: int64
endTimeMs
integer format: int64
durationMs
integer format: int64
comicMetadata
object
issueNumber
string
volumeName
string
volumeNumber
integer format: int32
storyArc
string
storyArcNumber
integer format: int32
alternateSeries
string
alternateIssue
string
pencillers
Array<string>
unique items
inkers
Array<string>
unique items
colorists
Array<string>
unique items
letterers
Array<string>
unique items
coverArtists
Array<string>
unique items
editors
Array<string>
unique items
imprint
string
format
string
blackAndWhite
boolean
manga
boolean
readingDirection
string
characters
Array<string>
unique items
teams
Array<string>
unique items
locations
Array<string>
unique items
webLink
string
notes
string
issueNumberLocked
boolean
volumeNameLocked
boolean
volumeNumberLocked
boolean
storyArcLocked
boolean
storyArcNumberLocked
boolean
alternateSeriesLocked
boolean
alternateIssueLocked
boolean
imprintLocked
boolean
formatLocked
boolean
blackAndWhiteLocked
boolean
mangaLocked
boolean
readingDirectionLocked
boolean
webLinkLocked
boolean
notesLocked
boolean
creatorsLocked
boolean
pencillersLocked
boolean
inkersLocked
boolean
coloristsLocked
boolean
letterersLocked
boolean
coverArtistsLocked
boolean
editorsLocked
boolean
charactersLocked
boolean
teamsLocked
boolean
locationsLocked
boolean
asin
string
amazonRating
number format: double
amazonReviewCount
integer format: int32
goodreadsId
string
comicvineId
string
goodreadsRating
number format: double
goodreadsReviewCount
integer format: int32
hardcoverId
string
hardcoverBookId
string
hardcoverRating
number format: double
hardcoverReviewCount
integer format: int32
doubanId
string
doubanRating
number format: double
doubanReviewCount
integer format: int32
lubimyczytacRating
number format: double
googleId
string
lubimyczytacId
string
ranobedbId
string
ranobedbRating
number format: double
audibleId
string
audibleRating
number format: double
audibleReviewCount
integer format: int32
externalUrl
string
coverUpdatedOn
string format: date-time
audiobookCoverUpdatedOn
string format: date-time
authors
Array<string>
categories
Array<string>
unique items
moods
Array<string>
unique items
tags
Array<string>
unique items
provider
string
Allowed values: Amazon GoodReads Google Hardcover Comicvine Douban Lubimyczytac Ranobedb Audible
thumbnailUrl
string
bookReviews
Array<object>
object
id
integer format: int64
metadataProvider
string
Allowed values: Amazon GoodReads Google Hardcover Comicvine Douban Lubimyczytac Ranobedb Audible
reviewerName
string
title
string
rating
number format: float
date
string format: date-time
body
string
country
string
spoiler
boolean
followersCount
integer format: int32
textReviewsCount
integer format: int32
rating
number format: double
isFixedLayout
boolean
allMetadataLocked
boolean
titleLocked
boolean
subtitleLocked
boolean
publisherLocked
boolean
publishedDateLocked
boolean
descriptionLocked
boolean
seriesNameLocked
boolean
seriesNumberLocked
boolean
seriesTotalLocked
boolean
isbn13Locked
boolean
isbn10Locked
boolean
asinLocked
boolean
goodreadsIdLocked
boolean
comicvineIdLocked
boolean
hardcoverIdLocked
boolean
hardcoverBookIdLocked
boolean
doubanIdLocked
boolean
googleIdLocked
boolean
pageCountLocked
boolean
languageLocked
boolean
amazonRatingLocked
boolean
amazonReviewCountLocked
boolean
goodreadsRatingLocked
boolean
goodreadsReviewCountLocked
boolean
hardcoverRatingLocked
boolean
hardcoverReviewCountLocked
boolean
doubanRatingLocked
boolean
doubanReviewCountLocked
boolean
lubimyczytacIdLocked
boolean
lubimyczytacRatingLocked
boolean
ranobedbIdLocked
boolean
ranobedbRatingLocked
boolean
audibleIdLocked
boolean
audibleRatingLocked
boolean
audibleReviewCountLocked
boolean
externalUrlLocked
boolean
coverLocked
boolean
audiobookCoverLocked
boolean
authorsLocked
boolean
categoriesLocked
boolean
moodsLocked
boolean
tagsLocked
boolean
reviewsLocked
boolean
narratorLocked
boolean
abridgedLocked
boolean
ageRating
integer format: int32
contentRating
string
ageRatingLocked
boolean
contentRatingLocked
boolean