Watermark Collection

Description

A collection of watermarks.

Properties

Property Description
items

A collection of resources returned in the current result set.

Property Description
created

The creation date of this watermark.

displayUrl read-only

An object of display demo URLs, identified by demo image ID.

Property Description
demoImage1

A URL indicating a demo image depicting the watermark.

demoImage2

A URL indicating a demo image depicting the watermark.

id

The identifier for this watermark.

isDefault

Whether this watermark is the brand's default watermark.

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.

name

The name of this watermark.

type

The type of object represented.

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 model type for the list response object.

OpenAPI Schema

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

{
  "description": "A collection of watermarks.",
  "properties": {
    "items": {
      "description": "A collection of resources returned in the current result set.",
      "items": {
        "description": "A watermark as viewed from a collection.\n\nA demo image representing the watermark for purposes of\ndemonstration may be retrieved using the `.displayUrl`.",
        "properties": {
          "created": {
            "description": "The creation date of this watermark.",
            "format": "date-time",
            "type": "string"
          },
          "displayUrl": {
            "description": "An object of display demo URLs, identified by demo image\nID.",
            "properties": {
              "demoImage1": {
                "description": "A URL indicating a demo image depicting the watermark.",
                "format": "uri",
                "type": "string"
              },
              "demoImage2": {
                "description": "A URL indicating a demo image depicting the watermark.",
                "format": "uri",
                "type": "string"
              }
            },
            "readOnly": true,
            "type": "object"
          },
          "id": {
            "description": "The identifier for this watermark.",
            "type": "integer"
          },
          "isDefault": {
            "description": "Whether this watermark is the brand's default watermark.",
            "type": "boolean"
          },
          "links": {
            "$ref": "#/components/schemas/Links"
          },
          "name": {
            "description": "The name of this watermark.",
            "type": "string"
          },
          "type": {
            "description": "The type of object represented.",
            "enum": [
              "watermark"
            ],
            "type": "string"
          }
        },
        "required": [
          "type",
          "links",
          "id",
          "name",
          "isDefault",
          "created"
        ],
        "type": "object"
      },
      "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 model type for the list response object.",
      "enum": [
        "watermark-collection"
      ],
      "example": "resource-type",
      "title": "Resource Type",
      "type": "string"
    }
  },
  "required": [
    "type",
    "items"
  ],
  "title": "Watermark Collection",
  "type": "object"
}