Creating / uploading a workbook

POST /api/v1/workbooks/xlsx

Create a workbook from an Excel workbook.

Parameters:

  • xlsx_file: the Excel workbook from which we will create the EqualTo Sheet workbook.

  • (optional) name: the name of the newly created workbook

Example curl invocation:

curl 'https://sheets.equalto.com/api/v1/workbooks/xlsx' \
    -F xlsx_file=@/path/to/file.xlsx \
    -H "Authorization: Bearer <license key>" 

The response contains some data about the newly-created workbook. Example:

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "name": "Book1",
  "revision": 1,
  "create_datetime": "2023-04-27T20:41:21.896Z",
  "modify_datetime": "2023-04-27T20:41:21.896Z"
}

POST /api/v1/workbooks/blank

Creates a blank workbook.

Parameters:

  • (optional) name: the name of the newly created workbook

The response contains some data about the newly-created workbook. Example:

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "name": "Book1",
  "revision": 1,
  "create_datetime": "2023-04-27T20:41:21.896Z",
  "modify_datetime": "2023-04-27T20:41:21.896Z"
}

POST /api/v1/workbooks/json

Create a workbook from JSON data.

Parameters:

  • workbook_json: the Excel workbook from which we will create the EqualTo Sheet workbook.

  • version: the version of the schema used by workbook_json

  • (optional) name: the name of the newly created workbook

The response contains some data about the newly-created workbook. Example:

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "name": "Book1",
  "revision": 1,
  "create_datetime": "2023-04-27T20:41:21.896Z",
  "modify_datetime": "2023-04-27T20:41:21.896Z"
}

Last updated