|
|
|
# `qaqc_settings_update`
|
|
|
|
|
|
|
|
#### version 2
|
|
|
|
|
|
|
|
```py
|
|
|
|
{
|
|
|
|
"version": 2 # The configuration version.
|
|
|
|
"project_uuid": <string> # The UUID of the project the quality config belongs to.
|
|
|
|
"name": <string> # Name of the qaqc config.
|
|
|
|
"context_window": <string> # Number or daterange of data to fetch before observations. [1]
|
|
|
|
"functions": [<QFunc>, ...] # Any number of quality functions.
|
|
|
|
}
|
|
|
|
|
|
|
|
<QFunc> = {
|
|
|
|
"name": <string> # User given alias for the function.
|
|
|
|
"func_id": <string> # Quality function identifier (aka. saqc method name).
|
|
|
|
"kwargs": <object> # Arguments to function.
|
|
|
|
"datastreams": [<DStream>, ...] # Any number of datastream objects.
|
|
|
|
}
|
|
|
|
|
|
|
|
# Either sta_thing_id and sta_stream_id must not be null
|
|
|
|
# or temporary_name must not be null.
|
|
|
|
# If all three are not null, temporary_name is ignored.
|
|
|
|
<DStream> = {
|
|
|
|
"arg_name": <string> # The argument name in the quality function.
|
|
|
|
"alias": <string> # A string alias (aka. speaking name) for this stream [2]
|
|
|
|
"sta_thing_id": <number> | null # ID of the Thing in the sensor things api (STA).
|
|
|
|
"sta_stream_id": <number> | null # ID of the Datatream in the sensor things api (STA).
|
|
|
|
}
|
|
|
|
```
|
|
|
|
|
|
|
|
#### version 3
|
|
|
|
```py
|
|
|
|
{
|
|
|
|
"version": 3 # The configuration version.
|
|
|
|
"default": <bool> # flag that indicates if this is the current active default setup
|
|
|
|
... # same as version 2 above
|
|
|
|
}
|
|
|
|
```
|
|
|
|
|
|
|
|
[1]: The `context_window` must be either a stringified number (e.g. `"5"`) or a datetime-range string (e.g. `"5d12h10ns"`). For allowed units see the `unit` argument in the docs of [pandas.Timedelta](https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.Timedelta.html#pandas-timedelta).
|
|
|
|
|
|
|
|
[2]: The alias string is `"T<sta_thing_id>S<sta_stream_id>"` if both are present (neither is `null`), otherwise this is a user-given name. |
|
|
|
\ No newline at end of file |