Skip to content
Stable

This component is complete and can be used. The interfaces will be supported until the function is removed from the project via the deprecation process. There will be ongoing extensions to this function, but it will be done to ensure backward compatibility as far as possible. If there is a need to break backward compatibility, this will be discussed and reviewed in the community, with a documented timeline.

Reference Data API

The Reference Data API provides a REST API to support user interfaces (UIs) relating to the capture and maintenance of reference data such as code tables and valid metadata values.

Key Features

The Reference Data API supports the following key features:

  • Valid Value Definition Management: Creation, retrieval, update and deletion of valid value definitions.
  • Valid Value Set Management: Organizing valid values into sets and hierarchies to represent code tables and taxonomies.
  • Reference Data Mapping: Linking valid values to their equivalents in different systems to support synchronization and mapping.
  • Implementation and Consumption Tracking: Identifying which systems and data fields use specific reference data.
  • Discovery and Exploration: Tools for finding valid value definitions by name, search string, or unique identifier.

Further information

Sample requests for the REST API can be found in Egeria-api-reference-data.http. Egeria-coco-sales-territories.http shows how to use the Reference Data API to create a reference data set.

Raise an issue or comment below