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.
Data Designer API¶
The Data Designer API provides a REST API to support user interfaces (UIs) relating to the definition of data structures, data fields and data value specifications. These can be assembled into data specifications to describe the data requirements for a project or digital product.
Key Features¶
The Data Designer API supports the following key concepts:
- Data Structures: Reusable definitions of the structure of data (e.g., a record or a message).
- Data Fields: Individual fields within a data structure.
- Data Value Specifications: Definitions of the valid values and formats for data, including data classes and data grains.
- Data Specifications: Assembly of data structures and fields with semantic definitions (glossary terms) and data value specifications to provide a complete description of data requirements.
These definitions can also be linked to certification types to guide automated data quality checks.
Further information¶
- Data Structure Concept
- Data Field Concept
- Data Value Specification Concept
- Data Specification Concept
Sample requests for the REST API can be found in Egeria-api-data-designer.http. In addition:
- Egeria.coco-create-data-spec.http provides an example of creating a data specification.
- Egeria-jacquard-data-design.http provides an example of using the Data Designer API to review data specification from the Open Metadata Digital Product Catalog.
Raise an issue or comment below