Renditions

Renditions are a version of a file stored in DAM that have undergone some type of transformation. These transformation are typically conversions or transcoding of the main file. They can be simple file type conversions or more specific renditions such as crops and trims. Users in the DAM typically are familiar with this mechanism as ‘additional files’. As an example, if you have a large video file, transcoding this into a social media mp4 version may take some time. Ideally, you would usually want these renditions generated by DAM Rules, so they can be ready when they are needed. However, sometimes it is unavoidable and you must generate a rendition on the fly. This can be accomplished using a maintenance job in the Aprimo DAM REST API.

To learn more about the options available when making a rendition refer to the training documentation.

The system setting where all renditions are defined in in the “.renditionPreset” setting. To generate a rendition, the rendition must be defined in this system setting.

The below example is an empty example showing the format of the request

curl --location 'https://{aprimoTenant}.dam.aprimo.com/api/core/maintenancejobs' \
--header 'Authorization: Bearer {accessToken}' \
--header 'API-VERSION: 1' \
--header 'Content-Type: application/json' \
--data '
{
   "type": "record",
   "targets": 
   [
      {
         "recordId": {recordId}
      }
   ],
   "actions": 
   [
      {
          "action": "CreateRenditions",
          "parameters": 
             {
               "presets": 
                  [
                     {renditionPresetName}
                  ]
             }
       }
   ]
}'

Remove Background

To create a rendition that has had it’s background removed, define the rendition like below

<add name="removeBG" format="png" usages="AI Renditions" aiActions="removeBackground" />

Then make the following request

curl --location 'https://{aprimoTenant}.dam.aprimo.com/api/core/maintenancejobs' \
--header 'Authorization: Bearer {accessToken}' \
--header 'API-VERSION: 1' \
--header 'Content-Type: application/json' \
--data '
{
   "type": "record",
   "targets": 
   [
      {
         "recordId": {recordId}
      }
   ],
   "actions": 
   [
      {
          "action": "CreateRenditions",
          "parameters": 
             {
               "presets": 
                  [
                     "removeBG"
                  ]
             }
       }
   ]
}'