com.siemens.mindsphere.sdk.timeseries.apiclient

Class TimeSeriesOperationsClient

Object

MindsphereAPIClient

TimeSeriesOperationsClient

public class TimeSeriesOperationsClient
extends MindsphereAPIClient

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static TimeSeriesOperationsClient.ClientBuilder	builder()
MultiStatusError	createOrUpdateTimeseries(CreateOrUpdateTimeseriesRequest requestObject) Create or update time series data for mutiple unique asset-aspect (entity-property set) combinations.
void	createOrUpdateTimeseriesData(CreateOrUpdateTimeseriesDataRequest requestObject) Create or update time series data Create or update time series data for one combination of an asset (entity) and an(a) aspect (property set).
void	deleteTimeseries(DeleteUpdatedTimeseriesRequest requestObject) Delete time series data Delete time series data for one combination of an asset (entity) and an(a) aspect (property set).
List<TimeSeriesDataItem>	retrieveTimeseries(RetrieveTimeseriesRequest requestObject) Retrieve time series data Retrieve time series data for one combination of an asset (entity) and an(a) aspect (property set).

Methods inherited from class Object

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

Constructor Detail

TimeSeriesOperationsClient

public TimeSeriesOperationsClient(TimeSeriesOperationsClient.ClientBuilder builder)

Method Detail

builder

public static TimeSeriesOperationsClient.ClientBuilder builder()

createOrUpdateTimeseries

public MultiStatusError createOrUpdateTimeseries(CreateOrUpdateTimeseriesRequest requestObject)
                                          throws MindsphereException

Create or update time series data for mutiple unique asset-aspect (entity-property set) combinations. Create or update time series data for multiple unique combinations of assets (entities) and aspects (property sets). In case of an update of data at an already existing time, all properties at that time will be replaced by the ones provided in the request. All asset-aspect (entity-property set) combinations need to belong to the same tenant. Request body limitations: 1. A maximum of 5 asset-aspect (entity-property set) combinations can be provided 2. The request body size must be equal or less than 100 kb 3. A maximum of 100 time series data items can be provided overall

202 - Accepted. For each asset-aspect (entity-property set) pair a validation error can occur. In case an error is returned for an asset-aspect (entity-property set) pair, time series data for that pair is not considered. Possible validation errors are - 400: bad request schema for asset-aspect (entity-property set) pair - 404: asset (entity) and/or aspect(proprety set) not found - 429: asset-aspect (entity-property set) pair could not be processed due to too many requests - default: unexpected error while processing

400 - Bad request, in case the resource is invalid. Few of the validations as below - - Total number of records for all assets (entites) and aspects (property sets) should not be more than 100 per PUT request. - Total size of the payload should not be more than 100 kb per PUT request. - Payload cannot have more than 5 asset (entity)/aspect (property set) combinations.

401 - unauthorized

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

Parameters:

requestObject - - Object of type CreateOrUpdateTimeseriesRequest {Parameters are timeseries*}

Returns:

MultiStatusError

Throws:

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

createOrUpdateTimeseriesData

public void createOrUpdateTimeseriesData(CreateOrUpdateTimeseriesDataRequest requestObject)
                                  throws MindsphereException

Create or update time series data Create or update time series data for one combination of an asset (entity) and an(a) aspect (property set). In case of an update of data at an already existing time, all properties at that time will be replaced by the ones provided in the request.

204 - timeseries written

400 - bad request

401 - unauthorized

404 - asset (entity) not found

429 - too many requests

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

Parameters:

requestObject - - Object of type CreateOrUpdateTimeseriesDataRequest {Parameters are entityId*,propertySetName*,timeseries*}

Throws:

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

deleteTimeseries

public void deleteTimeseries(DeleteUpdatedTimeseriesRequest requestObject)
                      throws MindsphereException

Delete time series data Delete time series data for one combination of an asset (entity) and an(a) aspect (property set). All property values within the given time range are deleted.

204 - deleted

400 - bad request

401 - unauthorized

404 - asset (entity) not found

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

Parameters:

requestObject - - Object of type DeleteTimeseriesRequest {Parameters are entityId*,propertySetName*,from*,to*}

Throws:

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

retrieveTimeseries

public List<TimeSeriesDataItem> retrieveTimeseries(RetrieveTimeseriesRequest requestObject)
                                            throws MindsphereException

Retrieve time series data Retrieve time series data for one combination of an asset (entity) and an(a) aspect (property set). The maximum number of time series data items returned per request is defined by parameter <i>limit</i>. In case more time series data items are present in the requested time range, only a subset of data items will be returned and a header <i>link</i> is added to the response. The header value contains the request URL to fetch the next set of time series data items, by increasing the <i>from</i> parameter accordingly. Returns the latest record if no range is provided.

200 - array of time series

400 - bad request

401 - unauthorized

404 - asset (entity) not found

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

Parameters:

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

Returns:

List<TimeSeriesDataItem>

Throws:

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