Page Comparison

itemType

Enum/int

0

The itemType of the asset. Always 0 for assets.

assetType

Enum/int

4 (image)

The asset type of the asset

assetId

int

16

The assetId of the asset. Not to confuse with itemId.

itemId

int

9588

The itemId of the asset. Not to confuse with assetId

itemGuid

String/Guid/UUID

b05b0e39-2bba-4098-8304-5dac38dff0d8

The itemGuid of the asset. Basically works like the itemId, but is a guid/uuid.

derivedFrom

int/null

null or 42

The assetId of the asset this asset is derived from (Cropped or trimmed), or null if this asset is not derived from another asset.

replacedWith

int/null

null or 42

The assetId of the asset that replaced this asset, or null. This is generally only set for previous versions of assets.

uploadMemberId

int

23

The id of the user that uploaded this asset.

hasWriteAccess

boolean

true or false

If you are allowed to make changes to this asset.

fileSize

int64/long

45179

The size in bytes of the source file of this asset

fileExtension

string

jpg

The file extension of the source file of this asset.

uploadDate

DateTime

2023-05-31T17:36:18.4330000

A timestamp for when this asset was originally uploaded.

lastModified

DateTime

2023-06-26T15:38:37.9630000

A timestamp for when this asset was last modified.

title

string

image-11

The value of the title metafield for this asset, in the requested language.

description

string

I am an image

The value of the description metafield for this asset, in the requested language.

cropName

string

banner or

The name of the crop size that was used for derive this asset, if this asset is a crop of another asset.

height

int/null

1920

The height in pixels of the source file. Only applicable for file types that has a height.

width

int/null

1080

The width in pixels of the source file. Only applicable for file types that has a width.

hashSha1

string

7D81F7133CE6A5405A2A2D3E51649435E5428B3E

The SHA1 hash of the source file of this asset.

duration

String/TimeSpan/null

00:15:42.156

A dotnet TimeSpan for how long this video/audio file is.

thumbnailUrl

string/url/null

A url for a small thumbnail for this asset.

largeThumbnailUrl

string/url/null

A larger thumbnail for the asset.

videoUrl

string/url/null

A url for streaming this specific asset as video

audioUrl

string/url/null

A url for streaming this specific asset as audio.

pdfUrl

string/url/null

A url for a pdf rendered version of this asset.

sourceUrl

string/url/null

A url for streaming the source file of this asset.

assetCode

string

image-11

The original file name of the asset, without the extension

deleted

boolean

true or false

bool indicating if this asset has been soft deleted. Soft deleted assets generally won’t be returned in search responses.

uploadComputer

string

Digizuite Media Manager

The computerName that was used when uploading this asset.

uploadUserName

string

contentcreator

The username of the user that uploaded this asset.

sourceLocationFileName

string

16.jpg

The filename of the file in the underlying storage. This is usually the asset id + extension.

sourceLocations

array

Information about which destinations in the digizuite the source file is available at.

originalFileName

string

image-11

The original file name of the asset, with without the extension.

transcodes

array

The transcodes that are available and has currently been generated for this asset.

transcodes.mediaFormatId

int

2

The id of the mediaFormat this transcode was generated as.

transcodes.destinationId

int

13

The id of the destination this format is available on.

transcodes.mediaTranscodeId

int

The id of the media transcode that was used to generate this media format.

transcodes.name

string

The name of this media format

transcodes.transcodeFileName

string

The name of the generated file in storage.

transcodes.url

string/url/null

A url for streaming this specific format.

transcodes.md5Hash

string

An md5 hash of the generated file.

transcodes.sha1Hash

string

A SHA1 hash of the generated file.

additionalMetadata

dictionary

Any additional metadata that was requested using the metaFieldItemGuids parameter. The dictionary is keys by the guid of each metafield. See documentation for each response type here

lockInfo

object

Information about the locked/checkout status of the asset.

lockInfo.assetId

int

The id of the asset that is locked. Same value as the assetId on the root of the response.

lockInfo.isLocked

boolean

true or false

If this file is locked/checked out by someone.

lockInfo.lockedByMemberId

int/null

The id of the user that has locked this asset, or null if not locked.

lockInfo.expirationDate

DateTimeOffset/null

The date when the lock will automatically open if not renewed before, or null if not locked.

lockInfo.note

string/null

An optional note that was passed in when the asset was locked, or null if not locked or no note.

assetIds

[123456, 789456]

The asset ids of the assets to get.

itemIds

[456123, 456789]

The item ids of the assets to get.

itemGuids

["2D569054-068E-4396-9773-F906CFDA70E0", "78B778DB-DDDF-4555-A833-7506704A3D66"]

The item guids of the assets to get.

metaFieldItemGuids

metaFieldItemGuids=6afe78b7-3f24-49f3-bf95-24890ea62696&metaFieldItemGuids=bf0ad1a6-984a-494e-a227-9d70c6a864f9

Optional parameter for additional metadata to get for each asset. The metadata response uses the same exact response format as the general metadata editor API. See INSERT LINK HERE!!!!

languageId

languageId=3

Optional parameter to overwrite the language the asset is returned in. If not passed, the language id from the access key will be used.