ReportVersionCollection.create¶
Commit a new snapshot of the current report body.
Server: POST /api/reports/{id}/versions.
Signature¶
create(*, message: str='') -> ReportVersion
Parameters¶
| Name | Type | Required | Default |
|---|---|---|---|
message |
str |
no | '' |
HTTP parameters¶
| Name | In | Type | Required | Default |
|---|---|---|---|---|
report_id |
path |
string |
yes | - |
Fields¶
Schema: ReportVersionCreateIn
| Field | Type | Required |
|---|---|---|
message |
string |
no |
Return shape¶
HTTP 200 — OK
Schema: ReportVersionOut
| Field | Type | Required |
|---|---|---|
content_hash |
string |
yes |
created_at |
string |
yes |
created_by_id |
string |
no |
id |
string |
yes |
message |
string |
yes |
payload |
object |
no |
report_id |
string |
yes |
restored_from_id |
string |
no |
version |
integer |
yes |
Permission¶
Required permission: report:update
HTTP¶
POST /api/reports/{report_id}/versions (createReportVersion)
Usage¶
report_version_collection.create()