Report.update

Patch this report. Stale expected_updated_at yields HTTP 409.

Server: PATCH /api/reports/{id}.

Signature

update(*, expected_updated_at: str | None=None, title: str | None=None, body_md: str | None=None, tag_ids: list[str] | None=None) -> Report

Parameters

Name	Type	Required	Default
expected_updated_at	str \| None	no	None
title	str \| None	no	None
body_md	str \| None	no	None
tag_ids	list[str] \| None	no	None

HTTP parameters

Name	In	Type	Required	Default
report_id	path	string	yes	-

Fields

Schema: ReportUpdateIn

Field	Type	Required
body_md	string	no
expected_updated_at	string	yes
tag_ids	array<string>	no
title	string	no

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

PATCH /api/reports/{id} (updateReport)

Usage

report.update()