IMP Object Types

Below are the Flex object types that support IMP:

IMP Asset

The IMP asset type is treated as both a package and a group asset. This means that it can have group members, much in the same way as an ordinary group asset. The members of an IMP asset reference the package components, such as CPL, MXFs, images, OPL, and media assets. The IMP technical details reference the imported asset map and PKL metadata information, stored internally in ArangoDB. This metadata is saved using Flex metadata definitions taken from the asset map and PKL XML schemas.

You can create and manage composition asset tracks and asset tracks, using the REST API:

GET:/api/assets/{uuid1}/compositionAssetTracks/{uuid2}: Retrieves all composition asset track(s) for a CPL, along with the asset track data.

POST: /api/assets/{uuid1}/compositionAssetTracks: Creates a new composition asset track for a CPL asset and sets the properties.

Body:

{
uuid: <value>,
name: <value>
}

PUT: /api/assets/{uuid1}/compositionAssetTracks/{uuid2}</samp>: Updates a composition asset track for a CPL asset.

Body:

{
name:<value>
}

GET: /api/assets/{uuid1}/compositionAssetTracks/{uuid2}/assetTracks</samp>: Retrieves existing asset tracks along with the asset track data.

POST: /api/assets/{uuid1}/compositionAssetTracks/{uuid2}/assetTracks</samp>: Creates a new asset track for a CPL asset and sets the properties.

Body:

    {
        uuid:<value>,
        name:<value>,
        trackType:<value>,
        sequenceUuid:<value>,
        trackUuid:<value>
    }

PUT:/api/assets/{uuid1}/compositionAssetTracks/{uuid2}/assetTracks/{uuid3}</samp>: Updates composition asset tracks for a CPL asset.

Body:

    {
        name:<value>,
        trackType:<value>,
        sequenceUuid:<value>,
        trackUuid:<value>
    }

CPL Asset

The CPL asset references a Composition Asset Track. This contains 0 or multiple asset tracks (these are Flex entities following IMP resource definitions). CPL assets are created using the same REST endpoint as for media assets.

Asset tracks reference Flex sequences for each track type, for example: images, audio tracks, and subtitles. A Flex sequence represents each of the MXF compositions per track type in the CPL.

The CPL technical details reference imported CPL metadata information, stored internally in ArangoDB. This metadata is saved using the Flex metadata definitions taken from CPL XML schemas.