Vorgang ExportSynchronous
Dieser Vorgang wartet auf die Fertigstellung des Exports und gibt das exportierte Berichtsbuch zurück. Verwenden Sie diesen Vorgang, um kleine Berichtsbücher zu exportieren, bei großen Exporten kann es zu Zeitüberschreitung kommen.
Anforderung
| Methode | URL |
|---|---|
GET |
/BI/api/rest/IonApi/BookExport/v1/ExportSynchronous |
| Parameter | Status | Typ | Wert |
|---|---|---|---|
appName |
Erforderlich | Zeichenfolge | Ein eindeutiger Name der Anwendung mit dem zu exportierenden Berichtsbuch. |
bookName |
Erforderlich | Zeichenfolge | Ein eindeutiger Name des zu exportierenden Berichtsbuchs. |
outputFormat |
Erforderlich | Enum |
Ausgabeformat des Exports. |
usePageLayout |
Optional | Boolesch | Der Standardwert ist TRUE. Nur für den Export von pptx oder Bildern verwenden. |
imageFormat |
Optional | Enum |
png. Nur für den Export von Bildern verwenden. |
string exportProfile |
Optional | Zeichenfolge | Ein Exportprofilname. Für einen standardmäßigen Export das Feld leer lassen. |
Ergebnis
Sie erhalten ein Stück binäre Daten, das ein exportiertes Berichtsbuch im gewählten Format darstellt.
Wenn der Export fehlschlägt, erhalten Sie eine JSON-Zeichenfolge mit einer Fehlermeldung.