ReportCollection.create¶
Create a report.
Server: POST /api/reports/. project_id is taken from the
collection URL when omitted.
Title may be passed positionally (create("Title", ...)) or as
title=.
Signature¶
create(*args: Any, **kwargs: Any) -> Report
Parameters¶
| Name | Type | Required | Default |
|---|---|---|---|
*args |
Any |
no | - |
**kwargs |
Any |
no | - |
Fields¶
Schema: ReportCreateIn
| Field | Type | Required |
|---|---|---|
body_md |
string |
no |
project_id |
string |
yes |
tag_ids |
array<string> |
no |
title |
string |
yes |
Return shape¶
HTTP 201 — Created
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:create
HTTP¶
POST /api/reports/ (createReport)
Usage¶
report_collection.create()