Resource: WatermarkPagedCollection

About this resource

Representation of a paged collection of Watermark items

Properties

Property	Description	Type
items	One page of this paged collection, which is a subcollection of the complete collection.	Collection of Watermark items
page	The current page of this paged collection.	int32
pageSize	The current page size of this paged collection.	int32
skip	The current skip size of this paged collection.	int32
take	The current take size of this paged collection.	int32
totalCount	The total count of items in this paged collection, not just on the current page.	int64

Relations

Method	Name	Description
GET	self	Provides a link to this resource.
GET	first	A link to the first page of this paged collection.
GET	prev	A link to the previous page of this paged collection.
GET	next	A link to the next page of this paged collection.
GET	last	A link to the last page of this paged collection.

Actions

Method

Action

Description

Response codes

POST /watermarks

create

Creates a new watermark

201	Request completed successfully. The response body is a JSON object which contains the "id" that corresponds to the newly created watermark id.
400	Bad request (in general)
403	Insufficient permissions

Examples

Searching for watermarks

The parameters are specified as http headers.

GET /watermarks HTTP/1.1
accept: application/hal+json
filter: ModifiedOn in today
sort: createdon
page: 1
pageSize: 20

The parameters are specified as query string parameters.

GET /watermarks?filter=ModifiedOn+in+today&sort=createdon&page=1&pagesize=10 HTTP/1.1

The parameters are specified as a combination of query string parameters and http headers.

GET /watermarks?page=1&pagesize=10 HTTP/1.1
filter: ModifiedOn in today
sort: createdon

Creating a new watermark

POST /watermarks
 {
    "name": "Test watermark",
    "position": "MiddleCenter",
    "tag": "<xml tag='test' />",
    "image": "NjlmMjFlOGQ0Mjg3NGEyN2EyMDJhODFjMDBlNjRkZTU="
}

In order to successfully create a watermark, the name, position and image must be specified via the relevant properties. "ImageMagick" media engine will be set by default.