| | 1 | = list = |
|---|
| | 2 | This service lists different aspects of ADEI server configuration like configured data sources, supported export formats, etc. The required aspect is defined by ''target'' property. |
|---|
| | 3 | |
|---|
| | 4 | == Supported targets == |
|---|
| | 5 | '''Data Sources''' |
|---|
| | 6 | * ''servers'' - Returns list of configured data sources |
|---|
| | 7 | * ''databases'' - Returns list of available databases within data source. This request returns both active and historical databases. |
|---|
| | 8 | * ''current_databases'' - Returns list of available databases within data source. Only currently active databases are returned. |
|---|
| | 9 | * ''groups'' - Returns list of available logging groups. If the ''db_server'' and ''db_name'' properties are specified, only groups belonging to the specified database are returned. Otherwise the service returns complete list of logging groups available in all configured data sources. |
|---|
| | 10 | * ''masks'' - Returns list of configured masks withing specified loggroup |
|---|
| | 11 | * ''items'' - Returns list of available data items (channels) within specified loggroup |
|---|
| | 12 | '''Data Intervals''' |
|---|
| | 13 | * ''experiments'' - Returns list of experiments |
|---|
| | 14 | * ''window_modes'' - Returns list of standard window sizes |
|---|
| | 15 | '''Data Export Configuration''' |
|---|
| | 16 | * ''formats'' - Returns list of supported export formats |
|---|
| | 17 | * ''sampling_rates'' - Returns list of supported sampling rates (optional, for data export) |
|---|
| | 18 | * ''export_window_modes'' - Returns list of supported export modes (interval) |
|---|
| | 19 | * Selection |
|---|
| | 20 | * Currently opened data window |
|---|
| | 21 | * Whole experiment |
|---|
| | 22 | * ''export_mask_modes'' - Returns list of supported export modes (item mask) |
|---|
| | 23 | * Current group only |
|---|
| | 24 | * All groups having the mask with specified name |
|---|
| | 25 | * Complete data source |
|---|
| | 26 | * Everything |
|---|
| | 27 | '''Data Aggregation''' |
|---|
| | 28 | * ''aggregation_modes'' - Returns list of supported data aggregation modes (MEAN, MMAX, ...) |
|---|
| | 29 | * ''interpolation_modes'' - Returns list of current interpolation modes |
|---|
| | 30 | * ''gaps_modes'' - Returns list of available modes for reporting missing data |
|---|
| | 31 | * ''marks_modes'' - Returns list of available modes for reporting positions of real data points |
|---|
| | 32 | |
|---|
| | 33 | == Mandatory Properties == |
|---|
| | 34 | * ''target'' - List target (see section above) |
|---|
| | 35 | * Other optional properties could become mandatory depending on target type |
|---|
| | 36 | |
|---|
| | 37 | == Optional Properties == |
|---|
| | 38 | * [wiki:adeiParam_db_server db_server ] - Data source |
|---|
| | 39 | * [wiki:adeiParam_db_name db_name ] - Database name |
|---|
| | 40 | * [wiki:adeiParam_db_group db_group ] - Log Group |
|---|
| | 41 | |
|---|
| | 42 | == Returned Result == |
|---|
| | 43 | XML document listing requested target or error message. The following format of XML document should be expected: |
|---|
| | 44 | {{{ |
|---|
| | 45 | <result> |
|---|
| | 46 | <Value value="<item_id>" name="<item_title>"/> |
|---|
| | 47 | <Value value="<item_id>" name="<item_title>"/> |
|---|
| | 48 | ... |
|---|
| | 49 | </result> |
|---|
| | 50 | }}} |
|---|
| | 51 | The additional node attributes may be used to provide additional information. Example (if listing all available groups, the actual server, database and group ids are explicitly specified): |
|---|
| | 52 | {{{ |
|---|
| | 53 | <result> |
|---|
| | 54 | <Value value="katrin__hauptspektrometer__0" name="HauptSpektrometer -- hauptspektrometer -- Nord-West" db_server="katrin" db_name="hauptspektrometer" db_group="0" /> |
|---|
| | 55 | ... |
|---|
| | 56 | </result> |
|---|
| | 57 | }}} |
|---|
| | 58 | If there is error occurred while request is processing, the error is returned. The following format is used: |
|---|
| | 59 | {{{ |
|---|
| | 60 | <result> |
|---|
| | 61 | <Error>Unknown list target (wines) is specified</Error> |
|---|
| | 62 | </result> |
|---|
| | 63 | }}} |
|---|
