Page Comparison

...

Excerpt

Search for publicly available content

Endpoint ID:	9005
Method:	Image Modified
URL:

POST

/

data

content/

content

tagged/search

Request body:

A JSON object describing the search parameters.

Required fields:
	tags	An array of tags
Optional fields:
	limit	The maximum number of content to return. If omitted,

"

limit

"

is set to 1.
	offset	The offset in search results from where to return data. If omitted,

"

offset

"

is set to 0.
	fromDate	UTC date used to filter search results by the content

"

activeFrom

"

date if it exists, or otherwise the

"

created

"

date.

compare

toDate

Used

UTC date used to filter

the

search results by the content

"value". Possible "compare"

activeTo date. Content with no activeTo date will always be included.

data

An array of data filters. All filters are applied, so the example below could be read as "data with key 'a' greater than 5.1, where data with key 'width' is not equal to '250px'"

key	The data key that is to be matched
compare	The comparison operator. Possible `compare` options are: = != < > <= >=

betweenDecimal

 empty notempty

compareValue1

compareValue

String or decimal comparison value. Required

if "compare" is one of=

for all comparison operators except empty and notempty.

Note

String data values will only be compared with string filter values, and numeric data values will only be compared with numeric filter values. So ensure that numeric values are entered as numbers, i.e. 5.9 not "5.9".

Numeric values are not culture-specific. Use period "." as decimal separator, and do not use thousand separators.

priorities

An array of data filters used to sort content. Similar to data filters, except that where data filters exclude content, priorities change the order of content, prioritizing content whose data match the filter or sorting content by data value.

key	The data key that is to be matched
compare	The comparison operator. Possible `compare` options are: = != < > <= >= asc

betweenDecimal

desc

compareValue2

compareValue

String or decimal comparison value. Required

if "compare" has value "between"

for all comparison operators except asc and desc.

Note

String data values will only be compared with string filter values, and numeric data values will only be compared with numeric filter values. So ensure that numeric values are entered as numbers, i.e. 5.9 not "5.9".

Numeric values are not culture-specific. Use period "." as decimal separator, and do not use thousand separators.

Code Block

title	Example

{
   "tags": [ "tag1", "tag2" ],
   "fromDate": "2014-01-01T01:00Z",
   "limit": 2,
   "offset": 10,
   "data": [
      {
         "key": "a",
         "compare": "

between

>",
         "

compareValue1

compareValue": 5.1
      },
      {

"compareValue2": 5.9

       "key": "width",
         "compare": "!=",
         "compareValue": "250px"
      }
   ],
   "priorities": [
      {
         "key": "b",
         "compare": ">",
         "compareValue": 10
      },
      {
         "key": "a",
         "compare": "desc"
      }
   ]
}

Response body:

JSON data with an array of content. The result will also contain a

"

paging

"

object detailing the number of content items returned,

the offset

the offset and whether there are more items than the ones returned.

Code Block

title	Example

{
   "content": [
      {
         "tags": [ "tag1", "tag2" ],
         "content": "PGh0bWw+PGJvZHk+TW9yZSBIVE1MIGNvbnRlbnQ8L2JvZHk+PC9odG1sPg==",
         "contentType": "text/html",
         "data": {
            "

content

width": "

PGh0bWw+PGJvZHk+TW9yZSBIVE1MIGNvbnRlbnQ8L2JvZHk+PC9odG1sPg==

300px",
            "

created

height": "

2014-02-10T12:53:42Z

50px",
            "

value

a": 5.5,
            "b": 15
         },
         "created": "2014-02-10T12:53:42Z",
         "activeFrom": "2014-03-01T12:00:00Z",
         "activeTo": "2014-03-08T12:00:00Z"
      },
      {
         "tags": [ "tag1", "tag2", "tag3" ],
         "content": "PGh0bWw+PGJvZHk+SFRNTCBjb250ZW50PC9ib2R5PjwvaHRtbD4=",
         "contentType": "text/html",
         "

content

data":

"PGh0bWw+PGJvZHk+SFRNTCBjb250ZW50PC9ib2R5PjwvaHRtbD4=",

 {
            "a": 5.9,
            "

created

width": "

2014-02-08T09:00:34Z"

200px"
         },
         "

value

created":

5.9

"2014-02-08T09:00:34Z"
      }
   ],
   "paging": {
      "offset": 10,
      "count": 2,
      "more": true
   }
}

Status codes:

200

OK

404.4

No

Content not found

...

Versions Compared

Old Version 10

New Version Current

Key