SCALAR
String
Represents textual data as UTF-8 character sequences. This type is most often used by GraphQL to represent free-form human-readable text.
link GraphQL Schema definition
- scalar String
link Require by
- AddressA mailing address
- AncillaryContentIllustration and other content types
- AudienceDescriptionA free text description of the intended audience, to augment the ONIX audience codes
- BarcodeA code indicating a barcode type and position on a product
- BICA code from the BIC schema
- BindingFields that specify one of the bindings on a production run
- BISACA code from the BISAC schema
- ChildrensBookMarketingCategoryBroadSubjectnull
- ChildrensBookMarketingCategoryCharacternull
- ChildrensBookMarketingCategoryInterestnull
- ChildrensBookMarketingCategoryTieInnull
- ChildrensBookMarketingCategoryTypeFormatnull
- Clientnull
- ContactA contact - either a person or an organisation
- ContactSearchAttributesAttributes for searching for contacts
- ContractA contract, forming a publication agreement between the client and a rights holder
- ContributorPlaceRelationshipA relationship that a contact has with a place
- CoverFields that specify one of the covers on a production run
- CreateContainedProductsFromCompiledInputAutogenerated input type of CreateContainedProductsFromCompiled
- CreateContainedProductsFromCompiledPayloadAutogenerated return type of CreateContainedProductsFromCompiled.
- CreateContentLanguageInputAutogenerated input type of CreateContentLanguage
- CreateContentLanguagePayloadAutogenerated return type of CreateContentLanguage.
- CreateContributionInputAutogenerated input type of CreateContribution
- CreateContributionPayloadAutogenerated return type of CreateContribution.
- CreateContributorsFromOriginalInputAutogenerated input type of CreateContributorsFromOriginal
- CreateContributorsFromOriginalPayloadAutogenerated return type of CreateContributorsFromOriginal.
- CreateDeliveryDateInputAutogenerated input type of CreateDeliveryDate
- CreateDeliveryDatePayloadAutogenerated return type of CreateDeliveryDate.
- CreateGratisCopyInputAutogenerated input type of CreateGratisCopy
- CreateGratisCopyPayloadAutogenerated return type of CreateGratisCopy.
- CreateLicensedRightInputAutogenerated input type of CreateLicensedRight
- CreateLicensedRightPayloadAutogenerated return type of CreateLicensedRight.
- CreateMarketingTextInputAutogenerated input type of CreateMarketingText
- CreateMarketingTextPayloadAutogenerated return type of CreateMarketingText.
- CreatePrizeInputAutogenerated input type of CreatePrize
- CreatePrizePayloadAutogenerated return type of CreatePrize.
- CreateProductionFileInputAutogenerated input type of CreateProductionFile
- CreateProductionFilePayloadAutogenerated return type of CreateProductionFile.
- CreateProductPartInputAutogenerated input type of CreateProductPart
- CreateProductPartPayloadAutogenerated return type of CreateProductPart.
- CreatePublishingRoleInputAutogenerated input type of CreatePublishingRole
- CreatePublishingRolePayloadAutogenerated return type of CreatePublishingRole.
- CreateRoleInputAutogenerated input type of CreateRole
- CreateRolePayloadAutogenerated return type of CreateRole.
- CreateSeriesMembershipInputAutogenerated input type of CreateSeriesMembership
- CreateSeriesMembershipPayloadAutogenerated return type of CreateSeriesMembership.
- CreateSupportingResourceInputAutogenerated input type of CreateSupportingResource
- CreateSupportingResourcePayloadAutogenerated return type of CreateSupportingResource.
- CreateTableOfContentsFromBookmarksInputAutogenerated input type of CreateTableOfContentsFromBookmarks
- CreateTableOfContentsFromBookmarksPayloadAutogenerated return type of CreateTableOfContentsFromBookmarks.
- CreateTableOfContentsInputAutogenerated input type of CreateTableOfContents
- CreateTableOfContentsPayloadAutogenerated return type of CreateTableOfContents.
- CreateWebLinkInputAutogenerated input type of CreateWebLink
- CreateWebLinkPayloadAutogenerated return type of CreateWebLink.
- CreateWorkOriginationInputAutogenerated input type of CreateWorkOrigination
- CreateWorkOriginationPayloadAutogenerated return type of CreateWorkOrigination.
- Currencynull
- DeleteContentLanguageInputAutogenerated input type of DeleteContentLanguage
- DeleteContentLanguagePayloadAutogenerated return type of DeleteContentLanguage.
- DeleteContributionInputAutogenerated input type of DeleteContribution
- DeleteContributionPayloadAutogenerated return type of DeleteContribution.
- DeleteDeliveryDateInputAutogenerated input type of DeleteDeliveryDate
- DeleteDeliveryDatePayloadAutogenerated return type of DeleteDeliveryDate.
- DeleteGratisCopyInputAutogenerated input type of DeleteGratisCopy
- DeleteGratisCopyPayloadAutogenerated return type of DeleteGratisCopy.
- DeleteLicensedRightInputAutogenerated input type of DeleteLicensedRight
- DeleteLicensedRightPayloadAutogenerated return type of DeleteLicensedRight.
- DeleteMarketingTextInputAutogenerated input type of DeleteMarketingText
- DeleteMarketingTextPayloadAutogenerated return type of DeleteMarketingText.
- DeletePrizeInputAutogenerated input type of DeletePrize
- DeletePrizePayloadAutogenerated return type of DeletePrize.
- DeleteProductionFileInputAutogenerated input type of DeleteProductionFile
- DeleteProductionFilePayloadAutogenerated return type of DeleteProductionFile.
- DeleteProductPartInputAutogenerated input type of DeleteProductPart
- DeleteProductPartPayloadAutogenerated return type of DeleteProductPart.
- DeletePublishingRoleInputAutogenerated input type of DeletePublishingRole
- DeletePublishingRolePayloadAutogenerated return type of DeletePublishingRole.
- DeleteSeriesMembershipInputAutogenerated input type of DeleteSeriesMembership
- DeleteSeriesMembershipPayloadAutogenerated return type of DeleteSeriesMembership.
- DeleteSupportingResourceInputAutogenerated input type of DeleteSupportingResource
- DeleteSupportingResourcePayloadAutogenerated return type of DeleteSupportingResource.
- DeleteWebLinkInputAutogenerated input type of DeleteWebLink
- DeleteWebLinkPayloadAutogenerated return type of DeleteWebLink.
- DeleteWorkOriginationInputAutogenerated input type of DeleteWorkOrigination
- DeleteWorkOriginationPayloadAutogenerated return type of DeleteWorkOrigination.
- DeliveryDateA delivery date, showing the deliverable type, requirement, due date, percentage, and slipped date
- DeliveryDateDeliverableA delivery date deliverable type
- DeweyA code from the Dewey Decimal Classification system
- DurationInputnull
- 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.
- EmailAn email address
- EmbellishmentFields that specify one of the embellishments on a production run
- FinishFields that specify one of the finishes on a production run
- FrontendConfigurationnull
- GenericProductA generic product, used for products not classified in more detail
- GratisCopyA gratis copy record, showing the product, contact, number of copies, send and sent dates, and notes
- GroupResultTypenull
- Imprintnull
- InHouseEditionAn in-house edition, used to assign a meaningful name to the edition of the product e.g. "Enhanced ebook"
- InHouseFormatAn in-house format, used to assign a meaningful name to the format of the product e.g. "Royal hardback"
- InHouseSubjectA code from the client in house subjects list
- InteriorFields that specify one of the interiors on a production run
- ISBNnull
- ISBNBlockA block of ISBNs
- KeywordQualityIssuenull
- Licencenull
- LicensedRightA licensed right, showing the percentage of revenues for different product types
- MarketingTextText that supports the marketing of a product, such as a review, short description, or table of contents
- MarketingTierA marketing tier in-house work classification
- NoteA note
- NURA code from the NUR schema
- ONIXCodeA value from an ONIX code list, as maintained by [EDItEUR](https://www.editeur.org/)
- ONIXCodeListAn ONIX code list, as maintained by [EDItEUR](https://www.editeur.org/)
- OrganisationAn organisation
- PersonA person
- PhoneA phone number
- 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
- PriceAn optional group of data elements which together describe a price
- PriceInputnull
- 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.
- ProductionFileA print production, ebook or audio file. When uploading a file using a resourceFileName, the mutation will return a presigned URL to upload the file to. Once the file has been uploaded, it will be processed in the background.
- 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.
- ProductSearchAttributesAttributes for searching for products
- ProfessionalAffiliationA professional relationship that a contact has with an organisation
- ProjectStageA project stage in-house work classification
- Publishernull
- QuantityFields that specify one of the quantity records on a production run
- Querynull
- RelationshipA relationship between two entities
- RoleA role that can fulfill certain duties
- SeasonA season in-house work classification
- SeriesA bibliographic series
- SeriesMembershipThe membership of a series by a work
- ShopA shopfront for the client account
- SortMarketingTextsInputAutogenerated input type of SortMarketingTexts
- SortMarketingTextsPayloadAutogenerated return type of SortMarketingTexts.
- StandardPriceComponentsnull
- SubjectCodeA code from one of a number of subject schemes that describes the content of the work
- SupportingResourceA supporting resource, such as a cover or jacket image. When uploading a file using a resourceFileName, the mutation will return a presigned URL to upload the file to. Once the file has been uploaded, it will be processed in the background and the different image sizes generated. The presigned URL and subsequent mutation are not required when uploading an image using an imageRemoteUrl rather than a file.
- SupportingResourceVersionA version of a supporting resource
- SystemPricenull
- ThemaA code from the Thema schema
- UpdateAncillaryContentInputIllustration and other content types
- UpdateContentLanguageInputAutogenerated input type of UpdateContentLanguage
- UpdateContentLanguagePayloadAutogenerated return type of UpdateContentLanguage.
- UpdateContractInputAutogenerated input type of UpdateContract
- UpdateContractPayloadAutogenerated return type of UpdateContract.
- UpdateContributionInputAutogenerated input type of UpdateContribution
- UpdateContributionPayloadAutogenerated return type of UpdateContribution.
- UpdateDeliveryDateInputAutogenerated input type of UpdateDeliveryDate
- UpdateDeliveryDatePayloadAutogenerated return type of UpdateDeliveryDate.
- UpdateGratisCopyInputAutogenerated input type of UpdateGratisCopy
- UpdateGratisCopyPayloadAutogenerated return type of UpdateGratisCopy.
- UpdateLicensedRightInputAutogenerated input type of UpdateLicensedRight
- UpdateLicensedRightPayloadAutogenerated return type of UpdateLicensedRight.
- UpdateMarketingTextInputAutogenerated input type of UpdateMarketingText
- UpdateMarketingTextPayloadAutogenerated return type of UpdateMarketingText.
- UpdatePrizeInputAutogenerated input type of UpdatePrize
- UpdatePrizePayloadAutogenerated return type of UpdatePrize.
- UpdateProductInputInput type of UpdateProduct and UpdateWork products field
- UpdateProductionFileInputAutogenerated input type of UpdateProductionFile
- UpdateProductionFilePayloadAutogenerated return type of UpdateProductionFile.
- UpdateProductPartInputAutogenerated input type of UpdateProductPart
- UpdateProductPartPayloadAutogenerated return type of UpdateProductPart.
- UpdateProductPayloadAutogenerated return type of UpdateProduct.
- UpdatePublishingRoleInputAutogenerated input type of UpdatePublishingRole
- UpdatePublishingRolePayloadAutogenerated return type of UpdatePublishingRole.
- UpdateSeriesMembershipInputAutogenerated input type of UpdateSeriesMembership
- UpdateSeriesMembershipPayloadAutogenerated return type of UpdateSeriesMembership.
- UpdateSupportingResourceInputAutogenerated input type of UpdateSupportingResource
- UpdateSupportingResourcePayloadAutogenerated return type of UpdateSupportingResource.
- UpdateWebLinkInputAutogenerated input type of UpdateWebLink
- UpdateWebLinkPayloadAutogenerated return type of UpdateWebLink.
- UpdateWorkInputAutogenerated input type of UpdateWork
- UpdateWorkOriginationInputAutogenerated input type of UpdateWorkOrigination
- UpdateWorkOriginationPayloadAutogenerated return type of UpdateWorkOrigination.
- UpdateWorkPayloadAutogenerated return type of UpdateWork.
- UserA user account on the system
- ValidationErrorA user-readable error
- ValidityA result of a validation
- ValidityInputAttributesAttributes for validating lists of values
- WebLinkA link to a web address
- WorkA unique item of intellectual property on which products are based
- WorkAudienceAn optional group of data elements which together describe an audience to which the work is directed
- WorkDerivationMethodMethods by which the work is derived from its original, such as compilation, revision, or translation
- WorkSearchAttributesAttributes for searching for works
- WorkTypeA work type in-house work classification
- __DirectiveA Directive provides a way to describe alternate runtime execution and type validation behavior in a GraphQL document. In some cases, you need to provide options to alter GraphQL's execution behavior in ways field arguments will not suffice, such as conditionally including or skipping a field. Directives provide this by describing additional information to the executor.
- __EnumValueOne possible value for a given Enum. Enum values are unique values, not a placeholder for a string or numeric value. However an Enum value is returned in a JSON response as a string.
- __FieldObject and Interface types are described by a list of Fields, each of which has a name, potentially a list of arguments, and a return type.
- __InputValueArguments provided to Fields or Directives and the input fields of an InputObject are represented as Input Values which describe their type and optionally a default value.
- __SchemaA GraphQL Schema defines the capabilities of a GraphQL server. It exposes all available types and directives on the server, as well as the entry points for query, mutation, and subscription operations.
- __TypeThe fundamental unit of any GraphQL Schema is the type. There are many kinds of types in GraphQL as represented by the `__TypeKind` enum. Depending on the kind of a type, certain fields describe information about that type. Scalar types provide no information beyond a name and description, while Enum types provide their values. Object and Interface types provide the fields they describe. Abstract types, Union and Interface, provide the Object types possible at runtime. List and NonNull types compose other types.