com.siemens.mindsphere.sdk.iot.asset.apiclient

Class AssetLocationClient

Object

MindsphereAPIClient

AssetLocationClient

public class AssetLocationClient
extends MindsphereAPIClient

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AssetLocationClient.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

Modifier	Constructor and Description
protected	AssetLocationClient(AssetLocationClient.ClientBuilder builder)

Method Summary

Modifier and Type	Method and Description
static AssetLocationClient.ClientBuilder	builder()
void	createOrUpdateAssetLocation(String id, Location location, String ifMatch) Update location assigned to given asset.
AssetResource	deleteAssetLocation(String id, String ifMatch) Delete location assigned to given asset.

Methods inherited from class Object

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

Constructor Detail

AssetLocationClient

protected AssetLocationClient(AssetLocationClient.ClientBuilder builder)

Method Detail

builder

public static AssetLocationClient.ClientBuilder builder()

deleteAssetLocation

public AssetResource deleteAssetLocation(String id,
                                         String ifMatch)
                                  throws MindsphereException

Delete location assigned to given asset.

• Only those locations can be deleted here which assigned to the given asset.
• If the location inherited from an ancestor asset, you have to delete the location with the assigned assetId (using location url in AssetResource object with DELETE method).
• The response contains the updated AssetResource with the inherited Location details.

Response Status Codes

200 - Location has been successfully deleted

401 - User is not authenticated

403 - User is not authorized for request

404 - Asset not found with given asset identifier

409 - Location not assigned to the given asset

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

Parameters:

id - Unique identifier

ifMatch - Last known version to facilitate optimistic locking

Returns:

AssetResource

Throws:

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

createOrUpdateAssetLocation

public void createOrUpdateAssetLocation(String id,
                                        Location location,
                                        String ifMatch)
                                 throws MindsphereException

Update location assigned to given asset.

• If the given asset has own location, this endpoint will update that location.
• If the given asset has inherited location, this endpoint will create a new location and update the given asset.
• If you want to update the inherited location, you have to use the \\'location\\' url in AssetResource object (with PUT method).

Response Status Codes

200 - Location has been successfully created or updated

400 - Invalid request

401 - User is not authenticated

403 - User is not authorized for request

404 - Asset not found with given asset identifier

412 - Location is changed in the background

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

Parameters:

id - Unique identifier

location - location

ifMatch - Last known version to facilitate optimistic locking

Throws:

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