...
Code Block | ||
---|---|---|
| ||
<?xml version="1.0" encoding="utf-8" ?> <configuration xmlns:patch="http://www.sitecore.net/xmlconfig/" xmlns:role="http://www.sitecore.net/xmlconfig/role/" xmlns:search="http://www.sitecore.net/xmlconfig/search/"> <sitecore> <pipelines> <group groupName="layoutService"> <pipelines> <getFieldSerializer performanceCritical="true"> <processor patch:before="processor[@type='Sitecore.LayoutService.Serialization.Pipelines.GetFieldSerializer.GetDefaultFieldSerializer, Sitecore.LayoutService']" type="DFS.JSS.Serializers.GetAssetFieldSerializer, DFS.JSS" resolve="true"> <FieldTypes hint="list"> <fieldType id="1">Asset</fieldType> </FieldTypes> </processor> <processor patch:before="processor[@type='Sitecore.LayoutService.Serialization.Pipelines.GetFieldSerializer.GetDefaultFieldSerializer, Sitecore.LayoutService']" type="DFS.JSS.Serializers.GetAssetLinkFieldSerializer, DFS.JSS" resolve="true"> <FieldTypes hint="list"> <fieldType id="1">Assetlink</fieldType> </FieldTypes> </processor> <processor patch:before="processor[@type='Sitecore.LayoutService.Serialization.Pipelines.GetFieldSerializer.GetDefaultFieldSerializer, Sitecore.LayoutService']" type="DFS.JSS.Serializers.GetAssetListFieldSerializer, DFS.JSS" resolve="true"> <FieldTypes hint="list"> <fieldType id="1">Assetlist</fieldType> </FieldTypes> </processor> </getFieldSerializer> </pipelines> </group> </pipelines> </sitecore> </configuration> |
Usisng Using the Sitecore Layout Services /sitecore/api/layout/render/[config]?item=[path]&sc_lang=[language]&sc_apikey=[key]
. The json output for each of the 3 fieldserializers can be configured. The configuration can be found in the file App_Config\Include\damforsitecore\DFS.Settings.config. The default config looks like this:
...
outputName
This is the property name of the json output.qualityId
This is the rendition id of an asset also known as the mediaFormatId. If you want to request the source of the asset, the type source or -1. If you down add this attribute, then the quality that the content editor selected will be used.download
If you want the url to be a donload url, then set this to true.
Examples
Here is a list of different usecases and how the configurations should look like.
I want to get the title of the asset
<property outputName="title" propertyName="Name" />
I want to get the Photograph metafield from my Digizuite which has the guid
baeefe6b-74df-44be-8a2b-ccfb2c57af8e
<property outputName="photograph" propertyName="baeefe6b-74df-44be-8a2b-ccfb2c57af8e" />
I want to get all the folders that the asset is part of. But i want the delimiter to be #
<property outputName="folders" propertyName="bf0ad1a6-984a-494e-a227-9d70c6a864f9" delimiter="#" />
I want to get the media url with the rendition the content editor selected
<quality outputName="src" />
I want to get the media url with a specific rendition from my Digizuite DAM. The rendition is called Small JPG and has mediaFormatId 50036
<quality outputName="src_small" qualityId="50036" />
I want to get the media url for the source of the asset
<quality outputName="src_source" qualityId="source" />
or<quality outputName="src_source" qualityId="-1" />
I want to get the media url with a specific rendition from my Digizuite DAM and make it a download link. The rendition is called Small JPG and has mediaFormatId 50036
<quality outputName="src_small_download" qualityId="50036" download="true" />
Crops
If an asset has crops, then it is posible to get a list of the crops in the json respons. You simply add a property called Crops like this.<property outputName="crops" propertyName="Crops" />
The json output would look like this.
Code Block | ||
---|---|---|
| ||
"DFS Medie": {
"value": {
"assetTypeId": 4,
"title": "Butterfly",
"crops": [
{
"assetTypeId": 4,
"title": "Butterfly",
"crops": "",
"src": "/dfsmedia/baeefe6b74df44be8a2bccfb2c57af8e/119-50036/butterfly",
"src_download": "/dfsmedia/baeefe6b74df44be8a2bccfb2c57af8e/119-50036/options/download/butterfly",
"cropname": "Widescreen"
},
{
"assetTypeId": 4,
"title": "Butterfly",
"crops": "",
"src": "/dfsmedia/baeefe6b74df44be8a2bccfb2c57af8e/120-50036/butterfly",
"src_download": "/dfsmedia/baeefe6b74df44be8a2bccfb2c57af8e/120-50036/options/download/butterfly",
"cropname": "Banner"
}
],
"src": "/dfsmedia/baeefe6b74df44be8a2bccfb2c57af8e/114-50036/butterfly",
"src_download": "/dfsmedia/baeefe6b74df44be8a2bccfb2c57af8e/114-50036/options/download/butterfly"
}
} |