BIRD API v2 documentation (OpenAPI)

Zusammenfassung

Es handelt sich um ein technisch-formales OpenAPI-3.0.3-Dokument für die BIRD API der Europäischen Zentralbank, verfügbar unter https://bird.ecb.europa.eu/api/v2. Die dokumentierte Version der Schnittstelle ist 2.0.0 und bietet primär als „Simplified endpoints“ gekennzeichnete Zugriffe auf das BIRD-/SMCube-Informationsmodell. Inhaltlich beschreibt das Dokument REST-Endpunkte zum Abruf von Entitäten (Cubes), Attributen (Variables), Wertkombinationen (Combination objects), Datenmodellen (Cube Hierarchy), Mappings sowie dazugehörigen Lineage-Informationen. Mehrere Endpunkte liefern Informationen über Allowed Values und deren Hierarchien (Member, Member Hierarchy), die Zuordnung dieser Werte zu Entitäten sowie die hierarchische Struktur ganzer Datenmodelle. Andere Endpunkte adressieren Mapping-Objekte zwischen nicht-referenziellen und Referenz-Variablen bzw. -Entitäten (Variable/Cube Mapping) und stellen damit die Verbindung zwischen verschiedenen Codifikationssystemen und dem harmonisierten SDD-Wörterbuch her. Spezielle Lineage-Endpunkte (IncomingRenderingLogicalLineage) erläutern die logische Herkunft von Datenpunkten in Rendering-Tabellen, einschließlich der eingesetzten Transformationsalgorithmen und Filter, soweit verfügbar. Die API unterstützt umfangreiche Filter- und Steuerungsparameter wie Codes, BusinessIds, FrameworkCodes, Versionen, Gültigkeitszeiträume, Pagination (start, limit), Sortierung und Ausgabeformat (JSON oder XML). Im Komponentenbereich referenziert das Dokument zentrale BIRD-/SMCube-Schemata wie AllowedValue, AllowedValueHierarchy, Attribute, DataModel, Entity, Mapping, ValueCombination, RenderingTable und verschiedene Lineage-Objekte, während einige Schema-Endpunkte kommentiert und damit derzeit inaktiv sind.