Corvus Hilfe > Api > Yuna > Aktionen > reportDownload

reportDownload

Mit der Aktion reportDownload kann man einen Report exportieren.

Diese Aktion gibt niemals ein JSON zurück, sondern immer ein Binär-Stream. Je nachdem welchen Export man wählt, kommt immer eine Datei, und niemals ein JSON.

Fehlermeldungen werden als HTTP/500 Internal Server Error gekennzeichnet.

Der Download wird in mehreren Methoden geteilt, die hier ausführlich beschrieben sind

Methode 1 - Report Name

Diese Methode eignet sich für eine Migration von den alten URLs am besten. Hier wird der Report Name und das Export-Format benötigt. Das sind exakt die gleichen Angaben wie bei den alten URL-Downloads.

Anfrage:

{
	"action": "reportDownload",
	"actionParameter": {
	    "reportName": "2023-01-17-day-peak",
	    "reportExportFormat": "CSV"
    }
}

Methode 2 - Report Type By Date

Diese Methode ist unabhängig vom Report Namen, hier wird der Typ des Reports angegeben, der Timeframe und das Format. Diese Funktion ist relativ unabhängig vom echten Report Namen.

Anfrage:

{
	"action": "reportDownload",
	"actionParameter": {
	    "reportType": "IP_POOL",
	    "reportTimeframe": "WEEK",
	    "reportYear": 2023,
	    "reportMonth": 1,
	    "reportDay": 24,
	    "reportExportFormat": "CSV"
    }
}

Methode 3 - Latest Report

Diese Methode eignet sich, um den letzten Report der verfügbar ist zu exportieren. Dabei wird nur der Typ, der Timeframe und anstatt dem Datum wird das Flag Latest auf true gesetzt.

Anfrage:

{
	"action": "reportDownload",
	"actionParameter": {
	    "reportType": "CUSTOM",
	    "reportTimeframe": "MONTH",
	    "reportDateLatest": true,
	    "reportExportFormat": "CSV"
    }
}

Der reportType ist der eigentliche Dateiname vom Download. Also zum Beispiel dynamicIpPoolAgg

Methode 4 - Sync

Diese Methode ist speziell für Backups und Cluster Synchronisationen vorgesehen. Mit dieser Funktion wird ein Report direkt ohne Export übertragen.

Anfrage:

{
	"action": "reportDownload",
	"actionParameter": {
	    "reportFileName": "20230119-day-bgp_updates.csr.xz"
    }
}

Parameter

Folgende Parameter können gesetzt werden, siehe dazu die Methoden, welche Kombination gültig und erlaubt sind. Ungültige oder unklare Kombinationen werden als Internal Server Error 500 gemeldet.

Parameter Name	Datentyp	Default	Beschreibung
.actionParameter.reportName	String	-	Der Name des Reports, das ist auch der gleiche Name der von reportGetList kommen würde
.actionParameter.reportType	String	-	Der Typ des Reports, der kommt auch von reportGetList und ist immer Upper-Case. Ausnahme für Methode 3, siehe Methode 3
.actionParameter.reportTimeframe	String	-	Der Zeitrahmen, der kann DAY, WEEK, MONTH, QUARTER, HALF, YEAR sein
.actionParameter.reportYear	Integer	0	Das Datum des Reports eines bestimmten Jahres
.actionParameter.reportMonth	Integer	0	Das Datum des Reports eines bestimmten Monats
.actionParameter.reportDay	Integer	0	Das Datum des Reports eines bestimmten Tages
.actionParameter.reportDateLatest	Boolean	false	Liefert immer den letzt verfügbaren Report zurück
.actionParameter.reportExportFormat	String	-	Das Format, kann sein CSV, XLS oder XML. reportGetList liefert die Information ob ein Report im Format XYZ exportiert werden kann
.actionParameter.reportProfile	UUID	-	Die UUID des Report Profils, sofern man eine Filterung wünscht