Assets and Files

Asset

An asset is an object which describes the digital asset with related metadata and files. The asset itself does not define where or how the file exists physically, it only defines the metadata and how the file is to be referenced. Each asset has a unique identifier. The asset is always linked to one or more folders. User access permissions for the asset are inherited from these linked relations.

Asset Information

Asset id

Every asset has a unique id which can be used to fetch information, edit, or upload files.

*With the asset ID, you cannot download any files—you can only upload files (Masterfiles and attachments).

Files

Each file can have multiple file versions of which only one is considered to be an active version. Only active versions are accessible using REST API. Each file version has a unique identifier. The file version includes information about the type, name, etc. of the file. File version includes links to available conversions.

Master file

Defines the masterfile of the asset. An asset can contain only one masterfile. API shows only the active version of the masterfile. Past versions are not accessible via API.

Masterifle file id JSON path is x.MasterFile.Id

Attachments

Defines the attachments asset. An asset can contain multiple attachments (Array). API shows only the active version of the attachment. Past versions are not accessible via API.

Attachment file id JSON path is x.AttachedFiles[n].FileInfo.Id

Property fields

More information about property fields.

Folder Hierarchy

More information about folder hierarchy.

Asset Model JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://example.com/schemas/assets.schema.json",
  "title": "Assets",
  "type": "array",
  "items": { "$ref": "#/$defs/asset" },
  "$defs": {
    "asset": {
      "type": "object",
      "additionalProperties": true,
      "required": [
        "Id",
        "Name",
        "Description",
        "Created",
        "Modified",
        "StatusId",
        "PropertyValues",
        "Keywords",
        "LinkedFolders",
        "MasterFile",
        "AttachedFiles",
        "Editable"
      ],
      "properties": {
        "Id": { "type": "string" },
        "Name": { "$ref": "#/$defs/localizedStringMap" },
        "Description": { "$ref": "#/$defs/localizedStringMap" },
        "Created": { "type": "integer" },
        "Modified": { "type": "integer" },
        "PublishEnd": { 
            "type": "integer",
            "description":"Unix timestamp" 
        },
        "StatusId": { "type": "string" },
        "PropertyValues": {
          "type": "array",
          "items": { "$ref": "#/$defs/propertyValue" }
        },
        "Keywords": {
          "type": "array",
          "items": { "$ref": "#/$defs/keyword" }
        },
        "LinkedFolders": {
          "type": "array",
          "items": { "type": "string" }
        },
        "MasterFile": { "$ref": "#/$defs/fileInfoContainer" },
        "AttachedFiles": {
          "type": "array",
          "items": { "$ref": "#/$defs/attachedFile" }
        },
        "Editable": { "type": "boolean" }
      }
    },
    "localizedStringMap": {
      "description": "Multi-language string map.",
      "type": "object",
      "additionalProperties": { "type": "string" },
      "properties": {
        "x-default": { "type": "string" },
        "fi": { "type": "string" },
        "en": { "type": "string" },
        "ru": { "type": "string" },
        "sv": { "type": "string" },
        "de": { "type": "string" }
      }
    },
    "propertyValue": {
      "type": "object",
      "additionalProperties": true,
      "required": ["FieldIdentifier", "Value"],
      "properties": {
        "FieldIdentifier": { "type": "string" },
        "Value": { "$ref": "#/$defs/propertyValueUnion" }
      }
    },
    "propertyValueUnion": {
      "description": "Value can be a localized string map, a plain string, number/integer, or boolean.",
      "oneOf": [
        { "$ref": "#/$defs/localizedStringMap" },
        { "type": "string" },
        { "type": "integer" },
        { "type": "number" },
        { "type": "boolean" }
      ]
    },
    "keyword": {
      "type": "object",
      "additionalProperties": true,
      "required": ["Id", "Value"],
      "properties": {
        "Id": {
          "description": "Keyword Identifier",
          "type": "string"
        },
        "Value": { "$ref": "#/$defs/localizedStringMap" }
      }
    },
    "attachedFile": {
      "type": "object",
      "additionalProperties": true,
      "required": ["AttachmentType", "FileInfo"],
      "properties": {
        "AttachmentType": { "type": "string" },
        "FileInfo": { "$ref": "#/$defs/fileInfoContainer" }
      }
    },
    "fileInfoContainer": {
      "type": "object",
      "additionalProperties": true,
      "required": [
        "Id",
        "Filename",
        "Extension",
        "Created",
        "Size",
        "PreviewSupported",
        "Conversions",
        "Info"
      ],
      "properties": {
        "Id": { "type": "string" },
        "Filename": { "type": "string" },
        "Extension": { "type": "string" },
        "Created": {             
            "type": "integer",
            "description":"Unix timestamp" 
        },
        "Size": { "type": "integer" },
        "PreviewSupported": { "type": "string" },
        "Conversions": {
          "type": "array",
          "items": { "type": "string" }
        },
        "Info": { "$ref": "#/$defs/imageInfo" }
      }
    },
    "imageInfo": {
      "type": "object",
      "additionalProperties": true,
      "required": ["Height", "Width", "Unit", "Resolution", "Colorspace"],
      "properties": {
        "Height": { "type": "integer" },
        "Width": { "type": "integer" },
        "Unit": { "type": "string" },
        "Resolution": { "type": "integer" },
        "Colorspace": { "type": "string" }
      }
    }
  }
}