Skip to content

Multi facet aware

What does "multi-facet" aware mean?

The "multi-facet aware" trait can be applied to any Mauro catalogue item that has at least these traits:

  1. Is metadata aware - that is, may contain additional metadata beyond its core properties.
  2. Is annotation aware - that is, may contain annotations or comments.
  3. Is semantic link aware - that is, may contain semantic links to other catalogue items.
  4. Is reference file aware - that is, may contain files or attachments for further reference material.
  5. Is rule aware - that is, may contain rule information.

What items are "multi-facet" aware?

The following Mauro catalogue items are multi-facet aware by the definition listed above:

  1. Classifiers
  2. Code sets
  3. Data classes
  4. Data class components
  5. Data elements
  6. Data element components
  7. Data flows
  8. Data models
  9. Data types
  10. Enumeration types
  11. Enumeration values
  12. Folders
  13. Model data types
  14. Primitive types
  15. Reference data elements
  16. Reference data models
  17. Reference data types
  18. Reference enumeration types
  19. Reference enumeration values
  20. Reference primitive types
  21. Reference types
  22. Terms
  23. Term relationships
  24. Term relationship types
  25. Terminologies
  26. Versioned folders

Usage in REST API

The Mauro REST API has many operations that are replicated across multiple catalogue item types, such as:

  • Getting information on a catalogue item
  • Saving data to a catalogue item
  • Removing a catalogue item
  • And so on...

Many of these endpoints require a {multiFacetAwareDomainType} parameter in their URLs. One generalised example is fetching all metadata for a catalogue item:

/api/{multiFacetAwareDomainType}/{id}/metadata

Replace the {multiFacetAwareDomainType} parameter in these types of URL with a name listed above, remembering to:

  1. Remove spaces and whitespace in the domain names.
  2. Use camelCase for the domain name.
  3. Pluralise the domain name.

Some examples would be:

  • Folder becomes folders.
  • Data Model becomes dataModels.
  • Data Class becomes dataClasses.
  • Terminology becomes terminologies.
  • And so on...