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

Class AssetTypeClient

Object

MindsphereAPIClient

AssetTypeClient

public class AssetTypeClient
extends MindsphereAPIClient

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static AssetTypeClient.ClientBuilder	builder()
AssetTypeResource	createAssetType(String id, AssetTypeDto assettype) Create an asset type
boolean	deleteAssetType(String id, String ifMatch) Delete an asset type Deletes an asset type.
AssetTypeResource	deleteFileAssignment(String id, String key, String ifMatch) Deletes a file assignment from an asset type.
AssetTypeResource	getAssetTypeById(String id) Read an asset type
AssetTypeResource	getAssetTypeById(String id, String ifNoneMatch) Read an asset type
AssetTypeResource	getAssetTypeById(String id, String ifNoneMatch, Boolean exploded) Read an asset type
AssetTypes	getAssetTypes() List all asset types
AssetTypes	getAssetTypes(Integer page, Integer size) List all asset types
AssetTypes	getAssetTypes(Integer page, Integer size, String sort, String filter, String ifNoneMatch) List all asset types
AssetTypes	getAssetTypes(String sort, String filter) List all asset types
AssetTypeResource	updateAssetType(String id, AssetTypeDto assettype, String ifMatch) Update an asset type
AssetTypeResource	updateFileAssignment(String id, String key, FileAssignmentDto assignment, String ifMatch) Add a new file assignment to a given asset type.

Methods inherited from class Object

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

Constructor Detail

AssetTypeClient

protected AssetTypeClient(AssetTypeClient.ClientBuilder builder)

Method Detail

builder

public static AssetTypeClient.ClientBuilder builder()

getAssetTypes

public AssetTypes getAssetTypes(Integer page,
                                Integer size,
                                String sort,
                                String filter,
                                String ifNoneMatch)
                         throws MindsphereException

List all asset types

Response Status Codes

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

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

ifNoneMatch - ETag hash of previous request to allow caching

Returns:

AssetTypes

Throws:

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

getAssetTypes

public AssetTypes getAssetTypes()
                         throws MindsphereException

List all asset types

Response Status Codes

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

304 - Asset-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:

AssetTypes

Throws:

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

getAssetTypes

public AssetTypes getAssetTypes(Integer page,
                                Integer size)
                         throws MindsphereException

List all asset types

Response Status Codes

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

304 - Asset-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:

AssetTypes

Throws:

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

getAssetTypes

public AssetTypes getAssetTypes(String sort,
                                String filter)
                         throws MindsphereException

List all asset types

Response Status Codes

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

304 - Asset-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 error-code and message

Parameters:

sort - Specifies the ordering of returned elements

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

Returns:

AssetTypes

Throws:

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

getAssetTypeById

public AssetTypeResource getAssetTypeById(String id,
                                          String ifNoneMatch,
                                          Boolean exploded)
                                   throws MindsphereException

Read an asset type

Response Status Codes

200 - Returns the asset type

304 - AssetType 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:

id - id Unique identifier

ifNoneMatch - ETag hash of previous request to allow caching

exploded - Specifies if the asset type should include all of it's inherited variables and aspects. Default is false.

Returns:

AssetTypeResource

Throws:

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

getAssetTypeById

public AssetTypeResource getAssetTypeById(String id,
                                          String ifNoneMatch)
                                   throws MindsphereException

Read an asset type

Response Status Codes

200 - Returns the asset type

304 - AssetType 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:

id - id Unique identifier

ifNoneMatch - ETag hash of previous request to allow caching inherited variables and aspects. Default is false.

Returns:

AssetTypeResource

Throws:

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

getAssetTypeById

public AssetTypeResource getAssetTypeById(String id)
                                   throws MindsphereException

Read an asset type

Response Status Codes

200 - Returns the asset type

304 - AssetType 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:

id - id Unique identifier

Returns:

AssetTypeResource

Throws:

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

updateAssetType

public AssetTypeResource updateAssetType(String id,
                                         AssetTypeDto assettype,
                                         String ifMatch)
                                  throws MindsphereException

Update an asset type

Response Status Codes 200 - The asset type has been updated

400 - Invalid request

401 - User is not authenticated

403 - User is not authorized for request

412 - AssetType is changed in the background

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

Parameters:

id - id Unique identifier

assettype - asset type

ifMatch - Last known version to facilitate optimistic locking

Returns:

AssetTypeResource

Throws:

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

createAssetType

public AssetTypeResource createAssetType(String id,
                                         AssetTypeDto assettype)
                                  throws MindsphereException

Create an asset type

201 - The asset type has been created

400 - Invalid request

401 - User is not authenticated

403 - User is not authorized for request

412 - AssetType is changed in the background

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

Parameters:

id - id Unique identifier

assettype - asset type

Returns:

AssetTypeResource

Throws:

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

deleteAssetType

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

Delete an asset type Deletes an asset type. Deletion only possible when the type has no child-type and there is no asset that instantiate it.

Response Status Codes

204 - Asset type deletion was successful

400 - Invalid request

401 - User is not authenticated

403 - User is not authorized for request

412 - AssetType 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:

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

updateFileAssignment

public AssetTypeResource updateFileAssignment(String id,
                                              String key,
                                              FileAssignmentDto assignment,
                                              String ifMatch)
                                       throws MindsphereException

Add a new file assignment to a given asset type. All asset which extends these types will have its file by default.

Response Status Codes 200 - The assignment has been updated or a new assignment has been added

400 - Invalid request

401 - User is not authenticated

403 - User is not authorized for request

412 - AssetType is changed in the background

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

Parameters:

id - id Unique identifier

key - key Keyword for the file to be assigned to an asset or asset type.

assignment - Data for file assignment

ifMatch - Last known version to facilitate optimistic locking

Returns:

AssetTypeResource

Throws:

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

deleteFileAssignment

public AssetTypeResource deleteFileAssignment(String id,
                                              String key,
                                              String ifMatch)
                                       throws MindsphereException

Deletes a file assignment from an asset type. If the type's parent has defined a file with the same key, the key will be displayed with the inherited value.

Response Status Codes

200 -The assignment has been deleted

400 - Invalid request

401 - User is not authenticated

403 - User is not authorized for request

412 - AssetType is changed in the background

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

Parameters:

id - id Unique identifier

key - Keyword for the file to be assigned to an asset or asset type.

ifMatch - Last known version to facilitate optimistic locking

Returns:

AssetTypeResource

Throws:

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