Skip to main content

Interface: MediaDocument

Defined in: type/MediaDocument.ts:7

Object class for MediaDocument

Properties​

alt​

alt: LocalizedString[]

Defined in: type/MediaDocument.ts:19

Media alt description that briefly explains the contents of the document.

categoryId?​

optional categoryId?: string | number

Defined in: type/MediaDocument.ts:15

Unique category identifier that the media relates to

clusterId?​

optional clusterId?: string | number

Defined in: type/MediaDocument.ts:13

Unique cluster identifier that the media relates to

createdAt?​

optional createdAt?: string

Defined in: type/MediaDocument.ts:27

The date and time (ISO 8601 format) when the media was created.

description​

description: LocalizedString[]

Defined in: type/MediaDocument.ts:21

Media short description.

documents?​

optional documents?: LocalizedDocument[]

Defined in: type/MediaDocument.ts:33

List of document objects

id​

id: string | number

Defined in: type/MediaDocument.ts:9

Media global unique identifier

lastModifiedAt?​

optional lastModifiedAt?: string

Defined in: type/MediaDocument.ts:29

The date and time (ISO 8601 format) when the media was last modified.

priority?​

optional priority?: number

Defined in: type/MediaDocument.ts:31

Media display priority [Lower value has higher priority] - default: 1000

productId?​

optional productId?: string | number

Defined in: type/MediaDocument.ts:11

Unique product identifier that the media relates to

sparePartsMachineId?​

optional sparePartsMachineId?: string | number

Defined in: type/MediaDocument.ts:17

Unique sparePartsMachine identifier that the media relates to

tags​

tags: LocalizedStringArray[]

Defined in: type/MediaDocument.ts:23

Media tags.

type?​

optional type?: string

Defined in: type/MediaDocument.ts:25

Media type