The appearance response object
You get an appearance JSON object in the Sitecore Discover Search and Recommendation response if you send an appearance object in the request. The response returns the HTML, CSS, and JavaScript templates and variables associated with a widget on a page. By default, the response only returns css_names and html_names.
The following code shows the basic structure of the appearance object in a response:
{
"appearance": {
"templates": {
"<section>": {
"devices": {
"<device>": {
"<content>": "string"
}
}
},
"variables": {
"<variable>": {
"valueType": "string",
"required": false,
"expanded": false
}
}
},
"css_names": ["string"],
"html_names": ["string"]
}
}
Keys
Depending on your request, you may see some or all keys.
The following table describes the keys in the appearance response object:
|
Key |
Type |
Description |
|---|---|---|
|
|
object |
All sections for a specific device as indicated in your request. |
|
|
object |
All variables defined in the widget's appearance style. |
|
|
string |
CSS class names that apply the appearance style to the widget. |
|
|
string |
HTML class names that apply the appearance style to the widget. |
Examples
The following code shows a sample request to get all HTML templates and variables for mobiles and tablets:
{
"appearance": {
"templates": {},
"variables": {}
}
}The following code shows the response to the above request. Along with css_names and html_names, you also see information about the templates for the devices and variables.
{
"appearance": {
"css_names": [
"rfk2_seo",
"rfk2_hs_home_seo"
],
"html_names": [
"seo",
"hs_home_seo"
],
"templates": {
"html": {
"devices": {
"mobile": {
"content": "<title>Reflektion</title><meta content=\"Reflektion Demo\" name=\"description\"><meta content=\"{{$keywords}}\" name=\"keywords\">\n"
},
"tablet": {
"content": "<title>Reflektion</title><meta content=\"Reflektion Demo\" name=\"description\"><meta content=\"{{$keywords}}\" name=\"keywords\">\n"
}
}
}
},
"variables": {
"keywords": {
"valueType": "paragraph",
"required": false,
"expanded": false
},
"description": {
"valueType": "paragraph",
"required": false,
"expanded": true,
"value": "Reflektion Demo"
},
"title": {
"valueType": "string",
"required": false,
"expanded": true,
"value": "Reflektion"
}
}
}
}