Egeria's API¶
Egeria's APIs provide task oriented, domain-specific REST APIs to open metadata and governance. They can be consumed directly by application such as a JavaScript web user interface. The python support in pyegeria also uses these APIs.
The APIs are secured with bearer tokens served up by the OMAG Server Platform that is hosting the view services. The source of the user information used to create and verify the bearer tokens is pluggable through the metadata security connectors.
Generic API Services¶
This first collection of view services provide generic function, using in many situations.
| API | Summary | Description |
|---|---|---|
| Actor Manager | Create and maintain actor information. | The Actor Manager API is a REST API to set up actor profiles, contact details, contribution records, actor roles and user identities. |
| Asset Maker | Create and maintain asset information. | The Asset Maker API is a REST API to set up all types of assets and software capabilities. |
| Automated Curation | Discovery, initiate and monitor metadata cataloging and governance actions such as automated surveying. | The Automated Curation API is a REST API that allows asset owners and consumers to set up, execute and monitor automated harvesting and governance services. |
| Classification Explorer | Query elements via their type, classifications and relationships. | The Classification Explorer API enables the caller to issue queries to understand how metadata elements are linked and classified. |
| Classification Manager | Manage relationships and classifications used to enrich details of elements. | The Classification Manager API enables the caller to maintain key classifications and relationships on elements. It is designed to support curaiton and stewardship. |
| Collection Manager | Manage collections of assets and other elements. | The Collection Manager API provides the REST APIs to create collections of asset and other elements such as glossary terms or policies. The collections can be nested (like folders in a file system) and they can be classified to describe the type of collection. For example, one type of classification for a collection is a DigitalProduct that allows the collections of assets and other related material to describe data and or services for a specific consumer or purpose. |
| Connection Maker | Create and maintain connection information for assets. | The Connection Maker API is a REST API to set up connectios, connector types and endpoints. |
| External Links | Maintain information about external sources and identifiers. | The External Links API manages details of external identifiers that capture the identifier for elements that are replicated in multiple systems/tools, as well as details of external sources such as external data sets, related media and models. |
| Feedback Manager | Maintain feedback such as comments, tags, reviews, likes and note logs. | The Feedback Manager API manages feedback from users. A registered user is able to add comments, informal tags, notes, reviews and likes to elements such as assets or glossary terms. |
| Governance Officer | Maintain governance definitions used to define any governance domain. | The Governance Officer API is a REST API supporting the creation and editing of a new governance domain. |
| Lineage Linker | Maintain lineage relationships. | The Lineage Linker API is a REST API supporting the creation and maintenance of lineage relaitonships. |
| Metadata Expert | Generic operations for maintining open metadata. | The Metadata Expert API is a REST API supporting the maintenance of open metadata using the generic API. It is an advanced API for users that understand the Open Metadata Types. |
| Metadata Explorer | Generic search, query and retrieval operations for open metadata. | The Metadata Explorer API is a REST API supporting the search, query and retrieval of open metadata. It is an advanced API for users that understand the Open Metadata Types. |
| Multi Language | Maintains translations for open metadata attributes in one or more languages. | The Multi Language API is a REST API supporting the maintenance of translations for open metadata. |
| Schema Maker | Create and maintain schema information for assets. | The Schema Maker API is a REST API to set up the schema elements that describe the structure of data associated with assets. |
| Time Keeper | Create and maintain context events used to identify significant events. | The Time Keeper API is a REST API that support the management of context events, used to describe significant events that affect the performance of organizations and hence data values. |
| Valid Metadata | Create and maintain metadata valid values. | The Valid Metadata API is a REST API that queries and maintains lists of valid values for open metadata attributes as well as query open metadata type definitions. |
Standard APIs¶
The specialized APIs are as follows. They focus on supporting specific types of users and scenarios. They are typically used in conjunction with one or more generic APIs.
| API | Summary | Description |
|---|---|---|
| Action Author | Create and maintain governance actions. | The Action Author API is for user interfaces supporting the governance team to set up governance actions. |
| Asset Catalog | Search for assets. | The Asset Catalog API provides search and query capabilities for tools and applications to support an asset catalog function. It supports search requests for assets with specific characteristics and returns summaries of the matching assets, plus methods to allow drill-down into the details of a specific asset to related metadata. |
| Community Matters | Maintains community information. | The Community Matters API is a REST API supporting the maintenance of communities. |
| Data Designer | Define data requirements. | The Data Designer API is a REST API for building specifications for data. This includes common data fields in a data dictionary, data specifications for a project and data classes for a subject area. |
| Data Discovery | Maintain survey reports | The Data Discovery API is a REST API for locating the data needed for a project. |
| Data Engineer | Maintain data management processes and work with physical data. | The Data Engineer API is a REST API for supporting the metadata for data pipelines and data management services. |
| Data Officer | Manage the governance of data. | The Data Officer API is a REST API for supporting a Data Officer as they lead the data governance program. This builds on the capabilities of the Governance Officer API. |
| Devops Pipeline | Maintain the metadata about the assets managed by a devops pipeline. | The Devops Pipeline API is a REST API for supporting a devops engineer to maintain the metadata about the changing digital resources being deployed through devops pipelines. |
| Digital Business | Maintain business capabilities. | The Digital Business API is a REST API for supporting the maintenance of business capabilities information. |
| Glossary Manager | Develop new glossary terms optionally in a controlled workflow process. | The Glossary Manager API is a REST API supporting the creation and editing of glossary content, such as glossary terms and categories, in a controlled workflow process. This means that as terms and categories are created, updated and deleted, these changes are invisible to the general user until they are approved. |
| Location Arena | Maintain location informaiton and linkage. | The Location Arena API is a REST API supporting the creation and editing of location information and how they relate to one another. |
| My Profile | Locate, retrieve and update information relating to the calling user's profile. | The My Profile API is a REST API supporting a personalized experience. A registered user is able to maintain information about themselves, their roles and their network. |
| Notification Manager | Locate, retrieve and update the types of user notifications that should be produced. | The Notification Manager API is a REST API supporting personalized notifications to specific users. A registered user is able to define which types of notification should be produced and who they should be delivered to. |
| People Organizer | Describe teams, roles and organizational structure. | The People Organizer API provides the REST APIs used to maintain information about an organization. This includes the definitions of teams, roles and organization structures. |
| Privacy Officer | Manage the governance of privacy. | The Privacy Officer API is a REST API for supporting a Privacy Officer as they lead the data privacy governance program. This builds on the capabilities of the Governance Officer API. |
| Product Catalog | Locate relevant digital products and manage subscriptions. | The Product Catalog API is a REST API for supporting product catalog searches and subscriptions to products. |
| Product Manager | Locate, retrieve and update information relating to digital products. | The Product Manager API is A REST API supporting the management of digital products, |
| Project Manager | Locate, retrieve and update information relating to projects. | The Project Manager API is a REST API supporting projects, either for a group of people or personalized sandboxes for individuals. A registered user is able to maintain information about a project and link it with other projects, users and resources. |
| Reference Data | Create and maintain reference data values and their mappings. | The Reference Data API is a REST API that maintain reference data values and their mappings. |
| Runtime Manager | Retrieve status information about Egeria's OMAG Server Platform and OMAG Servers. | The Runtime Manager API is a REST API that displays operational status about Egeria. |
| Security Officer | Manage the governance of security. | The Security Officer API is a REST API for supporting a Security Officer as they lead the security governance program. This builds on the capabilities of the Governance Officer API. |
| Solution Architect | Maintain the metadata about information supply chains and solution components. | The Solution Architect API is a REST API relating to the definition and display of solution blueprints and their supporting solution components along with the relevant information supply chains. |
| Subject Area | Maintain the metadata about subject areas. | The Subject Area API is a REST API relating to the definition and display of Subject Area definitions. |
| Template Manager | Create and maintain templates used to create new metadata elements. | The Template Manager API is a REST API that support the management of templates that are used when creating new metadata. |
Inside an API¶
Egeria's APIs are deployed together in a View Server. PyEgeria and external services connect to an API through its REST API. The REST API interacts with a remote Metadata Access Server to retrieve and maintain metadata.
Each API is secured with a bearer token. When a request is received, the view server validates the userId in the bearer token. The userId is passed in the URL on the calls between the Vire Server and the Metadata Access Store. These requests are secured with the View Server's bearer token and optional SSL certificates. Details of the user are included in the repository header of any element that is created, updates or deleted by the user.
Configuring an API¶
The View Server included in the standard runtime created by Egeria's build and Egeria Workspaces includes all of the APIs.
If you wish to create your own view server with selected APIs, see configure a View Server in the Administration Guide.