Berichte mit der Management Portal API exportieren

Auf dieser Seite werden die Grundlagen für die Verwendung der Managementportal-APIs zum Exportieren von Berichten erläutert.

Ausführlichere Beispiele und vollständige Beschreibungen für alle verfügbaren Endpunkte und ihre jeweiligen Parameter finden Sie im API-Leitfaden, der auf der Registerkarte "Support" im Managementportal verfügbar ist.

Die nachstehende Tabelle beschreibt die derzeit verfügbaren Berichtsexport-Endpunkte und ihre Unterschiede auf einer höheren Ebene und ermöglicht es dem Benutzer, die beste Option für seine Anforderungen zu wählen.

	Endpoint	Methode	Request Format	Export von Berichten für mehrere Geräte in einer einzigen Anfrage	Filterung der Berichte	Beschreibung
Export report	/report/export/{uuid}	GET	N/A			Exportiert einzelne Berichte mit der UUID.
Export reports (GET)	/report/export?@imei={imei}	GET	N/A			Exportiert die Berichte des vergangenen Monats mit optionaler IMEI-Filterung.
Export reports (POST)	/report/export	POST	application/json			Exportiert Berichte mit erweiterten Filtern/Optionen, die im Request-Body angegeben sind.

Export Report

Bei der einfachsten Form des Exports eines einzelnen Berichts muss die UUID des Berichts als Teil des Endpunkts angegeben werden.

Ersetzen Sie in den folgenden Beispielen {UUID} durch eine gültige Berichts-UUID und {API_KEY} durch die Zeichenfolge Ihres API-Schlüssels. Wenn Sie noch keinen API-Schlüssel haben, finden Sie weitere Informationen in der API Keys Dokumentation.

curl -X "GET" \
  "https://api.eu-west-1.blancco.cloud/v1/report/export/{UUID}" \
  -H "accept: */*" \
  -H "X-BLANCCO-API-KEY: {API_KEY}"

Standardmäßig wird der Bericht im XML-Format exportiert. Auch PDF und JSON werden unterstützt. Das Format kann geändert werden, indem der Parameter "?format=" als Teil der Anfrage-URL nach der UUID definiert wird. Unterstützte Werte für den Parameter "format" sind XML, JSON und PDF.

curl -X "GET" \
  "https://api.eu-west-1.blancco.cloud/v1/report/export/{UUID}?format=PDF" \
  -H "accept: */*" \
  -H "X-BLANCCO-API-KEY: {API_KEY}"

Export Reports (GET)

Exportieren Sie die Berichte des vergangenen Monats mit optionaler IMEI-Filterung. Wenn der Bericht nicht im vergangenen Monat erstellt wurde, wird er nicht in die Ergebnisse aufgenommen.

Ersetzen Sie in den folgenden Beispielen {IMEI} durch eine gültige Geräte-IMEI und {API_KEY} durch die Zeichenfolge Ihres API-Schlüssels. Wenn Sie noch keinen API-Schlüssel haben, finden Sie weitere Einzelheiten in der API Keys Dokumentation.

curl -X "GET" \
  "https://api.eu-west-1.blancco.cloud/v1/report/export?@imei={IMEI}" \
  -H "accept: */*" \
  -H "X-BLANCCO-API-KEY: {API_KEY}"

Export Reports (POST)

Exportieren von Berichten mit den im Anfragetext angegebenen Optionen. Ermöglicht es dem Benutzer, genauere Suchkriterien zu definieren und nur übereinstimmende Berichte zurückzugeben.

Supported report fields

Zusätzlich können mehrere andere Parameter definiert werden, um die zurückgegebenen Ergebnisse und das Ausgabeformat weiter einzuschränken.

Additional parameters

{
  "filter": {
    "date": {
      "gte": "2023-01-01T00:00:00Z"
    },
    "fields": [
      {
        "name": "@imei",
        "like": "{IMEI}"
      },
      {
        "name": "@custom-my custom field",
        "like": "{CUSTOM_FIELD_VALUE}"
      }
    ]
  },
  "format": "XML",
  "container": "ZIP"
}

{
	"filter": {
	   "date":{
	   },
	   "fields": [
		{
			"name": "@erasure_state",
			"like": "Successful"
		}
		]
	  },
	"csv":{
		"columns": ["blancco_erasure_report.erasures.erasure.timestamp","blancco_erasure_report.erasures.erasure.state","blancco_hardware_report.system.manufacturer","blancco_hardware_report.system.model"]
	  },
	"format": "CSV",
	"container": "NONE"
}

Beispiel-Anfrage

Diese Beispielanfrage würde Berichte im XML-Format für IMEI 123456789012345 exportieren, die nach dem 1. Januar 2023 erstellt wurden. Die exportierten Berichte werden in einem Zip-Ordner zurückgegeben (jeder Bericht in einer separaten Datei).

Im folgenden Beispiel ersetzen Sie IMEI durch eine gültige IMEI und {API_KEY} durch die Zeichenfolge Ihres API-Schlüssels. Wenn Sie noch keinen API-Schlüssel haben, finden Sie weitere Informationen in der API Keys Dokumentation.

curl -X 'POST' \
  'https://api.eu-west-1.blancco.cloud/v1/report/export' \
  -H 'accept: */*' \
  -H 'X-BLANCCO-API-KEY: {API_KEY}' \
  -H 'Content-Type: application/json' \
  -d '{
  "filter": {
    "date": {
      "gte": "2023-01-01T00:00:00Z"
    },
    "fields": [
      {
        "name": "@imei",
        "like": "123456789012345"
      },
      {
        "name": "@custom-my custom field",
        "like": "my custom field value"
      }
    ]
  },
  "format": "XML",
  "container": "ZIP"
}'