Export Models
This page documents the data models related to workbook exports and provenance signing.
ExportJob
Represents an export job with its status and configuration.
Properties
| Property | Type | Description |
id | string | Export job identifier |
workbook_id | string (UUID) | Source workbook |
format | ExportFormat | Export format |
status | ExportStatus | Current processing status |
file_size | integer? | Exported file size in bytes |
include_provenance | boolean | Whether provenance signing is enabled |
provenance | ProvenanceRecord? | Provenance data (when completed) |
options | ExportOptions? | Format-specific options |
created_at | string (ISO 8601) | Creation timestamp |
completed_at | string (ISO 8601)? | Completion timestamp |
expires_at | string (ISO 8601)? | File expiration timestamp |
Example
{
"id": "exp_abc123",
"workbook_id": "550e8400-e29b-41d4-a716-446655440000",
"format": "xlsx",
"status": "completed",
"file_size": 2458624,
"include_provenance": true,
"provenance": {
"data_hash": "sha256:a1b2c3d4e5f6...",
"hmac_signature": "hmac-sha256:d4e5f6a1b2c3...",
"manifest_version": "cb_hash_v1",
"hash_scope": "all_sheets"
},
"created_at": "2026-01-25T10:30:00Z",
"completed_at": "2026-01-25T10:30:15Z",
"expires_at": "2026-01-26T10:30:00Z"
}
ProvenanceRecord
Cryptographic provenance data for verifying export integrity.
Properties
| Property | Type | Description |
data_hash | string | SHA-256 canonical hash of all cell data |
hmac_signature | string | HMAC-SHA256 signature of the data hash |
manifest_version | string | Hash algorithm version (e.g., cb_hash_v1) |
hash_scope | string | Scope of hashing (all_sheets or specific sheets) |
tenant_id | string? | Tenant that created the export |
export_id | string? | Parent export job ID |
workbook_id | string (UUID)? | Source workbook ID |
export_format | string? | Format of the export |
created_at | string (ISO 8601)? | When provenance was computed |
Example
{
"data_hash": "sha256:e3b0c44298fc1c149afbf4c8996fb924...",
"hmac_signature": "hmac-sha256:b0344c61d8db38535ca8afceaf0bf12b...",
"manifest_version": "cb_hash_v1",
"hash_scope": "all_sheets"
}
ExportOptions
Format-specific export configuration.
Properties
| Property | Type | Description |
include_formulas | boolean | Include formula text in export |
include_metadata | boolean | Include workbook metadata |
redact_pii | boolean | Redact PII fields before export |
password | string? | Password-protect the export file |
Enumerations
| Value | Description |
xlsx | Excel Workbook (supports provenance, password) |
csv | Comma-Separated Values |
pdf | PDF Document (supports password) |
json | JSON Data |
ExportStatus
| Value | Description |
pending | Export job created, waiting to start |
processing | Export is being generated |
completed | Export ready for download |
failed | Export generation failed |
expired | Export file has expired |