Corvus Hilfe > Api > Yuna > Aktionen > reportGetList

reportGetList

Mit der Aktion reportGetList kann man eine Liste von Reports aus einem System anfordern.

Geliefert werden die Daten im reports Block

Beispiel

Anfrage:

{
	"action": "reportGetList"
}

Antwort (stark verkürzt):

{
	"action": "reportGetList",
	"reports": [
	    {
		    "name": "20230124-day-dynamicIpPoolAgg",
		    "year": 2023,
		    "month": 1,
		    "day": 24,
		    "dateTms": "1674518400000",
		    "timeframe": "DAY",
		    "type": "DYNAMICIPPOOLAGG",
		    "version": "YUNA_V1",
		    "canExportCSV": true,
		    "canExportXML": true
	    },
	    {
		    "name": "20230124-day-dynamicIpPoolSingle",
		    "year": 2023,
		    "month": 1,
		    "day": 24,
		    "dateTms": "1674518400000",
		    "timeframe": "DAY",
		    "type": "DYNAMICIPPOOLSINGLE",
		    "version": "YUNA_V1",
		    "canExportCSV": true,
		    "canExportXML": true
	    },
	    {
		    "name": "20230124-day-inventoryDevices",
		    "year": 2023,
		    "month": 1,
		    "day": 24,
		    "dateTms": "1674518400000",
		    "timeframe": "DAY",
		    "type": "INVENTORYDEVICES",
		    "version": "YUNA_V1",
		    "canExportCSV": true,
		    "canExportXML": true
	    }
    ],
	"timingInformation": {
		"serverReceivedTimestampUtcMs": "1675758953164",
		"serverProcessingBeginTimestampUtcMs": "1675758953232",
		"serverProcessingEndTimestampUtcMs": "1675758953353"
	}
}

Parameter

Man kann die Ausgabe durch Parameter beeinflussen, entweder man kann sie erweitern oder verringern.

Parameter Name	Datentyp	Default	Beschreibung
.actionParameter.filterReportByVersion	String	-	Einschränkung auf die Report Version. Kann sein YUNA_V1, MIKU_V3, MIKU_V2, KIKI_V2 und ggf. auch andere
.actionParameter.filterReportByTimeframe	String	-	Ein Filter auf den Timeframe, der kann DAY, WEEK, MONTH, QUARTER, HALF, YEAR sein
.actionParameter.filterReportByType	String	-	Damit kann ein bestimmter Report gefiltert werden
.actionParameter.filterReportByYear	Integer	0	Filtert die Ausgabe für Reports eines bestimmten Jahres
.actionParameter.filterReportByMonth	Integer	0	Filtert die Ausgabe für Reports eines bestimmten Monats
.actionParameter.filterReportByDay	Integer	0	Filtert die Ausgabe für Reports eines bestimmten Tages
.actionParameter.includeFileInformation	Boolean	false	Gibt zusätzliche Information über die original Datei aus. Ist nur für Synchronisationen interessant

Bitte beachten: Mehrere Filter zusammen in einer Anfrage sind immer im AND Modus. Für ein ODER müssen mehrere Anfragen gemacht werden.

Wenn keine Filter gesetzt sind, werden alle Reports angezeigt, diese Liste kann unterumständen relativ lang werden.

Beispiel mit Filtern und Includes

Im folgenden Beispiel werden mehrere Action-Parameter kombiniert. Die einzelne Beispiel-Auslistung wäre schlichtweg zu viel. Daher gibt es nur ein Beispiel, wo mehr oder weniger alles angezeigt wird.

Anfrage:

{
	"action": "reportGetList",
	"actionParameter": {
		"filterReportByTimeframe": "DAY",
		"filterReportByVersion": "YUNA_V1",
		"filterReportByType": "INVENTORYSYSDEP",
		"filterReportByYear": 2022,
		"filterReportByMonth": 12,
		"filterReportByDay": 24,
		"includeFileInformation": true
	}
}

Antwort:

{
	"reports": [
		{
			"name": "20221224-day-inventorySysdep",
			"year": 2022,
			"month": 12,
			"day": 24,
  		    "dateTms": "1671840000000",
			"timeframe": "DAY",
			"type": "INVENTORYSYSDEP",
			"version": "YUNA_V1",
			"canExportCSV": true,
			"canExportXML": true,
			"fileInformation": {
				"fileName": "20221224-day-inventorySysdep.csr.xz",
				"createTms": "1675596320892",
				"modifyTms": "1675596320895",
				"sizeBytes": "43952"
			}
		}
	]
}

Antwort Datenfelder

Hier eine vollständige Beschreibung aller möglichen Datenfelder der Antwort

Parameter Name	Datentyp	Beschreibung
.reports	Liste	Liste aller gefundenen Geräte und deren Informationen
.reports[].name	String	Der Name des Reports, der auch später im Download verwendet werden muss
.reports[].year	Integer	Die Jahreszahl des Reports, kommt effektiv aus dem Namen
.reports[].month	Integer	Die Monatszahl des Reports, kommt effektiv aus dem Namen
.reports[].day	Integer	Die Tageszahl des Reports, kommt effektiv aus dem Namen
.reports[].dateTms	Long	Ist der Timestamp im Millisekunden vom Tag, Monat und Jahr. Der ist 0 wenn das Datum ungültig ist
.reports[].timeframe	String	Der Report Timeframe, auch der kommt effektiv aus dem Namen, und wird auf DAY, WEEK, MONTH, QUARTER, HALF, YEAR gesetzt
.reports[].type	String	Der Report Typ, auch der kommt effektiv aus dem Namen, ist aber immer Upper-Case
.reports[].version	String	Ist die Corvus Interne Version des Reports, dass kann z.B. YUNA_V1 oder MIKU_V2 sein, oder andere Kennungen
.reports[].canExportCSV	Boolean	Wird auf true gesetzt, wenn dieser Report als CSV exportiert werden kann
.reports[].canExportXLS	Boolean	Wird auf true gesetzt, wenn dieser Report als Fake-XLS exportiert werden kann (das ist bei alten KIKI/MIKU Reports der Fall)
.reports[].canExportXML	Boolean	Wird auf true gesetzt, wenn dieser Report als SpreadSheet-XML exportiert werden kann (das ist bei YUNA_V1 der Fall)
.reports[].fileInformation	Record	Zusätzliche Information zu dem Report, ist vorhanden, wenn .actionParameter.includeFileInformation
.reports[].fileInformation.fileName	String	Der echte Dateiname auf dem Filesystem
.reports[].fileInformation.createTms	Long	Die Datei-Erstellung-Zeit der Datei in Millisekunden
.reports[].fileInformation.modifyTms	Long	Die Letzte-Modify-Zeit der Datei in Millisekunden
.reports[].fileInformation.sizeBytes	Long	Die Dateigröße der Datei in Bytes