Webservice-Schnittstelle Metadaten
Bundesbank SDMX Web Service API
Alle in der Bundesbank-Zeitreihendatenbank gespeicherten Metadaten können mit der unten beschriebenen Abfragezeichenfolge abgerufen werden.
-
Beschreibung: Der Endpunkt gibt die angegebene Datastructure (z.B. BBK_ERX) zurück.
Protokoll https Pfad /metadata/datastructure/BBK/{resourceID} Basispfad https://api.statistiken.bundesbank.de/rest Rückgabeformat application/vnd.sdmx.structure+xml;version=2.1
application/xml
text/xml
Parameter
Name Beschreibung Beispiel resourceID Die ID der angefragten Datastructure. BBK_QFS Beispiel: https://api.statistiken.bundesbank.de/rest/metadata/datastructure/BBK/BBK_QFS
Rückgabeformat-Parameter
Mit dem „format“-Parameter ist es möglich, den Webdienst anzuweisen, Daten in verschiedenen Formaten zurückzugeben. Wenn kein "format"-Parameter angegeben ist, wird beim Rückgabeformat der Eintrag "Accept-Header“ berücksichtigt.
Der "format"-Parameter hat Vorrang gegenüber dem "Accept-Header".
Rückgabetyp Parameterwert Media type SDMX-ML 2.1 struct_xml
application_xml
text_xml
application/vnd.sdmx.structure+xml
application/xml
text/xml
Abfrageparameter
Name Beschreibung detail Mithilfe des „detail“- Parameters kann die gewünschte Menge an Informationen näher spezifiziert werden.
full: Alle verfügbaren Informationen werden zurückgegeben. Das ist die Default-Einstellung.
Beispiel:
https://api.statistiken.bundesbank.de/rest/metadata/datastructure/BBK/BBK_QFS?detail=fullallstubs: Alle Artefakte werden als stubs zurückgegeben.
Beispiel:
https://api.statistiken.bundesbank.de/rest/metadata/datastructure/BBK/BBK_QFS?detail=allstubsreferencestubs: Die verwiesenen Artefakte werden als stubs zurückgegeben.
Bespiel:
https://api.statistiken.bundesbank.de/rest/metadata/datastructure/BBK/BBK_QFS?detail=referencestubsreferences Mithilfe des „references“-Parameters kann der Webservice angewiesen werden, auch die durch die angefragte Datastructure referenzierten Artefakte zurückzugeben (Codelists und Conceptschemes). Ebenso können die Artefakte erhalten werden, die die angefragte Datastructure referenzieren (Dataflows).
none: Keine Verweise werden zurückgegeben. Das ist der default-Wert.
Beispiel:
https://api.statistiken.bundesbank.de/rest/metadata/datastructure/BBK/BBK_QFS?references=noneparents: Die Dataflow wird zurückgegeben.
Beispiel:
https://api.statistiken.bundesbank.de/rest/metadata/datastructure/BBK/BBK_QFS?references=parentschildren: Die Artefakte, auf die das Datastructure verweist, werden zurückgegeben.
Beispiel:
https://api.statistiken.bundesbank.de/rest/metadata/datastructure/BBK/BBK_QFS?references=childrendescendants: Alle Referenzen, bis zu jeder Ebene, werden ebenfalls zurückgegeben.
Beispiel:
https://api.statistiken.bundesbank.de/rest/metadata/datastructure/BBK/BBK_QFS?references=descendantsall: Die Gesamtmenge der Metadaten.
Beispiel:
https://api.statistiken.bundesbank.de/rest/metadata/datastructure/BBK/BBK_QFS?references=allcodelist: Die Codelisten, auf die das Datastructure verweist, werden zurückgegeben.
Beispiel:
https://api.statistiken.bundesbank.de/rest/metadata/datastructure/BBK/BBK_QFS?references=codelistconceptscheme: Die Conzeptscheme, auf die das Datastructure verweist, werden zurückgegeben.
-
Beschreibung: Der Endpunkt gibt alle Datastructures zurück.
Protokoll https Pfad /metadata/datastructure/BBK Basispfad https://api.statistiken.bundesbank.de/rest Rückgabeformat application/vnd.sdmx.structure+xml;version=2.1
application/xml
text/xml
Beispiel: https://api.statistiken.bundesbank.de/rest/metadata/datastructure/BBK
Rückgabeformat-Parameter
Mit dem „format“-Parameter ist es möglich, den Webdienst anzuweisen, Daten in verschiedenen Formaten zurückzugeben. Wenn kein "format"-Parameter angegeben ist, wird beim Rückgabeformat der Eintrag "Accept-Header“ berücksichtigt.
Der "format"-Parameter hat Vorrang gegenüber dem "Accept-Header".
Rückgabetyp Parameterwert Media type SDMX-ML 2.1 struct_xml
application_xml
text_xml
application/vnd.sdmx.structure+xml
application/xml
text/xml
-
Beschreibung: Der Endpunkt gibt den angegebenen Dataflow (z.B. BBEX3) zurück.
Protokoll https Pfad /metadata/dataflow/BBK/{resourceID} Basispfad https://api.statistiken.bundesbank.de/rest Rückgabeformat application/vnd.sdmx.structure+xml;version=2.1
application/xml
text/xml
Parameter
Name Beschreibung Beispiel resourceID Die ID des angefragten Dataflow. BBEX3 Beispiel: https://api.statistiken.bundesbank.de/rest/metadata/dataflow/BBK/BBEX3
Rückgabeformat-Parameter
Mit dem „format“-Parameter ist es möglich, den Webdienst anzuweisen, Daten in verschiedenen Formaten zurückzugeben. Wenn kein "format"-Parameter angegeben ist, wird beim Rückgabeformat der Eintrag "Accept-Header“ berücksichtigt.
Der "format"-Parameter hat Vorrang gegenüber dem "Accept-Header".
Rückgabetyp Parameterwert Media type SDMX-ML 2.1 struct_xml
application_xml
text_xml
application/vnd.sdmx.structure+xml
application/xml
text/xml
Abfrageparameter
Name Beschreibung detail Mithilfe des „detail“- Parameters kann die gewünschte Menge an Informationen näher spezifiziert werden.
full: Alle verfügbaren Informationen werden zurückgegeben. Das ist die Default-Einstellung.
Beispiel:
https://api.statistiken.bundesbank.de/rest/metadata/dataflow/BBK/BBEX3?detail=fullallstubs: Alle Artefakte werden als stubs zurückgegeben.
Beispiel:
https://api.statistiken.bundesbank.de/rest/metadata/dataflow/BBK/BBEX3?detail=referencestubsreferences Mithilfe des Referenzparameters können Sie den Webservice anweisen, die Artefakte zurückzugeben, auf die durch den zurückzugebenden Dataflow verwiesen wird (oder nicht).
none: Keine Verweise werden zurückgegeben. Das ist der default-Wert.
children: Die Artefakte, auf die das Dataflow verweist, werden zurückgegeben.
descendants: Alle Referenzen, bis zu jeder Ebene, werden ebenfalls zurückgegeben.
all: Die Gesamtmenge der Metadaten.
datastructure: Die Datastructure, auf die das Dataflow verweist, wird zurückgegeben.
-
Beschreibung: Der Endpunkt gibt alle angebotenen Dataflows zurück.
Protokoll https Pfad /metadata/dataflow/BBK Basispfad https://api.statistiken.bundesbank.de/rest Rückgabeformat application/vnd.sdmx.structure+xml;version=2.1
application/xml
text/xml
Beispiel: https://api.statistiken.bundesbank.de/rest/metadata/dataflow/BBK
Rückgabeformat-Parameter
Mit dem „format“-Parameter ist es möglich, den Webdienst anzuweisen, Daten in verschiedenen Formaten zurückzugeben. Wenn kein "format"-Parameter angegeben ist, wird beim Rückgabeformat der Eintrag "Accept-Header“ berücksichtigt.
Der "format"-Parameter hat Vorrang gegenüber dem "Accept-Header".
Rückgabetyp Parameterwert Media type SDMX-ML 2.1 struct_xml
application_xml
text_xml
application/vnd.sdmx.structure+xml
application/xml
text/xml
-
Beschreibung: Der Endpunkt gibt die ausgewählte Codelist zurück (zum Beispiel CL_BBK_ERX_RATE_TYPE).
Protokoll https Pfad /metadata/codelist/BBK/{resourceID} Basispfad https://api.statistiken.bundesbank.de/rest Rückgabeformat application/xml
application/vnd.sdmx.structure+xml;version=2.1
text/xml
application/vnd.sdmx.structure+json;version=1.0.0
Parameter
Name Beschreibung Beispiel resourceID Die ID der angefragten Codelist. CL_BBK_ERX_RATE_TYPE Beispiel: https://api.statistiken.bundesbank.de/rest/metadata/codelist/BBK/CL_BBK_ERX_RATE_TYPE
Rückgabeformat-Parameter
Mit dem „format“-Parameter ist es möglich, den Webdienst anzuweisen, Daten in verschiedenen Formaten zurückzugeben. Wenn kein "format"-Parameter angegeben ist, wird beim Rückgabeformat der Eintrag "Accept-Header“ berücksichtigt.
Der "format"-Parameter hat Vorrang gegenüber dem "Accept-Header".
Rückgabetyp Parameterwert Media type SDMX-ML 2.1 struct_json
struct_xml
application_xml
text_xml
application/vnd.sdmx.structure+json
application/vnd.sdmx.structure+xml
application/xml
text/xml
Abfrageparameter
Name Beschreibung detail Mithilfe des „detail“- Parameters kann die gewünschte Menge an Informationen näher spezifiziert werden.
full: Alle verfügbaren Informationen werden zurückgegeben. Das ist die Default-Einstellung.
Beispiel:
https://api.statistiken.bundesbank.de/rest/metadata/codelist/BBK/CL_BBK_ERX_RATE_TYPE?detail=fullallstubs: Alle Artefakte werden als stubs zurückgegeben.
referencestubs: Die verwiesenen Artefakte werden als stubs zurückgegeben.
references Mithilfe des Referenzparameters können Sie den Webservice anweisen, die Artefakte zurückzugeben, auf die durch die zurückzugebende Codelist verwiesen wird (oder nicht).
none: Keine Verweise werden zurückgegeben. Das ist der default-Wert.
all: Die Gesamtmenge der Metadaten.
parents: Die Artefakte, die die Codelist verwenden, werden zurückgegeben.
parentsandsiblings: Die Artefakte, die die Codelist verwenden, sowie die von diesen Artefakten referenzierten Codelisten, werden zurückgegeben.
-
Beschreibung: Der Endpunkt gibt alle ausgewählten Codelisten zurück.
Protokoll https Pfad /metadata/codelist/BBK Basispfad https://api.statistiken.bundesbank.de/rest Rückgabeformat application/xml
application/vnd.sdmx.structure+xml;version=2.1
text/xml
application/vnd.sdmx.structure+json;version=1.0.0
Beispiel: https://api.statistiken.bundesbank.de/rest/metadata/codelist/BBK
Rückgabeformat-Parameter
Mit dem „format“-Parameter ist es möglich, den Webdienst anzuweisen, Daten in verschiedenen Formaten zurückzugeben. Wenn kein "format"-Parameter angegeben ist, wird beim Rückgabeformat der Eintrag "Accept-Header“ berücksichtigt.
Der "format"-Parameter hat Vorrang gegenüber dem "Accept-Header".
Rückgabetyp Parameterwert Media type SDMX-ML 2.1 struct_json
struct_xml
application_xml
text_xml
application/vnd.sdmx.structure+json
application/vnd.sdmx.structure+xml
application/xml
text/xml
-
Beschreibung: Der Endpunkt gibt das ausgewählte Conceptscheme zurück (zum Beispiel CS_BBK_ERX).
Protokoll https Pfad /metadata/conceptscheme/BBK/{resourceID} Basispfad https://api.statistiken.bundesbank.de/rest Rückgabeformat application/vnd.sdmx.structure+xml;version=2.1
application/xml
text/xmlParameter
Name Beschreibung Beispiel resourceID Die ID des angefragten Conceptscheme. CS_BBK_ERX Beispiel: https://api.statistiken.bundesbank.de/rest/metadata/conceptscheme/BBK/CS_BBK_ERX
Rückgabeformat-Parameter
Mit dem „format“-Parameter ist es möglich, den Webdienst anzuweisen, Daten in verschiedenen Formaten zurückzugeben. Wenn kein "format"-Parameter angegeben ist, wird beim Rückgabeformat der Eintrag "Accept-Header“ berücksichtigt.
Der "format"-Parameter hat Vorrang gegenüber dem "Accept-Header".
Rückgabetyp Parameterwert Media type SDMX-ML 2.1 struct_xml
application_xml
text_xml
application/vnd.sdmx.structure+xml
application/xml
text/xml
Abfrageparameter
Name Beschreibung detail Mithilfe des „detail“- Parameters kann die gewünschte Menge an Informationen näher spezifiziert werden.
full: Alle verfügbaren Informationen werden zurückgegeben. Das ist die Default-Einstellung.
Beispiel:
https://api.statistiken.bundesbank.de/rest/metadata/conceptscheme/BBK/CS_BBK_ERX?detail=fullallstubs: Alle Artefakte werden als stubs zurückgegeben.
Beispiel:
https://api.statistiken.bundesbank.de/rest/metadata/conceptscheme/BBK/CS_BBK_ERX?detail=allstubsreferencestubs: Die verwiesenen Artefakte werden als stubs zurückgegeben.
references Mithilfe des Referenzparameters können Sie den Webservice anweisen, die Artefakte zurückzugeben, auf die durch das zurückzugebende Concetpscheme verwiesen wird (oder nicht).
none: Keine Verweise werden zurückgegeben. Das ist der default-Wert.
all: Die Gesamtmenge der Metadaten.
parents: Die Artefakte, die das Conceptscheme verwenden, werden zurückgegeben.
parentsandsiblings: Die Artefakte, die das Conceptscheme verwenden, sowie die von diesen Artefakten referenzierten Conceptschemes, werden zurückgegeben.
children: Die Artefakte, auf die das Conceptscheme verweist, werden zurückgegeben.
descendants: Alle Referenzen, bis zu jeder Ebene, werden ebenfalls zurückgegeben.
codelist: Die Codelisten, auf die das Conceptscheme verweist, werden zurückgegeben.
-
Beschreibung: Der Endpunkt gibt alle ausgewählten Conceptschemes zurück.
Protokoll https Pfad /metadata/conceptscheme/BBK Basispfad https://api.statistiken.bundesbank.de/rest Rückgabeformat application/vnd.sdmx.structure+xml;version=2.1
application/xml
text/xml
Beispiel: https://api.statistiken.bundesbank.de/rest/metadata/conceptscheme/BBK
Rückgabeformat-Parameter
Mit dem „format“-Parameter ist es möglich, den Webdienst anzuweisen, Daten in verschiedenen Formaten zurückzugeben. Wenn kein "format"-Parameter angegeben ist, wird beim Rückgabeformat der Eintrag "Accept-Header“ berücksichtigt.
Der "format"-Parameter hat Vorrang gegenüber dem "Accept-Header".
Rückgabetyp Parameterwert Media type SDMX-ML 2.1 struct_xml
application_xml
text_xml
application/vnd.sdmx.structure+xml
application/xml
text/xml