ReportVersionCollection.restore¶
Restore a snapshot (append-only; does not rewrite history).
Server: POST /api/reports/{id}/versions/{version_id}/restore.
Signature¶
restore(version_id: str, *, expected_updated_at: str) -> Report
Parameters¶
| Name | Type | Required | Default |
|---|---|---|---|
version_id |
str |
yes | - |
expected_updated_at |
str |
yes | - |
HTTP parameters¶
| Name | In | Type | Required | Default |
|---|---|---|---|---|
report_id |
path |
string |
yes | - |
version_id |
path |
string |
yes | - |
Fields¶
Schema: ReportVersionRestoreIn
| Field | Type | Required |
|---|---|---|
expected_updated_at |
string |
yes |
Return shape¶
HTTP 200 — OK
Schema: ReportDetailOut
| Field | Type | Required |
|---|---|---|
attachments |
array<ReportAttachmentOut> |
no |
body_md |
string |
yes |
created_at |
string |
yes |
id |
string |
yes |
latest_version |
integer |
no |
owner_id |
string |
no |
project_id |
string |
yes |
project_title |
string |
no |
published_at |
string |
no |
published_by_id |
string |
no |
references |
array<ReportReferenceOut> |
no |
slug |
string |
no |
slug_number |
integer |
no |
status |
string |
yes |
tags |
array<ReportTagOut> |
no |
title |
string |
yes |
updated_at |
string |
yes |
Permission¶
Required permission: report:update
HTTP¶
POST /api/reports/{report_id}/versions/{version_id}/restore (restoreReportVersion)
Usage¶
report_version_collection.restore(version_id, expected_updated_at)