Documentation
**INPUT** - tenant: Only provide if you want to only query the specific tenant, leave blank to query first avaible tenant. - filter - idType: Only required if deviceId is an external id, leave empty if providing the internal c8y id of the device. - deviceId: Either the internal c8y id or external id of the device. - from: Start date from which filter measurements, date format is ISO 8601 - yyyy-MM-dd'T'HH:mm:ss.SSSXXX - to: End date from which to filter measurements, date format is ISO 8601 - yyyy-MM-dd'T'HH:mm:ss.SSSXXX currentPage - leave blank to return the first page, otherwise returns the events starting at of the offset of (currentPage * pageSize) pageSize - Specify the maximum number of events to return in a single request, default is 50 if blank **OUTPUT** - measurements: paged list of measurement associated with given device, limited to page size.
**INPUT** tenant - Only provide if you want to only query the specific tenant, leave blank to query first avaible tenant. idType - Only required if deviceId is an external id, leave empty if providing the internal c8y id of the device. deviceId - Either the internal c8y id or external id of the device. currentPage - leave blank to return the first page, otherwise returns the alarms at of the offset of (currentPage * pageSize) pageSize - Specify the maximum number of alarms to return in a single request, default is 50 if blank **OUTPUT** alarms - List of alarms of associated with given device, limited to page size.
**INPUT** tenant - Only provide if you want to only update the specific tenant, leave blank to update all subscribing tenants. idType - Only required if deviceId is an external id, leave empty if providing the internal c8y id of the device. deviceId - Either the internal c8y id or external id of the device to which the alarm is associated. status - One of ACTIVE, ACKNOWLEDGED or CLEARED **OUTPUT** none
apache proxy 2.4 vhosts exampleServerName softwareag.com #DocumentRoot /var/www/html ProxyPreserveHost On ProxyPass /health http://localhost:5555/rad/jc.cumulocity:tools/health ProxyPass /ping http://localhost:5555/invoke/wm.server/ping ProxyPass / http://localhost:5555/ ProxyPassReverse / http://localhost:5555/ RequestHeader unset Authorization
C8Y_BASEURL - Url of the cumulocity
C8Y_BOOTSTRAP_TENANT - the of the tenant where the application was created
C8Y_BOOTSTRAP_USER - Only required if no user login can be provided
C8Y_BOOTSTRAP_PASSWORD - Only required if no user login can be provided
Calling this service ensures that all calls the c8y services in this package will use the provided credentials rather than those provided via the local environment.
Use the following API call to obtain your application's bootstrap credentials;
*$ curl "https://{TENANT_NAME}.cumulocity.com/application/applications/{APP_ID}/bootstrapUser" -u '{USER_ID}:{PASSWORD}'
If you have not created your application in Cumulocity, you can connect using a user login via the following inputs instead.
C8Y_TENANT
C8Y_USER
C8Y_PASSWORD
**INPUT** tenant - Only provide if you want to only update the specific tenant, leave blank to update all subscribing tenants. idType - Only required if deviceId is an external id, leave empty if providing the internal c8y id of the device. deviceId - Either the internal c8y id or external id of the device to which the event is associated. type - label to be associated with the event. text - arbitrary description of the event. eventArgs - Optional custom attributes to be included in event, can be string, number, boolean or even complex document types. **OUTPUT** c8yOfEvent - the c8y internal id of the new event, return only last instance if posting to multiple instances.
**INPUT** tenant - Only provide if you want to only query the specific tenant, leave blank to query first available tenant. idType - Only required if deviceId is an external id, leave empty if providing the internal c8y id of the device. deviceId - Either the internal c8y id or external id of the device. currentPage - leave blank to return the first page, otherwise returns the events starting at of the offset of (currentPage * pageSize) pageSize - Specify the maximum number of events to return in a single request, default is 50 if blank **OUTPUT** events - List of events of associated with given device, limited to page size.
**INPUT** tenant - Only provide if you want to only update the specific tenant, leave blank to update all subscribing tenants. idType - Only required if deviceId is an external id, leave empty if providing the internal c8y id of the device. id - External id of the group to be created. name - label to be associated with the group. description - optional text set to c8y_Notes in c8y. args - Optional custom attributes to be included in event, can be string, number, boolean or even complex document types. position - Optional GPS position to be saved as c8y_Position in the managed object. parent/c8yId - Internal id of an optional parent group. If provided this group will be added as a sub group and only visible via the parent group hierarchy. **OUTPUT** groupId - the c8y internal id of the new event, return only last instance if posting to multiple instances.
**INPUT** tenant - Only provide if you want to only update the specific tenant, leave blank to update all subscribing tenants. idType - Only required if deviceId is an external id, leave empty if providing the internal c8y id of the device. id - External id of the object to be deleted. **OUTPUT** None
**INPUT** tenant - Only provide if you want to only query the specific tenant, leave blank to query first available tenant. idType - Only required if deviceId is an external id, leave empty if providing the internal c8y id of the device. id - External id of the object to be fetched. **OUTPUT** managedObject - The managed object in c8y matching the given id.
**INPUT** tenant - Only provide if you want to only query the specific tenant, leave blank to query first available tenant. type - Optional filter to return only devices for the given type. currentPage - leave blank to return the first page, otherwise returns the events starting at of the offset of (currentPage * pageSize) pageSize - Specify the maximum number of events to return in a single request, default is 50 if blank **OUTPUT** results - A page of managed object representing devices.
**INPUT** tenant - Only provide if you want to only query the specific tenant, leave blank to query first available tenant. currentPage - leave blank to return the first page, otherwise returns the events starting at of the offset of (currentPage * pageSize) pageSize - Specify the maximum number of events to return in a single request, default is 50 if blank **OUTPUT** results - A page of managed object representing groups.
**INPUT** tenant - Only provide if you want to only update the specific tenant, leave blank to update all subscribing tenants. object - The c8y Managed Object to be added. args - Optional custom attributes to be included in event, can be string, number, boolean or even complex document types. **OUTPUT** c8yIdOfObject - the c8y internal id of the new object, return only last instance if posting to multiple instances.
**INPUT**
tenant - Only provide if you want to only update the specific tenant, leave blank to update all subscribing tenants.
ids - Set of optional external id's and their types to be associated with the created managed object.
deviceName - label to be given to device in c8y
deviceType - label for the device type
supplier - label for the device supplier
deviceModel - label for the device model attribute
deviceCategory - custom attribute to help categorise the device.
network - Networking info to be used by agent to connect to device.
relayState - Current state of relay i.e. OPEN or CLOSED, only required for relay type devices.
supportedOperations - List of supported operations e.g. ['c8y_Command', 'c8y_Relay']
revision - Hardware revision of device
serialNumber - Optional serial number, will be included in external id's too
firmware - version of software loaded on device.
position - Optional GPS position of device, will be mapped to fragment c8y_Position
responseInterval - Sets the required response interval of device in minutes, c8y will consider the device unavailable if no event or metric
received in this time frame.
status - Initial availability of device, one of 'MAINTENANCE', 'AVAILABLE' or 'UNAVAILABLE'
args - Optional custom attributes to be included in event, can be string, number, boolean or even complex document types.
isAgent - Set to true if you want to indicate that this device will have child devices for which control notifications need to be processed
(adds the fragment com_cumulocity_model_Agent)
doNOTCreate - set to true if you only want to retrieve a manageObject that corresponds to your inputs, nothing will be created in c8y
**OUTPUT**
c8yIdOfObject - the c8y internal id of the new object, return only last instance if posting to multiple instances.
**INPUTS** tenant - Only provide if you want to only query the specific tenant, leave blank to query first available tenant. currentPage - leave blank to return the first page, otherwise returns the events starting at of the offset of (currentPage * pageSize) pageSize - Specify the maximum number of events to return in a single request, default is 50 if blank queries - queries/queries queries/queries/lh - left hand argument of query i.e. namespace of attribute in managed object using dot as name separator. Not required in the case of the 'has' operator. queries/queries/op - Either 'eq', 'ne' for not equal or 'lt' for less than or 'gt' for greater than and 'has' queries/queries/rh - value to be matched with left hand side or in the case of 'has' the element or fragment that must be present. queries/queries/exclusive - Only required if you want to make this query an 'OR' i.e. will not be considered a mandatory query like the others. - queries/matchAll - true if all queries must match, false if only one of the queries need match **OUTPUT** results - A page of managed object matching the queries.
**INPUT** tenant - Only provide if you want to only update the specific tenant, leave blank to update all subscribing tenants. idType - Only required if id is an external id, leave empty if providing the internal c8y id of the object. id - External or internal id of the object to be added to the group. groupId - Optional internal c8y id of the group, leave blank if it is to be created. groupPath - The full hierarchy of the group structure to be created, leave blank if groupId has been provided description - set as c8y_Notes for the last group in the hierarchy. **OUTPUT** lastGroupId - the c8y internal id of the last group in the hierarchy to which the object is attached directly.
**INPUT** tenant - Only provide if you want to only update the specific tenant, leave blank to update all subscribing tenants. object - The c8y Managed Object to be updated. args - Optional custom attributes to be included in object, can be string, number, boolean or even complex document types. **OUTPUT** none
**INPUT** tenant - Only provide if you want to only update the specific tenant, leave blank to update all subscribing tenants. args - Custom attributes to be included in object, can be string, number, boolean or even complex document types. **OUTPUT** none
**INPUT** tenant - Only provide if you want to only query the specific tenant, leave blank to query first available tenant. filter - idType - Only required if deviceId is an external id, leave empty if providing the internal c8y id of the device. - deviceId - Either the internal c8y id or external id of the device. - from - Start date from which filter measurements, date format is ISO 8601 - yyyy-MM-dd'T'HH:mm:ss.SSSXXX - to - End date from which to filter measurements, date format is ISO 8601 - yyyy-MM-dd'T'HH:mm:ss.SSSXXX currentPage - leave blank to return the first page, otherwise returns the events starting at of the offset of (currentPage * pageSize) pageSize - Specify the maximum number of events to return in a single request, default is 50 if blank **OUTPUT** measurements - paged list of measurement associated with given device, limited to page size.
**INPUT** tenant - Only provide if you want to only update the specific tenant, leave blank to update all subscribing tenants. idType - Only required if deviceId is an external id, leave empty if providing the internal c8y id of the device. c8yIdOfDevice - Either the internal c8y id or external id of the device to which the operation is associated. measurements - list of measurements to be recorded. **OUTPUT** none
**INPUT** tenant - Only provide if you want to only update the specific tenant, leave blank to update all subscribing tenants. idType - Only required if deviceId is an external id, leave empty if providing the internal c8y id of the device. deviceId - Either the internal c8y id or external id of the device to which the operation is associated. type - label to be associated with the operation. description - arbitrary description of the operation. details - Optional additional custom fragment to be included in operation body. **OUTPUT** c8yIdOfOperation - the c8y internal id of the new operation, return only last instance if posting to multiple instances.
**INPUT** tenant - Only provide if you want to only query the specific tenant, leave blank to query first available tenant. idType - Only required if deviceId is an external id, leave empty if providing the internal c8y id of the device. deviceId - Either the internal c8y id or external id of the device. currentPage - leave blank to return the first page, otherwise returns the events starting at of the offset of (currentPage * pageSize) pageSize - Specify the maximum number of events to return in a single request, default is 50 if blank **OUTPUT** events - List of operations of associated with given device, limited to page size.
**INPUT** tenant - Only provide if you want to only update the specific tenant, leave blank to update all subscribing tenants. c8yIdOfOperation - internal c8y id of operation to be updated. status - One of PENDING, EXECUTING, SUCCESSFUL or FAILED failureMessage - Required in the case of FAILED details - Optional, allows details to be updated. **OUTPUT** none
**INPUT** tenant - Only provide if you want to only update to listen for updates from a specific tenants, otherwise first available is used. c8yIdOfAgent - c8y internal of the managed object that represents the agent/device to which we have child devices attached. callback - The service to be called whenever an event or operation is intercepted (must implement specification jc.cumulocity.tools.notifications:callbackSignature) pollingInterval - Optional, leave blank to use c8y real time polling, otherwise specify the delay in seconds between each batch based polling. **OUTPUT** none
**INPUT** tenant - Only provide if you want to only update to listen for updates from a specific tenants, otherwise first available is used. c8yIdOfAgent - c8y internal of the managed object that represents the agent/device to which we have child devices attached. pollingInterval - Optional, leave blank to use c8y real time polling, otherwise specify the delay in seconds between each batch based polling. **OUTPUT** none
**INPUT** operation - The received operation to be processed agentId - The internal c8y id of the parent device/agent associated with the device. **OUTPUT** status - Result of operation action, either SUCCESSFUL or FAILED failureMessage - Only required if status is FAILED, to allow a reason to be recorded with the updated status of the operation