Interface InventoryApi
- All Known Implementing Classes:
InventoryApiImpl
-
Method Summary
Modifier and TypeMethodDescriptionReturns the count of managed objects from the platform based on specified filter.create(ManagedObjectRepresentation managedObject) Creates managed object in the platform.createBulk(ManagedObjectCollectionRepresentation managedObjects) Creates multiple managed objects (at most 50) in the platform with a single request.voidDeletes the Managed Object from the Cumulocity Server.voiddeleteCascade(GId id) Deletes the Managed Object and all child devices and child assets recursively from the Cumulocity Server.Returns the Managed Object of the Resource.get(GId id, QueryParam... params) Returns the Managed Object of the Resource.getManagedObject(GId gid) Deprecated.getManagedObjectApi(GId gid) Gets managed object resource by id.Gets the all the managed object in the platformGets the managed objects from the platform based on specified filter.Deprecated.Returns supported measurements of the Managed Object specified by its idReturns supported series of the Managed Object specified by its idupdate(ManagedObjectRepresentation managedObjectRepresentation) This update the ManagedObject for the operationCollection.updateBulk(ManagedObjectCollectionRepresentation managedObjects) Updates multiple managed objects (at most 50) in the platform with a single request.
-
Method Details
-
get
Returns the Managed Object of the Resource.- Parameters:
id- Managed Object General Identifier- Returns:
- ManagedObjectRepresentation
- Throws:
SDKException- if query failed
-
get
Returns the Managed Object of the Resource. Using additional query params e.g. withChildren=false to optimize access time.- Parameters:
id- Managed Object General Identifierparams- query parameters- Returns:
- ManagedObjectRepresentation
- Throws:
SDKException- if query failed
-
delete
Deletes the Managed Object from the Cumulocity Server.- Parameters:
id- Managed Object General Identifier- Throws:
SDKException- if the managed object could not be deleted
-
deleteCascade
Deletes the Managed Object and all child devices and child assets recursively from the Cumulocity Server.- Parameters:
id- Managed Object General Identifier- Throws:
SDKException- if the managed object could not be deleted
-
update
ManagedObjectRepresentation update(ManagedObjectRepresentation managedObjectRepresentation) throws SDKException This update the ManagedObject for the operationCollection. Cannot update the ID.- Parameters:
managedObjectRepresentation- managed object representation- Returns:
- ManagedObjectRepresentation updated ManagedObject.
- Throws:
SDKException- if the managed object could not be updated
-
updateBulk
ManagedObjectCollectionRepresentation updateBulk(ManagedObjectCollectionRepresentation managedObjects) throws SDKException Updates multiple managed objects (at most 50) in the platform with a single request. Every managed object must have its id set.If the request fails for one of the managed objects, a
BulkRequestExceptionis thrown. ItsfailedIndexis the position of that managed object in the request.For the limits and the validation rules, see Update multiple managed objects at once in the API reference.
- Parameters:
managedObjects- the managed objects to be updated- Returns:
- the updated managed objects
- Throws:
BulkRequestException- if the request failed for one of the managed objectsSDKException- if the managed objects could not be updated
-
getManagedObjectApi
Gets managed object resource by id. To get the managed object representation you have to callget()on the returned resource.- Parameters:
gid- id of the managed object to search for- Returns:
- the managed object resource associated with the given id
- Throws:
SDKException- if the query failed
-
create
Creates managed object in the platform. The id of the managed object must not be set, since it will be generated by the platform- Parameters:
managedObject- the managed object to be created- Returns:
- the created managed object with the generated id
- Throws:
SDKException- if the managed object could not be created
-
createBulk
ManagedObjectCollectionRepresentation createBulk(ManagedObjectCollectionRepresentation managedObjects) throws SDKException Creates multiple managed objects (at most 50) in the platform with a single request. The ids of the managed objects must not be set.If the request failed while writing, part of it may have been created. In this case
fragmentTypeidentifies the created managed objects. To complete the request without duplicates, look them up by this fragment type and send again only the managed objects that the lookup did not return. A failure without an error body, for example a gateway timeout, can also follow a partial write.For the limits, the validation rules, and the details of the recovery, see Create one or multiple managed objects in the API reference.
- Parameters:
managedObjects- the managed objects to be created- Returns:
- the created managed objects with their generated ids, in the order of the request
- Throws:
BulkRequestException- if the request failed for one of the managed objectsSDKException- if the managed objects could not be created
-
getManagedObjects
Gets the all the managed object in the platform- Returns:
- collection of managed objects with paging functionality
- Throws:
SDKException- if the query failed
-
getManagedObjectsByFilter
Gets the managed objects from the platform based on specified filter. Query based ontypeandfragmentTypeis not supported.- Parameters:
filter- the filter criteria(s)- Returns:
- collection of managed objects matched by the filter with paging functionality
- Throws:
SDKException- if the query failedIllegalArgumentException- if bothtypeandfragmentTypeare specified in the filter
-
countManagedObjectsByFilter
Returns the count of managed objects from the platform based on specified filter.- Parameters:
filter- the filter criteria(s)- Returns:
- count of managed objects matched by the filter
- Throws:
SDKException- if the query failedIllegalArgumentException- if the filter is null
-
getSupportedMeasurements
Returns supported measurements of the Managed Object specified by its id- Parameters:
id- id of the managed object to search for- Returns:
- SupportedMeasurementsRepresentation
- Throws:
SDKException- if managed object does not exists
-
getSupportedSeries
Returns supported series of the Managed Object specified by its id- Parameters:
id- id of the managed object to search for- Returns:
- SupportedSeriesRepresentation
- Throws:
SDKException- if managed object does not exists
-
getManagedObjectsByListOfIds
Deprecated.Gets the managed objects from the platform based on the given ids- Parameters:
ids- the list of ids of the managed objects to search for- Returns:
- collection of managed objects matched in order of the given ids
- Throws:
SDKException- if the query failed
-
getManagedObject
Deprecated.Gets managed object resource by id. To get the managed object representation you have to callget()on the returned resource.- Parameters:
gid- id of the managed object to search for- Returns:
- the managed object resource associated with the given id
- Throws:
SDKException- if the query failed
-