com.siemens.mindsphere.sdk.iotbulk.apiclient

Class ReadOperationsClient

Object

MindsphereAPIClient

ReadOperationsClient

public class ReadOperationsClient
extends MindsphereAPIClient

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ReadOperationsClient.ClientBuilder

Nested classes/interfaces inherited from class MindsphereAPIClient

MindsphereAPIClient.Builder<T extends MindsphereAPIClient.Builder<T>>

Field Summary

Fields inherited from class MindsphereAPIClient

credentials, restClientConfig, restTemplate

Constructor Summary

Constructors

Constructor and Description
ReadOperationsClient(ReadOperationsClient.ClientBuilder builder)

Method Summary

Modifier and Type	Method and Description
static ReadOperationsClient.ClientBuilder	builder()
TimeSeries	retrieveTimeseries(RetrieveTimeseriesRequest requestObject) Retrieve time series data Retrieve time series data for a single asset (entity) and aspect (property set).

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ReadOperationsClient

public ReadOperationsClient(ReadOperationsClient.ClientBuilder builder)

Method Detail

builder

public static ReadOperationsClient.ClientBuilder builder()

retrieveTimeseries

public TimeSeries retrieveTimeseries(RetrieveTimeseriesRequest requestObject)
                              throws MindsphereException

Retrieve time series data Retrieve time series data for a single asset (entity) and aspect (property set). Returns data for the specified time range. Returns only the selected properties if 'select' parameter is used. The maximum number of time series data items returned per request is defined by parameter 'limit'. In case more time series data items are present in the requested time range, only a subset of data items will be returned. In that case response property 'nextRecord' contains the request URL to fetch the next set of time series data items, by increasing the 'from' parameter accordingly.

200 - response object

400 - The request will return 400 BAD REQUEST in cases you can find below. - The input limit is less than zero. - One or more invalid property names specified. - Unable to find the asset (entity). - Unable to find the aspect (property set). - The time range specified is greater than 90 days. - The 'from' time is same as or after the 'to' time specified for range query.

0 - Other error with any status code and response body format.

Parameters:

requestObject - - Object of type RetrieveTimeseriesRequest {Parameters are entity*,propertySetName*,from*,to*,limit,select}

Returns:

TimeSeries

Throws:

MindsphereException - if an error occurs while attempting to invoke the API