About this resource
Representation of a watermark (a transparent image that will be applied to another image).
Properties
| Property | Description | Type |
|---|---|---|
| createdOn | Gets the creation datetime in UTC time. | datetime |
| id | Gets the Id of this watermark. | guid |
| modifiedOn | Gets the last modification datetime in UTC time. | datetime |
| name | Gets the name of this watermark. | string |
| position | Gets the watermark position. | string (values: topleft, topcenter, topright, middleleft, middlecenter, middleright, bottomleft, bottomcenter, bottomright) |
| tag | Gets the value for the Tag of this object. The value of this property should be valid Xml. This property will not be returned by default. In order to include the property in the response, add a header with the name 'select-watermark' and the value 'Tag' to your request. | string |
Relations
| Method | Name | Select-key | Resource type | Description |
|---|---|---|---|---|
| GET | self | Provides a link to this resource. | ||
| GET | image | select-Watermark: image | Image | Gets an object allowing you to control the image of this watermark. |
| GET | modifiedby | select-Watermark: modifiedby | User | Gets or sets the user that last modified this resource. |
| GET | createdby | select-Watermark: createdby | User | Gets or sets the user that created this resource. |
Actions
| Method | Action | Description | Response codes | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| PUT /watermark/{watermarkId} | edit | Edits an existing watermark |
|
||||||||
| DELETE /watermark/{watermarkId} | delete | Deletes an existing watermark |
|
Examples
Applying a watermark
A watermark can be applied to a file or a file version. Watermark can be configured through the
creation of a record and/or
editing of a record. The "watermarkType" parameter
specifies which watermark will be used (if any) and the "watermarkId" parameter specifies
the ID of the manually specified watermark if the "watermarkType" parameter is set to "UseSpecified".
The possible combinations of these parameters in a request are:
| watermarkType value | watermarkId value | Expected result |
|---|---|---|
| None | (ignored) | No watermark is applied. |
| UseSetting | (ignored) | The watermark ID is retrieved from the setting named ".watermarkName". |
| UseSpecified | An ID of an existing watermark. | The watermark that matches the specified ID will be used. |
|
InheritFromFile
(valid for file versions only) |
(ignored) | The watermark specified on a file will be used. |
Note: The "watermarkId" parameter will be validated in "UseSpecified" case only.
In all the other cases "watermarkId" parameter can still be set but will just be
used as a data storage.
Editing a watermark (full body)
PUT /watermark/1fe6e87a31bc4208bd1ca4f000dbfaff
{
"name":"Watermark",
"position":"MiddleCenter",
"tag":"<xml tag='test tag'/>",
"image":"OWY4OGNhNGYwZTE4NGE5YTkyYWNhODA5MDA5NGQwNTU="
}
Deleting a watermark
DELETE /watermark/c584888369ab4f049f367ea9f19137e3