Skip to main content

Media

{
"id": "integer",
"added_at": "string",
"type": "string",
"title": "string",
"description": "string",
"url": "string(uri)",
"image": "string",
"image_width": "integer",
"image_height": "integer",
"order": "integer",
"embed": {}
}

Properties

NameTypeRequiredRestrictionsDescription
idintegerfalseread-onlyA unique integer value identifying this media
added_atstring(date-time)falseread-onlyDate time of media creation
typestringtruenoneMedia type
titlestringfalseread-onlyMedia title
descriptionstringfalseread-onlyMedia description
urlstring(uri)falsenoneMedia url
imagestring(binary)falseread-onlyMedia image
image_widthintegerfalseread-onlyMedia image width
image_heightintegerfalseread-onlyMedia image height
orderintegerfalseread-onlyThe order
embedEmbed¦nullfalsenoneThe embed obj

Enumerated Values

PropertyValueDescription
typeimageMedia associated to a webpage url containing an image
typeurlMedia associated to a webpage url
typeembedMedia of type embed
typeimageMedia of type image
typeeimageMedia of type inline image, used in Discussion or Post text editor
typedocMedia of type document (pdf)
typeshareMedia associate to a community shared object (Discussion or Post)