Release receipts
Generated by
scripts/generate_docs.py(scripts/regen_docs.sh). Do not edit by hand.
Methods of client.release_receipts (reportnet_api.resources.release_receipts.ReleaseReceiptsResource). Every method also exists on AsyncReportnetClient as await a_client.release_receipts.<name>(...) with the same arguments. Roles are copied from the API spec; where it states none, this page says so rather than guessing.
Methods
- create_release_receipt
- delete_release_receipt_by_dataflow_id
- get_release_receipt_by_dataflow_id
- update_release_receipt
create_release_receipt
createReleaseReceipt
HTTP: POST /release-receipts
Call: client.release_receipts.create_release_receipt(...) (async client: await a_client.release_receipts.create_release_receipt(...))
| Argument | Type | Required | Default | Description |
|---|---|---|---|---|
release_receipt_vo |
ReleaseReceiptVO |
yes |
Returns: ReleaseReceiptVO
Allowed roles:
Not stated in the API spec.
delete_release_receipt_by_dataflow_id
deleteReleaseReceiptByDataflowId
HTTP: DELETE /release-receipts/dataflow/{dataflowId}
Call: client.release_receipts.delete_release_receipt_by_dataflow_id(...) (async client: await a_client.release_receipts.delete_release_receipt_by_dataflow_id(...))
| Argument | Type | Required | Default | Description |
|---|---|---|---|---|
dataflow_id |
int |
yes |
Returns: None
Allowed roles:
Not stated in the API spec.
get_release_receipt_by_dataflow_id
getReleaseReceiptByDataflowId
HTTP: GET /release-receipts/dataflow/{dataflowId}
Call: client.release_receipts.get_release_receipt_by_dataflow_id(...) (async client: await a_client.release_receipts.get_release_receipt_by_dataflow_id(...))
| Argument | Type | Required | Default | Description |
|---|---|---|---|---|
dataflow_id |
int |
yes |
Returns: ReleaseReceiptVO
Allowed roles:
Not stated in the API spec.
update_release_receipt
updateReleaseReceipt
HTTP: PUT /release-receipts
Call: client.release_receipts.update_release_receipt(...) (async client: await a_client.release_receipts.update_release_receipt(...))
| Argument | Type | Required | Default | Description |
|---|---|---|---|---|
release_receipt_vo |
ReleaseReceiptVO |
yes |
Returns: ReleaseReceiptVO
Allowed roles:
Not stated in the API spec.