Package de.svws_nrw.api.server

Klasse APIReporting

java.lang.Object

de.svws_nrw.api.server.APIReporting

@Path("/db/{schema}/reporting")
@Produces("application/json")
@Consumes("application/json")
public class APIReporting
extends Object

Die Klasse spezifiziert die OpenAPI-Schnittstelle für den Zugriff auf die Reporting-Funktionen des SVWS-Servers.

Konstruktorübersicht

Konstruktoren

Konstruktor	Beschreibung
APIReporting()	Leerer Standardkonstruktor.

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
jakarta.ws.rs.core.Response	pdfReport(String schema, ReportingParameter reportingParameter, jakarta.servlet.http.HttpServletRequest request)	Die OpenAPI-Methode für die Erstellung eines Reports im geforderten Format.

Von Klasse geerbte Methoden java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Konstruktordetails

APIReporting

public APIReporting()

Leerer Standardkonstruktor.

Methodendetails

pdfReport

@POST
@Produces("application/pdf")
@Path("/ausgabe")
public jakarta.ws.rs.core.Response pdfReport(@PathParam("schema")
 String schema,
 ReportingParameter reportingParameter,
 @Context
 jakarta.servlet.http.HttpServletRequest request)

Die OpenAPI-Methode für die Erstellung eines Reports im geforderten Format. Je nach übergebenen Parametern wird eine einzige Report-Datei oder eine ZIP-Datei mit einzelnen Dateien zurückgegeben.

Parameter:

schema - das Datenbankschema, auf welches die Abfrage ausgeführt werden soll

reportingParameter - Objekt mit den Daten und Einstellungen für den zu erstellenden Report.

request - die Informationen zur HTTP-Anfrage

Gibt zurück:

Der Report (bzw. ZIP-Datei mit einzelnen Dateien) mit den angeforderten Daten