Base Image

Description

Properties

Property Description
created read-only

The creation date of the image.

displayUrl nullable read-only

Display URLs for this image.

filesize read-only

The original filesize of the image (in bytes).

height read-only

The height in pixels of the image.

id

An entity identifier. It may be either an integer or a universally unique identifier (UUID) represented as a string.

links required read-only

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 read-only

The image file MIME type.

name

The original filename of the image.

type

The resource type

width read-only

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",
      "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"
}