com.siemens.mindsphere.sdk.iot.timeseries.apiclient

Class TimeseriesClient

Object

MindsphereAPIClient

TimeseriesClient

public class TimeseriesClient
extends MindsphereAPIClient

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TimeseriesClient.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
TimeseriesClient(TimeseriesClient.ClientBuilder builder)

Method Summary

Modifier and Type	Method and Description
static TimeseriesClient.ClientBuilder	builder()
boolean	deleteTimeseries(String entity, String propertySetName, Date from, Date to, Boolean sync) Invoking Service API to : Delete time series data for a single entity and propertyset within a given time range.
boolean	deleteTimeseries(String entity, String propertySetName, String from, String to, Boolean sync) Invoking Service API to : Delete time series data for a single entity and propertyset within a given time range.
TimeseriesData	getLatestTimeseries(String entity, String propertySetName) Invokes Service API to : Read time series data for a single entity and propertyset.
List<TimeseriesData>	getTimeseries(String entity, String propertySetName, Date from, Date to, Integer limit, String select) Invokes Service API to : Read time series data for a single entity and propertyset.
List<TimeseriesData>	getTimeseries(String entity, String propertySetName, String from, String to, Integer limit, String select) Invokes Service API to : Read time series data for a single entity and propertyset.
boolean	importTimeseries(String entity, String propertySetName, File timeSeriesDataFile, Boolean sync) Invokes Service API to : Write or update time series data for a single entity and propertyset.
boolean	putTimeseries(String entity, String propertySetName, List<TimeseriesData> timeSeriesList, Boolean sync) Invokes Service API to : Write or update time series data for a single entity and propertyset.
boolean	putTimeseries(String entity, String propertySetName, String timeSeriesList, Boolean sync) Invokes Service API to : Write or update time series data for a single entity and propertyset.

Methods inherited from class Object

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

Constructor Detail

TimeseriesClient

public TimeseriesClient(TimeseriesClient.ClientBuilder builder)

Method Detail

builder

public static TimeseriesClient.ClientBuilder builder()

getTimeseries

public List<TimeseriesData> getTimeseries(String entity,
                                          String propertySetName,
                                          String from,
                                          String to,
                                          Integer limit,
                                          String select)
                                   throws MindsphereException

Invokes Service API to :

• Read time series data for a single entity and propertyset.
• Returns data for a specified time range.
• Returns the latest value if no range is provided.

Mandatory input parameters are :entity and propertyset

Response Status Codes

200 - Array of time series

400 - Bad request, in case of invalid parameters

401 - Unauthorized

404 - Entity not found

500 - Server error, for more information see errorcode and message

Parameters:

entity - Unique identifier of the entity

propertySetName - Name of the propertyset

from - Beginning of the time range to read (exclusive)

to - End of the time range to read (inclusive)

limit - Maximum number of entries to read

select - Select fields to return

Returns:

Array of timeseries data objects

Throws:

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

getLatestTimeseries

public TimeseriesData getLatestTimeseries(String entity,
                                          String propertySetName)
                                   throws MindsphereException

Invokes Service API to :

• Read time series data for a single entity and propertyset.
• Returns data for a specified time range.
• Returns the latest value if no range is provided.

Mandatory input parameters are :entity and propertyset

Response Status Codes

200 - Array of time series

400 - Bad request, in case of invalid parameters

401 - Unauthorized

404 - Entity not found

500 - Server error, for more information see errorcode and message

Parameters:

entity - Unique identifier of the entity

propertySetName - Name of the propertyset

Returns:

Array of timeseries data objects

Throws:

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

getTimeseries

public List<TimeseriesData> getTimeseries(String entity,
                                          String propertySetName,
                                          Date from,
                                          Date to,
                                          Integer limit,
                                          String select)
                                   throws MindsphereException

Invokes Service API to :

• Read time series data for a single entity and propertyset.
• Returns data for a specified time range.
• Returns the latest value if no range is provided.

Mandatory input parameters are :entity and propertyset

Response Status Codes

200 - Array of time series

400 - Bad request, in case of invalid parameters

401 - Unauthorized

404 - Entity not found

500 - Server error, for more information see errorcode and message

Parameters:

entity - Unique identifier of the entity

propertySetName - Name of the propertyset

from - Beginning of the time range to read in Date format(exclusive)

to - End of the time range to read Date format (inclusive)

limit - Maximum number of entries to read

select - Select fields to return

Returns:

Array of timeseries data objects

Throws:

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

putTimeseries

public boolean putTimeseries(String entity,
                             String propertySetName,
                             String timeSeriesList,
                             Boolean sync)
                      throws MindsphereException

Invokes Service API to :

• Write or update time series data for a single entity and propertyset.
• Existing time series data is overwritten. Data for all
• properties within a propertyset needs to be provided together.

Mandatory Parameters are Entity, Property Set Name, Data to be inserted

Response Status Codes

204 - timeseries written successfully

400 - Bad request, in case the resource is invalid

401 - Unauthorized

404 - Entity not found

500 - Server error, for more information see errorcode and message

Parameters:

entity - Unique identifier of the entity

propertySetName - Name of the propertyset

timeSeriesList - JSON String

sync - set this parameter to true for direct write to db store

Returns:

true if successful, false otherwise

Throws:

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

putTimeseries

public boolean putTimeseries(String entity,
                             String propertySetName,
                             List<TimeseriesData> timeSeriesList,
                             Boolean sync)
                      throws MindsphereException

Invokes Service API to :

• Write or update time series data for a single entity and propertyset.
• Existing time series data is overwritten. Data for all
• properties within a propertyset needs to be provided together.

Mandatory Parameters are Entity, Property Set Name, Data to be inserted

Response Status Codes

204 - timeseries written successfully

400 - Bad request, in case the resource is invalid

401 - Unauthorized

404 - Entity not found

500 - Server error, for more information see errorcode and message

Parameters:

entity - Unique identifier of the entity

propertySetName - Name of the propertyset

timeSeriesList - List of TimeSeriesData objects

sync - set this parameter to true for direct write to db store

Returns:

true if successful, false otherwise

Throws:

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

importTimeseries

public boolean importTimeseries(String entity,
                                String propertySetName,
                                File timeSeriesDataFile,
                                Boolean sync)
                         throws MindsphereException

Invokes Service API to :

• Write or update time series data for a single entity and propertyset.
• Existing time series data is overwritten. Data for all
• properties within a propertyset needs to be provided together.

Mandatory Parameters are Entity, Property Set Name, Data to be inserted

Response Status Codes

204 - timeseries written successfully

400 - Bad request, in case the resource is invalid

401 - Unauthorized

404 - Entity not found

500 - Server error, for more information see errorcode and message

Parameters:

entity - Unique identifier of the entity

propertySetName - Name of the propertyset

timeSeriesDataFile - timeseries data as a File

sync - set this parameter to true for direct write to db store

Returns:

true if successful, false otherwise

Throws:

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

deleteTimeseries

public boolean deleteTimeseries(String entity,
                                String propertySetName,
                                String from,
                                String to,
                                Boolean sync)
                         throws MindsphereException

Invoking Service API to :

• Delete time series data for a single entity and propertyset within a given time range.
• Data for all properties within a propertyset is deleted.

Mandatory parameters Entity, Property Set Name, from and to time

Response Status Codes
204 - timeseries deleted successfully

400 - Bad request, in case the resource is invalid

401 - Unauthorized

404 - Entity not found

500 - Server error, for more information see errorcode and message

Parameters:

entity - Unique identifier of the entity

propertySetName - Name of the propertyset

from - Beginning of the timerange to delete (exclusive)

to - End of the timerange to delete (inclusive)

sync - set this parameter to true for direct write to db store

Returns:

true if successful, false otherwise

Throws:

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

deleteTimeseries

public boolean deleteTimeseries(String entity,
                                String propertySetName,
                                Date from,
                                Date to,
                                Boolean sync)
                         throws MindsphereException

Invoking Service API to :

• Delete time series data for a single entity and propertyset within a given time range.
• Data for all properties within a propertyset is deleted.

Mandatory parameters Entity, Property Set Name, from and to time

Response Status Codes
204 - timeseries deleted successfully

400 - Bad request, in case the resource is invalid

401 - Unauthorized

404 - Entity not found

500 - Server error, for more information see errorcode and message

Parameters:

entity - Unique identifier of the entity

propertySetName - Name of the propertyset

from - Beginning of the timerange in Date format to delete (exclusive)

to - End of the timerange in Date format to delete (inclusive)

sync - set this parameter to true for direct write to db store

Returns:

true if successful, false otherwise

Throws:

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