Price Sheet Element Image Collection In Patch

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 to be updated.",
  "example": {
    "items": [
      {
        "displayOrder": 1,
        "id": [
          1
        ],
        "type": "price-sheet-element-image"
      },
      {
        "displayOrder": 2,
        "id": [
          2
        ],
        "type": "price-sheet-element-image"
      }
    ],
    "type": "price-sheet-element-image-collection"
  },
  "properties": {
    "items": {
      "description": "A collection of one or more batched resources. If `items` is `null`\nor an empty array, no action is taken.",
      "items": {
        "description": "The items in the collection to be updated.",
        "properties": {
          "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"
          },
          "id": {
            "description": "Identifies one or more resources for which changes may be\napplied. This property accepts several different types of\nvalues:\n\n* `[]`: If the `id` property is an empty array, then the\nchanges will apply to all resources applicable to the context\nof the operation.\n* `number[]`: If the value is an array of integers, then the\nchanges will apply to each of the resources identified by the\nnumbers. If any of these numbers are negative (i.e., prefixed\nwith a minus sign, `-`), the changes will not apply to\nresources identified by those numbers, even if the same number\nis present in the array in its positive form.\n* `null` or _not present_: An undefined state. The changes\nwill not be applied to any resources.\n\nThis functionality allows a great degree of flexibility to\nbatch processing of API resources. We can ask that the changes\nbe applied to all resources for the given `type` by providing\nan empty array. We can apply the changes to all resources\nexcept a few (e.g., `\"id\": [-45, -76, -32]`). We can apply the\nchanges to some resources, but not others (e.g., `\"id\": [-32,\n56, 45, -6, 18, 32]`—in this example, the changes will not be\napplied to the resource identified by `32`).",
            "items": {
              "description": "A positive or negative integer, identifying a resource to\nwhich these changes should or should not (denoted by the\nminus sign) apply.",
              "type": "number"
            },
            "type": "array"
          },
          "type": {
            "description": "The type of object represented.",
            "enum": [
              "price-sheet-element-image"
            ],
            "type": "string"
          }
        },
        "required": [
          "type",
          "id"
        ],
        "type": "object"
      },
      "type": "array"
    },
    "type": {
      "description": "The model type for the collection object (i.e., `event-collection`).",
      "type": "string"
    }
  },
  "required": [
    "type",
    "items"
  ],
  "title": "Price Sheet Element Images Collection",
  "type": "object"
}