<script src="https://wiki.oceannetworks.ca/download/attachments/75170291/docs-client-libraries.js"></script> |
Near real-time (as fast as they get into our database) data access methods allow the extraction of sensor data as time-series, either as processed scalar data with Quality Assurance and Control flags (QAQC) or directly as raw data obtained from the device in its specific output format. In contrast to the Data product download methods, this data can be downloaded directly without waiting for any kind of generation process.
Common use cases include:
The methods Each request to our API can return a maximum of 100,000 samples; larger data requests must be downloaded as a sequence of "pages". Use the " |
Method | Description |
---|---|
| Obtain scalar data readings from a device category in a location |
Near real-time data access methods (filters, allPages) | Obtain scalar data readings from a device |
| Obtain raw data readings from a device category in a location |
| Obtain raw data readings from a device |
Downloads time-series of property readings from a device category in a location.
Returned data contains a value, time and QAQC flag for every measurement in the time-series.
Parameter | Type | Description | Example | |||
---|---|---|---|---|---|---|
filters | ^filters | A group of filters used to configure the scalar data request, to be provided to the getByLocation method from the API scalardata service. The following filters are required and will set the data origin: The following filters are optional:
Visit the getByLocation method documentation for information on filter usage. |
| |||
allPages | boolean | Whether this method should automatically download all pages when the data requested exceeds the row limit.
Default value: False Note for Matlab client: This parameter is already built in the client. You only need to pass true or false after the filters. | ^False |
(parameters with an underline are required)
Example: Get all property readings in a time range | ||||||
|
Returns | ||||||||||||||||||||||||
A ^dictionary with separate ^lists | vectors | lists of sensor readings for each property, as returned by the scalardata getByLocation method. By default, each property in the response includes a "
If the request filters include the "
If the request filters include the "
If there are additional data pages to download, the "
|
The response is a ^dictionary with the following structure:
" Each data property is a ^dictionary with the following structure:
When the "
|
Downloads time-series of property readings from a specific device.
The returned data contains a value, time and QAQC flag for every measurement in the time-series.
Parameter | Type | Description | Example | |||
---|---|---|---|---|---|---|
filters | ^filters | A group of filters used to configure the scalar data request, to be provided to the getByDevice method from the API scalardata service. The deviceCode filter is required and will set the data origin. The following filters are optional: Visit the getByDevice method documentation for information on filter usage. |
| |||
allPages | boolean | Whether this method should automatically download all pages when the data requested exceeds the row limit and requires to be downloaded in multiple pages.
Default value: ^False Note for Matlab client: This parameter is already built in the client. You only need to pass true or false after the filters. | ^False |
(parameters with an underline are required)
Example: Get all readings from a specific device in a time range | ||||||
|
Returns | ||||||
A ^dictionary with sensor readings for each data property in the response, as returned by the scalardata getByDevice method. Each property in sensorData includes a "
This response has the same structure and behavior as the response of the getDirectByLocation method. This includes:
|
The response is a ^dictionary with the following structure:
All the properties in the response have the same structure and behavior described for the getDirectByLocation method. |
Downloads time-series of raw device output from a device category in a location.
The response will contain raw device output for all properties available in the devices providing the data.
Depending on the source devices' output format, raw data might not be readable (requires to be parsed).
Parameter | Type | Description | Example | |||
---|---|---|---|---|---|---|
filters | ^dictionary | A group of filters used to configure the raw data request, provided to the rawdata service's getByLocation API method. The following filters are required and will set the data origin: The following filters are optional: Visit the getByLocation method documentation for information on filter usage. |
| |||
allPages | boolean | Whether this method should automatically download all pages when the data requested exceeds the row limit and requires to be downloaded in multiple pages.
Default value: ^False Note for Matlab client: This parameter is already built in the client. You only need to pass true or false after the filters. | ^False |
(parameters with an underline are required)
Example: Get raw readings from a location in a time range | ||||||
|
Returns | ||||||||||||||||||
A ^dictionary with separate ^lists of raw device output. By default, each data sample in the result is represented in matching lists for "
If the request filters include the "
If there are additional data pages to download, the "
|
The response is a ^dictionary with the following properties:
When the "
|
Downloads time-series of raw sensor readings from a specific device.
The response will contain readings for all properties available in the device.
Depending on the source devices' output format, raw data might not be readable (requires to be parsed; for more information, consult the device documentation in the Data Search page).
Parameter | Type | Description | Example | |||
---|---|---|---|---|---|---|
filters | ^filters | A group of filters used to configure the data product request, to be provided to the rawdata getByDevice API method. The filter deviceCode is required and will set the data origin. The following filters are optional: Visit the getByDevice method documentation for information on filter usage. |
| |||
allPages | boolean | Whether this method should automatically download all pages when the data requested exceeds the row limit and requires to be downloaded in multiple pages.
Default value: ^False Note for Matlab client: This parameter is already built in the client. You only need to pass true or false after the filters. | ^False |
(parameters with an underline are required)
Example: Get raw readings from a device in a time range | ||||||
|
Returns | ||||||
A ^dictionary with separate ^lists of raw device output, with the same structure described for the getDirectByLocation method. By default, each data sample in the result is represented in matching lists for "
This response has the same structure and behavior as the response of the
|
The response is a ^dictionary with the following properties:
All the properties in the response have the same structure and behavior described for the getRawDirectByLocation() method. |