ReportCollection.get¶
Fetch a report by id or slug.
Server: GET /api/reports/{report_id}.
Signature¶
get(report_id: str) -> Report
Parameters¶
| Name | Type | Required | Default |
|---|---|---|---|
report_id |
str |
yes | - |
HTTP parameters¶
| Name | In | Type | Required | Default |
|---|---|---|---|---|
report_id |
path |
string |
yes | - |
Fields¶
| Field |
|---|
report_id |
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:read
HTTP¶
GET /api/reports/{report_id} (getReport)
Usage¶
report_collection.get(report_id)