CADENZA-33493 [Embedding FA] Export Table and Indicator as JSON

DisyInformationssysteme · Oct 4, 2023 · d740b99 · d740b99
1 parent 9917231
commit d740b99
Show file tree

Hide file tree

Showing 3 changed files with 34 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -202,7 +202,7 @@ That's why the events use the `editGeometry` prefix.
 
 <small>API: [CadenzaClient#fetchData](./classes/CadenzaClient.html#fetchData)</small>
 
-Fetch data from a workbook view in CSV format.
+Fetch data from a workbook view in CSV or JSON format.
 
 ```javascript
 const response = await cadenzaClient.fetchData('{embeddingTargetId}', 'text/csv');
@@ -215,7 +215,7 @@ const text = await response.text();
 
 <small>API: [CadenzaClient#downloadData](./classes/CadenzaClient.html#downloadData)</small>
 
-Download data from a workbook view in Excel, CSV or PDF format. This triggers the browser's download dialog.
+Download data from a workbook view in Excel, CSV, JSON or PDF format. This triggers the browser's download dialog.
 
 ```javascript
 const button = document.createElement('button');

diff --git a/sandbox.html b/sandbox.html
@@ -103,6 +103,12 @@
           locationFinder
         });
       },
+      fetchData ({ embeddingTargetId, mediaType }) {
+        cadenzaClient.fetchData(embeddingTargetId, mediaType)
+          .then(response => response.text())
+          .then(text => alert(text))
+          .catch(exception => alert(exception));
+      },
       downloadData ({ embeddingTargetId, mediaType, fileName }) {
         cadenzaClient.downloadData(embeddingTargetId, mediaType, {
           fileName
@@ -147,6 +153,7 @@
         <option value="createGeometry">Create Geometry</option>
         <option value="editGeometry">Edit Geometry</option>
         <option value="downloadData">Download data</option>
+        <option value="fetchData">Fetch data</option>
       </select>
     </div>
 
@@ -291,13 +298,34 @@
   </div>
   <div>
     <label for="mediaType">Media type *</label>
-    <input name="mediaType" id="mediaType" value="text/csv" required>
+    <select name="mediaType" id="mediaType" required>
+      <option>text/csv</option>
+      <option>application/vnd.openxmlformats-officedocument.spreadsheetml.sheet</option>
+      <option>application/json</option>
+      <option>application/pdf</option>
+    </select>
   </div>
   <div>
     <label for="fileName">Filename</label>
     <input name="fileName" id="fileName">
   </div>
 </template>
 
+<template data-action="fetchData">
+  <div>
+    <label for="embeddingTargetId">Embedding target ID *</label>
+    <input name="embeddingTargetId" id="embeddingTargetId" required>
+  </div>
+  <div>
+    <label for="mediaType">Media type *</label>
+    <select name="mediaType" id="mediaType" required>
+      <option>text/csv</option>
+      <option>application/vnd.openxmlformats-officedocument.spreadsheetml.sheet</option>
+      <option>application/json</option>
+      <option>application/pdf</option>
+    </select>
+  </div>
+</template>
+
 </body>
 </html>
diff --git a/src/cadenza.js b/src/cadenza.js
@@ -454,6 +454,7 @@ export class CadenzaClient {
     assertSupportedMediaType(mediaType, [
       MediaType.CSV,
       MediaType.EXCEL,
+      MediaType.JSON,
       MediaType.PDF,
     ]);
     const params = createParams({ mediaType });
@@ -501,6 +502,7 @@ export class CadenzaClient {
     assertSupportedMediaType(mediaType, [
       MediaType.CSV,
       MediaType.EXCEL,
+      MediaType.JSON,
       MediaType.PDF,
     ]);
     const params = createParams({ fileName, mediaType });
@@ -655,6 +657,7 @@ function validGeometryType(value) {
 const MediaType = /** @type {Record<string, MediaType>} */ {
   CSV: 'text/csv',
   EXCEL: 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet',
+  JSON: 'application/json',
   PDF: 'application/pdf',
 };