Get Search Results
Get Search Results
OVERVIEW
Overview
Get search results from Publisher.
Search requests are made via POST to enable complexity of the search request.
Since v5.0
HTTP Request
POST /api/2/search
HTTP Request Object
Search request object either in JSON or XML format.
HTTP Headers
| HTTP Request Header | Description | Example |
|---|---|---|
| Authorization | The API Authorisation token | "Bearer XXXXXXXXXXXXX" |
| Accept |
The format of the expected response.
If no parameter is set, JSON is the default response given. |
"application/xml" |
| Content-Type |
The format of the provided content.
If no parameter is set, JSON is the expected content by default. |
"application/json" |
HTTP Response
Success
HTTP response 200 with search results object
(Example below)
Example HTTP Request & Response
GET http://example.com/context/api/2/search
JSON Request
{
"searchquery": {
"limit": "10",
"offset": "0",
"startdocumentindex": 0,
"query": "test",
"advancedquery": {
"all": null,
"any": "test search string",
"exclude": null
},
"date": {
"from": "20161201",
"to": "20181201"
},
"sort": "relevance",
"user": "user.name@example.com",
"language": "en_US",
"contenttypes": [
7
]
}
}
JSON Response
{
"totalCount": 19,
"total": 19,
"currentPage": 1,
"progressivekey": "618lYCsR9z_1536564412371",
"result": [
{
"id": 113,
"typeid": 10,
"type": "Module",
"title": "All_in_one_Unified_search_multilingual",
"url": "https://example.com/context/all_in_one_unified_search_multilingual",
"summary": "",
"image": {
"url": "https://example.com/context/images/v4/common/noimage/noimage128_96.png",
"urlMedium": "https://example.com/context/images/v4/common/noimage/noimage128_96.png",
"urlLarge": "https://example.com/context/images/v4/common/noimage/noimage256_192.png",
"alt": ""
},
"favourite": {
"url": "javascript:bookmarkproduct('favouriteModule_113','113',1,'Add to favourites','Remove from favourites');",
"favourited": false
},
"icon": {
"title": "Publication",
"className": "icon-highq-publication-module"
},
"score": 7.876536,
"lastmodifieddate": "07-08-2018 13:40:48:003",
"documentindex": 0
},
{
"id": 5,
"typeid": 3,
"type": "Page",
"title": "All_in_one_Unified_search_multilingual",
"url": "https://example.com/context/pages/sample-page",
"summary": "",
"image": {
"url": "https://example.com/context/images/v4/common/noimage/noimage128_96.png",
"urlMedium": "https://example.com/context/images/v4/common/noimage/noimage128_96.png",
"urlLarge": "https://example.com/context/images/v4/common/noimage/noimage256_192.png",
"alt": ""
},
"source": {
"id": 0,
"title": "Page",
"url": "-1"
},
"favourite": {
"url": "javascript:favouriteMicrositePage('5','1','12','favouriteMicrositePage_5_1_12','Add to favourites','Remove from favourites')",
"favourited": false
},
"icon": {
"title": "System pages",
"className": "icon-highq-microsite-small"
},
"score": 7.876536,
"lastmodifieddate": "07-08-2018 13:48:29:217",
"documentindex": 1
},
{
"id": 68,
"typeid": 1,
"type": "Content",
"title": "All_in_one_Unified_search_multilingual",
"url": "https://example.com/context/all_in_one_unified_search_multilingual-e/all_in_one_unified_search_multilingual_4",
"summary": "",
"image": {
"url": "https://example.com/context/images/v4/common/noimage/noimage128_96.png",
"urlMedium": "https://example.com/context/images/v4/common/noimage/noimage128_96.png",
"urlLarge": "https://example.com/context/images/v4/common/noimage/noimage256_192.png",
"alt": ""
},
"source": {
"id": 115,
"title": "All_in_one_Unified_search_multilingual e",
"url": "https://example.com/context/all_in_one_unified_search_multilingual-e"
},
"author": {
"id": 27,
"firstName": "User",
"lastName": "Name",
"url": "https://example.com/context/user/username"
},
"favourite": {
"url": "javascript:favouriteContent('68','115','favouriteContent_content.contentId','Add to favourites','Remove from favourites')",
"favourited": false
},
"icon": {
"title": "Event",
"className": "icon-highq-events-small"
},
"score": 7.876536,
"lastmodifieddate": "07-08-2018 13:53:43:563",
"documentindex": 2
},
{
"id": 67,
"typeid": 1,
"type": "Content",
"title": "All_in_one_Unified_search_multilingual",
"url": "https://example.com/context/all_in_one_unified_search_multilingual-v/all_in_one_unified_search_multilingual_3",
"summary": "",
"image": {
"url": "https://example.com/context/flag/flag_1025_128x96.gif",
"urlMedium": "https://example.com/context/flag/flag_1025_128x96.gif",
"urlLarge": "https://example.com/context/flag/flag_1025_256x192.gif",
"alt": ""
},
"source": {
"id": 114,
"title": "All_in_one_Unified_search_multilingual v",
"url": "https://example.com/context/all_in_one_unified_search_multilingual-v"
},
"author": {
"id": 27,
"firstName": "User",
"lastName": "Name",
"url": "https://example.com/context/user/username"
},
"favourite": {
"url": "javascript:favouriteContent('67','114','favouriteContent_content.contentId','Add to favourites','Remove from favourites')",
"favourited": false
},
"icon": {
"title": "Video",
"className": "icon-highq-video-small"
},
"score": 7.876536,
"lastmodifieddate": "07-08-2018 13:53:04:007",
"documentindex": 3
},
{
"id": 71,
"typeid": 1,
"type": "Content",
"title": "All_in_one_Unified_search_multilingual",
"url": "https://example.com/context/all_in_one_unified_search_multilingual/all_in_one_unified_search_multilingual_7",
"summary": "",
"image": {
"url": "https://example.com/context/images/v4/common/noimage/noimage128_96.png",
"urlMedium": "https://example.com/context/images/v4/common/noimage/noimage128_96.png",
"urlLarge": "https://example.com/context/images/v4/common/noimage/noimage256_192.png",
"alt": ""
},
"source": {
"id": 113,
"title": "All_in_one_Unified_search_multilingual",
"url": "https://example.com/context/all_in_one_unified_search_multilingual"
},
"author": {
"id": 27,
"firstName": "User",
"lastName": "Name",
"url": "https://example.com/context/user/username"
},
"favourite": {
"url": "javascript:favouriteContent('71','113','favouriteContent_content.contentId','Add to favourites','Remove from favourites')",
"favourited": false
},
"icon": {
"title": "url",
"className": "icon-highq-generic-small"
},
"score": 7.876536,
"lastmodifieddate": "07-08-2018 13:56:11:092",
"documentindex": 4
},
{
"id": 69,
"typeid": 1,
"type": "Content",
"title": "All_in_one_Unified_search_multilingual",
"url": "https://example.com/context/all_in_one_unified_search_multilingual/all_in_one_unified_search_multilingual_5",
"summary": "",
"image": {
"url": "https://example.com/context/images/v4/common/noimage/noimage128_96.png",
"urlMedium": "https://example.com/context/images/v4/common/noimage/noimage128_96.png",
"urlLarge": "https://example.com/context/images/v4/common/noimage/noimage256_192.png",
"alt": ""
},
"source": {
"id": 113,
"title": "All_in_one_Unified_search_multilingual",
"url": "https://example.com/context/all_in_one_unified_search_multilingual"
},
"author": {
"id": 27,
"firstName": "User",
"lastName": "Name",
"url": "https://example.com/context/user/username"
},
"favourite": {
"url": "javascript:favouriteContent('69','113','favouriteContent_content.contentId','Add to favourites','Remove from favourites')",
"favourited": false
},
"icon": {
"title": "Article",
"className": "icon-highq-publication-small"
},
"score": 7.876536,
"lastmodifieddate": "07-08-2018 13:54:28:022",
"documentindex": 5
},
{
"id": 1,
"typeid": 7,
"type": "Comparison Toolkit",
"title": "All_in_one_Unified_search_multilingual c: All_in_one_Unified_search_multilingual",
"url": "https://example.com/context/all_in_one_unified_search_multilingual-c/pages/all_in_one_unified_search_multilingual_8",
"summary": "",
"image": {
"url": "https://example.com/context/images/v4/common/noimage/noimage128_96.png",
"urlMedium": "https://example.com/context/images/v4/common/noimage/noimage128_96.png",
"urlLarge": "https://example.com/context/images/v4/common/noimage/noimage256_192.png",
"alt": ""
},
"source": {
"id": 116,
"title": "All_in_one_Unified_search_multilingual c",
"url": "https://example.com/context/all_in_one_unified_search_multilingual-c"
},
"icon": {
"title": "Comparison toolkit",
"className": "icon-highq-ctk-small"
},
"score": 7.876536,
"lastmodifieddate": "07-08-2018 13:57:40:787",
"documentindex": 6
},
{
"id": 16,
"typeid": 8,
"type": "Dashboard",
"title": "All_in_one_Unified_search_multilingual",
"url": "https://example.com/context/all_in_one_unified_search_multilingual_1",
"summary": "Tout_dans_un_Unifié_chercher_multilingue\n <strong>All_in_one_Unified_search_multilingual</strong>",
"image": {
"url": "https://example.com/context/images/v4/common/noimage/noimage128_96.png",
"urlMedium": "https://example.com/context/images/v4/common/noimage/noimage128_96.png",
"urlLarge": "https://example.com/context/images/v4/common/noimage/noimage256_192.png",
"alt": ""
},
"icon": {
"title": "Dashboard",
"className": "icon-dashboard channelDashboard"
},
"score": 7.876536,
"lastmodifieddate": "07-08-2018 14:01:00:023",
"documentindex": 7
},
{
"id": 70,
"typeid": 1,
"type": "Content",
"title": "All_in_one_Unified_search_multilingual",
"url": "https://example.com/context/all_in_one_unified_search_multilingual/all_in_one_unified_search_multilingual_6",
"summary": "",
"image": {
"url": "https://example.com/context/images/v4/fileicon/large_txt.svg",
"urlMedium": "https://example.com/context/images/v4/common/noimage/noimage128_96.png",
"urlLarge": "https://example.com/context/images/v4/common/noimage/noimage256_192.png",
"alt": "",
"title": "TXT"
},
"source": {
"id": 113,
"title": "All_in_one_Unified_search_multilingual",
"url": "https://example.com/context/all_in_one_unified_search_multilingual"
},
"author": {
"id": 27,
"firstName": "User",
"lastName": "Name",
"url": "https://example.com/context/user/username"
},
"favourite": {
"url": "javascript:favouriteContent('70','113','favouriteContent_content.contentId','Add to favourites','Remove from favourites')",
"favourited": false
},
"score": 7.876536,
"content": {
"attachment": {
"size": "73 Bytes",
"extension": "txt"
}
},
"lastmodifieddate": "07-08-2018 13:55:37:823",
"documentindex": 9
},
{
"id": 19,
"typeid": 2,
"type": "Microsite Page",
"title": "All_in_one_Unified_search_multilingual",
"url": "https://example.com/context/all_in_one_unified_search_multilingual-m/all_in_one_unified_search_multilingual_2",
"summary": "",
"image": {
"url": "https://example.com/context/images/v4/common/noimage/noimage128_96.png",
"urlMedium": "https://example.com/context/images/v4/common/noimage/noimage128_96.png",
"urlLarge": "https://example.com/context/images/v4/common/noimage/noimage256_192.png",
"alt": ""
},
"source": {
"id": 8,
"title": "All_in_one_Unified_search_multilingual m",
"url": "https://example.com/context/NewMicrosite111"
},
"favourite": {
"url": "javascript:favouriteMicrositePage('19','8','111','favouriteMicrositePage_19_8_111','Add to favourites','Remove from favourites')",
"favourited": false
},
"icon": {
"title": "Microsite",
"className": "icon-highq-microsite-small"
},
"score": 7.876536,
"lastmodifieddate": "13-08-2018 19:20:09:283",
"documentindex": 10
},
{
"id": 3,
"typeid": 9,
"type": "Dashboard",
"title": "All_in_one_Unified_search_multilingual",
"url": "https://example.com/context/all_in_one_unified_search_multilingual_1",
"summary": "",
"image": {
"url": "https://example.com/context/images/v4/common/noimage/noimage128_96.png",
"urlMedium": "https://example.com/context/images/v4/common/noimage/noimage128_96.png",
"urlLarge": "https://example.com/context/images/v4/common/noimage/noimage256_192.png",
"alt": ""
},
"icon": {
"title": "Dashboard",
"className": "icon-dashboard channelDashboard"
},
"score": 7.876536,
"lastmodifieddate": "07-08-2018 14:01:41:463",
"documentindex": 11
},
{
"id": 293,
"typeid": 7,
"type": "Comparison Toolkit",
"title": "All_in_one_Unified_search_multilingual c: England",
"url": "https://example.com/context/all_in_one_unified_search_multilingual-c/england",
"summary": "",
"image": {
"url": "https://example.com/context/images/v4/common/noimage/noimage128_96.png",
"urlMedium": "https://example.com/context/images/v4/common/noimage/noimage128_96.png",
"urlLarge": "https://example.com/context/images/v4/common/noimage/noimage256_192.png",
"alt": ""
},
"source": {
"id": 116,
"title": "All_in_one_Unified_search_multilingual c",
"url": "https://example.com/context/all_in_one_unified_search_multilingual-c"
},
"icon": {
"title": "Comparison toolkit",
"className": "icon-highq-ctk-small"
},
"score": 6.705191,
"lastmodifieddate": "07-08-2018 13:59:35:042",
"documentindex": 12
},
{
"id": 114,
"typeid": 10,
"type": "Module",
"title": "All_in_one_Unified_search_multilingual v",
"url": "https://example.com/context/all_in_one_unified_search_multilingual-v",
"summary": "",
"image": {
"url": "https://example.com/context/images/v4/common/noimage/noimage128_96.png",
"urlMedium": "https://example.com/context/images/v4/common/noimage/noimage128_96.png",
"urlLarge": "https://example.com/context/images/v4/common/noimage/noimage256_192.png",
"alt": ""
},
"favourite": {
"url": "javascript:bookmarkproduct('favouriteModule_114','114',1,'Add to favourites','Remove from favourites');",
"favourited": false
},
"icon": {
"title": "Video",
"className": "icon-highq-video-module"
},
"score": 5.364153,
"lastmodifieddate": "07-08-2018 13:41:22:547",
"documentindex": 13
},
{
"id": 116,
"typeid": 10,
"type": "Module",
"title": "All_in_one_Unified_search_multilingual c",
"url": "https://example.com/context/all_in_one_unified_search_multilingual-c",
"summary": "",
"image": {
"url": "https://example.com/context/images/v4/common/noimage/noimage128_96.png",
"urlMedium": "https://example.com/context/images/v4/common/noimage/noimage128_96.png",
"urlLarge": "https://example.com/context/images/v4/common/noimage/noimage256_192.png",
"alt": ""
},
"favourite": {
"url": "javascript:bookmarkproduct('favouriteModule_116','116',1,'Add to favourites','Remove from favourites');",
"favourited": false
},
"icon": {
"title": "Comparison toolkit",
"className": "icon-highq-ctk-module"
},
"score": 5.364153,
"lastmodifieddate": "07-08-2018 13:43:05:083",
"documentindex": 14
},
{
"id": 115,
"typeid": 10,
"type": "Module",
"title": "All_in_one_Unified_search_multilingual e",
"url": "https://example.com/context/all_in_one_unified_search_multilingual-e",
"summary": "",
"image": {
"url": "https://example.com/context/images/v4/common/noimage/noimage128_96.png",
"urlMedium": "https://example.com/context/images/v4/common/noimage/noimage128_96.png",
"urlLarge": "https://example.com/context/images/v4/common/noimage/noimage256_192.png",
"alt": ""
},
"favourite": {
"url": "javascript:bookmarkproduct('favouriteModule_115','115',1,'Add to favourites','Remove from favourites');",
"favourited": false
},
"icon": {
"title": "Event",
"className": "icon-highq-event-module"
},
"score": 5.364153,
"lastmodifieddate": "07-08-2018 13:42:21:227",
"documentindex": 15
},
{
"id": 111,
"typeid": 10,
"type": "Module",
"title": "All_in_one_Unified_search_multilingual m",
"url": "https://example.com/context/NewMicrosite111",
"summary": "",
"image": {
"url": "https://example.com/context/images/v4/common/noimage/noimage128_96.png",
"urlMedium": "https://example.com/context/images/v4/common/noimage/noimage128_96.png",
"urlLarge": "https://example.com/context/images/v4/common/noimage/noimage256_192.png",
"alt": ""
},
"favourite": {
"url": "javascript:bookmarkproduct('favouriteModule_111','111',1,'Add to favourites','Remove from favourites');",
"favourited": false
},
"icon": {
"title": "Microsite",
"className": "icon-highq-microsite-module"
},
"score": 5.364153,
"lastmodifieddate": "13-07-2018 19:20:18:008",
"documentindex": 16
},
{
"id": 18362,
"typeid": 5,
"type": "People",
"title": "User Name",
"url": "https://example.com/context/user/username",
"summary": "This is the Bio section of the user profile",
"image": {
"url": "https://example.com/context/userPhoto.action?userId=18362&avtarSize=64×tamp=1534169480793",
"urlMedium": "https://example.com/context/userPhoto.action?userId=18362&avtarSize=128×tamp=1534169480793",
"urlLarge": "https://example.com/context/userPhoto.action?userId=18362&avtarSize=256×tamp=1534169480793",
"alt": "User Name"
},
"score": 4.922835,
"people": {
"email": "user.name@domain.com",
"jobTitle": "Senior Solution Architect",
"city": "London",
"organisation": {
"id": 1989,
"name": "Organisation Pty Ltd"
}
},
lastmodifieddate": "07-08-2018 13:48:29:217",
"documentindex": 17
},
{
"id": 116,
"typeid": 7,
"type": "Comparison Toolkit",
"title": "All_in_one_Unified_search_multilingual c",
"url": "https://example.com/context/all_in_one_unified_search_multilingual-c/comparison",
"summary": "",
"image": {
"url": "https://example.com/context/images/v4/common/noimage/noimage128_96.png",
"urlMedium": "https://example.com/context/images/v4/common/noimage/noimage128_96.png",
"urlLarge": "https://example.com/context/images/v4/common/noimage/noimage256_192.png",
"alt": ""
},
"favourite": {
"url": "javascript:bookmarkproduct('favouriteModule_116','116',1,'Add to favourites','Remove from favourites');",
"favourited": false
},
"icon": {
"title": "Comparison toolkit",
"className": "icon-highq-ctk-small"
},
"score": 4.7412863,
"lastmodifieddate": "07-08-2018 13:58:41:823",
"documentindex": 18
},
{
"id": 19,
"typeid": 6,
"type": "Microsite Page Attachment",
"title": "test1_1026.txt - (All_in_one_Unified_search_multilingual)",
"url": "https://example.com/context/attachment_dw.action?
attkey=FRbANEucS95NMLRN47z%2BeeOgEFCt8EGQJsWJiCH2WAWHb%2FPDBPVvgudKiXhOdkSj&fromContentView=1&nav=FRbANEucS95NMLRN47z%2BeeOgEFCt8EGQvFOJX3HfkTs%3D&metaData.micrositeID=8&metaDa
ta.pageID=19×tamp=1534172226896",
"summary": "",
"image": {
"url": "https://example.com/context/images/v4/common/noimage/noimage128_96.png",
"urlMedium": "https://example.com/context/images/v4/common/noimage/noimage128_96.png",
"urlLarge": "https://example.com/context/images/v4/common/noimage/noimage256_192.png",
"alt": ""
},
"source": {
"id": 8,
"title": "All_in_one_Unified_search_multilingual m",
"url": "https://example.com/context/NewMicrosite111"
},
"icon": {
"title": "Microsite",
"className": "icon-highq-microsite-small"
},
"score": 3.793029,
"microsite": {
"attachment": {
"size": "38 Bytes",
"extension": "html"
}
},
"lastmodifieddate": "13-08-2018 19:20:09:283",
"documentindex": 19
}
]
}
Thank you
Your review has been submitted.
Comments
0 Comments