History

This section explains more about the snapshot backup management.

Documentation


Methods

The following methods are available to interact with the spreadsheet headers programmatically.
MethodDescription
getHistory Get the all the spreadsheet snapshots.

Jspreadsheet getHistory(): Promise<{ versionId: string, date: string, size: number }[]>

GET /api/:guid/history
setHistory Create a spreadsheet snapshot.

Jspreadsheet setHistory(): Promise<void>

POST /api/:guid/history
getVersion Get a specific spreadsheet snapshot.
@param versionId - searched version id

Jspreadsheet getVersion(versionId: string): Promise<Spreadsheet>

GET /api/:guid/history/:versionId
deleteVersion Delete a specific spreadsheet snapshot.
@param versionId - id of the version to be deleted

Jspreadsheet deleteVersion(versionId: string): Promise<void>

DELETE /api/:guid/history/:versionId
recoverVersion Recover the spreadsheet from a snapshot.
@param versionId - version id

Jspreadsheet recoverVersion(versionId: string): Promise<void>

POST /api/:guid/history/recover/:versionId


Examples


Manage the snapshots

Get a list of all spreadsheet snapshots.

import { Client } from "@intrasheets/client";

// Create a new client
const client = new Client({
  // API Server
  baseUrl: "http://localhost:8009/api",
  // Your authentication token
  token: "eyJhbGciOiJIUzUxMiIsInR5cCJ9.eyJkb21haW4iOiJsb2NhbGhvc3Q6ODAPQSJ9.Xr2Ir2-zEc_tqV5y6i",
});

// Spreadsheet Guid
const guid = '79b45919-c751-4e2b-a49a-6c1286e2fc03';

// Get the spreadsheet instance
const spreadsheet = client.getSpreadsheet(guid);

// Request data
spreadsheet.getHistory().then((data) => {
    console.log(data);
});


Create backups

How to create a new snapshot

import { Client } from "@intrasheets/client";

// Create a new client
const client = new Client({
  // API Server
  baseUrl: "http://localhost:8009/api",
  // Your authentication token
  token: "eyJhbGciOiJIUzUxMiIsInR5cCJ9.eyJkb21haW4iOiJsb2NhbGhvc3Q6ODAPQSJ9.Xr2Ir2-zEc_tqV5y6i",
});

// Spreadsheet Guid
const guid = '79b45919-c751-4e2b-a49a-6c1286e2fc03';

// Get the spreadsheet instance
const spreadsheet = client.getSpreadsheet(guid);

// Set Data
spreadsheet.setHistory().then(() => {
    // It worked correctly
}).catch((err) => {
    // Something went wrong
    console.log(err);
});