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.

External Links API

The External Links API is a REST API that enables the caller to maintain and search for external identifiers and external references attached to open metadata elements.

Key Features

  • External Reference Management: Support for creating, retrieving, updating, and deleting external references (links to resources outside of the open metadata ecosystem).
  • External Identifier Management: Support for adding, updating, and deleting external identifiers that link an open metadata element to its equivalent in an external system.
  • Relationship Management:
    • Linking external references to any metadata element.
    • Managing specialized external references such as media references and cited document references.
    • Managing the synchronization status and confirmation of external identifiers.
  • Discovery and Search: Finding external references and external identifiers by name, search strings, or through their unique identifiers (GUIDs).

Further information

Sample REST API requests can be found in Egeria-api-external-links.http.

Raise an issue or comment below