Common Object Properties

A number of resources have a standard set of common properties that are used to identify the resource and to provide basic information about the resource. Resources with common object properties include, for example:

  • Assets: aa:asset

    • Videos or audios with descriptive Meta data. Example: The recording of a soccer game.

    • Logical assets: An asset that contains Meta data of the series "Star Trek".

  • Folders and items in a folder: loc:item

Properties

A common object may have the following properties:

Property Description

base

A property with the basic platform identification for a resource.

common

A property with a set of common attributes.

status

A property with a list of status values. See Status of an aa:asset or loc:item for details.

Resources may have a number of additional properties. See the documentation of the individual resources for details.

Property "base"

The property base contains the ID quadruple for an entity. It has the following sub properties:

Sub property Description

systemType

Type of the object’s source system.

systemID

Unique identifier of the object’s source system in the scope of systemType.

type

Type of the object.

id

Unique identifier of the object in the source system identified by systemID

Example: MediaCentral Asset Management asset 
 
{
  "base": {
    "id": "2016011213534860101291561460050569B02260000012756B00000D0D000001",
    "type": "asset.VIDEO",
    "systemType": "interplay-mam",
    "systemID": "bb9d3d06-0e41-419e-8ae7-efdbbcbaa6e0"
  }
}

Property "common"

The property common may contain any of a set of well-defined common attributes. Typically, one cannot guarantee the presence of any of those attributes.

System-specific attributes can in some cases be put into an attributes property, e.g. for loc:item resources.

Currently, the following common properties are defined. In the future, more attributes may be added to this list.

Common properties

Sub property Type Description

assetType

string

The asset type if the entity is an asset (aa:asset) or references an asset, for example, like an item in a folder (loc:item).

assetTypeLabel

string

A label for the assetType in the given langage (query parameter lang) or in English.

created

datetime

Creation time of the entity. The value is a time like "2021-04-07T15:49:48+02:00".

creator

string

Login name of the user that created the entity.

description

string

Description for the entity.

name

string

Name of the entity.

modified

datetime

Last modification time of the entity. The value is a time like "2021-04-07T15:49:48+02:00".

modifier

string

Login name of the last user that modified the entity.

path

string

The path of the parent folder

 

Properties for assets with media

Sub property Type Description

editRate

string

the edit rate of the asset. The value is a fraction of integer values.

Examples: "25/1", "30000/1001".

dropframe

boolean

true if the video uses a drop-frame framerate.

duration

int

the length of the asset in edit units which are either frames or ms if there is no edit rate defined on the asset.

durationTC

string

The length of the media for this asset as a SMPTE timecode string, e.g. "00:00:03:00".

In case of a sub clip, this is the length of the sub clip.

startTC

string

The SMPTE timecode of the first frame of the video for this asset.

In case of a sub clip, this is the SMPTE timecode of the first frame of the sub clip.

endTC

string

The SMPTE timecode of the last frame of the video for this asset.

In case of a sub clip, this is the SMPTE timecode of the last frame of the sub clip.

 
New in MC | Cloud UX 2023.7 Please note that starting with MC | AM 2023.7 the handling of SMPTE timecode strings around midnight has changed. See timecodes in MC | AM for details.

 

Deprecated properties

Sub property Type Description

typeIcon

string

Direct link to the type icon in an AM system.

typeIconSmall

string

Direct link to the small type icon in an AM system.