Enhance GET API calls so Labels (or Functional Values) are returned for attributes of all DataTypes along with their GUIDs

christopher.fredrickson 3 months ago in Digital Asset Management updated by petra.tant 1 month ago 4

Business Context:

Aprimo DAM which acts as Enterprise DAM in SE needs to integrate with other platforms managing Product data such as PIM, BSL, etc. with these integrations expected to be performed using Aprimo DAM REST APIs. These integrations are either required to link the Digital Asset Records in Aprimo with SE’s Commercial References/Product Ranges or for some of the Product Data related workflows in PIM.

Enhancement Request Details:

When using Aprimo DAM APIs to “retrieve” or “GET” record details, the Values for Text Fields are returned in the API response along with their GUIDs. However, when it comes to attributes of other Data Types such as ClassificationList or OptionList, only the GUIDs are returned and not the “Labels” (aka functional values) for those attributes. SE requests Aprimo to enhance the GET API calls so that the Labels (or Functional Values) are returned for attributes of all DataTypes along with their GUIDs – for the following reasons:

  • The DAM API consumers will not be interested in the GUIDs of Aprimo DAM
  • SE architecture guidelines do not encourage replicating or caching the GUID-to-Label mappings outside that platform (Aprimo in this case)
  • Enforcing additional API calls from API consumers to retrieve the Label values from this GUID for each of these attributes translates to poor developer experience and an inefficient integration design


On a Digital Asset Record, consider an OptionList type attribute “Owner Scope” with Labels and GUIDs in the list:

Global :: aaaa-bbb-cccc-ddd

Local :: wwww-xxx-yyyy-zzz

The current GET /record API with the Owner Scope for an asset set to “Global” returns only “aaaa-bbb-cccc-ddd” in the API response and not the Label “Global”. The request is to return the Label “Global” in the API response as well, given that the API consumers will be interested in this value and not the GUID for this label.

Fields / Attributes API

For now we're putting this enhancement request in shelved state to understand through voting how common this request is and/or because we will not be able to pick this up in our near term roadmap schedule (<6 Months).

I forgot to add, this is related to this other request which was recently qualified: https://voice.aprimo.com/communities/42/topics/2191-event-driven-architecture-or-web-hooks-of-aprimo-dam

This request is also being entered at the direction of Joris Wynendaele and Andrew Conforti