Page Comparison

...

Endpoint ID:

9005

Method:

URL:

POST /data/content/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	Used to filter the search results by content "value". Possible "compare" options are: = < > <= >= between empty notempty
	compareValue1	Decimal comparison value. Required if "compare" is one of = < > <= >= between
	compareValue2	Decimal comparison value. Required if "compare" has value "between".

Code Block

title	Example

{
   "tags": [ "tag1", "tag2" ],
   "fromDate": "2014-01-01T01:00Z",
   "limit": 2,
   "offset": 10,
   "compare": "between",
   "compareValue1": 5.1,
   "compareValue2": 5.9
}

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 and whether there are more items than the ones returned.

Code Block

title	Example

{
   "content": [
      {
         "tags": [ "tag1", "tag2" ],
         "contentType": "text/html",
         "content": "PGh0bWw+PGJvZHk+TW9yZSBIVE1MIGNvbnRlbnQ8L2JvZHk+PC9odG1sPg==",
         "created": "2014-02-10T12:53:42Z",
         "value": 5.5,
         "activeFrom": "2014-03-01T12:00:00Z",
         "activeTo": "2014-03-08T12:00:00Z"
      },
      {
         "tags": [ "tag1", "tag2", "tag3" ],
         "contentType": "text/html",
         "content": "PGh0bWw+PGJvZHk+SFRNTCBjb250ZW50PC9ib2R5PjwvaHRtbD4=",
         "created": "2014-02-08T09:00:34Z",
         "value": 5.9
      }
   ],
   "paging": {
      "offset": 10,
      "count": 2,
      "more": true
   }
}

Status codes:

200

OK

404.4

No Content found

Versions Compared

Old Version 10

New Version 11

Key