Skip to content

Attachment

Attachment

Data type: Entity

Complements the description of an element (for instance a product) through video, pictures...

Name Type Description Example
@type (1) string When sub-classing, this defines the sub-class Extensible name
@baseType string When sub-classing, this defines the super-class
@schemaLocation string A URI to a JSON-Schema file that defines additional attributes and relationships
id string Unique identifier 2d7ed5fd-9f62-4211-bc84-357f5f7b80f5
href URI Hyperlink reference https://api.example.org/resource/id
attachmentType string Attachment type such as video, picture video
content string The actual contents of the attachment object, if embedded, encoded as base64
description string A narrative text describing the content of the attachment Photograph of the Product
mimeType string Attachment mime type such as extension file for video, picture and document image/AVIF
name string The name of the attachment attachment.file
url URI Uniform Resource Locator, is a web page address (a subset of URI) https://api.example.org/content/4aafacbd-11ff-4dc8-b445-305f2215715f
size Quantity
validFor TimePeriod