Page Comparison

Excerpt

Private content search

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

Endpoint ID:	9004
Method:	Image Modified
URL:

POST: /user/dp-key/{dpKey}/content/search
POST: /user

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

extKey

ext-key}/{

extType

ext-type}

/contentdp

/search

entity-

keydialogportal™ master key

id	Rubiq entity ID that uniquely identifies

the account to search content.

an entity
	ext-key	External key that uniquely identifies

the account to search content.

an entity
	ext-type	Type of external key
Request body:

JSON data with information about the content to be searched compare:Defines logical operator to be applied for search criteria. Possible valid values are ["=", "<", ">", "<=", ">=","between", "empty", "notempty"]

A JSON object describing the search parameters.

Required fields:

compareValue1:

Required if "compare" has value. Possible valid values of "compare" are ["=", "<", ">", "<=", ">=", "between"]

compareValue2:

Required if "compare" has value "between"

Optional fields: tags:JSON array of Tags. preferPrivateIf omitted, limit is set to "false". fromDate:Date value defining content active start date. The date must be in UTC, for example "2014-01-01T01:00Z". 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

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

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": [

//

optional

-

default

to

false

fromDate

key": "

2014-01-01T01:00Z

a",
         "compare": ">=",

//

optional

-

ISO

UTC

date

limit

compareValue":

2,

5.1
      },
      {
         "key": "a",

//

optional

- default to 1

"compare": "<=",

"offset":

10,

   "compareValue": 5.9
      },
      {
         "key": "x",

//

optional

-

default

to 0

    "compare": "

between",

isempty"
      }
   ],
   "priorities": [
      {

//

optional

["=",

"<",

">",

<=

key"

,

: "

>=

b",
         "compare": ">",
         "compareValue": 10
      },

//

between

key"

,

: "

empty

a",

"notempty"]

"compareValue1":

5.1,

    "compare": "desc"
      }
   ],
   "impressions": "sortByTimesViewed"

// required for "compare":

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

Code Block

title	Example

{
   "content": [
      {                                        /

/

* public content - no entityID   */

["=",

"<",

">",

"<=",

">=",

"between"]

compareValue2

tags":

5.9

[ "tag1", "tag2" ],

"content": "PGh0bWw+PGJvZHk+TW9yZSBIVE1MIGNvbnRlbnQ8L2JvZHk+PC9odG1sPg==",

//

required

for

compare

contentType": "

between

text/html"

}

Response body:

JSON data with information about the content searched.

Code Block

title	Example

{

"content":

[

    "data":

{
            "width": "300px",
            "height": "50px",

// public content - no entityID

 "a": 5.5,
            "

Versions Compared

Old Version 4

New Version Current

Key