Asset Metadata Payload Structure
  • 3 Minutes to read
  • Dark
    Light

Asset Metadata Payload Structure

  • Dark
    Light

Article summary

Below you can see how the Asset metadata is structured.

GET


Headers

Authorization: Specify required Auth Token in the header.

Request Parameters

Expand to see the parameters and description


Parameter  Parameter TypeData TypeAccepted ValuesDescription
NameRequiredStringAn asset filename.Specifies the asset's filename.
TagsOptionalArray of StringsAny tags desired.Provides an array of tags applicable to an asset.
BinaryAssetIdRequired
StringGUIDBinary asset identifier.
CollectionCountOptionalIntegerCollection countA number of collections.
UploadDateRequired
IntegerYYYY-MM-DDDetermines an upload date.
SourceUrlRequired
StringAn asset's source URLEnsures the asset is not duplicated. 
StatsRequired
Array of StringsAsset detailsIncludes information about the asset file.
IdPart of StatsStringAn asset GUIDIt's an asset identifier.
BinaryIdPart of StatsStringThe binary file GUIDIdentifier of a binary file.
HashPart of StatsStringChecksum used for validationContains a hash for the validation of assets.
DescriptionPart of StatsStringA file nameDescribes a file name.
HeightPart of StatsIntegerHeight in pixelsDefines an asset height.
WidthPart of StatsIntegerWidth in pixelsDefines an asset width.
FormatPart of StatsStringA file formatDefines a file format for example: jpg, png, jpeg.
FileSizePart of StatsIntegerSize in bytesGives info about the file size.
DPIPart of StatsFloatDPI of an asset.Provides info about an asset DPI.
HasClippingPathPart of StatsBooleanTrue/FalseDefines if an asset has a clipping path included.
FramesPart of StatsIntegerDefault is 1
DurationPart of StatsFloatDefault is 0.0
CodecPart of StatsStringCodec type e.g. mjpegSets a codec type of an image.
IsArchivedOptionalBooleanTrue/FalseDefines if an asset is archived.
AltTextOptionalArray of StringsIncludes a locale and a description.Used for accessibility purposes.
IdRequired
StringAsset GUID.It's an asset identifier.
DataOwnerRequired
String
GUID
Company ID GUID
AuditInfoOptionalArray of StringsExamples: CreateDate, CreatorName.Provides audit data.
ContextIdPart of AuditInfoStringContext GUID
CreateDatePart of AuditInfoStringYYYY-MM-DDProvides a create date.
CreatorIdPart of AuditnfoStringCreator GUIDProvides the creator identifier.
CreatorNamePart of AuditInfoStringCreator first & last nameProvides info on the creator of the asset.
LastModifiedDatePart of AuditInfoStringYYYY-MM-DDShows the last modified date.
PrincipleId
Part of AuditInfoStringPrinciple GUIDAn identifier of the principle.
PrincipleName
Part of AuditInfoStringPrinciple first & last name
MachineName
Part of AuditInfoStringMachine Id
Properties
Required
Array of StringsAsset properties
Provides you with information about the asset properties.
SpecialPurpose
Part of PropertiesStringExample:
Ad, Marketing
Used for specifying the purpose of an asset. 
Variant
Part of Properties
String
TBAMakes it easy to set variants for assets.
CPVIdentifier
Part of Properties
String
Identifier
TBA
ContentDescription
Part of Properties
String
A description of the asset's contentTBA
FileFormatDescription
Part of Properties
String
File format description.
FileOptimalViewerName
Part of Properties
String


FileOriginCountry
Part of Properties
String
Country of origin
FileCameraPerspective
Part of Properties
String
Example: FrontProvides information about the camera perspective.
IsPrimaryFile
Part of Properties
BooleanTrue/FalseDefines if the file is primary.
IsBackgroundTransparent
Part of Properties
Boolean
True/False
Marks if the background of an asset is transparent.
AssetMetadataIsLocked
Part of Properties
Boolean
True/False

image.png

Response 200 OK


{
    "Name": "Banana.jpg",
    "Tags": [
        "Banana Fruit Exotic Yellow Fresh"
    ],
    "BinaryAssetId": "d15b778e-55a4-42d5-b20d-8bedc141fbc9",
    "CollectionCount": 0,
    "UploadDate": "2023-04-24T21:19:48.9275248Z",
    "SourceUrl": "https://images.unsplash.com/photo-1587132137056-bfbf0166836e",
    "Stats": {
        "id": "d15b778e-55a4-42d5-b20d-8bedc141fbc9",
        "BinaryId": "d15b778e-55a4-42d5-b20d-8bedc141fbc9",
        "Hash": "0d2900fd4a16d7c80dbf2902db996923b5bcf62d017fa10d08ccd5655c9ff0ba",
        "Description": "Banana.jpg",
        "Height": 4048,
        "Width": 4048,
        "Format": "jpeg",
        "FileSize": 2537487,
        "ExifInfo": [
            "ImageWidth (Short): 3923",
            "ImageLength (Short): 3923",
            "BitsPerSample (Short): ImageMagick.ExifShortArray",
            "Compression (Short): Adobe Deflate",
            "PhotometricInterpretation (Short): RGB",
            "Make (String): Canon",
            "Model (String): Canon EOS 6D",
            "Orientation (Short): Horizontal (normal)",
            "SamplesPerPixel (Short): 3",
            "XResolution (Rational): 3000000/10000",
            "YResolution (Rational): 3000000/10000",
            "PlanarConfiguration (Short): Chunky",
            "ResolutionUnit (Short): Inches",
            "Software (String): Adobe Photoshop 21.0 (Windows)",
            "DateTime (String): 2020:04:16 17:52:40",
            "ExposureTime (Rational): 1/4",
            "FNumber (Rational): 14",
            "ExposureProgram (Short): Manual",
            "ISOSpeedRatings (Short): ImageMagick.ExifShortArray",
            "SensitivityType (Short): Recommended Exposure Index",
            "RecommendedExposureIndex (Long): 100",
            "ExifVersion (Undefined): ImageMagick.ExifByteArray",
            "DateTimeOriginal (String): 2019:07:28 22:53:18",
            "DateTimeDigitized (String): 2019:07:28 22:53:18",
            "ShutterSpeedValue (SignedRational): 2",
            "ApertureValue (Rational): 761471/100000",
            "ExposureBiasValue (SignedRational): 0",
            "MaxApertureValue (Rational): 3",
            "MeteringMode (Short): Center-weighted average",
            "Flash (Short): Off, Did not fire",
            "FocalLength (Rational): 100",
            "SubsecTimeOriginal (String): 6",
            "ColorSpace (Short): sRGB",
            "PixelXDimension (Short): 4048",
            "PixelYDimension (Short): 4048",
            "FocalPlaneXResolution (Rational): 49807360/32768",
            "FocalPlaneYResolution (Rational): 49807360/32768",
            "FocalPlaneResolutionUnit (Short): Centimeter",
            "CustomRendered (Short): 0",
            "ExposureMode (Short): Manual",
            "WhiteBalance (Short): Manual",
            "SceneCaptureType (Short): Standard",
            "SerialNumber (String): 122128000061",
            "LensInfo (Rational): ImageMagick.ExifRationalArray",
            "LensModel (String): EF100mm f/2.8L Macro IS USM",
            "LensSerialNumber (String): 000005743a"
        ],
        "Dpi": {
            "X": 300.0,
            "Y": 300.0
        },
        "HasClippingPath": false
    },
    "IsArchived": false,
    "AltText": {},
    "id": "d15b778e-55a4-42d5-b20d-8bedc141fbc9",
    "DataOwner": "3b904928-20b7-413e-bda6-28edf4b2ff31",
    "AuditInfo": {
        "ContextId": "a12e464b-ed2c-49b8-8ed1-87b962547d50",
        "CreateDate": "2023-04-24T21:19:48.942789Z",
        "CreatorId": "d8c859b9-f622-40b6-8565-87e0175bcb5f",
        "CreatorName": "Admin",
        "CreatorImpersonator": {
            "Id": "d946ce82-88e8-453e-9a77-e056b33082ea",
            "Name": "Service User"
        },
        "LastModifiedDate": "2024-10-15T16:10:17.9336624Z",
        "PrincipleId": "a56dcfe1-b1e8-465c-af6d-625f32302258",
        "PrincipleName": "Admin",
        "MachineName": "assetservice-55c645866-xdvjd"
    },
    "Properties": {
        "Angle": "C",
        "Facing": "1",
        "ImageType": "A",
        "State": "0",
        "Variant": "First",
        "ContentDescription": "The image contains a banana.",
        "FileFormatDescription": "jpg",
        "FileOptimalViewerName": "90 degrees",
        "FileOriginCountry": "Internet",
        "IsPrimaryFile": "true",
        "IsBackgroundTransparent": "true",
        "AssetMetadataIsLocked": "true"
    },
    "Partition": "d15b778e-55a4-42d5-b20d-8bedc141fbc9",
    "Type": "Asset"
}


Was this article helpful?

Changing your password will log you out immediately. Use the new password to log back in.
First name must have atleast 2 characters. Numbers and special characters are not allowed.
Last name must have atleast 1 characters. Numbers and special characters are not allowed.
Enter a valid email
Enter a valid password
Your profile has been successfully updated.
ESC

Eddy AI, facilitating knowledge discovery through conversational intelligence