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

Package com.softwareag.jc.cumulocity.services.models

Classes defining the model for all of the cumulocity asset types.

API Services will provide your callback function with a RequestResponder object representing the API response. If the response status attribute is 200.201 then content attribute if set will be either a single or list of one of the following types.

Types

Alarm

 data class Alarm : JsonSerializable

Represents an alarm associated with a device.

Alarms

 data class Alarms

Collection of alarms associated with a ManagedObject/device

Availability

 data class Availability

Represents last status received by Cumulocity of associated device

DataPoints

 class DataPoints : JsonSerializable

Represents a set of DataPoints for a ManagedObject, which allows measurements captured by Cumulocity to be displayed more intuitively by prefacing them with unit labels, line colors etc.

Event

 data class Event : JsonSerializable

Represents an event, non measurable activity triggered by or for a device

ExternalId

 class ExternalId

Represents an external id associated with a ManagedObject

ExternalIds

 class ExternalIds

Represents a collection of external id's associated with a single ManagedObject

Firmware

 data class Firmware : JsonSerializable

Firmware of device represented by ManagedObject

Hardware

 class Hardware : PropertiesBase, JsonSerializable

Collection of properties to identify the device type

IsDeviceType

 class IsDeviceType : JsonSerializable

ManagedObject

 data class ManagedObject : PropertiesBase, JsonSerializable

This is the single most important asset type referenced by Cumulocity. Principally identifies the devices to be managed, but can be used to define any required asset type, such as groups, buildings, rooms etc. etc.

ManagedObjectQuery

 class ManagedObjectQuery

Class representing a set of query arguments to used when using the query method of the ManagedObjectsService to fetch ManagedObjects. Currently all queries have to be true i.e. they are ANDED together

ManagedObjects

 data class ManagedObjects

A collection of ManagedObjects as returned by one of the methods of ManagedObjectService class

Measurement

 data class Measurement : JsonSerializable

Represents individual measurements that can be queried, created and deleted

MeasurementSeries

 data class MeasurementSeries

Represents a series of measurements captured over a period of time that can be queried, created and deleted

MeasurementValue

 data class MeasurementValue : JsonSerializable

Individual measurement consisting of a human readable label, its unit of measure and the value

Operation

 class Operation : JsonSerializable

Represents a Cumulocity operation to be executed or that has been executed on a device

Position

 data class Position : JsonSerializable

Represents the GPS coordinated of the device associated with this ManagedObject

RequiredAvailability

 data class RequiredAvailability : JsonSerializable

Used by Cumulocity to determine Availability, the status will be assumed to 'UNAVAILABLE' if no message or event is received by Cumulocity within the time period (minutes) represented by the response interval property.

User

 data class User

Represents a Cumulocity user profile This attribute becomes available as an attribute of the CumulocityConnection instance after successfully calling its connect() method

Properties

C8Y_ALARM_SEVERITY

 const val C8Y_ALARM_SEVERITY: String

C8Y_ALARM_SOURCE

 const val C8Y_ALARM_SOURCE: String

C8Y_ALARM_SOURCE_ID

 const val C8Y_ALARM_SOURCE_ID: String

C8Y_ALARM_STATUS

 const val C8Y_ALARM_STATUS: String

C8Y_ALARM_TEXT

 const val C8Y_ALARM_TEXT: String

C8Y_ALARM_TIME

 const val C8Y_ALARM_TIME: String

C8Y_ALARM_TYPE

 const val C8Y_ALARM_TYPE: String

C8Y_EVENT_SOURCE

 const val C8Y_EVENT_SOURCE: String

C8Y_EVENT_SOURCE_ID

 const val C8Y_EVENT_SOURCE_ID: String

C8Y_EVENT_TEXT

 const val C8Y_EVENT_TEXT: String

C8Y_EVENT_TIME

 const val C8Y_EVENT_TIME: String

C8Y_EVENT_TYPE

 const val C8Y_EVENT_TYPE: String

C8Y_MANAGED_EXTID_REF

 const val C8Y_MANAGED_EXTID_REF: String

C8Y_MANAGED_EXTID_TYPE

 const val C8Y_MANAGED_EXTID_TYPE: String

C8Y_MANAGED_EXTIDS_API

 const val C8Y_MANAGED_EXTIDS_API: String

C8Y_MANAGED_EXTIDS_OBJECTS

 const val C8Y_MANAGED_EXTIDS_OBJECTS: String

C8Y_MANAGED_OBJECT

 const val C8Y_MANAGED_OBJECT: String

C8Y_MANAGED_OBJECT_ALARMS

 const val C8Y_MANAGED_OBJECT_ALARMS: String

C8Y_MANAGED_OBJECT_ALARMS_CRITICAL

 const val C8Y_MANAGED_OBJECT_ALARMS_CRITICAL: String

C8Y_MANAGED_OBJECT_ALARMS_MAJOR

 const val C8Y_MANAGED_OBJECT_ALARMS_MAJOR: String

C8Y_MANAGED_OBJECT_ALARMS_MINOR

 const val C8Y_MANAGED_OBJECT_ALARMS_MINOR: String

C8Y_MANAGED_OBJECT_ALARMS_WARNING

 const val C8Y_MANAGED_OBJECT_ALARMS_WARNING: String

C8Y_MANAGED_OBJECT_API

 const val C8Y_MANAGED_OBJECT_API: String

C8Y_MANAGED_OBJECT_APP_ID

 const val C8Y_MANAGED_OBJECT_APP_ID: String

C8Y_MANAGED_OBJECT_APP_OWNER

 const val C8Y_MANAGED_OBJECT_APP_OWNER: String

C8Y_MANAGED_OBJECT_ASSETS

 const val C8Y_MANAGED_OBJECT_ASSETS: String

C8Y_MANAGED_OBJECT_AVAILABILITY

 const val C8Y_MANAGED_OBJECT_AVAILABILITY: String

C8Y_MANAGED_OBJECT_AVAILABILITY_MESSAGE

 const val C8Y_MANAGED_OBJECT_AVAILABILITY_MESSAGE: String

C8Y_MANAGED_OBJECT_AVAILABILITY_STATUS

 const val C8Y_MANAGED_OBJECT_AVAILABILITY_STATUS: String

C8Y_MANAGED_OBJECT_CONNECTION

 const val C8Y_MANAGED_OBJECT_CONNECTION: String

C8Y_MANAGED_OBJECT_CONNECTION_STATUS

 const val C8Y_MANAGED_OBJECT_CONNECTION_STATUS: String

C8Y_MANAGED_OBJECT_CREATED

 const val C8Y_MANAGED_OBJECT_CREATED: String

C8Y_MANAGED_OBJECT_DATA_POINTS

 const val C8Y_MANAGED_OBJECT_DATA_POINTS: String

C8Y_MANAGED_OBJECT_DATAPOINT_COLOR

 const val C8Y_MANAGED_OBJECT_DATAPOINT_COLOR: String

C8Y_MANAGED_OBJECT_DATAPOINT_FRAGMENT

 const val C8Y_MANAGED_OBJECT_DATAPOINT_FRAGMENT: String

C8Y_MANAGED_OBJECT_DATAPOINT_ID

 const val C8Y_MANAGED_OBJECT_DATAPOINT_ID: String

C8Y_MANAGED_OBJECT_DATAPOINT_LABEL

 const val C8Y_MANAGED_OBJECT_DATAPOINT_LABEL: String

C8Y_MANAGED_OBJECT_DATAPOINT_LINE_TYPE

 const val C8Y_MANAGED_OBJECT_DATAPOINT_LINE_TYPE: String

C8Y_MANAGED_OBJECT_DATAPOINT_RENDER_TYPE

 const val C8Y_MANAGED_OBJECT_DATAPOINT_RENDER_TYPE: String

C8Y_MANAGED_OBJECT_DATAPOINT_SERIES

 const val C8Y_MANAGED_OBJECT_DATAPOINT_SERIES: String

C8Y_MANAGED_OBJECT_DATAPOINT_UNIT

 const val C8Y_MANAGED_OBJECT_DATAPOINT_UNIT: String

C8Y_MANAGED_OBJECT_DEVICES

 const val C8Y_MANAGED_OBJECT_DEVICES: String

C8Y_MANAGED_OBJECT_FIRMWARE

 const val C8Y_MANAGED_OBJECT_FIRMWARE: String

C8Y_MANAGED_OBJECT_FIRMWARE_VERSION

 const val C8Y_MANAGED_OBJECT_FIRMWARE_VERSION: String

C8Y_MANAGED_OBJECT_HARDWARE

 const val C8Y_MANAGED_OBJECT_HARDWARE: String

C8Y_MANAGED_OBJECT_HARDWARE_MODEL

 const val C8Y_MANAGED_OBJECT_HARDWARE_MODEL: String

C8Y_MANAGED_OBJECT_HARDWARE_SERIAL

 const val C8Y_MANAGED_OBJECT_HARDWARE_SERIAL: String

C8Y_MANAGED_OBJECT_HARDWARE_SUPPLIER

 const val C8Y_MANAGED_OBJECT_HARDWARE_SUPPLIER: String

C8Y_MANAGED_OBJECT_ID

 const val C8Y_MANAGED_OBJECT_ID: String

C8Y_MANAGED_OBJECT_LAST_UPDATED

 const val C8Y_MANAGED_OBJECT_LAST_UPDATED: String

C8Y_MANAGED_OBJECT_LNSTYPE

 const val C8Y_MANAGED_OBJECT_LNSTYPE: String

C8Y_MANAGED_OBJECT_LPWAN_DEVICE

 const val C8Y_MANAGED_OBJECT_LPWAN_DEVICE: String

C8Y_MANAGED_OBJECT_LPWAN_DEVICE_PROVISIONED

 const val C8Y_MANAGED_OBJECT_LPWAN_DEVICE_PROVISIONED: String

C8Y_MANAGED_OBJECT_NAME

 const val C8Y_MANAGED_OBJECT_NAME: String

C8Y_MANAGED_OBJECT_NOTES

 const val C8Y_MANAGED_OBJECT_NOTES: String

C8Y_MANAGED_OBJECT_OPERATIONS

 const val C8Y_MANAGED_OBJECT_OPERATIONS: String

C8Y_MANAGED_OBJECT_OWNER

 const val C8Y_MANAGED_OBJECT_OWNER: String

C8Y_MANAGED_OBJECT_POSITION

 const val C8Y_MANAGED_OBJECT_POSITION: String

C8Y_MANAGED_OBJECT_POSITION_ALT

 const val C8Y_MANAGED_OBJECT_POSITION_ALT: String

C8Y_MANAGED_OBJECT_POSITION_LAT

 const val C8Y_MANAGED_OBJECT_POSITION_LAT: String

C8Y_MANAGED_OBJECT_POSITION_LONG

 const val C8Y_MANAGED_OBJECT_POSITION_LONG: String

C8Y_MANAGED_OBJECT_REQ_AVAILABILITY

 const val C8Y_MANAGED_OBJECT_REQ_AVAILABILITY: String

C8Y_MANAGED_OBJECT_REQ_AVAILABILITY_INTERVAL

 const val C8Y_MANAGED_OBJECT_REQ_AVAILABILITY_INTERVAL: String

C8Y_MANAGED_OBJECT_TYPE

 const val C8Y_MANAGED_OBJECT_TYPE: String

C8Y_MANAGED_OBJECT_TYPE_DETAILS

 const val C8Y_MANAGED_OBJECT_TYPE_DETAILS: String

C8Y_MANAGED_OBJECTS_API

 const val C8Y_MANAGED_OBJECTS_API: String

C8Y_MANAGED_OBJECTS_EXT_API

 const val C8Y_MANAGED_OBJECTS_EXT_API: String

C8Y_MANAGED_OBJECTS_OBJECTS

 const val C8Y_MANAGED_OBJECTS_OBJECTS: String

C8Y_MESUREMENT_SOURCE

 const val C8Y_MESUREMENT_SOURCE: String

C8Y_MESUREMENT_SOURCE_ID

 const val C8Y_MESUREMENT_SOURCE_ID: String

C8Y_MESUREMENT_TIME

 const val C8Y_MESUREMENT_TIME: String

C8Y_MESUREMENT_TYPE

 const val C8Y_MESUREMENT_TYPE: String

C8Y_MESUREMENT_VALUE_UNIT

 const val C8Y_MESUREMENT_VALUE_UNIT: String

C8Y_MESUREMENT_VALUE_VALUE

 const val C8Y_MESUREMENT_VALUE_VALUE: String

C8Y_MSERIES_SERIES

 const val C8Y_MSERIES_SERIES: String

C8Y_MSERIES_SERIES_NAME

 const val C8Y_MSERIES_SERIES_NAME: String

C8Y_MSERIES_SERIES_TYPE

 const val C8Y_MSERIES_SERIES_TYPE: String

C8Y_MSERIES_SERIES_UNIT

 const val C8Y_MSERIES_SERIES_UNIT: String

C8Y_MSERIES_VALUES

 const val C8Y_MSERIES_VALUES: String

C8Y_MSERIES_VALUES_MAX

 const val C8Y_MSERIES_VALUES_MAX: String

C8Y_MSERIES_VALUES_MIN

 const val C8Y_MSERIES_VALUES_MIN: String

C8Y_OPERATIONS_API

 const val C8Y_OPERATIONS_API: String

C8Y_OPERATIONS_DEVICE_ID

 const val C8Y_OPERATIONS_DEVICE_ID: String

C8Y_TYPE_DEVICE_TYPE

 const val C8Y_TYPE_DEVICE_TYPE: String

C8Y_USER_API

 const val C8Y_USER_API: String

CY8_USER_EMAIL

 const val CY8_USER_EMAIL: String

CY8_USER_FIRST_NAME

 const val CY8_USER_FIRST_NAME: String

CY8_USER_ID

 const val CY8_USER_ID: String

CY8_USER_LAST_NAME

 const val CY8_USER_LAST_NAME: String

CY8_USER_UNAME

 const val CY8_USER_UNAME: String

JC_MANAGED_OBJECT_IS_VERIFIED

 const val JC_MANAGED_OBJECT_IS_VERIFIED: String

JC_MANAGED_OBJECT_IS_VERIFIED_DATE

 const val JC_MANAGED_OBJECT_IS_VERIFIED_DATE: String