Price Sheet Element Image Collection

Description

A collection of Price Sheet Element Images

Properties

Property Description
items

A collection of resources returned in the current result set.

Property Description
created read-only

The creation date of the image.

displayOrder

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

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

The original filename of the image.

type

The type of object represented.

width read-only

The width in pixels of the image.

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.

meta read-only

Metadata describing the current result set.

Property Description
currentPage

The current page of results returned.

rows

The number of rows returned per page for the current result set.

totalItems

The total number of items in the result set. This may be affected by active search/filter parameters.

totalPages

The total number of pages in the result set. This is affected by the rows parameter (totalItems / rows == totalPages).

type

The type of resource represented.

OpenAPI Schema

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

{
  "description": "A collection of Price Sheet Element Images",
  "properties": {
    "items": {
      "description": "A collection of resources returned in the current result set.",
      "items": {
        "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",
            "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"
      },
      "title": "Price Sheet Element Image",
      "type": "array"
    },
    "links": {
      "$ref": "#/components/schemas/Links"
    },
    "meta": {
      "description": "Metadata describing the current result set.",
      "properties": {
        "currentPage": {
          "description": "The current page of results returned.",
          "type": "integer"
        },
        "rows": {
          "description": "The number of rows returned per page for the current result set.",
          "type": "integer"
        },
        "totalItems": {
          "description": "The total number of items in the result set. This may be\naffected by active search/filter parameters.",
          "type": "integer"
        },
        "totalPages": {
          "description": "The total number of pages in the result set. This is affected by\nthe `rows` parameter (`totalItems / rows == totalPages`).",
          "type": "integer"
        }
      },
      "readOnly": true,
      "type": "object"
    },
    "type": {
      "description": "The type of resource represented.",
      "enum": [
        "price-sheet-element-image-collection"
      ],
      "example": "resource-type",
      "title": "Resource Type",
      "type": "string"
    }
  },
  "required": [
    "type",
    "items"
  ],
  "title": "Collection",
  "type": "object"
}