Skip to main content

LicenseInput

The parameters that can be used to create a license.

input LicenseInput {
  checkoutsLeft: Int
  customAttributes: [AttributeInput!]
  namespaceId: ID!
  protection: ProtectionInfoInput
  restrictionType: RestrictionType
  source: String!
  target: ID!
  terms: LicenseTermsInput
}

Fields​

LicenseInput.checkoutsLeft ● Int scalar​

For a partially-consumed license, the number of checkouts left.

LicenseInput.customAttributes ● [AttributeInput!] list input​

A list of key-value attributes to set with the license.

LicenseInput.namespaceId ● ID! non-null scalar​

The namespace in which to create the license. Should be a UUID.

LicenseInput.protection ● ProtectionInfoInput input​

The specific conditions for consumption as requested by the content owner.

LicenseInput.restrictionType ● RestrictionType enum​

The type of the restrictions defined by the license. Defaults to LIMITED.

LicenseInput.source ● String! non-null scalar​

An annotation for the origin of the license.

LicenseInput.target ● ID! non-null scalar​

The target (e.g. ISBN) for which to create a licence.

LicenseInput.terms ● LicenseTermsInput input​

The terms for the activation of the license and the limits for each individual loan.

Member Of​

createLicense mutation