This section describes the public JSON formats of site home configuration.
Public Format for Site Homes
Properties in the JSON file:
|
Attribute |
Type |
Description |
|---|---|---|
|
ecr:type |
String |
Required. Site-home |
|
ecr:createDate |
yyyy-MM-dd'T'HH:mm:ss.SSSX |
Optional. Date and time that this item was created. Defaults to creation date of the JCR. |
|
displayName |
String |
Required. The site "displayName" is used as the display name in the Workbench wherever sites are referenced. |
|
description |
String |
Information about the nature and content of the site home. |
|
urlPattern |
String |
The patterns used to match the request URL to this site definition, based on the scheme used by the application to encode site into the URL. When attempting to identify a site from a request, this patterns will be matched against the URL. For example, "/discoverSony" can be specified for the DiscoverSony site definition. Multiple patterns can be specified, delimited by commas. |
|
previewUrl |
String |
The URL used to preview the specific site definition. |
|
linkServiceUrl |
String |
A host specific for this site or a domain or URL specific for this site. |
|
assembleServiceURL |
String |
The URL that exposes the Assembler Service REST API for non-Java applications. |
The following example illustrates the exported JSON format for defining a site home whose display name is "Discover Sony" and whose URL pattern is "/sony":
{
"ecr:type":"site-home",
"ecr:createDate": "2015-08-11T14:57:34.946Z",
"displayName":"Discover Sony",
"urlPattern":"/sony"
}
