OBJECT

SupportingResource

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

GraphQL Schema definition

type SupportingResource {
#   The aspect ratio of the file
aspectRatio: Float 
#   Explanatory words that may accompany a resource such as identifying an author or 
#   place in a photograph
caption: String 
#   The copyright holder for the resource. Note that if you store and send the 
#   resource, the recipient can use it without consultation.
copyright: String 
#   The copyright holder's name. Note that if you store and send the resource, the 
#   recipient can use it without consultation.
copyrightHolder: String 
#   The date and time the resource was created
createdAt: ISO8601DateTime! 
#   The status of the associated delayed job, if any
delayedJobStatus: String 
#   File size in bytes
fileSize: Int 
#   The name of the file uploaded to Consonance
filename: String 
#   File height in pixels
height: Int 
#   The Consonance unique identifier
id: Int! 
#   The mime type of the supporting resource, e.g. image/jpeg
imageContentType: String 
#   The remote URL for the file
imageRemoteUrl: URI 
#   Whether the file is being processed
isProcessing: Boolean! 
#   The intended audience. This is advisory, rather than a restriction.
onixContentAudience: [ONIXCode!]! @deprecated( reason: "Use onixIntendedContentAudience for only one intended audience
"  )
#   The ONIX code for the intended audience. This is advisory, rather than a 
#   restriction.
onixContentAudienceCode: ONIXContentAudienceCode! 
#   The intended audience. This is advisory, rather than a restriction.
onixIntendedContentAudience: ONIXCode! 
#   The IDs of products linked to this supporting resource
productIds: [Int!]! 
#   Credit that must be displayed when the resource is used
requiredCredit: String 
#   The type of content of the supporting resource e.g. Front cover
resourceVariant: SupportingResourceVariant! 
#   The point the resource is at along its lifecycle e.g. draft, approved
status: SupportingResourceStatus 
#   The date and time the resource was updated
updatedAt: ISO8601DateTime! 
#   The public URL of the supporting resource
url: String 
#   Alternative versions of the original file, in different sizes and file formats.
# 
#   This list of versions will be empty when the supporting resource is processing 
#   (`isProcessing: true`)
versions: [SupportingResourceVersion!]! 
#   File width in pixels
width: Int 
}

SupportingResource

link GraphQL Schema definition

link Require by

GraphQL Schema definition

Require by