ReportReferenceCollection.add¶
Add a manual reference.
Server: POST /api/reports/{id}/references.
Signature¶
add(*, type: str, target_id: str, label: str='') -> ReportReference
Parameters¶
| Name | Type | Required | Default |
|---|---|---|---|
type |
str |
yes | - |
target_id |
str |
yes | - |
label |
str |
no | '' |
HTTP parameters¶
| Name | In | Type | Required | Default |
|---|---|---|---|---|
report_id |
path |
string |
yes | - |
Fields¶
Schema: ReportReferenceCreateIn
| Field | Type | Required |
|---|---|---|
label |
string |
no |
target_id |
string |
yes |
type |
string |
yes |
Return shape¶
HTTP 201 — Created
Schema: ReportReferenceOut
| Field | Type | Required |
|---|---|---|
id |
string |
yes |
is_trashed |
boolean |
no |
label |
string |
yes |
order |
integer |
yes |
project_id |
string |
no |
slug |
string |
no |
source |
string |
yes |
target_id |
string |
yes |
type |
string |
yes |
Permission¶
Required permission: report:update
HTTP¶
POST /api/reports/{report_id}/references (addReportReference)
Usage¶
report_reference_collection.add(type, target_id)