ReportCollection.list¶
List reports in a project.
Server: GET /api/reports/.
Signature¶
list(project: str, *, q: str | None=None, ordering: str | None=None) -> list[Report]
Parameters¶
| Name | Type | Required | Default |
|---|---|---|---|
project |
str |
yes | - |
q |
str \| None |
no | None |
ordering |
str \| None |
no | None |
HTTP parameters¶
| Name | In | Type | Required | Default |
|---|---|---|---|---|
limit |
query |
integer |
no | 50 |
offset |
query |
integer |
no | 0 |
ordering |
query |
string |
no | - |
project_id |
query |
string |
yes | - |
q |
query |
string |
no | - |
Fields¶
| Field |
|---|
project |
q |
ordering |
Return shape¶
HTTP 200 — OK
array<ReportListOut>
Permission¶
Required permission: report:read
HTTP¶
GET /api/reports/ (listReports)
Usage¶
report_collection.list(project)