OBJECT

ProductionFile

A 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.

GraphQL Schema definition

type ProductionFile {
#   Whether the production file is distributable
allowDistribution: ProductionFileAllowDistribution! 
#   The epublication accessibility summary extracted from an analysed epub file.
analysedEpubAccessibilitySummary: String 
#   The analysis status of the production file
analysisStatus: ProductionFileAnalysisStatus! 
#   The approval status of the production file
approvalStatus: ProductionFileApprovalStatus! 
#   Whether the file contains bookmarks
bookmarks: Boolean! 
#   The date and time the file was created
createdAt: ISO8601DateTime 
#   The status of the associated delayed job, if any
delayedJobStatus: String 
#   Whether the uploaded file exists or not
exists: Boolean! 
#   The short form of the file type, such as PDF
fileFormat: String 
#   File size in bytes
fileSize: BigInt 
#   The file type of the production file
fileType: String @deprecated( reason: "Use fileVariant, approvalStatus and allowDistribution instead"  )
#   The file variant of the production file
fileVariant: ProductionFileFileVariant! 
#   The name of the file uploaded to Consonance
filename: String 
#   The Consonance unique identifier
id: Int 
#   Whether the file can be analysed for accessibility
inspectable: Boolean! 
#   The content type accessibility features extracted from an analysed epub file.
onixAnalysedContentTypeAccessibility: [ONIXCode!]! 
#   The epublication accessibility features extracted from an analysed epub file.
onixAnalysedEpubAccessibility: [ONIXCode!]! 
#   The table of contents generated from the file bookmarks
# 
# Arguments
#   depth: The number of nested levels for the table of contents
onixToc(depth: Int!): String 
#   The IDs of products linked to this supporting resource
productIds: [Int!]! 
#   A presigned expirable URL from which to download the file.
# 
#   Checks that the
# 
# Arguments
#   expirySeconds: The number of seconds after which the URL will 
#   expire. Default 86,400 (one day).
# 
#   Values between 60 and 86,400 are valid. Values outside of this range will be 
#   silently changed to 60 or 86,400 as appropriate.
#   asAttachment: Set to true for the response_content_disposition 
#   to be set to attachment instead of inline
#   name: Sets the filename in the response_content_disposition. 
#   Omit this to use the original name of the uploaded file
url(expirySeconds: Int, asAttachment: Boolean, name: String): String 
}

ProductionFile

link GraphQL Schema definition

link Require by

GraphQL Schema definition

Require by