OBJECT
Work
A unique item of intellectual property on which products are based
link GraphQL Schema definition
- type Work {
- # An abbreviated form of the title
- String :
- # The work's acronym or initialism e.g. BNF
- String :
- # The name of a city or town associated with the imprint or publisher, inherited
- # from the imprint or publisher unless set directly on the work
- String :
- # Alternative titles by which the work is widely known
- String :
- # Illustration and other content types
- AncillaryContent!]! : [
- # The audiences for the work
- WorkAudience! :
- # The audience descriptions for the work
- AudienceDescription @deprecated( reason: "Moved to WorkAudience type" ) :
- # 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.
- String :
- # The set of BIC category codes assigned, ordered by priority
- String!] : [
- # 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.
- Contact!]! : [
- # 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.
- Int!]! : [
- # The set of BISAC category codes assigned, ordered by priority
- String!] : [
- # Describes the adoption of the work as a book club selection
- String :
- # Children's Book Marketing Category broad subject. CBMC codes are valid only when
- # all five codes are present.
- ChildrensBookMarketingCategoryBroadSubject :
- # Children's Book Marketing Category character. CBMC codes are valid only when all
- # five codes are present.
- ChildrensBookMarketingCategoryCharacter :
- # Children's Book Marketing Category interest level. CBMC codes are valid only
- # when all five codes are present.
- ChildrensBookMarketingCategoryInterest :
- # Children's Book Marketing Category tie-in. CBMC codes are valid only when all
- # five codes are present.
- ChildrensBookMarketingCategoryTieIn :
- # Children's Book Marketing Category type or format. CBMC codes are valid only
- # when all five codes are present.
- ChildrensBookMarketingCategoryTypeFormat :
- # The Consonance unique client identifier
- Client :
- # The Consonance unique client identifier number
- Int :
- # ISBNs of other publishers' competing products. Included as related products in
- # ONIX.
- String! :
- # Freeform notes on other publishers' competing products. These can be used in
- # custom reports, or integrated into Advance Information (TIP) sheets. These notes
- # will not be sent in ONIX messages.
- String :
- # The languages in which the work is presented, or translated from
- ContentLanguage!]! : [
- # The contract attached to the work
- Contract! :
- # A list of contributions made by contacts to works
- Contribution!]! : [
- # A sentence listing the work contributors
- String :
- # 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.
- String :
- # Identifiers of the persons or organisations holding copyright
- Int!]! : [
- # The persons or organisations holding copyright
- Contact!]! : [
- # The year in which copyright in the work was registered
- Int :
- # The Dewey Decimal Classification edition number
- Int :
- # The name of the assigned publishing division
- String :
- # The ebook cataloguing identifier assigned by the Library of Congress
- 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.
- 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.
- Int :
- # 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.
- String :
- # The content files for the work which have bookmarks
- ProductionFile!]! : [
- # When products that have no prices set should be marked in ONIX as being free
- Boolean! :
- # The full record for the level of marketing effort for the work
- MarketingTier :
- # The full record for the stage of development for the work
- ProjectStage :
- # The full record for the publishing season for the work
- Season :
- # The full record for the category assigned to the work
- WorkType :
- # Quality label by which the Flemish Publishers Association (VUV) indicates that
- # the
- # publication bearing this label has conducted a peer review procedure that
- # complies with
- # the international scientific standard
- Boolean! :
- # The Consonance unique identifier
- Int! :
- # The digital object identifier for the work
- String :
- # Optional indication of the lead product
- ISBN! :
- # 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.
- String :
- # The imprint or brand name
- #
- # ### EDItEUR advice
- # There is often significant confusion over the nature of the imprint and
- # publisher. In almost all cases, this can be clarified through understanding that
- # the imprint is merely a brand name, whereas the publisher is a legal entity of
- # some kind (often but not necessarily a commercial organisation). The uncertainty
- # arises because the organisation may use its own name as its brand – this is
- # almost always the case with small publishers. And naturally, when one publisher
- # acquires another, one organisation disappears, but its brand name may live on as
- # a brand of the acquiring publisher. Over time, large publishers acquire a
- # portfolio of brands or imprints.
- #
- # Further uncertainty can arise where a series or collection of products becomes
- # very large – does it become a brand in its own right? Ultimately, identities can
- # be arranged in a hierarchy, from the narrowest (the title of a single book),
- # through sub-series and series with their collection titles, to the imprint or
- # brand which may encompass many books and collections of books, to a publisher
- # with one or many brands, and eventually to the broadest (a conglomerate that
- # owns several publishing companies. A workable rule of thumb is that the imprint
- # is the broadest entity in that hierarchy that is not a legal entity, and the
- # publisher is the narrowest entity that is a legal entity.
- Imprint :
- # The set of in-house subject codes assigned, ordered by priority
- String!] : [
- # Your in-house reference for the work
- String :
- # The set of search keywords applied to the work
- String :
- # Keyword quality issues relating to contributor similarities
- KeywordQualityIssue!]! : [
- # Keyword quality issues relating to disallowed characters
- KeywordQualityIssue!]! : [
- # Keyword quality issues relating to non-ASCII characters
- KeywordQualityIssue!]! : [
- # Keyword quality issues relating to similarities between keywords
- KeywordQualityIssue!]! : [
- # Keyword quality issues relating to stop words
- KeywordQualityIssue!]! : [
- # Keyword quality issues relating to similarities to the title
- KeywordQualityIssue!]! : [
- # The Library of Congress children's subject heading
- String :
- # The Library of Congress fiction genre heading
- String :
- # The Library of Congress subject heading
- String :
- # The Library of Congress subject heading region
- String :
- # A unique cataloguing identifier, assigned by the Library of Congress
- String :
- # The legal deposit reference
- String :
- # Creative Commons licence type
- Licence! :
- # The main BIC code
- String :
- # The main BISAC code
- String :
- # The main Thema code
- String :
- # The set of marketing texts assigned
- #
- # Arguments
- # variantIn: Marketing text variant is any of
- MarketingTextVariant!]): [MarketingText!]! ( : [
- # The in-house assignment for the level of marketing effort for the work
- String @deprecated( reason: "Use marketingTierName for the name of the marketing tier" ) :
- # The in-house assignment for the level of marketing effort for the work
- String :
- # Freeform notes on your related products. These can be integrated into Advance
- # Information (TIP) sheets. These notes will not be sent in ONIX messages.
- String :
- # The total number of illustrations in a book or other printed product.
- #
- # The more informative free text field "IllustrationsNote" and/or the use of
- # "Ancillary Content" are strongly preferred, but some ONIX recipients may accept
- # only this simple count.
- Int :
- # The set of NUR category codes assigned, ordered by priority
- String!] : [
- # A code from [ONIX code list 91](https://ns.editeur.org/onix/en/91) Country,
- # inherited from the imprint or publisher unless set directly on the work
- ONIXCode :
- # The ONIX audience codes
- ONIXAudienceCode!]! @deprecated( reason: "Moved to WorkAudience type" ) : [
- # Details of the ONIX audiences
- ONIXCode!]! @deprecated( reason: "Moved to WorkAudience type" ) : [
- # Codes identifying the types of a version or edition
- ONIXEditionTypeCode!]! : [
- # Codes from [ONIX code list 21](https://ns.editeur.org/onix/en/21) Edition Type,
- # set directly on the work
- ONIXCode!]! : [
- # [ONIX code list 61](https://ns.editeur.org/onix/en/61) which indicates the price
- # status
- ONIXCode! :
- # A code from [ONIX code list 61](https://ns.editeur.org/onix/en/61) indicating
- # the price status.
- ONIXPriceStatusCode! :
- # A code from [ONIX code list 91](https://ns.editeur.org/onix/en/91) Country, set
- # directly on the work
- ONIXCode :
- # A code identifying the country where the product is published
- ONIXCountryCode :
- # The organisations that fund both research and publication
- Contact!]! : [
- # The identifiers of the organisations that fund both research and publication
- Int!]! : [
- # The identifiers of the bodies funding publication fees, if different from the
- # body funding the underlying research
- Int!]! : [
- # Bodies funding publication fees, if different from the body funding the
- # underlying research
- Contact!]! : [
- # The identifiers of the bodies funding the research on which publication is
- # based, if different from the body funding the publication
- Int!]! : [
- # Bodies funding the research on which publication is based, if different from the
- # body funding the publication
- Contact!]! : [
- # Works from which this work is derived
- Work!]! : [
- # A table of contents which represents the original works
- String :
- # A table of contents which represents the original works and their tables of
- # contents
- String :
- # IDs of works that this work is derived from
- Int!]! : [
- # The date on which the development of the work is planned to be handed over to
- # production
- ISO8601Date :
- # The prefix to the title, for example "The" or "An"
- String :
- # 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.
- Contact!]! : [
- # 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.
- Int!]! : [
- # The prizes or awards won by the work
- Prize!]! : [
- # The production files for the work, such as an epub or pdf
- ProductionFile!]! : [
- # The date on which the development of the work is handed over to production
- ISO8601Date :
- # The production runs of the work
- ProductionRun!]! : [
- # The products of the work
- #
- # Arguments
- # first: Limits the result to a number of products
- # productSearch: Search for products based on their attributes
- # workSearch: Search for products based on attributes of their
- # work
- # priceSearch: Search for products based on attributes of their
- # prices
- # shopSearch: Search for products based on their link to a shop
- (
- Int, :
- ProductSearchAttributes, :
- WorkSearchAttributes, :
- PriceSearchAttributes, :
- ShopSearchAttributes :
- ): [Product!]!
- # A stage of development for the work
- String @deprecated( reason: "Use projectStageName for the name of the project stage" ) :
- # A stage of development for the work
- String :
- # Describes the promotion and advertising campaign
- String :
- # The earliest pub date of any of the work products
- String :
- # The name of a city or town associated with the imprint or publisher
- String :
- # The legal entity responsible for publishing the work
- Publisher @deprecated( reason: "Available from imprint instead" ) :
- # The name of the assigned publisher area
- String :
- # The full address of the publisher's promotional, informational, or sales web
- # page for this work
- URI :
- # The publishing roles for the work
- PublishingRole!]! : [
- # Your organisation's unique Salesforce ID for this work
- String :
- # Your organisation's Salesforce URL for this work
- String :
- # Only relevant to Scribd staff - not relevant to users of Scribd's services.
- # 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.
- String :
- # The publishing season for the work
- String @deprecated( reason: "Use seasonName for the name of the season" ) :
- # The name of the publishing season for the work
- String :
- # The series name
- SeriesMembership!]! @deprecated( reason: "Need to handle multiple series memberships, plural" ) : [
- # The series name
- SeriesMembership!]! : [
- # Ids of products that are similar to this work
- Int!]! : [
- # Products that are similar to this work. "If you like this work, you may also
- # like..."
- Product!]! : [
- # The subject codes assigned to the work
- #
- # Arguments
- # mainOnly: Whether to return only main subject codes
- # schemesIn: The set of schemas to be returned
- (
- Boolean, :
- SubjectCodeSchemeCategory!] : [
- ): [SubjectCode!]
- # The subtitle of the work
- String :
- # For translated works only, the subtitle of the work in its original language
- String :
- # The supporting resources for the work, such as a cover or jacket image
- SupportingResource!]! : [
- # The set of Thema category codes assigned, ordered by priority
- String!] : [
- # The full title, including prefix. This is constructed by Consonance from the
- # title and title prefix.
- String! :
- # For translated works only, the title of the work in its original language
- String :
- # How the title is intended to be presented
- String :
- # The title without prefix
- String :
- # Work derivations
- WorkDerivation!]! : [
- # Work originations
- WorkDerivation!]! : [
- # A category assigned to the work
- String @deprecated( reason: "Use workTypeName for the name of the work type" ) :
- # A category assigned to the work
- String :
- # The nominal year of an annual publication
- Int @deprecated( reason: "Use years_of_annual to encompass either a single year or pair of years
" ) :
- # The nominal year or pair of years of an annual publication
- String :
- }
link Require by
- ContractA contract, forming a publication agreement between the client and a rights holder
- ContributionA contribution to a work by a contact, ordered by sequence number and describing the nature of the contribution e.g. "Foreword by"
- CreateContainedProductsFromCompiledPayloadAutogenerated return type of CreateContainedProductsFromCompiled.
- CreateContributorsFromOriginalPayloadAutogenerated return type of CreateContributorsFromOriginal.
- CreateTableOfContentsFromBookmarksPayloadAutogenerated return type of CreateTableOfContentsFromBookmarks.
- CreateTableOfContentsPayloadAutogenerated return type of CreateTableOfContents.
- CreateWorkOriginationPayloadAutogenerated return type of CreateWorkOrigination.
- ElectronicAudioProductAn audio book product in electronic form, such as one delivered via MP3 or streamed online
- ElectronicBookProductA textual or graphical book product in electronic form, such as one delivered via PDF or EPUB file formats, or viewable online as HTML
- ElectronicProductA product in electronic form, rather than physical form, such as a downloadable resource. Digital products carried on a physical medium, such as CD-ROMs, are a physical type, not an electronic type.
- GenericProductA generic product, used for products not classified in more detail
- PhysicalAudioProductA physical product with audio content e.g. an audio CD
- PhysicalBookProductA physical book with graphical or textual content. e.g. a paperback
- PhysicalProductA physical product, which may carry content in either physical or digital form
- PrizeAn optional group of data elements which together describe a prize or award won by the product or work, and repeatable where it has gained multiple prizes or awards
- ProductAn individually traded item. Consonance supports a wide range of product types e.g. hardback book, CD audio book, poster.
- ProductionRunA production run, which is usually a print run of physical books but may be the creation of physical or digital audio or electronic books. Not part of the ONIX standard.
- Querynull
- RoleFulfillableUnionObject on which a role can be fulfilled
- SeriesMembershipThe membership of a series by a work
- UpdateWorkOriginationPayloadAutogenerated return type of UpdateWorkOrigination.
- UpdateWorkPayloadAutogenerated return type of UpdateWork.
- WorkA unique item of intellectual property on which products are based
- WorkDerivationA record of a work being derived from the content of another work, through one or more derivation methods