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:
- Is metadata aware - that is, may contain additional metadata beyond its core properties.
- Is annotation aware - that is, may contain annotations or comments.
- Is semantic link aware - that is, may contain semantic links to other catalogue items.
- Is reference file aware - that is, may contain files or attachments for further reference material.
- 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:
- Classifiers
- Code sets
- Data classes
- Data class components
- Data elements
- Data element components
- Data flows
- Data models
- Data types
- Enumeration types
- Enumeration values
- Folders
- Model data types
- Primitive types
- Reference data elements
- Reference data models
- Reference data types
- Reference enumeration types
- Reference enumeration values
- Reference primitive types
- Reference types
- Terms
- Term relationships
- Term relationship types
- Terminologies
- 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:
Replace the {multiFacetAwareDomainType} parameter in these types of URL with a name listed above, remembering to:
- Remove spaces and whitespace in the domain names.
- Use
camelCase
for the domain name. - 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...