Base Image

Description

image
Image

Properties

Property Description
created read-only
string
date-time

The creation date of the image.
displayUrl nullable read-only
object
Image Display Url

Display URLs for this image.

Property Description
extraLarge nullable
string
uri

A URL for an extra-large-sized version of the image.
extraLarge2 nullable
string
uri

A URL for an extra-large-2-sized version of the image.
extraLarge3 nullable
string
uri

A URL for an extra-large-3-sized version of the image.
large nullable
string
uri

A URL for a large-sized version of the image.
medium nullable
string
uri

A URL for a medium-sized version of the image.
mediumLarge nullable
string
uri

A URL for a medium-to-large-sized version of the image.
original nullable
string
uri

A URL for an original version of the image.
small nullable
string
uri

A URL for a small-sized version of the image.
thumb nullable
string
uri

A URL for a thumbnail-sized version of the image.
filesize read-only
integer

The original filesize of the image (in bytes).
height read-only
integer

The height in pixels of the image.
id
either
string
uuid
UUID Entity Identifier
or
integer
Integer Entity Identifier

An entity identifier. It may be either an integer or a universally unique identifier (UUID) represented as a string.
links required read-only
object
Links

Each property defines a hypertext link relationship as indicated by a link object or array of link objects. The target URL of each hypertext link relationship is related to the current resource according to the defined semantics of the link relationship property name.
mimeType nullable read-only
string

The image file MIME type.
name
string
  • ≤ 250 characters

The original filename of the image.
type
string
enum
  • image

The resource type
width read-only
integer

The width in pixels of the image.

OpenAPI Schema

The following schema is based on OpenAPI 3.0 and is provided in our downloadable OpenAPI document.

{
  "properties": {
    "created": {
      "description": "The creation date of the image.",
      "format": "date-time",
      "readOnly": true,
      "type": "string"
    },
    "displayUrl": {
      "allOf": [
        {
          "description": "Display URLs for this image.",
          "nullable": true,
          "readOnly": true
        },
        {
          "$ref": "#/components/schemas/ImageDisplayUrl"
        }
      ]
    },
    "filesize": {
      "description": "The original filesize of the image (in bytes).",
      "example": 18452563,
      "readOnly": true,
      "type": "integer"
    },
    "height": {
      "description": "The height in pixels of the image.",
      "example": 3000,
      "readOnly": true,
      "type": "integer"
    },
    "id": {
      "$ref": "#/components/schemas/Id"
    },
    "links": {
      "$ref": "#/components/schemas/Links"
    },
    "mimeType": {
      "description": "The image file MIME type.",
      "example": "image/jpeg",
      "nullable": true,
      "readOnly": true,
      "type": "string"
    },
    "name": {
      "description": "The original filename of the image.",
      "example": "my-file.jpg",
      "maxLength": 250,
      "type": "string"
    },
    "type": {
      "description": "The resource type",
      "enum": [
        "image"
      ],
      "type": "string"
    },
    "width": {
      "description": "The width in pixels of the image.",
      "example": 2400,
      "readOnly": true,
      "type": "integer"
    }
  },
  "title": "Image",
  "type": "object"
}
Image