public class StructureClient extends MindsphereAPIClient
Modifier and Type | Class and Description |
---|---|
static class |
StructureClient.ClientBuilder |
MindsphereAPIClient.Builder<T extends MindsphereAPIClient.Builder<T>>
credentials, restClientConfig, restTemplate
Constructor and Description |
---|
StructureClient(StructureClient.ClientBuilder builder) |
Modifier and Type | Method and Description |
---|---|
static StructureClient.ClientBuilder |
builder() |
AspectListResource |
listAssetAspects(ListAssetAspectsRequest requestObject)
Get all aspects of an asset
Get all static and dynamic aspects of a given asset
|
AspectListResource |
listAssetAspects(String id,
Integer page,
Integer size,
String sort,
String filter,
String ifNoneMatch)
Get all aspects of an asset Get all static and dynamic aspects of a given
asset
|
VariableListResource |
listAssetVariables(ListAssetVariablesRequest requestObject)
Get all variables of an asset
Get all variables of a given asset including inherited ones
|
VariableListResource |
listAssetVariables(String id,
Integer page,
Integer size,
String sort,
String filter,
String ifNoneMatch)
Get all variables of an asset Get all variables of a given asset including
inherited ones
|
public StructureClient(StructureClient.ClientBuilder builder)
public static StructureClient.ClientBuilder builder()
public AspectListResource listAssetAspects(ListAssetAspectsRequest requestObject) throws MindsphereException
200 - Static and dynamic aspects of the given asset matched by the given filter criterias
304 - Resource aspects have not been modified
400 - Invalid request
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
requestObject
- - Object of type ListAssetAspectsRequest {Parameters are id*,page,size,sort,filter,If-None-Match}MindsphereException
- if an error occurs while attempting to invoke the APIpublic VariableListResource listAssetVariables(ListAssetVariablesRequest requestObject) throws MindsphereException
200 - Variables of the given asset matched by the given filter criterias
304 - Resource variables have not been modified
400 - Invalid request
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
requestObject
- - Object of type ListAssetVariablesRequest {Parameters are id*,page,size,sort,filter,If-None-Match}MindsphereException
- if an error occurs while attempting to invoke the APIpublic AspectListResource listAssetAspects(String id, Integer page, Integer size, String sort, String filter, String ifNoneMatch) throws MindsphereException
200 - Static and dynamic aspects of the given asset matched by the given filter criterias
304 - Resource aspects have not been modified
400 - Invalid request
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
id
- Unique identifierpage
- Specifies the requested page indexsize
- Specifies the number of elements in a pagesort
- Specifies the ordering of returned elementsfilter
- Specifies the additional filtering criteriaifNoneMatch
- ETag hash of previous request to allow cachingMindsphereException
- if an error occurs while attempting to invoke the APIpublic VariableListResource listAssetVariables(String id, Integer page, Integer size, String sort, String filter, String ifNoneMatch) throws MindsphereException
200 - Variables of the given asset matched by the given filter criterias
304 - Resource variables have not been modified
400 - Invalid request
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
id
- Unique identifierpage
- Specifies the requested page indexsize
- Specifies the number of elements in a pagesort
- Specifies the ordering of returned elementsfilter
- Specifies the additional filtering criteriaifNoneMatch
- ETag hash of previous request to allow cachingMindsphereException
- if an error occurs while attempting to invoke the API