Search for content available to a specific user. The result may also include public content.
Endpoint ID: | 9004 | |||||||||||||||||||||||||||||||
Method: | ||||||||||||||||||||||||||||||||
URL: | POST: /user/dp-key/{dp-key}/content/search | |||||||||||||||||||||||||||||||
| dp-key | dialogportal™ master key that uniquely identifies the account to search content. | |||||||||||||||||||||||||||||||
| ext-key | External key that uniquely identifies the account to search content. | |||||||||||||||||||||||||||||||
| ext-type | Type of external key | |||||||||||||||||||||||||||||||
Request body: | A JSON object describing the search parameters.
Example {
"tags": [ "tag1", "tag2" ],
"preferPrivate": false,
"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. Example {
"content": [
{ /* public content - no dpKey */
"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"
},
{ /* private content - has dpKey */
"dpKey": 12345,
"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.1 | User not found | |||||||||||||||||||||||||||||||
| 404.2 | External user could not be found | |||||||||||||||||||||||||||||||
| 404.4 | No Content found | |||||||||||||||||||||||||||||||