Digital Rule Collection

Description

A collection of digital rules.

Properties

Property Description
items

A list of digital rules.

Property Description
brandWatermark nullable read-only

A brand watermark.

brandWatermarkId nullable

ID of the brand watermark that will be applied to each image generated according to this rule

created read-only

The creation date of this digital rule.

downloadAll

Whether this rule allows for the bulk download of all images in the gallery/album.

downloadLimit nullable

The maximum number of images a single user is allowed to download from the gallery/album.

downloadPin nullable

The presence of a downloadPin requires PIN entry for free digital downloads. Must contain only digits.

id

The identifier for this digital rule.

name

Human readable name for this digital rule.

printRelease nullable

The print release that will be included with images generated according to this rule.

requireDownloadPin read-only

Flag indicating whether the DigitalRule requires a downloadPin. This allows rules derived from brand event defaults rules to inherit the requirement for a downloadPin from the brand event defaults rules.

resolution nullable

Length, in pixels, of longest side of image resulting from this rule. If null, the rule will deliver the original full size resolution

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 digital rules.",
  "properties": {
    "items": {
      "description": "A list of digital rules.",
      "items": {
        "description": "A digital rule.",
        "properties": {
          "brandWatermark": {
            "allOf": [
              {
                "nullable": true,
                "readOnly": true
              },
              {
                "$ref": "#/components/schemas/BrandWatermark"
              }
            ]
          },
          "brandWatermarkId": {
            "description": "ID of the brand watermark that will be applied to each image\ngenerated according to this rule",
            "nullable": true,
            "type": "integer"
          },
          "created": {
            "description": "The creation date of this digital rule.",
            "format": "date-time",
            "readOnly": true,
            "type": "string"
          },
          "downloadAll": {
            "description": "Whether this rule allows for the bulk download of all images in the\ngallery/album.",
            "type": "boolean"
          },
          "downloadLimit": {
            "description": "The maximum number of images a single user is allowed to download\nfrom the gallery/album.",
            "nullable": true,
            "type": "integer"
          },
          "downloadPin": {
            "description": "The presence of a `downloadPin` requires PIN entry for free digital\ndownloads. Must contain only digits.",
            "maxLength": 8,
            "minLength": 4,
            "nullable": true,
            "type": "string"
          },
          "id": {
            "description": "The identifier for this digital rule.",
            "type": "integer"
          },
          "name": {
            "description": "Human readable name for this digital rule.",
            "maxLength": 100,
            "type": "string"
          },
          "printRelease": {
            "description": "The print release that will be included with images generated\naccording to this rule.",
            "maxLength": 7500,
            "nullable": true,
            "type": "string"
          },
          "requireDownloadPin": {
            "default": false,
            "description": "Flag indicating whether the DigitalRule requires a `downloadPin`. This\nallows rules derived from brand event defaults rules to inherit the\nrequirement for a `downloadPin` from the brand event defaults rules.",
            "readOnly": true,
            "type": "boolean"
          },
          "resolution": {
            "description": "Length, in pixels, of longest side of image resulting from this\nrule. If `null`, the rule will deliver the original full size\nresolution",
            "nullable": true,
            "type": "integer"
          },
          "type": {
            "description": "The type of object represented",
            "enum": [
              "digital-rule"
            ],
            "type": "string"
          }
        },
        "required": [
          "type",
          "id",
          "name",
          "resolution",
          "downloadAll"
        ],
        "title": "Digital Rule",
        "type": "object"
      },
      "title": "Digital Rule",
      "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": [
        "digital-rule-collection"
      ],
      "example": "resource-type",
      "title": "Resource Type",
      "type": "string"
    }
  },
  "required": [
    "type",
    "items"
  ],
  "title": "Digital Rules Collection",
  "type": "object"
}