A digital rule.
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 |
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 |
resolution nullable |
Length, in pixels, of longest side of image resulting from this rule. If |
type |
The type of object represented |
The following schema is based on OpenAPI 3.0 and is provided in our downloadable OpenAPI document.
{
"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"
}