Skip to main content

MediaDocument

Document media item with file access and metadata management capabilities

type MediaDocument {
  id: ID!
  productId: ID
  clusterId: ID
  categoryId: ID
  sparePartsMachineId: ID
  alt(
    language: String
  ): [LocalizedString!]!
  description(
    language: String
  ): [LocalizedString!]!
  tags(
    language: String
  ): [LocalizedStringArray!]!
  type: String
  createdAt: DateTime
  lastModifiedAt: DateTime
  priority: Int
  documents: [LocalizedDocument!]
}

Fields​

MediaDocument.id ● ID! non-null scalar​

Globally unique identifier for the media item.

Used to reference and retrieve the specific media item across all operations. This ID is immutable and unique across the entire media system.

MediaDocument.productId ● ID scalar​

Associates the media item with a specific product for product catalogs and displays

MediaDocument.clusterId ● ID scalar​

Associates the media item with a specific cluster for organizational grouping

MediaDocument.categoryId ● ID scalar​

Associates the media item with a specific product category for categorization and filtering

MediaDocument.sparePartsMachineId ● ID scalar​

Associates the media item with a specific spare parts machine for maintenance and service documentation

MediaDocument.alt ● [LocalizedString!]! non-null object​

Alternative text descriptions for accessibility and SEO purposes.

Provides brief, descriptive text that explains the media content for screen readers and when the media cannot be displayed. Essential for web accessibility compliance and search engine optimization.

MediaDocument.alt.language ● String scalar​

Filter results to a specific language code (e.g., 'EN', 'DE'). If not provided, returns all available languages.

MediaDocument.description ● [LocalizedString!]! non-null object​

Detailed descriptions of the media content.

Provides comprehensive information about what the media shows or contains. Used for content management, search indexing, and user information display.

MediaDocument.description.language ● String scalar​

Filter results to a specific language code (e.g., 'EN', 'DE'). If not provided, returns all available languages.

MediaDocument.tags ● [LocalizedStringArray!]! non-null object​

Searchable tags for categorizing and organizing media content.

Keywords that help classify and discover media items. Used for search functionality, content filtering, and organizational purposes.

MediaDocument.tags.language ● String scalar​

Filter results to a specific language code (e.g., 'EN', 'DE'). If not provided, returns all available languages.

MediaDocument.type ● String scalar​

Type classification of the media item.

Indicates whether this is an image, video, document, or attachment. Used for processing, display, and filtering logic.

MediaDocument.createdAt ● DateTime scalar​

Timestamp when the media item was originally created.

Recorded in ISO 8601 format with timezone information. Used for sorting, filtering, and audit purposes.

MediaDocument.lastModifiedAt ● DateTime scalar​

Timestamp when the media item was last modified.

Updated whenever the media metadata or content is changed. Recorded in ISO 8601 format with timezone information.

MediaDocument.priority ● Int scalar​

Display order priority for the media item.

Lower numeric values indicate higher priority and will be displayed first. Used for controlling the order of media items in galleries, carousels, and listings.

MediaDocument.documents ● [LocalizedDocument!] list object​

Collection of document files in different languages and formats.

Contains the actual document files with their metadata, file sizes, and storage locations. Each document can have multiple language variants and format versions such as PDF, DOCX, or XLSX.

Returned By​

mediaDocument query ● mediaDocumentCreate mutation ● mediaDocumentUpdate mutation

Member Of​

Media object ● PaginatedMediaDocumentResponse object