# SyGridWorkbookSnapshotReport

Fields, allowed values, and APIs that use SyGridWorkbookSnapshotReport.

Canonical: https://grid.syidax.com/docs/types/SyGridWorkbookSnapshotReport/

<a id="definition"></a>

## Type definition

A question mark (?) marks an optional field; readonly marks a value you should not change directly. A union (|) accepts one of the listed forms. Functions are callbacks that Grid invokes at the relevant point.

```typescript
export interface SyGridWorkbookSnapshotReport {
  status: 'ok' | 'unpublished' | 'inactive';
  reason: SyGridWorkbookInactiveReason | null;
  workbookKey: number;
  sheetId: number;
  registrationId: number;
  generation: number;
  snapshotHash: string;
  cells: ReadonlyArray<SyGridWorkbookSnapshotCell>;
  issue: string;
}
```

<a id="used-by"></a>

## APIs using this type

- [getWorkbookSnapshotReport](https://grid.syidax.com/docs/methods/getWorkbookSnapshotReport.md) — Reads the last published workbook cells, hashes, and generations. Do not assume all Grid data was published.

<a id="parents"></a>

## Contracts containing this type

- [SyGridImperativeMethods](https://grid.syidax.com/docs/types/SyGridImperativeMethods.md)

<a id="related"></a>

## Related types

- [SyGridWorkbookInactiveReason](https://grid.syidax.com/docs/types/SyGridWorkbookInactiveReason.md)
- [SyGridWorkbookSnapshotCell](https://grid.syidax.com/docs/types/SyGridWorkbookSnapshotCell.md)