Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 4 Next »

When working with metadata through the API, the recommendation is to use the API rather than working with the item directly.
The API returns a well-defined data model of type AssetMetadata which contains the following properties and methods:

Property name

Type

Stampvalue

Description

Name

String

{stampvalue-asset:name}

The title of the asset.

Description

String

{stampvalue-asset:description}

The description of the asset.

ItemIdSrting{stampvalue-asset:itemid}Sitecore item Id.

AssetId

Int

{stampvalue-asset:assetid}

This is a unique id descending from the DAM Center.

AssetTypeId

Int

{stampvalue-asset:assettypeid}

This is a unique id, representing what type the asset is. E.g. The assettype for images is 4 and the assettype for videos is 1. This id can be mapped to an item using this location:system/modules/Digizuite/[silo id]/AssetTypeRoot

AssetTypeName

String

{stampvalue-asset:assettypename}

The name of the asset type.

AssetSiloIdString{stampvalue-asset:assetsiloid}The Sitecore itemId of the silo in which the asset is located.
AssetSiloNameString{stampvalue-asset:assetsiloname}The Sitecore item name of the silo in which the asset is located.
HashSha1String{stampvalue-asset:hashsha1}The HashSha1 of the source file. Can be use to test if the fysical file of the asset has replaced.

ImportedBy

String

{stampvalue-asset:importedby}

The name of the user who uploaded the asset.

LastModified

DateTime

{stampvalue-asset:lastmodified}

The change date.

UploadDateDateTime{stampvalue-asset:uploaddate}The upload date.
FilesizeLong{stampvalue-asset:filesize}The file size of the original file in bytes.
FilesizeAbbreviatedString{stampvalue-asset:filesizeabbreviated}A more readable version of the file size ex. 606.34 KB
FileExtensionString{stampvalue-asset:fileextension}The extension of the original file.

Duration

String

{stampvalue-asset:duration}

If the asset is of type video, then this is the length of the video.

WidthInt{stampvalue-asset:width}The width of the original file.
HeightInt{stampvalue-asset:height}The height of the original file.
CropnameString{stampvalue-asset:cropname}The cropname.

DynamicMetadata

IDictionary<string, string>

{stampvalue-asset:[enter metafieldId]}

This dictionary contains all the dynamic metafields from the DAM Center. The key is the MetafieldId of the metafield. All metafields can be found either in DAM Center or in this location: Sitecore:system/modules/Digizuite/[silo id]/MetaGroupRoot.

If you use the stampvalue, it would look like this: {stampvalue-asset:54322}

TranscodesIDictionary<string, AssetTranscode>NAA list of all transcode for the asset.

Method name

Description

Example of return value

GetMediaUrl()

Returns the media URL for the source file.

/media/512ffeba519249ff866095d7a25846ec/1-source

GetMediaUrl(string mediaFormatId, int resizeWidth = 0, int resizeHeight = 0, bool keepAspectRatio = true, bool allowUpScale = false))Returns a media URL for the specified quality (mediaFormatId). This gives the opportunity resize the image. By default the keepAspectRatio is true and allowUpScale is false./media/512ffeba519249ff866095d7a25846ec/1-50044/resize/100x0/options/keepaspectratio

GetDownloadUrl()

Returns the download URL for the source file.

/media/512ffeba519249ff866095d7a25846ec/1-source/options/download

GetDownloadUrl(string mediaFormatId)Returns the download URL for the specified quality (mediaFormatId)./media/512ffeba519249ff866095d7a25846ec/1-50044/options/download

GetDigizuiteStreamingUrl(string mediaFormatId)

Returns a media URL for the specified quality.

/media/512ffeba519249ff866095d7a25846ec/1-50045

GetQualityName(string quality)Returns the quality name.JPG Small

To see an example of how metadata looks for a specific asset use the DAM for Sitecore Administration dashboard - DFS 11.0 - Asset metadata viewer.

4.1 How to retrieve metadata from an item placed in the silo bucket

In order to retrieve the metadata for the silo item,  call the following pipeline: DFS.GetAssetMetadata
The GetAssetMetadataArgs takes AssetItemId which is of type Sitecore.Data.ID and ContextLanguage which is of type Sitecore.Globalization.Language.

See example below

var renderArgs = new GetAssetMetadataArgs { AssetItemId = item.ID, ContextLanguage = Sitecore.Context.Language };
CorePipeline.Run(PipelineNames.GetAssetMetadata, renderArgs);
if (renderArgs.AssetMetadata == null)
{
	return;
}
var name = renderArgs.AssetMetadata.Name;

4.2 How to retrieve metadata for the field type Asset

AssetField assetField = Sitecore.Context.Item.Fields["Asset"]; 
var name = assetField.AssetMetadata.Name; 
AssetlinkField assetLinkField = Sitecore.Context.Item.Fields["AssetLink"]; 
var name = assetLinkField.AssetMetadata.Name; 

4.4 How to retrieve metadata for the field type AssetList

AssetlistField assetList = Sitecore.Context.Item.Fields["AssetList"];
if (assetList != null)
{
	foreach (var asset in assetList.Assets)
		{
		// To request the rendering html for the asset you call the
		// RenderAsset method. It returns an RenderFieldResult object
		var renderResultItem = asset.RenderAsset(); 
		var title = asset.AssetMetadata.Name;
		var id = asset.AssetMetadata.AssetId;
		var assetTypeId = asset.AssetMetadata.AssetTypeId;
		var assetTypeName = asset.AssetMetadata.AssetTypeName; 


		// Get dynamic metadata
		var someDynamicMetadata = asset.AssetMetadata["50343"];
	}
}
  • No labels