Reference dataset (hand-written)
Generated by
scripts/generate_docs.py(scripts/regen_docs.sh). Do not edit by hand.
Methods of client.reference_dataset (reportnet_api.resources.reference_dataset_ext.ReferenceDatasetResource). Every method also exists on AsyncReportnetClient as await a_client.reference_dataset.<name>(...) with the same arguments. Roles are copied from the API spec; where it states none, this page says so rather than guessing.
Methods
set_updatable
Lock or unlock a reference dataset (PUT /referenceDataset/{datasetId}).
Call: client.reference_dataset.set_updatable(...) (async client: await a_client.reference_dataset.set_updatable(...))
| Argument | Type | Required | Default | Description |
|---|---|---|---|---|
dataset_id |
int |
yes | ||
updatable |
bool |
yes |
Returns: None
Allowed roles:
Not an endpoint of its own; the rights are those of the underlying calls.
The backend sets the reference dataset's updatable flag. Setting it to
False ("lock") also generates the reference dataset's files
(FileTreatmentHelper#createReferenceDatasetFiles), so it is more than a
flag flip; True ("unlock") only saves the flag. Answers an empty 200.
404 is returned both when the dataset is not a reference dataset and
for any I/O failure while generating the files (the controller maps
EEAException/IOException to the same 404). Roles (@PreAuthorize):
dataset/dataschema/reference-dataset custodian, steward, steward support,
observer or reference lead reporter on the dataset, or a data custodian/
steward with access to the reference entity; not documented for ApiKey.
This WRITES. A PUT is never retried after the request was sent (see
RetryPolicy), so a lock is not re-run by a retry.
Raises TypeError if updatable is not a real bool.
Live-tested notes:
- Mocked tests only; not run live (it writes, and
updatable=falsegenerates files).