Opération ExportSynchronous
Cette opération attend la fin de l'exportation et renvoie le classeur de rapports exporté. Cette opération permet d'exporter de petits classeurs de rapports. Les exportations importantes peuvent entraîner des problèmes d'expiration.
Requête
Méthode | URL |
---|---|
GET |
/BI/api/rest/IonApi/BookExport/v1/ExportSynchronous |
Paramètre | Statut | Type | Valeur |
---|---|---|---|
appName |
Obligatoire | Chaîne | Nom unique de l'application contenant le classeur des rapports à exporter. |
bookName |
Obligatoire | Chaîne | Nom unique du classeur de rapports à exporter. |
outputFormat |
Obligatoire | Enum |
Format de sortie de l'exportation. |
usePageLayout |
Facultatif | Booléen | La valeur par défaut est TRUE . Utiliser uniquement pour l'exportation de fichiers pptx ou d'images. |
imageFormat |
Facultatif | Enum |
png . Utiliser uniquement pour l'exportation d'images. |
string exportProfile |
Facultatif | Chaîne | Un nom de profil d'exportation. Pour exporter de la manière par défaut, laisser le champ vide. |
Résultat
Un morceau de données binaires est reçu, qui représente un classeur de rapports exporté dans le format choisi.
Lorsque l'exportation échoue, une chaîne JSON
contenant un message d'erreur est obtenue.