qaqc_settings_update
version 2
{
"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
{
"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.
[2]: The alias string is "T<sta_thing_id>S<sta_stream_id>"
if both IDs are present (neither is null
), otherwise the alias is constructed as a user-given name or a mixture of user-given name and ID. See the following table for all cases. Note that often sta_thing_id
is referred as TID and sta_stream_id
as SID.
sta_thing_id |
sta_stream_id |
alias |
example | Description |
---|---|---|---|---|
null |
- (ignored) | any user given string | null,null,"myStream" |
A temporary stream, used for example for intermediate calculation results; after QC run the stream/data is discarded. |
ID | null |
auto-generated string with user part | 23,null,"T23SmyResult" |
A new data product stream; the stream is created and the data will be uploaded to the new stream. The new stream belongs to the thing with ID from column 1 (23 in the example); the name of the stream will be the user given part of the alias ( "myResult" in the example). |
ID | ID | auto-generated string | 23,42,"T23S42" |
A default data stream. |