com.siemens.mindsphere.sdk.assetmanagement.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

Constructor and Description
AssettypeClient(AssettypeClient.ClientBuilder builder)

Method Summary

Modifier and Type	Method and Description
static AssettypeClient.ClientBuilder	builder()
void	deleteAssetType(DeleteAssetTypeRequest requestObject) Delete an asset type Deletes an asset type.
void	deleteAssetType(String ifMatch, String id) Delete an asset type Deletes an asset type.
AssetTypeResource	deleteAssetTypeFileAssignment(DeleteAssetTypeFileAssignmentRequest requestObject) Deletes a file assignment from an asset type Deletes a file assignment from an asset type.
AssetTypeResource	deleteAssetTypeFileAssignment(String id, String key, String ifMatch) Deletes a file assignment from an asset type Deletes a file assignment from an asset type.
AssetTypeResource	getAssetType(GetAssetTypeRequest requestObject) Read an asset type Read an asset type
AssetTypeResource	getAssetType(String id, String ifNoneMatch, Boolean exploded) Read an asset type Read an asset type
AssetTypeListResource	getAssetTypesContains(FieldTypeEnum fieldType, String filterValue) Filter asset types by name or tenantId or parentTypeId.
AssetTypeListResource	getAssetTypesEndsWith(FieldTypeEnum fieldType, String filterValue) Filter asset types by name or tenantId or parentTypeId.
AssetTypeListResource	getAssetTypesEqualTo(FieldTypeEnum fieldType, String filterValue) Filter asset types by name or tenantId or parentTypeId.
AssetTypeListResource	getAssetTypesLike(FieldTypeEnum fieldType, String... filterValue) Filter asset types by name or tenantId or parentTypeId.
AssetTypeListResource	getAssetTypesStartsWith(FieldTypeEnum fieldType, String filterValue) Filter asset types by name or tenantId or parentTypeId.
AssetTypeListResource	listAssetTypes(Integer page, Integer size, String sort, String filter, String ifNoneMatch, Boolean exploded) List all asset types List all asset types
AssetTypeListResource	listAssetTypes(ListAssetTypesRequest requestObject) List all asset types List all asset types
AssetTypeResource	saveAssetType(SaveAssetTypeRequest requestObject) Create or Update an asset type Create or Update an asset type
AssetTypeResource	saveAssetType(String id, AssetType assettype, String ifMatch) Create or Update an asset type Create or Update an asset type
AssetTypeResource	saveAssetType(String id, AssetType assettype, String ifMatch, String ifNoneMatch, Boolean exploded) Create or Update an asset type Create or Update an asset type
AssetTypeResource	saveAssetTypeFileAssignment(SaveAssetTypeFileAssignmentRequest requestObject) Add a new file assignment to an asset type Add a new file assignment to a given asset type.
AssetTypeResource	saveAssetTypeFileAssignment(String ifMatch, String id, String key, KeyedFileAssignment assignment) Add a new file assignment to an asset type Add a new file assignment to a given asset type.
AssetTypeResource	updateAssetType(String ifMatch, String id, AssetType assettype) Patch an asset type Patch an asset type.
AssetTypeResource	updateAssetType(String ifMatch, String id, AssetType assettype, Boolean exploded) Patch an asset type Patch an asset type.
AssetTypeResource	updateAssetType(UpdateAssetTypeRequest requestObject) Patch an asset type Patch an asset type.

Methods inherited from class Object

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

Constructor Detail

AssettypeClient

public AssettypeClient(AssettypeClient.ClientBuilder builder)

Method Detail

builder

public static AssettypeClient.ClientBuilder builder()

deleteAssetType

public void deleteAssetType(DeleteAssetTypeRequest requestObject)
                     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.

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:

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

Throws:

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

deleteAssetTypeFileAssignment

public AssetTypeResource deleteAssetTypeFileAssignment(DeleteAssetTypeFileAssignmentRequest requestObject)
                                                throws MindsphereException

Deletes a file assignment from an asset type 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.

200 - The assignment has been deleted

401 - User is not authenticated

403 - User is not authorized for request

404 - Asset type or key not found

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

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

Parameters:

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

Returns:

AssetTypeResource

Throws:

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

getAssetType

public AssetTypeResource getAssetType(GetAssetTypeRequest requestObject)
                               throws MindsphereException

Read an asset type Read an asset type

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:

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

Returns:

AssetTypeResource

Throws:

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

listAssetTypes

public AssetTypeListResource listAssetTypes(ListAssetTypesRequest requestObject)
                                     throws MindsphereException

List all asset types List all asset types

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:

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

Returns:

AssetTypeListResource

Throws:

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

saveAssetType

public AssetTypeResource saveAssetType(SaveAssetTypeRequest requestObject)
                                throws MindsphereException

Create or Update an asset type Create or Update an asset type

200 - The asset type has been updated

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:

requestObject - - Object of type SaveAssetTypeRequest {Parameters are id*,assettype*,If-Match,If-None-Match,exploded}

Returns:

AssetTypeResource

Throws:

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

saveAssetTypeFileAssignment

public AssetTypeResource saveAssetTypeFileAssignment(SaveAssetTypeFileAssignmentRequest requestObject)
                                              throws MindsphereException

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

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 type not found

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

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

Parameters:

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

Returns:

AssetTypeResource

Throws:

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

updateAssetType

public AssetTypeResource updateAssetType(UpdateAssetTypeRequest requestObject)
                                  throws MindsphereException

Patch an asset type Patch an asset type. Patching requires the inclusion of all existing variables and aspects. Missing file assignments will be deleted. Other fields may be omitted. Conforms to RFC 7396 - JSON merge Patch.

200 - The asset type has been updated

400 - Invalid request

401 - User is not authenticated

403 - User is not authorized for request

404 - AssetType not found

412 - AssetType is changed in the background

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

Parameters:

requestObject - - Object of type UpdateAssetTypeRequest {Parameters are If-Match*,id*,assettype*,exploded}

Returns:

AssetTypeResource

Throws:

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

deleteAssetType

public void deleteAssetType(String ifMatch,
                            String id)
                     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.

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:

ifMatch - Last known version to facilitate optimistic locking

id - The type's id is a unique identifier. The id's length must be between 1 and 128 characters and matches the following symbols \"A-Z\", \"a-z\", \"0-9\", \"_\" and \".\" beginning with the tenant prefix what has a maximum of 8 characters. (e.g . ten_pref.type_id)

Throws:

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

deleteAssetTypeFileAssignment

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

Deletes a file assignment from an asset type 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.

200 - The assignment has been deleted

401 - User is not authenticated

403 - User is not authorized for request

404 - Asset type or key not found

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

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

Parameters:

id - The type's id is a unique identifier. The id's length must be between 1 and 128 characters and matches the following symbols \"A-Z\", \"a-z\", \"0-9\", \"_\" and \".\" beginning with the tenant prefix what has a maximum of 8 characters. (e.g . ten_pref.type_id)

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 - if an error occurs while attempting to invoke the API

getAssetType

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

Read an asset type Read an asset type

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 - The type's id is a unique identifier. The id's length must be between 1 and 128 characters and matches the following symbols \"A-Z\", \"a-z\", \"0-9\", \"_\" and \".\" beginning with the tenant prefix what has a maximum of 8 characters. (e.g . ten_pref.type_id)

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 - if an error occurs while attempting to invoke the API

listAssetTypes

public AssetTypeListResource listAssetTypes(Integer page,
                                            Integer size,
                                            String sort,
                                            String filter,
                                            String ifNoneMatch,
                                            Boolean exploded)
                                     throws MindsphereException

List all asset types List all asset types

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

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:

AssetTypeListResource

Throws:

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

saveAssetType

public AssetTypeResource saveAssetType(String id,
                                       AssetType assettype,
                                       String ifMatch)
                                throws MindsphereException

Create or Update an asset type Create or Update an asset type

200 - The asset type has been updated

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 - The type's id is a unique identifier. The id's length must be between 1 and 128 characters and matches the following symbols \"A-Z\", \"a-z\", \"0-9\", \"_\" and \".\" beginning with the tenant prefix what has a maximum of 8 characters. (e.g . ten_pref.type_id)

assettype - asset type

ifMatch - Last known version to facilitate optimistic locking

Returns:

AssetTypeResource

Throws:

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

saveAssetType

public AssetTypeResource saveAssetType(String id,
                                       AssetType assettype,
                                       String ifMatch,
                                       String ifNoneMatch,
                                       Boolean exploded)
                                throws MindsphereException

Create or Update an asset type Create or Update an asset type

200 - The asset type has been updated

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 - The type's id is a unique identifier. The id's length must be between 1 and 128 characters and matches the following symbols \"A-Z\", \"a-z\", \"0-9\", \"_\" and \".\" beginning with the tenant prefix what has a maximum of 8 characters. (e.g . ten_pref.type_id)

assettype - asset type

ifMatch - Last known version to facilitate optimistic locking

ifNoneMatch - Set ifNoneMatch header to \"*\" for ensuring create request

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

Returns:

AssetTypeResource

Throws:

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

saveAssetTypeFileAssignment

public AssetTypeResource saveAssetTypeFileAssignment(String ifMatch,
                                                     String id,
                                                     String key,
                                                     KeyedFileAssignment assignment)
                                              throws MindsphereException

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

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 type not found

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

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

Parameters:

ifMatch - Last known version to facilitate optimistic locking

id - The type's id is a unique identifier. The id's length must be between 1 and 128 characters and matches the following symbols \"A-Z\", \"a-z\", \"0-9\", \"_\" and \".\" beginning with the tenant prefix what has a maximum of 8 characters. (e.g . ten_pref.type_id)

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

assignment - Data for file assignment

Returns:

AssetTypeResource

Throws:

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

updateAssetType

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

Patch an asset type Patch an asset type. Patching requires the inclusion of all existing variables and aspects. Missing file assignments will be deleted. Other fields may be omitted. Conforms to RFC 7396 - JSON merge Patch.

200 - The asset type has been updated

400 - Invalid request

401 - User is not authenticated

403 - User is not authorized for request

404 - AssetType not found

412 - AssetType 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 - The type's id is a unique identifier. The id's length must be between 1 and 128 characters and matches the following symbols \"A-Z\", \"a-z\", \"0-9\", \"_\" and \".\" beginning with the tenant prefix what has a maximum of 8 characters. (e.g . ten_pref.type_id)

assettype - asset type

Returns:

AssetTypeResource

Throws:

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

updateAssetType

public AssetTypeResource updateAssetType(String ifMatch,
                                         String id,
                                         AssetType assettype,
                                         Boolean exploded)
                                  throws MindsphereException

Patch an asset type Patch an asset type. Patching requires the inclusion of all existing variables and aspects. Missing file assignments will be deleted. Other fields may be omitted. Conforms to RFC 7396 - JSON merge Patch.

200 - The asset type has been updated

400 - Invalid request

401 - User is not authenticated

403 - User is not authorized for request

404 - AssetType not found

412 - AssetType 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 - The type's id is a unique identifier. The id's length must be between 1 and 128 characters and matches the following symbols \"A-Z\", \"a-z\", \"0-9\", \"_\" and \".\" beginning with the tenant prefix what has a maximum of 8 characters. (e.g . ten_pref.type_id)

assettype - asset type

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

Returns:

AssetTypeResource

Throws:

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

getAssetTypesEqualTo

public AssetTypeListResource getAssetTypesEqualTo(FieldTypeEnum fieldType,
                                                  String filterValue)
                                           throws MindsphereException

Filter asset types by name or tenantId or parentTypeId. Returns asset types whose name or tenantId or parentTypeId equals to filterValue. Only one field type and value can be passed at a time.

200 - Array of asset types matched the tenant scope and filter the array of input values

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:

fieldType - Field type on which asset types need to be filtered.

filterValue - Value based on which asset types need to be filtered.

Returns:

AssetTypeListResource

Throws:

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

getAssetTypesLike

public AssetTypeListResource getAssetTypesLike(FieldTypeEnum fieldType,
                                               String... filterValue)
                                        throws MindsphereException

Filter asset types by name or tenantId or parentTypeId. Returns asset types whose name or tenantId or parentTypeId matches an array of filter values. One field type and multiple filter values can be passed.

200 - Array of asset types matched the tenant scope and filter the array of input values

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:

fieldType - Field type on which asset types need to be filtered.

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

Returns:

AssetTypeListResource

Throws:

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

getAssetTypesStartsWith

public AssetTypeListResource getAssetTypesStartsWith(FieldTypeEnum fieldType,
                                                     String filterValue)
                                              throws MindsphereException

Filter asset types by name or tenantId or parentTypeId. Returns asset types whose name or tenantId or parentTypeId starts with the filter value. Only one field type and filter value can be passed.

200 - Array of asset types matched the tenant scope and filter the array of input values

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:

fieldType - Field type on which asset types need to be filtered.

filterValue - Value based on which asset types need to be filtered.

Returns:

AssetTypeListResource

Throws:

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

getAssetTypesEndsWith

public AssetTypeListResource getAssetTypesEndsWith(FieldTypeEnum fieldType,
                                                   String filterValue)
                                            throws MindsphereException

Filter asset types by name or tenantId or parentTypeId. Returns asset types whose name or tenantId or parentTypeId ends with the filter value. Only one field type and filter value can be passed.

200 - Array of asset types matched the tenant scope and filter the array of input values

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:

fieldType - Field type on which asset types need to be filtered.

filterValue - Value based on which asset types need to be filtered.

Returns:

AssetTypeListResource

Throws:

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

getAssetTypesContains

public AssetTypeListResource getAssetTypesContains(FieldTypeEnum fieldType,
                                                   String filterValue)
                                            throws MindsphereException

Filter asset types by name or tenantId or parentTypeId. Returns asset types whose name or tenantId or parentTypeId contains the filter value. Only one field type and filter value can be passed.

200 - Array of asset types matched the tenant scope and filter the array of input values

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:

fieldType - Field type on which asset types need to be filtered.

filterValue - Value based on which asset types need to be filtered.

Returns:

AssetTypeListResource

Throws:

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