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

Class AssetStructureClient

Object

MindsphereAPIClient

AssetStructureClient

public class AssetStructureClient
extends MindsphereAPIClient

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static AssetStructureClient.ClientBuilder	builder()
StructureAspects	getAspects(String id) Get all static and dynamic aspects of a given asset
StructureAspects	getAspects(String id, Integer page, Integer size) Get all static and dynamic aspects of a given asset
StructureAspects	getAspects(String id, Integer page, Integer size, String sort, String filter, String ifNoneMatch) Get all static and dynamic aspects of a given asset
StructureAspects	getAspects(String id, String sort, String filter) Get all static and dynamic aspects of a given asset
StructureVariables	getVariables(String id) Get all variables of a given asset including inherited ones
StructureVariables	getVariables(String id, Integer page, Integer size) Get all variables of a given asset including inherited ones
StructureVariables	getVariables(String id, Integer page, Integer size, String sort, String filter, String ifNoneMatch) Get all variables of a given asset including inherited ones
StructureVariables	getVariables(String id, String sort, String filter) Get all variables of a given asset including inherited ones

Methods inherited from class Object

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

Constructor Detail

AssetStructureClient

protected AssetStructureClient(AssetStructureClient.ClientBuilder builder)

Method Detail

builder

public static AssetStructureClient.ClientBuilder builder()

getVariables

public StructureVariables getVariables(String id,
                                       Integer page,
                                       Integer size,
                                       String sort,
                                       String filter,
                                       String ifNoneMatch)
                                throws MindsphereException

Get all variables of a given asset including inherited ones

Response Status Codes

200 - Variables of the given asset matched by the given filter criteria

304 - Resource variables have not been modified

400 - Bad request, in case of invalid parameters

401 - User is not authenticated

403 - User is not authorized for request

404 - Asset not found

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

Parameters:

id - Unique identifier

page - Specifies the requested page index

size - Specifies the number of elements in a page

sort - Specifies the ordering of returned elements

filter - Specifies the additional filtering criteria, e.g. "{\"name\":\"variable_name\"}" or as an encoded string, "%7B%22name%22:%22variable_name%22%7D"

ifNoneMatch - ETag hash of previous request to allow caching

Returns:

StructureVariables

Throws:

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

getVariables

public StructureVariables getVariables(String id)
                                throws MindsphereException

Get all variables of a given asset including inherited ones

Response Status Codes

200 - Variables of the given asset matched by the given filter criteria

304 - Resource variables have not been modified

400 - Bad request, in case of invalid parameters

401 - User is not authenticated

403 - User is not authorized for request

404 - Asset not found

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

Parameters:

id - Unique identifier

Returns:

StructureVariables

Throws:

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

MindsphereException

getVariables

public StructureVariables getVariables(String id,
                                       Integer page,
                                       Integer size)
                                throws MindsphereException

Get all variables of a given asset including inherited ones

Response Status Codes

200 - Variables of the given asset matched by the given filter criteria

304 - Resource variables have not been modified

400 - Bad request, in case of invalid parameters

401 - User is not authenticated

403 - User is not authorized for request

404 - Asset not found

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

Parameters:

id - Unique identifier

page - Specifies the requested page index

size - Specifies the number of elements in a page

Returns:

StructureVariables

Throws:

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

MindsphereException

getVariables

public StructureVariables getVariables(String id,
                                       String sort,
                                       String filter)
                                throws MindsphereException

Get all variables of a given asset including inherited ones

Response Status Codes

200 - Variables of the given asset matched by the given filter criteria

304 - Resource variables have not been modified

400 - Bad request, in case of invalid parameters

401 - User is not authenticated

403 - User is not authorized for request

404 - Asset not found

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

Parameters:

id - Unique identifier

sort - Specifies the ordering of returned elements

filter - Specifies the additional filtering criteria, e.g. "{\"name\":\"variable_name\"}" or as an encoded string, "%7B%22name%22:%22variable_name%22%7D"

Returns:

StructureVariables

Throws:

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

MindsphereException

getAspects

public StructureAspects getAspects(String id,
                                   Integer page,
                                   Integer size,
                                   String sort,
                                   String filter,
                                   String ifNoneMatch)
                            throws MindsphereException

Get all static and dynamic aspects of a given asset

Response Status Codes

200 - Static and dynamic aspects of the given asset matched by the given filter criteria

304 - Resource aspects have not been modified

400 - Bad request, in case of invalid parameters

401 - User is not authenticated

403 - User is not authorized for request

404 - Asset not found

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

Parameters:

id - Unique identifier

page - Specifies the requested page index

size - Specifies the number of elements in a page

sort - Specifies the ordering of returned elements

filter - Specifies the additional filtering criteria, e.g. "{\"name\":\"aspect_name\"}" or as an encoded string, "%7B%22name%22:%22aspect_name%22%7D"

ifNoneMatch - ETag hash of previous request to allow caching

Returns:

StructureAspects

Throws:

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

getAspects

public StructureAspects getAspects(String id)
                            throws MindsphereException

Get all static and dynamic aspects of a given asset

Response Status Codes

200 - Static and dynamic aspects of the given asset matched by the given filter criterias

304 - Resource aspects have not been modified

400 - Bad request, in case of invalid parameters

401 - User is not authenticated

403 - User is not authorized for request

404 - Asset not found

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

Parameters:

id - Unique identifier

Returns:

StructureAspects

Throws:

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

MindsphereException

getAspects

public StructureAspects getAspects(String id,
                                   Integer page,
                                   Integer size)
                            throws MindsphereException

Get all static and dynamic aspects of a given asset

Response Status Codes

200 - Static and dynamic aspects of the given asset matched by the given filter criterias

304 - Resource aspects have not been modified

400 - Bad request, in case of invalid parameters

401 - User is not authenticated

403 - User is not authorized for request

404 - Asset not found

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

Parameters:

id - Unique identifier

page - Specifies the requested page index

size - Specifies the number of elements in a page

Returns:

StructureAspects

Throws:

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

MindsphereException

getAspects

public StructureAspects getAspects(String id,
                                   String sort,
                                   String filter)
                            throws MindsphereException

Get all static and dynamic aspects of a given asset

Response Status Codes

200 - Static and dynamic aspects of the given asset matched by the given filter criteria

304 - Resource aspects have not been modified

400 - Bad request, in case of invalid parameters

401 - User is not authenticated

403 - User is not authorized for request

404 - Asset not found

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

Parameters:

id - Unique identifier

sort - Specifies the ordering of returned elements

filter - Specifies the additional filtering criteria, e.g. "{\"name\":\"aspect_name\"}" or as an encoded string, "%7B%22name%22:%22aspect_name%22%7D"

Returns:

StructureAspects

Throws:

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

MindsphereException