ds_list¶
List of variants in auxiliary viewing regime
Synopsis¶
ds_list
Arguments:
ds: dataset name
filter: optional name of applying filter
- conditions: optional list of applying condition descriptors
in JSON string representation
dtree: optional name of applying decision tree
code: optional code of applying decision tree
no: optional position on tree, int as string
smpcnt: optional count of samples int as string
Return value:
{dictionary"task_id": task ID, string}Return value for task:
{dictionary"records": optional full listif selection is sufficiently small"samples": optional samples listif selection is sufficiently large"active-samples": active samples indexes, string}
Description¶
The request is the principal one for organizing auxiliary variant of Viewing regimes. So this request is used in context of of XL-dataset or decision tree.
The request does not return proper information at once. It creates background task. The client needs to use request job_status to receive the proper result after some delay.
Properties records, samples are discussed here.
Selection of variants is defined by arguments:
filter applies if either filter or conditions is set (see discussion here)
decision tree applies if either dtree or code is set (see discussion here)
in this case no is neccessary, since decision tree defines serie of selections
otherwize selection is the full list of variants in dataset
Some samples can be active in context of current filter or decision tree condition, and this information forms property active-samples of descriptor. The string has form of list of integers separated by ',' and can be used as argument of reccnt call.
Default value for smpcnt, length of sample list, is 25. Possible values are between 10 and 150, values out of bounds are interpeted as bound values 10 or 150.
Comment¶
Implementation of the request via background task is strongly neccessary for XL-datasets, since its evaluation might take essential time. It is not true in context of decision tree of workspace, so it is possible to add to REST API direct variant of the request in this case if a developper needs it.