Page Comparison

...

Excerpt

Search for content available to a specific entity. The result may also include public content.

Endpoint ID:	9004
Method:	Image Modified
URL:	/content/tagged/entity/

dp-key

id/{

dp

entity-

keydp

id}/search
/content/tagged/entity/ext-key/{ext-key}/{ext-type}/search

entity-

keydialogportal™ master key

id	Rubiq entity ID that uniquely identifies an entity


	ext-key	External key that uniquely identifies an entity

ext-type

Type of external key

Request body:

A JSON object describing the search parameters.

Required fields:


	tags	An array of tags
Optional fields:

limit The maximum number of content items to return. If omitted, limit is set to 1.


	offset	A search offset, used together with `limit` to implement a paging system. 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.


	toDate	UTC date used to filter search results by the content `activeTo` date. Content with no `activeTo` date will always be included.
	preferPrivate	When `true`, private content will be returned before public content. If omitted, `preferPrivate` is set to `false`.

data

An array of data filters. All filters are applied, so the example below could be read as "data with key 'a' between 5.1 and 5.9, where there is no 'x' data"

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

value

compareValue

String or decimal comparison value. Required 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 desc

compareValue

String or decimal comparison value. Required 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.

impressions

A string value which states how previous content views or "impressions" affect this search:

ignore	Previous views are not taken into consideration. This is the default.
sortByTimesViewed	Content that has been viewed least often is shown first.
showOnceOnly	Content which has previously been displayed for this entity will be excluded from the search.

Code Block

title	Example

{
   "tags": [ "tag1", "tag2" ],
   "preferPrivate": false,
   "fromDate": "2014-01-01T01:00Z",
   "limit": 2,
   "offset": 10,
   "data": [
      {
         "key": "a",
         "compare": ">=",
         "compareValue": 5.1
      },
      {
         "key": "a",
         "compare": "<=",
         "compareValue": 5.9
      },
      {
         "key": "x",
         "compare": "isempty"
      }
   ],
   "priorities": [
      {
         "key": "b",
         "compare": ">",
         "compareValue": 10
      },
      {
         "key": "a",
         "compare": "desc"
      }
   ],
   "impressions": "sortByTimesViewed"
}

Response body:

JSON data with an array of content. The result also contains 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": [
      {                                        /* public content - no

dpKey

entityID   */
         "tags": [ "tag1", "tag2" ],
         "content": "PGh0bWw+PGJvZHk+TW9yZSBIVE1MIGNvbnRlbnQ8L2JvZHk+PC9odG1sPg==",
         "contentType": "text/html",
         "data": {
            "width": "300px",
            "height": "50px",
            "a": 5.5,
            "b": 15
         },
         "created": "2014-02-10T12:53:42Z",
         "activeFrom": "2014-03-01T12:00:00Z",
         "activeTo": "2014-03-08T12:00:00Z"
      },
      {                                        /* private content - has

dpKey

entityID */
         "

dpKey

entityID": 12345,
         "tags": [ "tag1", "tag2", "tag3" ],
         "content": "PGh0bWw+PGJvZHk+SFRNTCBjb250ZW50PC9ib2R5PjwvaHRtbD4=",
         "contentType": "text/html",
         "data": {
            "a": 5.9
         },
         "created": "2014-02-08T09:00:34Z"
      }
   ],
   "paging": {
      "offset": 10,
      "count": 2,
      "more": true
   }
}

Status codes:

200

OK


	404.1

User

Entity not found


	404.2	External

user could

entity not

be

found

404.4

No

Content not found

Versions Compared

Old Version 10

New Version Current

Key