9004 : Private content search

Private content search

Endpoint ID:

9004

Method:

URL:

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

dp-key

dialogportal™ master key that uniquely identifies the account to connect content.

ext-key

External key that uniquely identifies the account to connect content.

ext-type

Type of external key

Request body:

JSON data with information about the content to be searched.

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.
	preferPrivate	If 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
	compare:	Defines logical operator to be applied for search criteria. Possible valid values are ["=", "<", ">", "<=", ">=","between", "empty", "notempty"].

Example

{
   "tags": [ "tag1", "tag2" ],
   "preferPrivate": false,                     // optional - default to false
   "fromDate": "2014-01-01T01:00Z",            // optional - ISO UTC date
   "limit": 2,                                 // optional - default to 1
   "offset": 10,                               // optional - default to 0
   "compare": "between",                       // optional ["=", "<", ">", "<=", ">=",
                                               //    "between", "empty", "notempty"]
   "compareValue1": 5.1,                       // required for "compare":
                                               //    ["=", "<", ">", "<=", ">=", "between"]
   "compareValue2": 5.9                        // required for "compare": "between"
}

Response body:

JSON data with information about the content searched.

Example

{
   "content": [
      {                                        // public content - no entityID
         "tags": [ "tag1", "tag2" ],
         "contentType": "text/html",
         "content": "base64 encoded content string",
         "created": "2014-02-10T12:53Z",
         "value": 19.5
      },
      {                                        // private content
         "entityID": 12345,
         "tags": [ "tag1", "tag2" ],
         "contentType": "text/html",
         "content": "base64 encoded content string",
         "created": "2014-02-08T09:00Z"
      }
   ],
   "paging": {
      "offset": 10,
      "count": 2,
      "more": true
   }
}

Status codes:

201

Created

404.1

User not found

404.2

External user could not be found

404.4

Content not found