Introduction on Cumulocity API

For this documentation basic knowledge of API's is assumed.

The application Materiaalbeheer (also known as Asset Tracking) is developed on Cumulocity. If you have the Materieelbeheer application, you have your own Cumulocity tenant. Each Cumulocity tenant exposes the default Cumulocity REST API. This API can be used to integrate some parts of a Cumulocity application in your own systems.

you can find the name of your KPN Things Cumulocity tenant in the URL of your Materieelbeheer application. This will be of the form https://<tenantName>.kpnthings.com/...

Cumulocity's domain model

Cumulocity has it's own domain model. The domain model enables specific application implementations. Please make yourself familiar with the Cumulocity domain model before continuing this guide by going over the Cumulocity documentation:

Cumulocity IoT's domain model - Cumulocity IoT Guides

Cumulocity REST implementation

Use the following link to learn more about the Cumulocity REST API's.

https://cumulocity.com/guides/reference/rest-implementation/cumulocity.com

On KPN Things Cumulocity we currently only support Basic authentication.

REST API Examples

Below are two simple examples on creating an object and a relation in Cumulocity. In the following examples, variables are shown as <variable> .

Create managed object

An example API call to create a Materieelbeheer Asset is:

POST /inventory/managedObjects HTTP/1.1
Host: <tenantName>.kpnthings.com
Authorization: Basic <token>
Content-Type: application/json
{
  "name" : "<name>",
  "c8y_IsAsset": {},
  "c8y_IsForAssetTracking":{},
  ...
}

Create child device relation

POST /inventory/managedObjects/<parentId>/childDevices HTTP/1.1
Host: <tenantName>.kpnthings.com
Authorization: Basic <token>
Content-Type: application/json
{
  "managedObject": {
    "id": "<childId>"
  }
}