Price Sheet Element Image

Description

price-sheet-element-image
Base Image

An image attached to some element of a price sheet.

Properties

Property Description
created read-only
string
date-time

The creation date of the image.
displayOrder
integer
  • ≥ 0
  • ≤ 999

The order in which the image should be displayed in a list of other images for the related price sheet element.
displayUrl nullable read-only
object
Image Display Url

Display URLs for this 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 read-only
string
  • ≤ 100 characters

The original filename of the image.
type
string
enum
  • price-sheet-element-image

The type of object represented.
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.

{
  "description": "An image attached to some element of a price sheet.",
  "properties": {
    "created": {
      "description": "The creation date of the image.",
      "format": "date-time",
      "readOnly": true,
      "type": "string"
    },
    "displayOrder": {
      "description": "The order in which the image should be displayed in a list of\nother images for the related price sheet element.",
      "example": 4,
      "maximum": 999,
      "minimum": 0,
      "type": "integer"
    },
    "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": 100,
      "readOnly": true,
      "type": "string"
    },
    "type": {
      "description": "The type of object represented.",
      "enum": [
        "price-sheet-element-image"
      ],
      "type": "string"
    },
    "width": {
      "description": "The width in pixels of the image.",
      "example": 2400,
      "readOnly": true,
      "type": "integer"
    }
  },
  "required": [
    "type",
    "displayOrder"
  ],
  "title": "Price Sheet Element Image",
  "type": "object"
}
Price Sheet Element Image