INPUT_OBJECT

UpdateWorkInput

Autogenerated input type of UpdateWork

link GraphQL Schema definition

  • input UpdateWorkInput {
  • # A unique identifier for the client performing the mutation.
  • clientMutationId: String
  • # The Consonance unique identifier
  • id: Int!
  • # The ID of the category assigned to the work
  • workTypeId: Int
  • # The ID of the publishing season for the work
  • seasonId: Int
  • # The ID of the marketing tier for the work
  • marketingTierId: Int
  • # The ID of the project stage for the work
  • projectStageId: Int
  • # The subtitle of the work. Editeur [link:
  • # https://www.editeur.org/93/Release-3.0-Downloads/#Best%20practice] discourages
  • # putting the product form, edition, translation or marketing messages in the
  • # subtitle. Retailers and librarians consider promotional subtitles that do not
  • # reflect the text on the product’s title page to be a serious problem.
  • subtitle: String
  • # The full title, including prefix
  • title: String
  • # Title acronym or initialism e.g. BNF
  • acronym: String
  • # Alternative titles by which the work is widely known. Add alternative titles
  • # whether they appear on the products or not. These can be used by bibliographic
  • # systems for indexing purposes.
  • alternativeTitles: [String!]
  • # An ordered list of the Thema subject classification codes on the work
  • themas: [String!]
  • # An ordered list of the BISAC subject classification codes on the work
  • bisacs: [String!]
  • # An ordered list of the BIC subject classification codes on the work
  • bics: [String!]
  • # An ordered list of the NUR subject classification codes on the work
  • nurs: [String!]
  • # An ordered list of the in-house subject codes on the work
  • inHouseSubjects: [String!]
  • # Children's Book Marketing Category interest level
  • cbmcInterestLevelCode: InterestLevel
  • # Children's Book Marketing Category broad subject
  • cbmcBroadSubjectCode: BroadSubject
  • # Children's Book Marketing Category character
  • cbmcCharacterCode: Character
  • # Children's Book Marketing Category tie-in
  • cbmcTieInCode: TieIn
  • # Children's Book Marketing Category type or format
  • cbmcTypeFormatCode: TypeFormat
  • # How the title is intended to be presented. Use when concatenating the title,
  • # subtitle, edition, series names, part numbers, and year of annual might not give
  • # a satisfactory result. For example, "The Two Towers (The Lord of the Rings, Book
  • # Two)", or "The Lord of the Rings, Book 2: The Two Towers, Illustrated Edition".
  • titleStatement: String
  • # An abbreviated form of the work title
  • abbreviatedTitle: String
  • # For translated works only, the title of the work in its original language. This
  • # may not be indexed by retailers, so consider adding it as a keyword.
  • titleInOriginalLanguage: String
  • # For translated works only, the subtitle of the work in its original language
  • subtitleInOriginalLanguage: String
  • # Optional indication of the "lead" product. ISBNs are product, not work,
  • # identifiers, but some other systems require you to nominate a "lead" product.
  • identifyingIsbn: String
  • # Managed by the International DOI Foundation [link: https://www.doi.org/], the
  • # DOI provides persistent identification of content objects and related entities
  • # in digital networks. We do not currently validate DOI formats.
  • identifyingDoi: String
  • # A unique cataloguing identifier, assigned by the Library of Congress. Library of
  • # Congress Control Numbers are assigned under the Preassigned Control Number
  • # Program. We do not currently validate LCCN formats. Use for both print and
  • # ebooks, unless you want to specify a separate ebook LCCN.
  • lccn: String
  • # Library of Congress Control Numbers are assigned under the Preassigned Control
  • # Number Program. We do not currently validate LCCN formats. If the LCCN is
  • # present, but the ebook LCCN isn't, then the LCCN is used for both print and
  • # ebooks.
  • ebookLccn: String
  • # The in-house reference for the work
  • inHouseWorkReference: String
  • # The full address of the publisher's promotional, informational, or sales web
  • # page for this work
  • publishersUrl: URI
  • # The name of a city or town associated with the imprint or publisher
  • publicationCity: String
  • # A code identifying the country where the product is published
  • onixPublicationCountryCode: ONIXCountryCode
  • # Division name
  • divisionName: String
  • # Publisher area
  • publisherArea: String
  • # Imprint ID
  • imprintId: Int
  • # Publisher ID. Only used when setting publishers and imprints separately.
  • soloPublisherId: Int
  • # Your organisation's unique Salesforce ID for this work
  • salesforceUid: String
  • # Scribd Doc ID for the source book or audiobook that the Snapshot is based on.
  • # Required to pull in category information and generate a cover.
  • scribdSourceDocId: String
  • # When you issue a new major version of a work, you typically create a new set of
  • # products with a new edition number. The guidance that we have received from
  • # EDItEUR is that an edition should not be marked as the first until the second is
  • # created. The trade would generally infer from the existence of Edition 1 that
  • # Edition 2 either exists or is forthcoming. The ONIX documentation states: "The
  • # number of a numbered edition. Optional and non-repeating. Normally sent only for
  • # the second and subsequent editions of a work, but by agreement between parties
  • # to an ONIX exchange a first edition may be explicitly numbered." This implies
  • # that the first edition may be left unnumbered, but we’d discourage this because
  • # the creation of new, unnumbered products could then be ambiguous.
  • editionNumber: Int
  • # When you issue a new major version of a work, you typically create a new set of
  • # products with a new edition number. The guidance that we have received from
  • # EDItEUR is that an edition should not be marked as the first until the second is
  • # created. The trade would generally infer from the existence of Edition 1 that
  • # Edition 2 either exists or is forthcoming. The ONIX documentation states: "The
  • # number of a numbered edition. Optional and non-repeating. Normally sent only for
  • # the second and subsequent editions of a work, but by agreement between parties
  • # to an ONIX exchange a first edition may be explicitly numbered." This implies
  • # that the first edition may be left unnumbered, but we’d discourage this because
  • # the creation of new, unnumbered products could then be ambiguous.
  • edition: Int
  • # The nominal year of an annual publication
  • yearOfAnnual: Int
  • # The nominal year or pair of years of an annual publication
  • yearsOfAnnual: String
  • # A short, free-text description of a version or edition. When used, the Edition
  • # Statement must carry a complete description of the nature of the edition, i.e.
  • # it should not be treated as merely supplementary to an Edition Type Code or an
  • # Edition Number. The Edition Statement should be strictly limited to describing
  • # features of the content of the edition, and should not include aspects such as
  • # rights or market restrictions which are properly covered elsewhere.
  • editionStatement: String
  • # Codes identifying the types of a version or edition
  • onixEditionTypeCodes: [ONIXEditionTypeCode!]
  • # A free text description of the intended audience, to augment the ONIX audience
  • # codes
  • audienceDescription: String
  • # Intended starting interest age for the work, in years from 0-99
  • interestAgeFrom: Int
  • # Intended ending interest age for the work, in years from 0-99
  • interestAgeTo: Int
  • # Intended starting reading age for the work, in years from 0-99
  • readingAgeFrom: Int
  • # Intended ending reading age for the work, in years from 0-99
  • readingAgeTo: Int
  • # Starting code from [ONIX code list 77](https://ns.editeur.org/onix/en/77),
  • # US and Canada (excluding Quebec) school or college grade
  • northAmericanSchoolGradeFrom: ONIXNorthAmericanSchoolGradeCode
  • # Ending code from [ONIX code list 77](https://ns.editeur.org/onix/en/77),
  • # US and Canada (excluding Quebec) school or college grade
  • northAmericanSchoolGradeTo: ONIXNorthAmericanSchoolGradeCode
  • # A code from [ONIX code list 203](https://ns.editeur.org/onix/en/203),
  • #
  • # ONIX adult audience rating
  • contentWarnings: [ONIXContentWarningCode!]
  • # A code from [ONIX code list 28](https://ns.editeur.org/onix/en/28),
  • #
  • # ONIX audience type
  • onixAudiences: [ONIXAudienceCode!]
  • # The existing products of the work. Note that the products must already belong to
  • # the work being updated.
  • products: [UpdateProductInput!]
  • # The status to be applied by default to the work's prices, unless they or their
  • # product has a status set themselves.
  • onixPriceStatusCode: ONIXPriceStatusCode
  • # IDs of products that are similar to this work
  • similarProductIds: [Int!]
  • # The Library of Congress subject heading
  • lcSubjectHeading: String
  • # The Library of Congress subject heading region
  • lcSubjectHeadingRegion: String
  • # The Library of Congress fiction genre heading
  • lcFictionGenreHeading: String
  • # The Library of Congress children's subject heading
  • lcChildrensSubjectHeading: String
  • # The set of search keywords applied to the work
  • keywords: String
  • # The Dewey Decimal Classification edition
  • deweyDecimalEdition: Int
  • # The Dewey Decimal Classification code
  • deweyDecimalCode: String
  • # A free text statement of the whole of the authorship of the work in the form in
  • # which the publisher intends it to be displayed. Can be overwritten by product
  • # level authorship description.
  • authorshipDescription: String
  • # Whether products that have no prices set should be marked in ONIX as being free
  • freeProducts: Boolean
  • # Creative Commons licence type
  • licenceType: OpenAccessLicence
  • # The organisations that fund both research and publication
  • openAccessFundingBodyIds: [Int!]
  • # The identifiers of the bodies funding publication fees, if different from the
  • # body funding the underlying research
  • openAccessPublicationFunderIds: [Int!]
  • # The identifiers of the bodies funding the research on which publication is
  • # based, if different from the body funding the publication
  • openAccessResearchFunderIds: [Int!]
  • # The identifiers of the organisations responsible for printing a printed product.
  • # Supplied primarily to meet legal deposit requirements, and may apply only to the
  • # first impression. The organisation may also be responsible for binding, when a
  • # separate binder is not specified.
  • printersOfRecordIds: [Int!]
  • # The identifiers of the organisations responsible for binding a printed product
  • # (where distinct from the printer). Supplied primarily to meet legal deposit
  • # requirements, and may apply only to the first impression.
  • bindersOfRecordIds: [Int!]
  • # Legal deposit reference
  • legalDepositReference: String
  • # Flemish quality label
  • guaranteedPeerReviewedContent: Boolean
  • # Freeform notes on other publishers' competing products. These can be integrated
  • # into Advance Information (TIP) sheets. These notes will not be sent in ONIX
  • # messages.
  • comparisonProducts: String
  • # Freeform notes on the publisher's related products. These can be used in custom
  • # reports, or integrated into Advance Information (TIP) sheets. These notes will
  • # not be sent in ONIX messages.
  • notesOnRelatedProducts: String
  • # ISBNs of other publishers' competing products. Included as related products in
  • # ONIX.
  • comparisonIsbns: String
  • # The number and type of illustrations. The text may also include other content
  • # items, e.g. maps, bibliography, tables, index etc.
  • #
  • # This can be overridden for individual products.
  • illustrationsNote: String
  • # The total number of illustrations in a book or other printed product.
  • #
  • # The more informative free text field "Illustrations Note" and/or the use of
  • # "Ancillary Content" are strongly preferred, but some ONIX recipients may accept
  • # only this simple count.
  • numberOfIllustrations: Int
  • # Illustration and other content types
  • ancillaryContents: [UpdateAncillaryContentInput!]
  • # Describes the adoption of the work as a book club selection
  • bookClubAdoptionAnnouncement: String
  • # Describes the promotion and advertising campaign
  • promotionalCampaignAnnouncement: String
  • # The year in which copyright in the work was registered
  • copyrightYear: Int
  • # A formal copyright statement of the year and copyright owners. Required only for
  • # complex situations in which the copyright cannot be expressed simply as a year
  • # and a list of owners.
  • copyrightNotice: String
  • # The identifiers of persons or organisations holding copyright
  • copyrightOwnerIds: [Int!]
  • # A Consonance internal field to determine which prices should appear in a
  • # client's pricing region on the metadata page.
  • scope: String
  • }

link Require by