Cumulocity API Services / com.softwareag.jc.cumulocity.services.api

Package com.softwareag.jc.cumulocity.services.api

Query/update Cumulocity assets via well defined classes

Each class represents a specific resource type provided by Cumulocity. ManagedObject represents the most heavily referenced type of data, of which the model can be heavily customised. Both devices and groups are represented as ManagedObjects. Identified ManagedObjects can be queried and updated via the ManagedObjectService class either using the Cumulocity internal id or a registered external id.

Complex queries for multiple ManagedObjects can be implemented via ManagedObjectsService.

Types

AlarmsService

 class AlarmsService : ConnectionRequest<User, List<Alarm>>

Allows Alarms to be posted and queried from Cumulocity

BinariesService

 class BinariesService : ConnectionMultipartRequest<User, ByteArray>

Allows files to be uploaded/downloaded from Cumulocity using the /inventory/binaries api

CumulocityConnectionFactory

 class CumulocityConnectionFactory : ConnectionFactory<User>

Establish your connection instances to Cumulocity through this class.

EventsService

 class EventsService : ConnectionRequest<User, List<Event>>

Access point for retrieving and sending events to/from Cumulocity, data represented as Event and accessed via API endpoint /event/events

ExternalIdService

 class ExternalIdService : ConnectionRequest<User, List<ExternalId>>

Allows lookup of external id's associated with ManageObjects

LoRaService

 class LoRaService : ConnectionRequest<User, String>

Custom class to leverage LoRa agent developed by Cyril Poder - cyril.poder@softwarag.com

ManagedObjectService

 class ManagedObjectService : ConnectionRequest<User, ManagedObject>

Principal access point for all Cumulocity data represented as ManagedObject and accessed via API endpoint /inventory/managedObjects.

ManagedObjectsService

 class ManagedObjectsService : ConnectionRequest<User, List<ManagedObject>>

Principal access point for all Cumulocity data represented as ManagedObjects such as devices and groups and implemented through the API endpoint /inventory/managedObjects.

MeasurementSeriesService

 class MeasurementSeriesService : ConnectionRequest<User, MeasurementSeries>

Access point for retrieving measurements collected over a period of time from Cumulocity, data represented as MeasurementSeries and accessed via API endpoint /measurement/measurements/series

MeasurementsService

 class MeasurementsService : ConnectionRequest<User, List<Measurement>>

Access point for retrieving and sending measurements to/from Cumulocity, data represented as Measurement and accessed via API endpoint /measurement/measurements

OperationService

 class OperationService : ConnectionRequest<User, Operation>

Access point for posting operations to remote assets via Cumulocity

Properties

C8Y_ALARMS_API

 const val C8Y_ALARMS_API: String

C8Y_ALARMS_LIST

 const val C8Y_ALARMS_LIST: String

C8Y_BINARIES_API

 const val C8Y_BINARIES_API: String

C8Y_BINARIES_FILE

 const val C8Y_BINARIES_FILE: String

C8Y_BINARIES_FILE_SIZE

 const val C8Y_BINARIES_FILE_SIZE: String

C8Y_BINARIES_ID

 const val C8Y_BINARIES_ID: String

C8Y_BINARIES_NAME

 const val C8Y_BINARIES_NAME: String

C8Y_BINARIES_OBJECT

 const val C8Y_BINARIES_OBJECT: String

C8Y_BINARIES_TYPE

 const val C8Y_BINARIES_TYPE: String

C8Y_EVENTS_API

 const val C8Y_EVENTS_API: String

C8Y_EVENTS_LIST

 const val C8Y_EVENTS_LIST: String

C8Y_LORA_OBJENIOUS_MS

 const val C8Y_LORA_OBJENIOUS_MS: String

C8Y_MEASUREMENTS_API

 const val C8Y_MEASUREMENTS_API: String

C8Y_MEASUREMENTS_API_GET_REF

 const val C8Y_MEASUREMENTS_API_GET_REF: String

C8Y_MEASUREMENTS_API_GET_SERIES

 const val C8Y_MEASUREMENTS_API_GET_SERIES: String

C8Y_MEASUREMENTS_API_GET_TYPE

 const val C8Y_MEASUREMENTS_API_GET_TYPE: String

C8Y_MEASUREMENTS_LIST

 const val C8Y_MEASUREMENTS_LIST: String

JC_HEADER_CONTENT_DISPOSITION

 const val JC_HEADER_CONTENT_DISPOSITION: String

JC_HEADER_LOCATION

 const val JC_HEADER_LOCATION: String