Response [200 Ok]

Uri /api/v2/image!watermark
UriDescription Watermark Images
EndpointType WatermarkImages

Timing

Total

cycles 1
objects 0
time 0.02619

Request

Uri /api/v2/image!watermark
Method GET
Version v2

Config

{
    "expand_method": "ref",
    "shorturis": false
}

Options

Notes

  • Watermark Image Uris (WatermarkUris) is a comma-separated list

Methods

OPTIONS

Permissions
  • Read

GET

Permissions
  • Read

POST

Permissions
  • Modify

DELETE
Deprecated: Use POST with Mode set to "Remove"

Permissions
  • Modify

Parameters

POST

Should watermarks be added or removed?

DELETE
Deprecated: Use POST with Mode set to "Remove"

JSON

{
    "Request": {
        "Version": "v2",
        "Method": "GET",
        "Uri": "/api/v2/image!watermark"
    },
    "Options": {
        "MethodDetails": {
            "OPTIONS": {
                "Permissions": [
                    "Read"
                ]
            },
            "GET": {
                "Permissions": [
                    "Read"
                ]
            },
            "POST": {
                "Permissions": [
                    "Modify"
                ]
            },
            "DELETE": {
                "Permissions": [
                    "Modify"
                ],
                "Deprecated": "Use POST with Mode set to \"Remove\""
            }
        },
        "Methods": [
            "OPTIONS",
            "GET",
            "POST",
            "DELETE"
        ],
        "ParameterDescription": {
            "Uri": "Absolute or relative URL, restricted to Locator(s) of the supplied URL if not null.   Up to a MAX_LENGTH in length.",
            "Select": "Select one option. Options should pass only the \"Value\".",
            "Text": "Variable length text from MIN_CHARS to MAX_CHARS (MAX_CHARS = INFINITY meaning arbitrary length)"
        },
        "Parameters": {
            "POST": [
                {
                    "Name": "WatermarkUri",
                    "Required": false,
                    "ReadOnly": false,
                    "Default": null,
                    "Type": "Uri",
                    "MAX_LENGTH": "INFINITY",
                    "Locator": [
                        "Watermark"
                    ]
                },
                {
                    "Name": "Mode",
                    "Required": false,
                    "ReadOnly": false,
                    "Default": "Add",
                    "Description": "Should watermarks be added or removed?",
                    "Type": "Select",
                    "OPTIONS": [
                        "Add",
                        "Remove"
                    ],
                    "MIN_COUNT": 1,
                    "MAX_COUNT": 1
                },
                {
                    "Name": "WatermarkUris",
                    "Required": true,
                    "ReadOnly": false,
                    "Default": null,
                    "Type": "Text",
                    "MIN_CHARS": 0,
                    "MAX_CHARS": "INFINITY"
                }
            ],
            "DELETE": [
                {
                    "Name": "WatermarkUris",
                    "Required": true,
                    "ReadOnly": false,
                    "Default": null,
                    "Type": "Text",
                    "MIN_CHARS": 0,
                    "MAX_CHARS": "INFINITY"
                }
            ]
        },
        "MediaTypes": [
            "application/json",
            "application/vnd.php.serialized",
            "application/x-msgpack",
            "text/html",
            "text/csv"
        ],
        "Notes": [
            "Watermark Image Uris (WatermarkUris) is a comma-separated list"
        ]
    },
    "Response": {
        "Uri": "/api/v2/image!watermark",
        "UriDescription": "Watermark Images",
        "EndpointType": "WatermarkImages",
        "Timing": {
            "Total": {
                "time": 0.02619,
                "cycles": 1,
                "objects": 0
            }
        }
    },
    "Code": 200,
    "Message": "Ok"
}