Skip to main content

Media

Unified media access point providing single items and paginated collections for all media types

type Media {
  image(
    mediaId: String!
  ): MediaImage
  images(
    search: MediaImageSearchInput = [object Object]
  ): PaginatedMediaImageResponse
  video(
    mediaId: String!
  ): MediaVideo
  videos(
    search: MediaVideoSearchInput = [object Object]
  ): PaginatedMediaVideoResponse
  document(
    mediaId: String!
  ): MediaDocument
  documents(
    search: MediaDocumentSearchInput = [object Object]
  ): PaginatedMediaDocumentResponse
  attachment(
    id: String!
  ): MediaAttachment!
  attachments(
    input: MediaAttachmentSearchInput = [object Object]
  ): PaginatedMediaAttachmentResponse!
}

Fields​

Media.image ● MediaImage object​

Single image media item.

Provides access to a specific image with its metadata, transformations, and localized variants. Used for retrieving individual images by ID.

Media.image.mediaId ● String! non-null scalar​

Unique identifier of the image to retrieve.

Must be a valid media ID representing an existing image in the media storage system.

Media.images ● PaginatedMediaImageResponse object​

Paginated collection of image media items.

Returns a searchable and filterable list of images with pagination support. Includes metadata for navigation and result counts.

Media.images.search ● MediaImageSearchInput input​

Search criteria for filtering images.

If not provided, returns all accessible images with default pagination settings. Supports filtering by metadata, dimensions, file types, and upload dates.

Media.video ● MediaVideo object​

Single video media item.

Provides access to a specific video with its metadata, hosting information, and localized variants. Used for retrieving individual videos by ID.

Media.video.mediaId ● String! non-null scalar​

Unique identifier of the video to retrieve.

Must be a valid media ID representing an existing video in the media storage system.

Media.videos ● PaginatedMediaVideoResponse object​

Paginated collection of video media items.

Returns a searchable and filterable list of videos with pagination support. Includes metadata for navigation and result counts.

Media.videos.search ● MediaVideoSearchInput input​

Search criteria for filtering videos.

If not provided, returns all accessible videos with default pagination settings. Supports filtering by metadata, duration, resolution, file types, and upload dates.

Media.document ● MediaDocument object​

Single document media item.

Provides access to a specific document with its metadata, file information, and localized variants. Used for retrieving individual documents by ID.

Media.document.mediaId ● String! non-null scalar​

Unique identifier of the document to retrieve.

Must be a valid media ID representing an existing document in the media storage system.

Media.documents ● PaginatedMediaDocumentResponse object​

Paginated collection of document media items.

Returns a searchable and filterable list of documents with pagination support. Includes metadata for navigation and result counts.

Media.documents.search ● MediaDocumentSearchInput input​

Search criteria for filtering documents.

If not provided, returns all accessible documents with default pagination settings. Supports filtering by metadata, file types, sizes, and upload dates.

Media.attachment ● MediaAttachment! non-null object​

Retrieve a specific attachment by its identifier.

Returns detailed information about an attachment including metadata, storage location, file information, and association details. Used for attachment display and management operations.

Media.attachment.id ● String! non-null scalar​

Unique identifier of the attachment to retrieve.

Must be a valid attachment ID representing an existing attachment in the media storage system.

Media.attachments ● PaginatedMediaAttachmentResponse! non-null object​

Search and retrieve attachments with comprehensive filtering and pagination.

Provides flexible search capabilities across attachment metadata including names, file types, associations, and upload dates. Results are paginated and filtered based on user permissions for secure access control.

Media.attachments.input ● MediaAttachmentSearchInput input​

Search criteria for filtering attachments.

If not provided, returns all accessible attachments with default pagination settings. Supports filtering by metadata, file types, associations, and upload dates. Access is controlled based on user permissions.

Returned By​

media query