Attachment

Extends

Entity

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

Field Required Nullable Type Description Constraints Example

@type

Yes

No

String

When sub-classing, this defines the sub-class Extensible name

default null;

@baseType

No

No

String

When sub-classing, this defines the super-class

default null;

@schemaLocation

No

No

String

A URI to a JSON-Schema file that defines additional attributes and relationships

default null;

id

No

No

String

Unique identifier

default null;

2d7ed5fd-9f62-4211-bc84-357f5f7b80f5

href

No

No

URI

Hyperlink reference

default null;

https://api.example.org/resource/id

attachmentType

No

No

String

Attachment type such as video, picture

default null;

video

content

No

No

String

The actual contents of the attachment object, if embedded, encoded as base64

default null;

description

No

No

String

A narrative text describing the content of the attachment

default null;

Photograph of the Product

mimeType

No

No

String

Attachment mime type such as extension file for video, picture and document

default null;

image/AVIF

name

No

No

String

The name of the attachment

default null;

attachment.file

url

No

No

URI

Uniform Resource Locator, is a web page address (a subset of URI)

default null;

https://api.example.org/content/4aafacbd-11ff-4dc8-b445-305f2215715f

size

No

No

Quantity

The size of the attachment.

default null;

validFor

No

No

TimePeriod

The period of time for which the attachment is valid

default null;