Export workbook as an .xlsx file

POST

workbooks

{id}

export

import Grid from '@grid-is/api';

const client = new Grid();

async function main() {
  const response = await client.workbooks.export('id');

  console.log(response);

  const content = await response.blob();
  console.log(content);
}

main();

This response does not have an example.

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

string

required

Body

application/json

Request body for exporting a workbook as an .xlsx file. Cells can be updated before reading the workbook, and a goal seek function can be used to calculate the required input value for a formula to achieve a specified target result.

apply

object[] | null

Cells to update before exporting

Specifies a temporary change to a workbook cell, including the target cell reference and the value to apply. The API has no state, and so any changes made are cleared after each request.

Example:

[{ "target": "A2", "value": 1234 }]

goalSeek

object | null

Goal seek. Use this to calculate the required input value for a formula to achieve a specified target result. Useful when the desired outcome is known, but the corresponding input is not

Response

200

application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

Workbook exported as an .xlsx file

The response is of type file.

List workbooks Render a chart using workbook data

import Grid from '@grid-is/api';

const client = new Grid();

async function main() {
  const response = await client.workbooks.export('id');

  console.log(response);

  const content = await response.blob();
  console.log(content);
}

main();

This response does not have an example.

GRID API

Endpoints

Export workbook as an .xlsx file

Authorizations

Path Parameters

Body

Response