com.siemens.mindsphere.sdk.assetmanagement.apiclient

Class AssetsClient

Object

MindsphereAPIClient

AssetsClient

public class AssetsClient
extends MindsphereAPIClient

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
AssetResourceWithHierarchyPath	addAsset(AddAssetRequest requestObject) Create an asset Creates a new asset with the provided content.
AssetResourceWithHierarchyPath	addAsset(Asset asset) Create an asset Creates a new asset with the provided content.
static AssetsClient.ClientBuilder	builder()
void	deleteAsset(DeleteAssetRequest requestObject) Delete an asset Deletes the given asset.
void	deleteAsset(String ifMatch, String id) Delete an asset Deletes the given asset.
AssetResourceWithHierarchyPath	deleteAssetFileAssigment(DeleteAssetFileAssigmentRequest requestObject) Deletes a file assignment from an asset Deletes a file assignment from an asset.
AssetResourceWithHierarchyPath	deleteAssetFileAssigment(String id, String key, String ifMatch) Deletes a file assignment from an asset Deletes a file assignment from an asset.
boolean	deleteAssetWithConfirmation(String ifMatch, String id) Deletes an asset and returns a boolean which confirms deletion.
AssetResourceWithHierarchyPath	getAsset(GetAssetRequest requestObject) Returns an asset.
AssetResourceWithHierarchyPath	getAsset(String id, String ifNoneMatch) Returns an asset.
AssetListResource	getAssetsContains(FieldTypeEnum fieldType, String filterValue) Filter assets by name or assetId or tenantId or externalId or subTenant or parentId or typeId.
AssetListResource	getAssetsEndsWith(FieldTypeEnum fieldType, String filterValue) Filter assets by name or assetId or tenantId or externalId or subTenant or parentId or typeId.
AssetListResource	getAssetsEqualTo(FieldTypeEnum fieldType, String filterValue) Filter assets by name or assetId or tenantId or externalId or subTenant or parentId or typeId.
AssetListResource	getAssetsLike(FieldTypeEnum fieldType, String... filterValue) Filter assets by name or assetId or tenantId or externalId or subTenant or parentId or typeId.
AssetListResource	getAssetsOfType(String filter) Filter all Assets by asset type id.
AssetListResource	getAssetsStartsWith(FieldTypeEnum fieldType, String filterValue) Filter assets by name or assetId or tenantId or externalId or subTenant or parentId or typeId.
RootAssetResource	getRootAsset(GetRootAssetRequest requestObject) Returns the root asset of the user.
RootAssetResource	getRootAsset(String ifNoneMatch) Returns the root asset of the user.
AssetListResource	listAssets(Integer page, Integer size, String sort, String filter, String ifNoneMatch) List all available assets List all assets available for the authenticated user.
AssetListResource	listAssets(ListAssetsRequest requestObject) List all available assets List all assets available for the authenticated user.
AssetResourceWithHierarchyPath	moveAsset(MoveAssetRequest requestObject) Move an asset Moves an asset (and all it's children) in the instance hierarchy
AssetResourceWithHierarchyPath	moveAsset(String ifMatch, String id, AssetMove moveParameters) Move an asset Moves an asset (and all it's children) in the instance hierarchy
AssetResourceWithHierarchyPath	replaceAsset(ReplaceAssetRequest requestObject) Update an asset Updates an asset with the provided content.
AssetResourceWithHierarchyPath	replaceAsset(String ifMatch, String id, AssetUpdate asset) Update an asset Updates an asset with the provided content.
AssetResourceWithHierarchyPath	saveAssetFileAssignment(SaveAssetFileAssignmentRequest requestObject) Save an file assignment to an asset Save a file assignment to a given asset
AssetResourceWithHierarchyPath	saveAssetFileAssignment(String id, String key, String ifMatch, KeyedFileAssignment assignment) Save an file assignment to an asset Save a file assignment to a given asset
AssetResourceWithHierarchyPath	updateAsset(String ifMatch, String id, AssetUpdate asset) Patch an asset Patch an asset with the provided content.
AssetResourceWithHierarchyPath	updateAsset(UpdateAssetRequest requestObject) Patch an asset Patch an asset with the provided content.

Methods inherited from class Object

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

Constructor Detail

AssetsClient

public AssetsClient(AssetsClient.ClientBuilder builder)

Method Detail

builder

public static AssetsClient.ClientBuilder builder()

addAsset

public AssetResourceWithHierarchyPath addAsset(AddAssetRequest requestObject)
                                        throws MindsphereException

Create an asset Creates a new asset with the provided content. Only instantiable types could be used.

201 - The asset is created

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:

requestObject - - Object of type AddAssetRequest {Parameters are asset*}

Returns:

AssetResourceWithHierarchyPath

Throws:

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

deleteAsset

public void deleteAsset(DeleteAssetRequest requestObject)
                 throws MindsphereException

Delete an asset Deletes the given asset. After deletion only users with admin role can read it, but modification is not possible anymore. It's not possible to delete an asset if it has children.

204 - Asset deletion was successful

400 - Invalid request

401 - User is not authenticated

403 - User is not authorized for request

404 - Asset not found

412 - Asset is changed in the background

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

Parameters:

requestObject - - Object of type DeleteAssetRequest {Parameters are If-Match*,id*}

Throws:

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

deleteAssetFileAssigment

public AssetResourceWithHierarchyPath deleteAssetFileAssigment(DeleteAssetFileAssigmentRequest requestObject)
                                                        throws MindsphereException

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

200 - The assignment has been deleted

401 - User is not authenticated

403 - User is not authorized for request

404 - Asset or key not found

412 - Asset or the file assignment has changed in the background

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

Parameters:

requestObject - - Object of type DeleteAssetFileAssigmentRequest {Parameters are id*,key*,If-Match*}

Returns:

AssetResourceWithHierarchyPath

Throws:

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

getAsset

public AssetResourceWithHierarchyPath getAsset(GetAssetRequest requestObject)
                                        throws MindsphereException

Returns an asset. Read a single asset. All static properties of asset are returned.

200 - Returns an asset with its static properties.

304 - Resource asset is not modified

401 - User is not authenticated

403 - User is not authorized for request

404 - Not found

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

Parameters:

requestObject - - Object of type GetAssetRequest {Parameters are id*,If-None-Match}

Returns:

AssetResourceWithHierarchyPath

Throws:

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

getRootAsset

public RootAssetResource getRootAsset(GetRootAssetRequest requestObject)
                               throws MindsphereException

Returns the root asset of the user. Read the root asset of the user, from which the whole asset hierarchy can be rebuilt.

200 - Returns the root asset of the user.

304 - Resource asset is not modified

401 - User is not authenticated

403 - User is not authorized for request

404 - Not found

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

Parameters:

requestObject - - Object of type GetRootAssetRequest {Parameters are If-None-Match}

Returns:

RootAssetResource

Throws:

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

listAssets

public AssetListResource listAssets(ListAssetsRequest requestObject)
                             throws MindsphereException

List all available assets List all assets available for the authenticated user. ## Filter Supports all basic fields and the 'hasType' filter which search for the assets with type that originated from the given asset type. # Examples Example: This filter searches for assets which type is exactly the given type: ``` { \"typeId\": \"mandal.ship\" } ``` Beyond the basic fields we can search for assets which type is inherited from the given type: ``` { \"hasType\": \"mandal.ship\" } ```

200 - Array of assets matched the tenant scope and filter criterias

304 - The answer's content has not changed since the last request

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:

requestObject - - Object of type ListAssetsRequest {Parameters are page,size,sort,filter,If-None-Match}

Returns:

AssetListResource

Throws:

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

moveAsset

public AssetResourceWithHierarchyPath moveAsset(MoveAssetRequest requestObject)
                                         throws MindsphereException

Move an asset Moves an asset (and all it's children) in the instance hierarchy

200 - The asset is moved

400 - Invalid request

401 - User is not authenticated

403 - User is not authorized for request

404 - Asset not found

412 - Asset is changed in the background

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

Parameters:

requestObject - - Object of type MoveAssetRequest {Parameters are If-Match*,id*,moveParameters*}

Returns:

AssetResourceWithHierarchyPath

Throws:

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

replaceAsset

public AssetResourceWithHierarchyPath replaceAsset(ReplaceAssetRequest requestObject)
                                            throws MindsphereException

Update an asset Updates an asset with the provided content. Only values can be modified, asset's structure have to be modified in asset's type

200 - The asset is updated

400 - Invalid request

401 - User is not authenticated

403 - User is not authorized for request

404 - Asset not found

412 - Asset is changed in the background

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

Parameters:

requestObject - - Object of type ReplaceAssetRequest {Parameters are If-Match*,id*,asset*}

Returns:

AssetResourceWithHierarchyPath

Throws:

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

saveAssetFileAssignment

public AssetResourceWithHierarchyPath saveAssetFileAssignment(SaveAssetFileAssignmentRequest requestObject)
                                                       throws MindsphereException

Save an file assignment to an asset Save a file assignment to a given asset

200 - The assignment has been updated or a new assignment has been added

401 - User is not authenticated

403 - User is not authorized for request

404 - Asset not found

412 - Asset or the file assignment has changed in the background

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

Parameters:

requestObject - - Object of type SaveAssetFileAssignmentRequest {Parameters are id*,key*,If-Match*,assignment*}

Returns:

AssetResourceWithHierarchyPath

Throws:

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

updateAsset

public AssetResourceWithHierarchyPath updateAsset(UpdateAssetRequest requestObject)
                                           throws MindsphereException

Patch an asset Patch an asset with the provided content. Only values can be modified, asset's structure have to be modified in asset's type. Conforms to RFC 7396 - JSON merge Patch.

200 - The asset is updated

400 - Invalid request

401 - User is not authenticated

403 - User is not authorized for request

404 - Asset not found

412 - Asset is changed in the background

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

Parameters:

requestObject - - Object of type UpdateAssetRequest {Parameters are If-Match*,id*,asset*}

Returns:

AssetResourceWithHierarchyPath

Throws:

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

addAsset

public AssetResourceWithHierarchyPath addAsset(Asset asset)
                                        throws MindsphereException

Create an asset Creates a new asset with the provided content. Only instantiable types could be used.

201 - The asset is created

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:

asset - asset

Returns:

AssetResourceWithHierarchyPath

Throws:

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

deleteAsset

public void deleteAsset(String ifMatch,
                        String id)
                 throws MindsphereException

Delete an asset Deletes the given asset. After deletion only users with admin role can read it, but modification is not possible anymore. It's not possible to delete an asset if it has children.

204 - Asset deletion was successful

400 - Invalid request

401 - User is not authenticated

403 - User is not authorized for request

404 - Asset not found

412 - Asset is changed in the background

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

Parameters:

ifMatch - Last known version to facilitate optimistic locking

id - Unique identifier

Throws:

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

deleteAssetFileAssigment

public AssetResourceWithHierarchyPath deleteAssetFileAssigment(String id,
                                                               String key,
                                                               String ifMatch)
                                                        throws MindsphereException

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

200 - The assignment has been deleted

401 - User is not authenticated

403 - User is not authorized for request

404 - Asset or key not found

412 - Asset or the file assignment has changed in the background

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

Parameters:

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:

AssetResourceWithHierarchyPath

Throws:

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

getAsset

public AssetResourceWithHierarchyPath getAsset(String id,
                                               String ifNoneMatch)
                                        throws MindsphereException

Returns an asset. Read a single asset. All static properties of asset are returned.

200 - Returns an asset with its static properties.

304 - Resource asset is not modified

401 - User is not authenticated

403 - User is not authorized for request

404 - Not found

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

Parameters:

id - Unique identifier

ifNoneMatch - ETag hash of previous request to allow caching

Returns:

AssetResourceWithHierarchyPath

Throws:

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

getRootAsset

public RootAssetResource getRootAsset(String ifNoneMatch)
                               throws MindsphereException

Returns the root asset of the user. Read the root asset of the user, from which the whole asset hierarchy can be rebuilt.

200 - Returns the root asset of the user.

304 - Resource asset is not modified

401 - User is not authenticated

403 - User is not authorized for request

404 - Not found

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

Parameters:

ifNoneMatch - ETag hash of previous request to allow caching

Returns:

RootAssetResource

Throws:

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

listAssets

public AssetListResource listAssets(Integer page,
                                    Integer size,
                                    String sort,
                                    String filter,
                                    String ifNoneMatch)
                             throws MindsphereException

List all available assets List all assets available for the authenticated user. ## Filter Supports all basic fields and the 'hasType' filter which search for the assets with type that originated from the given asset type. # Examples Example: This filter searches for assets which type is exactly the given type: ``` { \"typeId\": \"mandal.ship\" } ``` Beyond the basic fields we can search for assets which type is inherited from the given type: ``` { \"hasType\": \"mandal.ship\" } ```

200 - Array of assets matched the tenant scope and filter criterias

304 - The answer's content has not changed since the last request

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

ifNoneMatch - ETag hash of previous request to allow caching

Returns:

AssetListResource

Throws:

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

moveAsset

public AssetResourceWithHierarchyPath moveAsset(String ifMatch,
                                                String id,
                                                AssetMove moveParameters)
                                         throws MindsphereException

Move an asset Moves an asset (and all it's children) in the instance hierarchy

200 - The asset is moved

400 - Invalid request

401 - User is not authenticated

403 - User is not authorized for request

404 - Asset not found

412 - Asset is changed in the background

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

Parameters:

ifMatch - Last known version to facilitate optimistic locking

id - Unique identifier

moveParameters - parameters for the asset move

Returns:

AssetResourceWithHierarchyPath

Throws:

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

replaceAsset

public AssetResourceWithHierarchyPath replaceAsset(String ifMatch,
                                                   String id,
                                                   AssetUpdate asset)
                                            throws MindsphereException

Update an asset Updates an asset with the provided content. Only values can be modified, asset's structure have to be modified in asset's type

200 - The asset is updated

400 - Invalid request

401 - User is not authenticated

403 - User is not authorized for request

404 - Asset not found

412 - Asset is changed in the background

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

Parameters:

ifMatch - Last known version to facilitate optimistic locking

id - Unique identifier

asset - asset

Returns:

AssetResourceWithHierarchyPath

Throws:

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

saveAssetFileAssignment

public AssetResourceWithHierarchyPath saveAssetFileAssignment(String id,
                                                              String key,
                                                              String ifMatch,
                                                              KeyedFileAssignment assignment)
                                                       throws MindsphereException

Save an file assignment to an asset Save a file assignment to a given asset

200 - The assignment has been updated or a new assignment has been added

401 - User is not authenticated

403 - User is not authorized for request

404 - Asset not found

412 - Asset or the file assignment has changed in the background

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

Parameters:

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

assignment - Data for file assignment

Returns:

AssetResourceWithHierarchyPath

Throws:

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

updateAsset

public AssetResourceWithHierarchyPath updateAsset(String ifMatch,
                                                  String id,
                                                  AssetUpdate asset)
                                           throws MindsphereException

Patch an asset Patch an asset with the provided content. Only values can be modified, asset's structure have to be modified in asset's type. Conforms to RFC 7396 - JSON merge Patch.

200 - The asset is updated

400 - Invalid request

401 - User is not authenticated

403 - User is not authorized for request

404 - Asset not found

412 - Asset is changed in the background

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

Parameters:

ifMatch - Last known version to facilitate optimistic locking

id - Unique identifier

asset - asset

Returns:

AssetResourceWithHierarchyPath

Throws:

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

deleteAssetWithConfirmation

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

Deletes an asset and returns a boolean which confirms deletion. It internally checks existence of the asset after we receive a confirmation from server. It retries 3 times for getting the confirmation from server. After deletion only users with admin role can read it, but modification is not possible anymore. It's not possible to delete an asset if it has children.

204 - Asset deletion was successful

400 - Invalid request

401 - User is not authenticated

403 - User is not authorized for request

404 - Asset not found

412 - Asset is changed in the background

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

Parameters:

ifMatch - Last known version to facilitate optimistic locking

id - Unique identifier

Returns:

boolean to determine whether the asset deletion is confirmed.

Throws:

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

getAssetsEqualTo

public AssetListResource getAssetsEqualTo(FieldTypeEnum fieldType,
                                          String filterValue)
                                   throws MindsphereException

Filter assets by name or assetId or tenantId or externalId or subTenant or parentId or typeId. Returns assets whose name or tenantId equals to filterValue. Only one field type and value can be passed at a time.

200 - Array of assets matched the tenant scope and filter criterias

304 - The answer's content has not changed since the last request

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:

fieldType - Field type on which assets need to be filtered.

filterValue - Value based on which assets need to be filtered.

Returns:

AssetListResource

Throws:

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

getAssetsLike

public AssetListResource getAssetsLike(FieldTypeEnum fieldType,
                                       String... filterValue)
                                throws MindsphereException

Filter assets by name or assetId or tenantId or externalId or subTenant or parentId or typeId. Returns assets whose name or tenantId matches an array of filter values. One field type and multiple filter values can be passed.

200 - Array of assets matched the tenant scope and filter criterias

304 - The answer's content has not changed since the last request

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:

fieldType - Field type on which assets need to be filtered.

filterValue - Variable array of values based on which assets need to be filtered.

Returns:

AssetListResource

Throws:

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

getAssetsOfType

public AssetListResource getAssetsOfType(String filter)
                                  throws MindsphereException

Filter all Assets by asset type id. Returns all assets of a particular asset type.

200 - Array of assets matched the tenant scope and filter criterias

304 - The answer's content has not changed since the last request

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:

filter - filter assets of a particular asset type.

Returns:

AssetListResource

Throws:

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

getAssetsStartsWith

public AssetListResource getAssetsStartsWith(FieldTypeEnum fieldType,
                                             String filterValue)
                                      throws MindsphereException

Filter assets by name or assetId or tenantId or externalId or subTenant or parentId or typeId. Returns assets whose name or assetId or tenantId or externalId or subTenant or parentId or typeId starts with the filter value. Only one field type and filter value can be passed.

200 - Array of assets matched the tenant scope and filter criterias

304 - The answer's content has not changed since the last request

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:

fieldType - Field type on which assets need to be filtered.

filterValue - Value based on which assets need to be filtered.

Returns:

AssetListResource

Throws:

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

getAssetsEndsWith

public AssetListResource getAssetsEndsWith(FieldTypeEnum fieldType,
                                           String filterValue)
                                    throws MindsphereException

Filter assets by name or assetId or tenantId or externalId or subTenant or parentId or typeId. Returns assets whose name or assetId or tenantId or externalId or subTenant or parentId or typeId ends with the filter value. Only one field type and filter value can be passed.

200 - Array of assets matched the tenant scope and filter criterias

304 - The answer's content has not changed since the last request

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:

fieldType - Field type on which assets need to be filtered.

filterValue - Value based on which assets need to be filtered.

Returns:

AssetListResource

Throws:

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

getAssetsContains

public AssetListResource getAssetsContains(FieldTypeEnum fieldType,
                                           String filterValue)
                                    throws MindsphereException

Filter assets by name or assetId or tenantId or externalId or subTenant or parentId or typeId. Returns assets whose name or assetId or tenantId or externalId or subTenant or parentId or typeId contains the filter value. Only one field type and filter value can be passed.

200 - Array of assets matched the tenant scope and filter criterias

304 - The answer's content has not changed since the last request

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:

fieldType - Field type on which assets need to be filtered.

filterValue - Value based on which assets need to be filtered.

Returns:

AssetListResource

Throws:

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