Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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


The description of the asset.

AssetId

Int


This is a unique id descending from the DAM Center.

AssetTypeId

Int


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


The name of the asset type.

AssetSiloIdString
The Sitecore itemId of the silo in which the asset is located.
AssetSiloNameString
The Sitecore item name of the silo in which the asset is located.

ImportedBy

String


The name of the user who uploaded the asset.

CreatedDateTime

DateTime


The upload date.

ChangedDateTimeDateTime
The change date.
FilesizeLong
The file size of the original file in bytes.
FilesizeabreviatedString
A more readable version of the file size ex. 606.34 KB
ExtensionString
The extension of the original file.

VideoLength

String


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

VideoWidthInt
The width of the original file.
VideoHeightInt
The height of the original file.
VideoFpsFloat
The frames per seconds of the original file.
ImageWidthInt
The width of the original file.
ImageHeightInt
The height of the original file.
ImageDpiInt
The dpi of the original file.
ThumbSmallString
Url to a specific image quality.
ThumbString
Url to a specific image quality.
PreviewString
Url to a specific image quality.
WebPreviewString
Url to a specific image quality.
RawUrlString
Url to the source file. This will download the source file. 

DynamicMetadata

IDictionary<string, string>


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.


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 the direct streaming URL to Digizuite. Use this for streams, for instance video or images. Please note that using this bypasses the Sitecore cache. Furthermore, the link contains an access token, which expires after some period of time, where the default is 24 hours. Therefore do NOT make the URL static on your pages, since the access token will expire.

https://[DIGIZUITE URL]/Dmm3BWSV3/assetstream.aspx?assetid=23&mediaformatid=50052&destinationid=10010&accesskey=f0b020bc-81e3-4824-82e3-2e6c1d8f714c

...