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

Class AspectTypeClient

Object

MindsphereAPIClient

AspectTypeClient

public class AspectTypeClient
extends MindsphereAPIClient

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static AspectTypeClient.ClientBuilder	builder()
AspectTypeResource	createAspectType(String id, AspectTypeDto aspecttype) Create an aspect type Create or Update an aspect type.
boolean	deleteAspectType(String id, String ifMatch) Delete aspect type Delete an aspect type.
AspectTypeResource	getAspectTypeById(String id) Read an aspect type Read an aspect type.
AspectTypeResource	getAspectTypeById(String id, String ifNoneMatch) Read an aspect type Read an aspect type.
AspectTypes	getAspectTypes() List all aspect types
AspectTypes	getAspectTypes(Integer page, Integer size) List all aspect types
AspectTypes	getAspectTypes(Integer page, Integer size, String sort, String filter, String ifNoneMatch) List all aspect types
AspectTypes	getAspectTypes(String sort, String filter) List all aspect types
AspectTypeResource	updateAspectType(String id, AspectTypeDto aspecttype, String ifMatch) Update an aspect type Create or Update an aspect type.

Methods inherited from class Object

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

Constructor Detail

AspectTypeClient

protected AspectTypeClient(AspectTypeClient.ClientBuilder builder)

Method Detail

builder

public static AspectTypeClient.ClientBuilder builder()

getAspectTypes

public AspectTypes getAspectTypes(Integer page,
                                  Integer size,
                                  String sort,
                                  String filter,
                                  String ifNoneMatch)
                           throws MindsphereException

List all aspect types

Response Status Codes

200 - Array of aspect types matched the tenant scope and filter criterias

304 - Aspect-types page not changed

400 - Invalid request

401 - User is not authenticated

403 - User is not authorized for request

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

Parameters:

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\":\"aspecttype_name\"}" or as an encoded string, "%7B%22name%22:%22aspecttype_name%22%7D"

ifNoneMatch - ETag hash of previous request to allow caching

Returns:

AspectTypes

Throws:

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

getAspectTypes

public AspectTypes getAspectTypes()
                           throws MindsphereException

List all aspect types

Response Status Codes

200 - Array of aspect types matched the tenant scope and filter criterias

304 - Aspect-types page not changed

400 - Invalid request

401 - User is not authenticated

403 - User is not authorized for request

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

Returns:

AspectTypes

Throws:

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

MindsphereException

getAspectTypes

public AspectTypes getAspectTypes(Integer page,
                                  Integer size)
                           throws MindsphereException

List all aspect types

Response Status Codes

200 - Array of aspect types matched the tenant scope and filter criterias

304 - Aspect-types page not changed

400 - Invalid request

401 - User is not authenticated

403 - User is not authorized for request

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

Parameters:

page - Specifies the requested page index

size - Specifies the number of elements in a page

Returns:

AspectTypes

Throws:

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

MindsphereException

getAspectTypes

public AspectTypes getAspectTypes(String sort,
                                  String filter)
                           throws MindsphereException

List all aspect types

Response Status Codes

200 - Array of aspect types matched the tenant scope and filter criterias

304 - Aspect-types page not changed

400 - Invalid request

401 - User is not authenticated

403 - User is not authorized for request

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

Parameters:

sort - Specifies the ordering of returned elements

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

Returns:

AspectTypes

Throws:

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

getAspectTypeById

public AspectTypeResource getAspectTypeById(String id,
                                            String ifNoneMatch)
                                     throws MindsphereException

Read an aspect type Read an aspect type.

Response Status Codes

200 - Returns the aspect type

304 - AspectType not changed

400 - Invalid request

401 - User is not authenticated

403 - User is not authorized for request

404 - AspectType not found

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

Parameters:

id - id Unique identifier

ifNoneMatch - ETag hash of previous request to allow caching

Returns:

AspectTypeResource

Throws:

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

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

MindsphereException

getAspectTypeById

public AspectTypeResource getAspectTypeById(String id)
                                     throws MindsphereException

Read an aspect type Read an aspect type.

Response Status Codes

200 - Returns the aspect type

304 - AspectType not changed

400 - Invalid request

401 - User is not authenticated

403 - User is not authorized for request

404 - AspectType not found

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

Parameters:

id - id Unique identifier

Returns:

AspectTypeResource

Throws:

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

MindsphereException

updateAspectType

public AspectTypeResource updateAspectType(String id,
                                           AspectTypeDto aspecttype,
                                           String ifMatch)
                                    throws MindsphereException

Update an aspect type Create or Update an aspect type. Only adding variables supported.

Response Status Codes

200 - The aspect type has been updated

400 - Invalid request

401 - User is not authenticated

403 - User is not authorized for request

404 - AspectType not found

412 - AspectType is changed in the background

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

Parameters:

id - id Unique identifier

aspecttype - aspect type

ifMatch - Last known version to facilitate optimistic locking

Returns:

AspectTypeResource

Throws:

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

MindsphereException

createAspectType

public AspectTypeResource createAspectType(String id,
                                           AspectTypeDto aspecttype)
                                    throws MindsphereException

Create an aspect type Create or Update an aspect type. Only adding variables supported.

Response Status Codes

201 - The aspect type has been created

400 - Invalid request

401 - User is not authenticated

403 - User is not authorized for request

404 - AspectType not found

412 - AspectType is changed in the background

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

Parameters:

id - id Unique identifier

aspecttype - aspect type

Returns:

AspectTypeResource

Throws:

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

MindsphereException

deleteAspectType

public boolean deleteAspectType(String id,
                                String ifMatch)
                         throws MindsphereException

Delete aspect type Delete an aspect type. Aspect type can only be deleted if there is no asset type using it.

Response Status Codes

204 - Aspect type deletion was successful

400 - Invalid request

401 - User is not authenticated

403 - User is not authorized for request

404 - AspectType not found

412 - AspectType is changed in the background

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

Parameters:

id - id Unique identifier

ifMatch - Last known version to facilitate optimistic locking

Returns:

true if successful, false otherwise

Throws:

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

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

MindsphereException