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.
Asset Catalog API¶
The Asset Catalog API provides a REST API to search for digital resources (assets) that are catalogued in open metadata. It also enables the caller to retrieve asset properties, schema, lineage and other related information.
Key Features¶
The Asset Catalog API supports the following key features:
- Asset Search: Locate assets using a search string or regular expression across the asset domain.
- Asset Graphs: Retrieve all elements anchored to an asset, including their relationships, to visualize the asset's structure and context.
- Lineage Graphs: Explore the lineage of an asset to understand how data flows in and out of it, including relationships from the asset itself and its anchored schema elements.
- Supported Types: Query the subtypes of assets supported by the ecosystem.
API Operations¶
The Asset Catalog API provides services to search for data resources including:
- data stores
- event feeds
- APIs
- data sets
The search locates data resources based on the content of the asset metadata itself and the metadata that links to it. This includes:
- glossary terms
- schema elements
- assets
- lineage
The Asset Catalog REST API supports:
- the retrieval of assets based on unique identifiers
- the retrieval of asset's relationships and classifications
- the query for related assets and lineage
- the retrieval of assets based on their type
- the retrieval of glossaries and their content
Further information¶
Sample requests for the REST API can be found in Egeria-api-asset-catalog.http.
Raise an issue or comment below