API docs by Redocly

FCS API (0.0.1)

Download OpenAPI specification:

Version

API version information

Get the current API version

Retrieves the current deployed API version. This endpoint can be used to verify a working call-through to the API

Authorizations:
None

Responses

Response samples

Content type
application/json
{
  • "default": {
    }
}

for CORS

Authorizations:
custom-auth

Responses

Response samples

Content type
application/json
{ }

Customer

Customer information

Get the list of customers.

Load a list of customers.

Authorizations:
custom-auth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a customer.

Create a specific customer.

Authorizations:
custom-auth
Request Body schema: application/json
required
uuid
required
string <uuid>

unique identifier for this customer

name
required
string

full name of the customer

active
required
boolean

if false the company's features and functions are all deactivated, and no user can login

customerNumber
required
string

Customer number of the customer

contactPerson
string or null

Name of a real person to get in contact with for this customer

contactPhoneNumber
string or null

Phone number of the contact person

contactEmail
string or null

Email address of the contact person

addressStreet1
string or null

First line of address

addressStreet2
string or null

Optional second line of address

addressZip
string or null

Zip code of the city

addressCity
string or null

City

addressCountry
string or null

2-char ISO code for the country

isMaster
boolean

Identifies the customer as the so-called "master" customer, which represents the owner of the platform. The UI can enable or disable fields or features based on this flag, e.g. disabling the "active yes/no" switch in the customer edit dialog for this master customer. It is safe to expose this flag to the UI, as changing the value in the browser has no impact on the authorization/access right calculation in the backend. So if someone alters this field, it cannot be persisted, and it is not used in the backend. We calculate the value of this field when creating the customer response object, based on database values and static information, independent from anything that the browser has sent, or is sending at the moment to the backend.

Responses

Request samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "Fiegl & Spielberger",
  • "active": true,
  • "customerNumber": "cust123456",
  • "contactPerson": "Markus Holy",
  • "contactPhoneNumber": "+43 512 33330",
  • "contactEmail": "salzamt@fiegl.co.at",
  • "addressStreet1": "Langer Weg 28",
  • "addressStreet2": "string",
  • "addressZip": 6020,
  • "addressCity": "Innsbruck",
  • "addressCountry": "AT",
  • "isMaster": true
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "Fiegl & Spielberger",
  • "active": true,
  • "customerNumber": "cust123456",
  • "contactPerson": "Markus Holy",
  • "contactPhoneNumber": "+43 512 33330",
  • "contactEmail": "salzamt@fiegl.co.at",
  • "addressStreet1": "Langer Weg 28",
  • "addressStreet2": "string",
  • "addressZip": 6020,
  • "addressCity": "Innsbruck",
  • "addressCountry": "AT",
  • "isMaster": true,
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

for CORS

Authorizations:
custom-auth

Responses

Response samples

Content type
application/json
{ }

Get a customer.

Get a specific customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "Fiegl & Spielberger",
  • "active": true,
  • "customerNumber": "cust123456",
  • "contactPerson": "Markus Holy",
  • "contactPhoneNumber": "+43 512 33330",
  • "contactEmail": "salzamt@fiegl.co.at",
  • "addressStreet1": "Langer Weg 28",
  • "addressStreet2": "string",
  • "addressZip": 6020,
  • "addressCity": "Innsbruck",
  • "addressCountry": "AT",
  • "isMaster": true,
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

Update a customer.

Update a specific customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

Request Body schema: application/json
required
uuid
required
string <uuid>

unique identifier for this customer

name
required
string

full name of the customer

active
required
boolean

if false the company's features and functions are all deactivated, and no user can login

customerNumber
required
string

Customer number of the customer

contactPerson
string or null

Name of a real person to get in contact with for this customer

contactPhoneNumber
string or null

Phone number of the contact person

contactEmail
string or null

Email address of the contact person

addressStreet1
string or null

First line of address

addressStreet2
string or null

Optional second line of address

addressZip
string or null

Zip code of the city

addressCity
string or null

City

addressCountry
string or null

2-char ISO code for the country

isMaster
boolean

Identifies the customer as the so-called "master" customer, which represents the owner of the platform. The UI can enable or disable fields or features based on this flag, e.g. disabling the "active yes/no" switch in the customer edit dialog for this master customer. It is safe to expose this flag to the UI, as changing the value in the browser has no impact on the authorization/access right calculation in the backend. So if someone alters this field, it cannot be persisted, and it is not used in the backend. We calculate the value of this field when creating the customer response object, based on database values and static information, independent from anything that the browser has sent, or is sending at the moment to the backend.

Responses

Request samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "Fiegl & Spielberger",
  • "active": true,
  • "customerNumber": "cust123456",
  • "contactPerson": "Markus Holy",
  • "contactPhoneNumber": "+43 512 33330",
  • "contactEmail": "salzamt@fiegl.co.at",
  • "addressStreet1": "Langer Weg 28",
  • "addressStreet2": "string",
  • "addressZip": 6020,
  • "addressCity": "Innsbruck",
  • "addressCountry": "AT",
  • "isMaster": true
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "Fiegl & Spielberger",
  • "active": true,
  • "customerNumber": "cust123456",
  • "contactPerson": "Markus Holy",
  • "contactPhoneNumber": "+43 512 33330",
  • "contactEmail": "salzamt@fiegl.co.at",
  • "addressStreet1": "Langer Weg 28",
  • "addressStreet2": "string",
  • "addressZip": 6020,
  • "addressCity": "Innsbruck",
  • "addressCountry": "AT",
  • "isMaster": true,
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

Responses

Response samples

Content type
application/json
{ }

User

User information

Get user information of the current user.

Load user information of the current logged-in user.

Authorizations:
custom-auth

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "Max Mustermann",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "email": "user@example.com",
  • "username": "string",
  • "admin": false,
  • "active": true,
  • "phone": "string",
  • "allowedLocations": [
    ],
  • "isSuperAdmin": true,
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

Update user information of the current user.

Update user information of the current logged-in user.

Authorizations:
custom-auth
Request Body schema: application/json
required
uuid
required
string <uuid>

unique identifier for this user

name
required
string

full name of the user

customer
required
string <uuid>

reference to the customer's uuid this user belongs to

email
required
string <email>

the email address for this user

username
required
string

the username to use

admin
required
boolean
Default: false

if the user has admin rights for its associated customer

active
required
boolean

if false the user cannot login

phone
required
string

phone number of the user

allowedLocations
required
Array of strings <uuid> [ items <uuid > ]

list of locations for which the user is allowed to read associated dashboards

isSuperAdmin
boolean

identifies a user as a so-called "super admin", which is a user with admin rights for Fiegl & Spielberger, implying that this user can also administer other customers. This property is for UI-purposes only, and therein also only for enabling or disabling fields, and does not exist in the user database. It is calculated during creating the user response object. It can be sent in user update/create requests as it is not persisted, and will be ignored. All authorization/access right calculations in the backed are independent from this property, so it is safe that we expose this for UI purposes. If someone would change this property in the browser's context, it won't change anything in the backend, it would just enable some otherwise read-only fields in the UI, but any change on such fields would cause an error in the backend when trying to persist the change, as we calculate the "isSuperAdmin" in the backend based on the data source, and there are no means how the altered user object in the browser can influence the backend (as we do not persist this property).

Responses

Request samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "Max Mustermann",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "email": "user@example.com",
  • "username": "string",
  • "admin": false,
  • "active": true,
  • "phone": "string",
  • "allowedLocations": [
    ],
  • "isSuperAdmin": true
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "Max Mustermann",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "email": "user@example.com",
  • "username": "string",
  • "admin": false,
  • "active": true,
  • "phone": "string",
  • "allowedLocations": [
    ],
  • "isSuperAdmin": true,
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

for CORS

Authorizations:
custom-auth

Responses

Response samples

Content type
application/json
{ }

Get user information of a specific user.

Load user information of a specific user.

Authorizations:
custom-auth
path Parameters
userId
required
string

id of the user to get

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "Max Mustermann",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "email": "user@example.com",
  • "username": "string",
  • "admin": false,
  • "active": true,
  • "phone": "string",
  • "allowedLocations": [
    ],
  • "isSuperAdmin": true,
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

Update user information of a specific user.

Update user information of a specific user.

Authorizations:
custom-auth
path Parameters
userId
required
string

id of the user to get

Request Body schema: application/json
required
uuid
required
string <uuid>

unique identifier for this user

name
required
string

full name of the user

customer
required
string <uuid>

reference to the customer's uuid this user belongs to

email
required
string <email>

the email address for this user

username
required
string

the username to use

admin
required
boolean
Default: false

if the user has admin rights for its associated customer

active
required
boolean

if false the user cannot login

phone
required
string

phone number of the user

allowedLocations
required
Array of strings <uuid> [ items <uuid > ]

list of locations for which the user is allowed to read associated dashboards

isSuperAdmin
boolean

identifies a user as a so-called "super admin", which is a user with admin rights for Fiegl & Spielberger, implying that this user can also administer other customers. This property is for UI-purposes only, and therein also only for enabling or disabling fields, and does not exist in the user database. It is calculated during creating the user response object. It can be sent in user update/create requests as it is not persisted, and will be ignored. All authorization/access right calculations in the backed are independent from this property, so it is safe that we expose this for UI purposes. If someone would change this property in the browser's context, it won't change anything in the backend, it would just enable some otherwise read-only fields in the UI, but any change on such fields would cause an error in the backend when trying to persist the change, as we calculate the "isSuperAdmin" in the backend based on the data source, and there are no means how the altered user object in the browser can influence the backend (as we do not persist this property).

Responses

Request samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "Max Mustermann",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "email": "user@example.com",
  • "username": "string",
  • "admin": false,
  • "active": true,
  • "phone": "string",
  • "allowedLocations": [
    ],
  • "isSuperAdmin": true
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "Max Mustermann",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "email": "user@example.com",
  • "username": "string",
  • "admin": false,
  • "active": true,
  • "phone": "string",
  • "allowedLocations": [
    ],
  • "isSuperAdmin": true,
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

for CORS

Authorizations:
custom-auth
path Parameters
userId
required
string

id of the user to get

Responses

Response samples

Content type
application/json
{ }

Get all users of a customer.

Get all users of a specific customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new user.

Create a new user for a specific customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

Request Body schema: application/json
required
uuid
required
string <uuid>

unique identifier for this user

name
required
string

full name of the user

customer
required
string <uuid>

reference to the customer's uuid this user belongs to

email
required
string <email>

the email address for this user

username
required
string

the username to use

admin
required
boolean
Default: false

if the user has admin rights for its associated customer

active
required
boolean

if false the user cannot login

phone
required
string

phone number of the user

allowedLocations
required
Array of strings <uuid> [ items <uuid > ]

list of locations for which the user is allowed to read associated dashboards

isSuperAdmin
boolean

identifies a user as a so-called "super admin", which is a user with admin rights for Fiegl & Spielberger, implying that this user can also administer other customers. This property is for UI-purposes only, and therein also only for enabling or disabling fields, and does not exist in the user database. It is calculated during creating the user response object. It can be sent in user update/create requests as it is not persisted, and will be ignored. All authorization/access right calculations in the backed are independent from this property, so it is safe that we expose this for UI purposes. If someone would change this property in the browser's context, it won't change anything in the backend, it would just enable some otherwise read-only fields in the UI, but any change on such fields would cause an error in the backend when trying to persist the change, as we calculate the "isSuperAdmin" in the backend based on the data source, and there are no means how the altered user object in the browser can influence the backend (as we do not persist this property).

Responses

Request samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "Max Mustermann",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "email": "user@example.com",
  • "username": "string",
  • "admin": false,
  • "active": true,
  • "phone": "string",
  • "allowedLocations": [
    ],
  • "isSuperAdmin": true
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "Max Mustermann",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "email": "user@example.com",
  • "username": "string",
  • "admin": false,
  • "active": true,
  • "phone": "string",
  • "allowedLocations": [
    ],
  • "isSuperAdmin": true,
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

Responses

Response samples

Content type
application/json
{ }

Resend the user invitiation

Resend the user invitiation

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

userId
required
string

id of the user to work on

Responses

Response samples

Content type
application/json
{
  • "uuid": "string",
  • "resent": true,
  • "error": "string"
}

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

userId
required
string

id of the user to get

Responses

Response samples

Content type
application/json
{ }

UserSettings

Get user settings of the current user.

Load user settings of the current logged-in user.

Authorizations:
custom-auth

Responses

Response samples

Content type
application/json
{
  • "uuid": "userUuid",
  • "settings": { }
}

Save user settings of the current user.

Save user settings of the current logged-in user.

Authorizations:
custom-auth
Request Body schema: application/json
required
uuid
required
string <uuid>

the UUID of the user for these settings

settings
object or null

Responses

Request samples

Content type
application/json
{
  • "uuid": "userUuid",
  • "settings": { }
}

Response samples

Content type
application/json
{
  • "uuid": "userUuid",
  • "settings": { }
}

Create user settings for the current user.

Create user settings for the current logged-in user.

Authorizations:
custom-auth
Request Body schema: application/json
required
uuid
required
string <uuid>

the UUID of the user for these settings

settings
object or null

Responses

Request samples

Content type
application/json
{
  • "uuid": "userUuid",
  • "settings": { }
}

Response samples

Content type
application/json
{
  • "uuid": "userUuid",
  • "settings": { }
}

for CORS

Authorizations:
custom-auth

Responses

Response samples

Content type
application/json
{ }

Get user settings of the given user.

Load user settings of the given user.

Authorizations:
custom-auth
path Parameters
userId
required
string

id of the user to get

Responses

Response samples

Content type
application/json
{
  • "uuid": "userUuid",
  • "settings": { }
}

Save user settings of the given user.

Save user settings of the given user.

Authorizations:
custom-auth
path Parameters
userId
required
string

id of the user to get

Request Body schema: application/json
required
uuid
required
string <uuid>

the UUID of the user for these settings

settings
object or null

Responses

Request samples

Content type
application/json
{
  • "uuid": "userUuid",
  • "settings": { }
}

Response samples

Content type
application/json
{
  • "uuid": "userUuid",
  • "settings": { }
}

Create user settings for the given user.

Create user settings for the given user.

Authorizations:
custom-auth
path Parameters
userId
required
string

id of the user to get

Request Body schema: application/json
required
uuid
required
string <uuid>

the UUID of the user for these settings

settings
object or null

Responses

Request samples

Content type
application/json
{
  • "uuid": "userUuid",
  • "settings": { }
}

Response samples

Content type
application/json
{
  • "uuid": "userUuid",
  • "settings": { }
}

for CORS

Authorizations:
custom-auth
path Parameters
userId
required
string

id of the user to get

Responses

Response samples

Content type
application/json
{ }

Connector

Get all active connectors of a customer's location.

Get all active connectors of a specific customer's location.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

strict
boolean

if set to true, only connectors directly associated with the given location will be returned; otherwise (defaul) also connectors which have "isAllowedOnAllLocation" will be returned, too

typeKey
string
Example: wago

if set, the returned connector list will be filtered for the given connector type key, e.g. "wago"; Note that either this one or typeId can be used, not both at the same time

typeId
string <uuid>

if set, the returned connector list will be filtered for the given connector type ID; Note that either this one or typeKey can be used, not both at the same time

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

Responses

Response samples

Content type
application/json
{ }

Get all connectors of a customer's location.

Get all connectors of a specific customer's location.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

strict
boolean

if set to true, only connectors directly associated with the given location will be returned; otherwise (default) also connectors which have "isAllowedOnAllLocation" will be returned, too

typeKey
string
Example: wago

if set, the returned connector list will be filtered for the given connector type key, e.g. "wago"; Note that either this one or typeId can be used, not both at the same time

typeId
string <uuid>

if set, the returned connector list will be filtered for the given connector type ID; Note that either this one or typeKey can be used, not both at the same time

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

Responses

Response samples

Content type
application/json
{ }

Get connector of a customer's location.

Get connector of a specific customer's location.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

connectorId
required
string

id of the connector to get the data for

Responses

Response samples

Content type
application/json
Example
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "type": "4595bf66-18b2-445a-a884-1b08d0c2df0e",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "active": true,
  • "originalConnectorId": "string",
  • "isAllowedOnAllLocations": true,
  • "config": {
    },
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

connectorId
required
string

id of the connector to get the data for

Responses

Response samples

Content type
application/json
{ }

Get unused devices of a connector of a customer's location.

Get unused devices of a connector of a specific customer's location.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

connectorId
required
string

id of the connector to get the data for

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

connectorId
required
string

id of the connector to get the data for

Responses

Response samples

Content type
application/json
{ }

Get all active SMA connectors of a customer's location.

Get all active SMA connectors of a specific customer's location.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

strict
boolean

if set to true, only connectors directly associated with the given location will be returned; otherwise (defaul) also connectors which have "isAllowedOnAllLocation" will be returned, too

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

Responses

Response samples

Content type
application/json
{ }

Create SMA connector for customer.

Create SMA connector for customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

Request Body schema: application/json
required
uuid
required
string <uuid>

unique identifier for this connector

type
required
string <uuid>

the connector type's UUId the connector is an instance of.

name
required
string

the name for this Connector instance.

nameAlias1
string

the name alias 1 for this Connector instance.

nameAlias2
string

the name alias 2for this Connector instance.

location
required
string <uuid>

the location's UUId the connector is assigned to.

active
required
boolean
originalConnectorId
string

the optional original connector id for this connector

isAllowedOnAllLocations
boolean

if set to true, this connector may be used on devices which come from a different location of the customer than the one this connector is associated with. This is needed when the connector represents a system which aggregates data from different physical locations, e.g. via networks

Responses

Request samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "type": "4595bf66-18b2-445a-a884-1b08d0c2df0e",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "active": true,
  • "originalConnectorId": "string",
  • "isAllowedOnAllLocations": true
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "type": "4595bf66-18b2-445a-a884-1b08d0c2df0e",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "active": true,
  • "originalConnectorId": "string",
  • "isAllowedOnAllLocations": true,
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

Get all SMA connectors of a customer's location.

Get all SMA connectors of a specific customer's location.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

strict
boolean

if set to true, only connectors directly associated with the given location will be returned; otherwise (defaul) also connectors which have "isAllowedOnAllLocation" will be returned, too

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

Responses

Response samples

Content type
application/json
{ }

Get SMA connector of a customer's location.

Get SMA connector of a specific customer's location.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

connectorId
required
string

id of the connector to get the data for

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "type": "4595bf66-18b2-445a-a884-1b08d0c2df0e",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "active": true,
  • "originalConnectorId": "string",
  • "isAllowedOnAllLocations": true,
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

connectorId
required
string

id of the connector to get the data for

Responses

Response samples

Content type
application/json
{ }

Update connector for customer's location.

Update connector for customer's location.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

connectorId
required
string

id of the connector to get the data for

Request Body schema: application/json
required
uuid
required
string <uuid>

unique identifier for this connector

type
required
string <uuid>

the connector type's UUId the connector is an instance of.

name
required
string

the name for this Connector instance.

nameAlias1
string

the name alias 1 for this Connector instance.

nameAlias2
string

the name alias 2for this Connector instance.

location
required
string <uuid>

the location's UUId the connector is assigned to.

active
required
boolean
originalConnectorId
string

the optional original connector id for this connector

isAllowedOnAllLocations
boolean

if set to true, this connector may be used on devices which come from a different location of the customer than the one this connector is associated with. This is needed when the connector represents a system which aggregates data from different physical locations, e.g. via networks

Responses

Request samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "type": "4595bf66-18b2-445a-a884-1b08d0c2df0e",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "active": true,
  • "originalConnectorId": "string",
  • "isAllowedOnAllLocations": true
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "type": "4595bf66-18b2-445a-a884-1b08d0c2df0e",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "active": true,
  • "originalConnectorId": "string",
  • "isAllowedOnAllLocations": true,
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

Get all active WAGO connectors of a customer's location.

Get all active WAGO connectors of a specific customer's location.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

strict
boolean

if set to true, only connectors directly associated with the given location will be returned; otherwise (defaul) also connectors which have "isAllowedOnAllLocation" will be returned, too

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

Responses

Response samples

Content type
application/json
{ }

Create WAGO connector for customer.

Create WAGO connector for customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

Request Body schema: application/json
required
uuid
required
string <uuid>

unique identifier for this connector

type
required
string <uuid>

the connector type's UUId the connector is an instance of.

name
required
string

the name for this Connector instance.

nameAlias1
string

the name alias 1 for this Connector instance.

nameAlias2
string

the name alias 2for this Connector instance.

location
required
string <uuid>

the location's UUId the connector is assigned to.

active
required
boolean
originalConnectorId
required
string

the optional original connector id for this connector

isAllowedOnAllLocations
boolean

if set to true, this connector may be used on devices which come from a different location of the customer than the one this connector is associated with. This is needed when the connector represents a system which aggregates data from different physical locations, e.g. via networks

required
object or null

Responses

Request samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "type": "4595bf66-18b2-445a-a884-1b08d0c2df0e",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "active": true,
  • "originalConnectorId": "string",
  • "isAllowedOnAllLocations": true,
  • "config": {
    }
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "type": "4595bf66-18b2-445a-a884-1b08d0c2df0e",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "active": true,
  • "originalConnectorId": "string",
  • "isAllowedOnAllLocations": true,
  • "config": {
    },
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

Get all WAGO connectors of a customer's location.

Get all WAGO connectors of a specific customer's location.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

strict
boolean

if set to true, only connectors directly associated with the given location will be returned; otherwise (defaul) also connectors which have "isAllowedOnAllLocation" will be returned, too

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

Responses

Response samples

Content type
application/json
{ }

Get WAGO connector of a customer's location.

Get WAGO connector of a specific customer's location.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

connectorId
required
string

id of the connector to get the data for

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "type": "4595bf66-18b2-445a-a884-1b08d0c2df0e",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "active": true,
  • "originalConnectorId": "string",
  • "isAllowedOnAllLocations": true,
  • "config": {
    },
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

connectorId
required
string

id of the connector to get the data for

Responses

Response samples

Content type
application/json
{ }

Update connector for customer's location.

Update connector for customer's location.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

connectorId
required
string

id of the connector to get the data for

Request Body schema: application/json
required
uuid
required
string <uuid>

unique identifier for this connector

type
required
string <uuid>

the connector type's UUId the connector is an instance of.

name
required
string

the name for this Connector instance.

nameAlias1
string

the name alias 1 for this Connector instance.

nameAlias2
string

the name alias 2for this Connector instance.

location
required
string <uuid>

the location's UUId the connector is assigned to.

active
required
boolean
originalConnectorId
required
string

the optional original connector id for this connector

isAllowedOnAllLocations
boolean

if set to true, this connector may be used on devices which come from a different location of the customer than the one this connector is associated with. This is needed when the connector represents a system which aggregates data from different physical locations, e.g. via networks

required
object or null

Responses

Request samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "type": "4595bf66-18b2-445a-a884-1b08d0c2df0e",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "active": true,
  • "originalConnectorId": "string",
  • "isAllowedOnAllLocations": true,
  • "config": {
    }
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "type": "4595bf66-18b2-445a-a884-1b08d0c2df0e",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "active": true,
  • "originalConnectorId": "string",
  • "isAllowedOnAllLocations": true,
  • "config": {
    },
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

Get all active SWARM connectors of a customer's location.

Get all active SWARM connectors of a specific customer's location.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

strict
boolean

if set to true, only connectors directly associated with the given location will be returned; otherwise (defaul) also connectors which have "isAllowedOnAllLocation" will be returned, too

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

Responses

Response samples

Content type
application/json
{ }

Create SWARM connector for customer.

Create SWARM connector for customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

Request Body schema: application/json
required
uuid
required
string <uuid>

unique identifier for this connector

type
required
string <uuid>

the connector type's UUId the connector is an instance of.

name
required
string

the name for this Connector instance.

nameAlias1
string

the name alias 1 for this Connector instance.

nameAlias2
string

the name alias 2for this Connector instance.

location
required
string <uuid>

the location's UUId the connector is assigned to.

active
required
boolean
originalConnectorId
string

the optional original connector id for this connector

isAllowedOnAllLocations
boolean

if set to true, this connector may be used on devices which come from a different location of the customer than the one this connector is associated with. This is needed when the connector represents a system which aggregates data from different physical locations, e.g. via networks

required
object or null

Responses

Request samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "type": "4595bf66-18b2-445a-a884-1b08d0c2df0e",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "active": true,
  • "originalConnectorId": "string",
  • "isAllowedOnAllLocations": true,
  • "config": {
    }
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "type": "4595bf66-18b2-445a-a884-1b08d0c2df0e",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "active": true,
  • "originalConnectorId": "string",
  • "isAllowedOnAllLocations": true,
  • "config": {
    },
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

Get all SWARM connectors of a customer's location.

Get all SWARM connectors of a specific customer's location.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

strict
boolean

if set to true, only connectors directly associated with the given location will be returned; otherwise (defaul) also connectors which have "isAllowedOnAllLocation" will be returned, too

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

Responses

Response samples

Content type
application/json
{ }

Get SWARM connector of a customer's location.

Get SWARM connector of a specific customer's location.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

connectorId
required
string

id of the connector to get the data for

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "type": "4595bf66-18b2-445a-a884-1b08d0c2df0e",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "active": true,
  • "originalConnectorId": "string",
  • "isAllowedOnAllLocations": true,
  • "config": {
    },
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

connectorId
required
string

id of the connector to get the data for

Responses

Response samples

Content type
application/json
{ }

Update connector for customer's location.

Update connector for customer's location.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

connectorId
required
string

id of the connector to get the data for

Request Body schema: application/json
required
uuid
required
string <uuid>

unique identifier for this connector

type
required
string <uuid>

the connector type's UUId the connector is an instance of.

name
required
string

the name for this Connector instance.

nameAlias1
string

the name alias 1 for this Connector instance.

nameAlias2
string

the name alias 2for this Connector instance.

location
required
string <uuid>

the location's UUId the connector is assigned to.

active
required
boolean
originalConnectorId
string

the optional original connector id for this connector

isAllowedOnAllLocations
boolean

if set to true, this connector may be used on devices which come from a different location of the customer than the one this connector is associated with. This is needed when the connector represents a system which aggregates data from different physical locations, e.g. via networks

required
object or null

Responses

Request samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "type": "4595bf66-18b2-445a-a884-1b08d0c2df0e",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "active": true,
  • "originalConnectorId": "string",
  • "isAllowedOnAllLocations": true,
  • "config": {
    }
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "type": "4595bf66-18b2-445a-a884-1b08d0c2df0e",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "active": true,
  • "originalConnectorId": "string",
  • "isAllowedOnAllLocations": true,
  • "config": {
    },
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

Get all active WEATHER connectors of a customer's location.

Get all active WEATHER connectors of a specific customer's location.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

strict
boolean

if set to true, only connectors directly associated with the given location will be returned; otherwise (defaul) also connectors which have "isAllowedOnAllLocation" will be returned, too

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

Responses

Response samples

Content type
application/json
{ }

Create WEATHER connector for customer.

Create WEATHER connector for customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

Request Body schema: application/json
required
uuid
required
string <uuid>

unique identifier for this connector

type
required
string <uuid>

the connector type's UUId the connector is an instance of.

name
required
string

the name for this Connector instance.

nameAlias1
string

the name alias 1 for this Connector instance.

nameAlias2
string

the name alias 2for this Connector instance.

location
required
string <uuid>

the location's UUId the connector is assigned to.

active
required
boolean
originalConnectorId
string

the optional original connector id for this connector

isAllowedOnAllLocations
boolean

if set to true, this connector may be used on devices which come from a different location of the customer than the one this connector is associated with. This is needed when the connector represents a system which aggregates data from different physical locations, e.g. via networks

Responses

Request samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "type": "4595bf66-18b2-445a-a884-1b08d0c2df0e",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "active": true,
  • "originalConnectorId": "string",
  • "isAllowedOnAllLocations": true
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "type": "4595bf66-18b2-445a-a884-1b08d0c2df0e",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "active": true,
  • "originalConnectorId": "string",
  • "isAllowedOnAllLocations": true,
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

Get all WEATHER connectors of a customer's location.

Get all WEATHER connectors of a specific customer's location.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

strict
boolean

if set to true, only connectors directly associated with the given location will be returned; otherwise (defaul) also connectors which have "isAllowedOnAllLocation" will be returned, too

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

Responses

Response samples

Content type
application/json
{ }

Get WEATHER connector of a customer's location.

Get WEATHER connector of a specific customer's location.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

connectorId
required
string

id of the connector to get the data for

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "type": "4595bf66-18b2-445a-a884-1b08d0c2df0e",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "active": true,
  • "originalConnectorId": "string",
  • "isAllowedOnAllLocations": true,
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

connectorId
required
string

id of the connector to get the data for

Responses

Response samples

Content type
application/json
{ }

Update connector for customer's location.

Update connector for customer's location.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

connectorId
required
string

id of the connector to get the data for

Request Body schema: application/json
required
uuid
required
string <uuid>

unique identifier for this connector

type
required
string <uuid>

the connector type's UUId the connector is an instance of.

name
required
string

the name for this Connector instance.

nameAlias1
string

the name alias 1 for this Connector instance.

nameAlias2
string

the name alias 2for this Connector instance.

location
required
string <uuid>

the location's UUId the connector is assigned to.

active
required
boolean
originalConnectorId
string

the optional original connector id for this connector

isAllowedOnAllLocations
boolean

if set to true, this connector may be used on devices which come from a different location of the customer than the one this connector is associated with. This is needed when the connector represents a system which aggregates data from different physical locations, e.g. via networks

Responses

Request samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "type": "4595bf66-18b2-445a-a884-1b08d0c2df0e",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "active": true,
  • "originalConnectorId": "string",
  • "isAllowedOnAllLocations": true
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "type": "4595bf66-18b2-445a-a884-1b08d0c2df0e",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "active": true,
  • "originalConnectorId": "string",
  • "isAllowedOnAllLocations": true,
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

Get all active WEATHERSITE connectors of a customer's location.

Get all active WEATHERSITE connectors of a specific customer's location.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

strict
boolean

if set to true, only connectors directly associated with the given location will be returned; otherwise (defaul) also connectors which have "isAllowedOnAllLocation" will be returned, too

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

Responses

Response samples

Content type
application/json
{ }

Create WEATHERSITE connector for customer.

Create WEATHERSITE connector for customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

Request Body schema: application/json
required
uuid
required
string <uuid>

unique identifier for this connector

type
required
string <uuid>

the connector type's UUId the connector is an instance of.

name
required
string

the name for this Connector instance.

nameAlias1
string

the name alias 1 for this Connector instance.

nameAlias2
string

the name alias 2for this Connector instance.

location
required
string <uuid>

the location's UUId the connector is assigned to.

active
required
boolean
originalConnectorId
string

the optional original connector id for this connector

isAllowedOnAllLocations
boolean

if set to true, this connector may be used on devices which come from a different location of the customer than the one this connector is associated with. This is needed when the connector represents a system which aggregates data from different physical locations, e.g. via networks

required
object or null

Responses

Request samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "type": "4595bf66-18b2-445a-a884-1b08d0c2df0e",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "active": true,
  • "originalConnectorId": "string",
  • "isAllowedOnAllLocations": true,
  • "config": {
    }
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "type": "4595bf66-18b2-445a-a884-1b08d0c2df0e",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "active": true,
  • "originalConnectorId": "string",
  • "isAllowedOnAllLocations": true,
  • "config": {
    }
}

Get all WEATHERSITE connectors of a customer's location.

Get all WEATHERSITE connectors of a specific customer's location.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

strict
boolean

if set to true, only connectors directly associated with the given location will be returned; otherwise (defaul) also connectors which have "isAllowedOnAllLocation" will be returned, too

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

Responses

Response samples

Content type
application/json
{ }

Get WEATHERSITE connector of a customer's location.

Get WEATHERSITE connector of a specific customer's location.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

connectorId
required
string

id of the connector to get the data for

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "type": "4595bf66-18b2-445a-a884-1b08d0c2df0e",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "active": true,
  • "originalConnectorId": "string",
  • "isAllowedOnAllLocations": true,
  • "config": {
    }
}

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

connectorId
required
string

id of the connector to get the data for

Responses

Response samples

Content type
application/json
{ }

Update connector for customer's location.

Update connector for customer's location.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

connectorId
required
string

id of the connector to get the data for

Request Body schema: application/json
required
uuid
required
string <uuid>

unique identifier for this connector

type
required
string <uuid>

the connector type's UUId the connector is an instance of.

name
required
string

the name for this Connector instance.

nameAlias1
string

the name alias 1 for this Connector instance.

nameAlias2
string

the name alias 2for this Connector instance.

location
required
string <uuid>

the location's UUId the connector is assigned to.

active
required
boolean
originalConnectorId
string

the optional original connector id for this connector

isAllowedOnAllLocations
boolean

if set to true, this connector may be used on devices which come from a different location of the customer than the one this connector is associated with. This is needed when the connector represents a system which aggregates data from different physical locations, e.g. via networks

required
object or null

Responses

Request samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "type": "4595bf66-18b2-445a-a884-1b08d0c2df0e",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "active": true,
  • "originalConnectorId": "string",
  • "isAllowedOnAllLocations": true,
  • "config": {
    }
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "type": "4595bf66-18b2-445a-a884-1b08d0c2df0e",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "active": true,
  • "originalConnectorId": "string",
  • "isAllowedOnAllLocations": true,
  • "config": {
    }
}

Get all active SOLAREDGE connectors of a customer's location.

Get all active SOLAREDGE connectors of a specific customer's location.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

strict
boolean

if set to true, only connectors directly associated with the given location will be returned; otherwise (defaul) also connectors which have "isAllowedOnAllLocation" will be returned, too

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

Responses

Response samples

Content type
application/json
{ }

Create SOLAREDGE connector for customer.

Create SOLAREDGE connector for customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

Request Body schema: application/json
required
uuid
required
string <uuid>

unique identifier for this connector

type
required
string <uuid>

the connector type's UUId the connector is an instance of.

name
required
string

the name for this Connector instance.

nameAlias1
string

the name alias 1 for this Connector instance.

nameAlias2
string

the name alias 2for this Connector instance.

location
required
string <uuid>

the location's UUId the connector is assigned to.

active
required
boolean
originalConnectorId
required
string

the optional original connector id for this connector

isAllowedOnAllLocations
boolean

if set to true, this connector may be used on devices which come from a different location of the customer than the one this connector is associated with. This is needed when the connector represents a system which aggregates data from different physical locations, e.g. via networks

required
object or null

Responses

Request samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "type": "4595bf66-18b2-445a-a884-1b08d0c2df0e",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "active": true,
  • "originalConnectorId": "string",
  • "isAllowedOnAllLocations": true,
  • "config": {
    }
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "type": "4595bf66-18b2-445a-a884-1b08d0c2df0e",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "active": true,
  • "originalConnectorId": "string",
  • "isAllowedOnAllLocations": true,
  • "config": {
    },
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

Get all SOLAREDGE connectors of a customer's location.

Get all SOLAREDGE connectors of a specific customer's location.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

strict
boolean

if set to true, only connectors directly associated with the given location will be returned; otherwise (defaul) also connectors which have "isAllowedOnAllLocation" will be returned, too

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

Responses

Response samples

Content type
application/json
{ }

Get SOLAREDGE connector of a customer's location.

Get SOLAREDGE connector of a specific customer's location.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

connectorId
required
string

id of the connector to get the data for

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "type": "4595bf66-18b2-445a-a884-1b08d0c2df0e",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "active": true,
  • "originalConnectorId": "string",
  • "isAllowedOnAllLocations": true,
  • "config": {
    },
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

connectorId
required
string

id of the connector to get the data for

Responses

Response samples

Content type
application/json
{ }

Update connector for customer's location.

Update connector for customer's location.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

connectorId
required
string

id of the connector to get the data for

Request Body schema: application/json
required
uuid
required
string <uuid>

unique identifier for this connector

type
required
string <uuid>

the connector type's UUId the connector is an instance of.

name
required
string

the name for this Connector instance.

nameAlias1
string

the name alias 1 for this Connector instance.

nameAlias2
string

the name alias 2for this Connector instance.

location
required
string <uuid>

the location's UUId the connector is assigned to.

active
required
boolean
originalConnectorId
required
string

the optional original connector id for this connector

isAllowedOnAllLocations
boolean

if set to true, this connector may be used on devices which come from a different location of the customer than the one this connector is associated with. This is needed when the connector represents a system which aggregates data from different physical locations, e.g. via networks

required
object or null

Responses

Request samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "type": "4595bf66-18b2-445a-a884-1b08d0c2df0e",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "active": true,
  • "originalConnectorId": "string",
  • "isAllowedOnAllLocations": true,
  • "config": {
    }
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "type": "4595bf66-18b2-445a-a884-1b08d0c2df0e",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "active": true,
  • "originalConnectorId": "string",
  • "isAllowedOnAllLocations": true,
  • "config": {
    },
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

Get all active DT connectors of a customer's location.

Get all active DT connectors of a specific customer's location.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

strict
boolean

if set to true, only connectors directly associated with the given location will be returned; otherwise (defaul) also connectors which have "isAllowedOnAllLocation" will be returned, too

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

Responses

Response samples

Content type
application/json
{ }

Create DT connector for customer.

Create DT connector for customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

Request Body schema: application/json
required
uuid
required
string <uuid>

unique identifier for this connector

type
required
string <uuid>

the connector type's UUId the connector is an instance of.

name
required
string

the name for this Connector instance.

nameAlias1
string

the name alias 1 for this Connector instance.

nameAlias2
string

the name alias 2for this Connector instance.

location
required
string <uuid>

the location's UUId the connector is assigned to.

active
required
boolean
originalConnectorId
string

the optional original connector id for this connector

isAllowedOnAllLocations
boolean

if set to true, this connector may be used on devices which come from a different location of the customer than the one this connector is associated with. This is needed when the connector represents a system which aggregates data from different physical locations, e.g. via networks

required
object or null

Responses

Request samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "type": "4595bf66-18b2-445a-a884-1b08d0c2df0e",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "active": true,
  • "originalConnectorId": "string",
  • "isAllowedOnAllLocations": true,
  • "config": {
    }
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "type": "4595bf66-18b2-445a-a884-1b08d0c2df0e",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "active": true,
  • "originalConnectorId": "string",
  • "isAllowedOnAllLocations": true,
  • "config": {
    },
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

Get all DT connectors of a customer's location.

Get all DT connectors of a specific customer's location.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

strict
boolean

if set to true, only connectors directly associated with the given location will be returned; otherwise (defaul) also connectors which have "isAllowedOnAllLocation" will be returned, too

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

Responses

Response samples

Content type
application/json
{ }

Get DT connector of a customer's location.

Get DT connector of a specific customer's location.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

connectorId
required
string

id of the connector to get the data for

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "type": "4595bf66-18b2-445a-a884-1b08d0c2df0e",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "active": true,
  • "originalConnectorId": "string",
  • "isAllowedOnAllLocations": true,
  • "config": {
    },
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

connectorId
required
string

id of the connector to get the data for

Responses

Response samples

Content type
application/json
{ }

Update connector for customer's location.

Update connector for customer's location.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

connectorId
required
string

id of the connector to get the data for

Request Body schema: application/json
required
uuid
required
string <uuid>

unique identifier for this connector

type
required
string <uuid>

the connector type's UUId the connector is an instance of.

name
required
string

the name for this Connector instance.

nameAlias1
string

the name alias 1 for this Connector instance.

nameAlias2
string

the name alias 2for this Connector instance.

location
required
string <uuid>

the location's UUId the connector is assigned to.

active
required
boolean
originalConnectorId
string

the optional original connector id for this connector

isAllowedOnAllLocations
boolean

if set to true, this connector may be used on devices which come from a different location of the customer than the one this connector is associated with. This is needed when the connector represents a system which aggregates data from different physical locations, e.g. via networks

required
object or null

Responses

Request samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "type": "4595bf66-18b2-445a-a884-1b08d0c2df0e",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "active": true,
  • "originalConnectorId": "string",
  • "isAllowedOnAllLocations": true,
  • "config": {
    }
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "type": "4595bf66-18b2-445a-a884-1b08d0c2df0e",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "active": true,
  • "originalConnectorId": "string",
  • "isAllowedOnAllLocations": true,
  • "config": {
    },
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

Get all active GENERIC connectors of a customer's location.

Get all active GENERIC connectors of a specific customer's location.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

strict
boolean

if set to true, only connectors directly associated with the given location will be returned; otherwise (defaul) also connectors which have "isAllowedOnAllLocation" will be returned, too

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

Responses

Response samples

Content type
application/json
{ }

Create GENERIC connector for customer.

Create GENERIC connector for customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

Request Body schema: application/json
required
uuid
required
string <uuid>

unique identifier for this connector

type
required
string <uuid>

the connector type's UUId the connector is an instance of.

name
required
string

the name for this Connector instance.

nameAlias1
string

the name alias 1 for this Connector instance.

nameAlias2
string

the name alias 2for this Connector instance.

location
required
string <uuid>

the location's UUId the connector is assigned to.

active
required
boolean
originalConnectorId
string

the optional original connector id for this connector

isAllowedOnAllLocations
boolean

if set to true, this connector may be used on devices which come from a different location of the customer than the one this connector is associated with. This is needed when the connector represents a system which aggregates data from different physical locations, e.g. via networks

Responses

Request samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "type": "4595bf66-18b2-445a-a884-1b08d0c2df0e",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "active": true,
  • "originalConnectorId": "string",
  • "isAllowedOnAllLocations": true
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "type": "4595bf66-18b2-445a-a884-1b08d0c2df0e",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "active": true,
  • "originalConnectorId": "string",
  • "isAllowedOnAllLocations": true,
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

Get all GENERIC connectors of a customer's location.

Get all GENERIC connectors of a specific customer's location.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

strict
boolean

if set to true, only connectors directly associated with the given location will be returned; otherwise (defaul) also connectors which have "isAllowedOnAllLocation" will be returned, too

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

Responses

Response samples

Content type
application/json
{ }

Get GENERIC connector of a customer's location.

Get GENERIC connector of a specific customer's location.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

connectorId
required
string

id of the connector to get the data for

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "type": "4595bf66-18b2-445a-a884-1b08d0c2df0e",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "active": true,
  • "originalConnectorId": "string",
  • "isAllowedOnAllLocations": true,
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

connectorId
required
string

id of the connector to get the data for

Responses

Response samples

Content type
application/json
{ }

Update connector for customer's location.

Update connector for customer's location.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

connectorId
required
string

id of the connector to get the data for

Request Body schema: application/json
required
uuid
required
string <uuid>

unique identifier for this connector

type
required
string <uuid>

the connector type's UUId the connector is an instance of.

name
required
string

the name for this Connector instance.

nameAlias1
string

the name alias 1 for this Connector instance.

nameAlias2
string

the name alias 2for this Connector instance.

location
required
string <uuid>

the location's UUId the connector is assigned to.

active
required
boolean
originalConnectorId
string

the optional original connector id for this connector

isAllowedOnAllLocations
boolean

if set to true, this connector may be used on devices which come from a different location of the customer than the one this connector is associated with. This is needed when the connector represents a system which aggregates data from different physical locations, e.g. via networks

Responses

Request samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "type": "4595bf66-18b2-445a-a884-1b08d0c2df0e",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "active": true,
  • "originalConnectorId": "string",
  • "isAllowedOnAllLocations": true
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "type": "4595bf66-18b2-445a-a884-1b08d0c2df0e",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "active": true,
  • "originalConnectorId": "string",
  • "isAllowedOnAllLocations": true,
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

Send data to the generic-connector

Send data to the generic-connector

Authorizations:
custom-auth
Request Body schema: application/json
required
connectorUuid
required
string <uuid>
customerUuid
required
string <uuid>
deviceUuid
required
string <uuid>
datapointUuid
required
string <uuid>
timestamp
required
string <date-time>
value
required
string

Responses

Request samples

Content type
application/json
{
  • "connectorUuid": "d35b761f-01a3-438e-b959-b4349902444b",
  • "customerUuid": "12589d07-fa98-4994-8d16-bef116e8e30f",
  • "deviceUuid": "9e508920-d2ae-4d6c-8e73-5b5607accb47",
  • "datapointUuid": "d99c3de4-7271-45b1-8d86-111f93f6ce3e",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "value": "string"
}

Response samples

Content type
application/json
{ }

for CORS

Authorizations:
custom-auth

Responses

Response samples

Content type
application/json
{ }

Get all active OPCUA connectors of a customer's location.

Get all active OPCUA connectors of a specific customer's location.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

strict
boolean

if set to true, only connectors directly associated with the given location will be returned; otherwise (defaul) also connectors which have "isAllowedOnAllLocation" will be returned, too

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

Responses

Response samples

Content type
application/json
{ }

Create OPCUA connector for customer.

Create OPCUA connector for customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

Request Body schema: application/json
required
modifiedAt
required
string <date-time>
required
object (uiUserInfo)
createdAt
required
string <date-time>
required
object (uiUserInfo)

Responses

Request samples

Content type
application/json
{
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "type": "4595bf66-18b2-445a-a884-1b08d0c2df0e",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "active": true,
  • "originalConnectorId": "string",
  • "isAllowedOnAllLocations": true
}

Get all OPCUA connectors of a customer's location.

Get all OPCUA connectors of a specific customer's location.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

strict
boolean

if set to true, only connectors directly associated with the given location will be returned; otherwise (defaul) also connectors which have "isAllowedOnAllLocation" will be returned, too

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

Responses

Response samples

Content type
application/json
{ }

Get OPCUA connector of a customer's location.

Get OPCUA connector of a specific customer's location.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

connectorId
required
string

id of the connector to get the data for

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "type": "4595bf66-18b2-445a-a884-1b08d0c2df0e",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "active": true,
  • "originalConnectorId": "string",
  • "isAllowedOnAllLocations": true
}

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

connectorId
required
string

id of the connector to get the data for

Responses

Response samples

Content type
application/json
{ }

Update connector for customer's location.

Update connector for customer's location.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

connectorId
required
string

id of the connector to get the data for

Request Body schema: application/json
required
modifiedAt
required
string <date-time>
required
object (uiUserInfo)
createdAt
required
string <date-time>
required
object (uiUserInfo)

Responses

Request samples

Content type
application/json
{
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "type": "4595bf66-18b2-445a-a884-1b08d0c2df0e",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "active": true,
  • "originalConnectorId": "string",
  • "isAllowedOnAllLocations": true
}

Get all active CALC connectors of a customer's location.

Get all active CALC connectors of a specific customer's location.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

strict
boolean

if set to true, only connectors directly associated with the given location will be returned; otherwise (defaul) also connectors which have "isAllowedOnAllLocation" will be returned, too

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

Responses

Response samples

Content type
application/json
{ }

Create CALC connector for customer.

Create CALC connector for customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

Request Body schema: application/json
required
uuid
required
string <uuid>

unique identifier for this connector

type
required
string <uuid>

the connector type's UUId the connector is an instance of.

name
required
string

the name for this Connector instance.

nameAlias1
string

the name alias 1 for this Connector instance.

nameAlias2
string

the name alias 2for this Connector instance.

location
required
string <uuid>

the location's UUId the connector is assigned to.

active
required
boolean
originalConnectorId
required
string or null

the optional original connector id for this connector

isAllowedOnAllLocations
boolean

if set to true, this connector may be used on devices which come from a different location of the customer than the one this connector is associated with. This is needed when the connector represents a system which aggregates data from different physical locations, e.g. via networks

required
object

Responses

Request samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "type": "4595bf66-18b2-445a-a884-1b08d0c2df0e",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "active": true,
  • "originalConnectorId": "string",
  • "isAllowedOnAllLocations": true,
  • "config": {
    }
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "type": "4595bf66-18b2-445a-a884-1b08d0c2df0e",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "active": true,
  • "originalConnectorId": "string",
  • "isAllowedOnAllLocations": true,
  • "config": {
    },
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

Get all CALC connectors of a customer's location.

Get all CALC connectors of a specific customer's location.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

strict
boolean

if set to true, only connectors directly associated with the given location will be returned; otherwise (defaul) also connectors which have "isAllowedOnAllLocation" will be returned, too

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

Responses

Response samples

Content type
application/json
{ }

Get CALC connector of a customer's location.

Get CALC connector of a specific customer's location.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

connectorId
required
string

id of the connector to get the data for

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "type": "4595bf66-18b2-445a-a884-1b08d0c2df0e",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "active": true,
  • "originalConnectorId": "string",
  • "isAllowedOnAllLocations": true,
  • "config": {
    },
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

connectorId
required
string

id of the connector to get the data for

Responses

Response samples

Content type
application/json
{ }

Update connector for customer's location.

Update connector for customer's location.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

connectorId
required
string

id of the connector to get the data for

Request Body schema: application/json
required
uuid
required
string <uuid>

unique identifier for this connector

type
required
string <uuid>

the connector type's UUId the connector is an instance of.

name
required
string

the name for this Connector instance.

nameAlias1
string

the name alias 1 for this Connector instance.

nameAlias2
string

the name alias 2for this Connector instance.

location
required
string <uuid>

the location's UUId the connector is assigned to.

active
required
boolean
originalConnectorId
required
string or null

the optional original connector id for this connector

isAllowedOnAllLocations
boolean

if set to true, this connector may be used on devices which come from a different location of the customer than the one this connector is associated with. This is needed when the connector represents a system which aggregates data from different physical locations, e.g. via networks

required
object

Responses

Request samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "type": "4595bf66-18b2-445a-a884-1b08d0c2df0e",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "active": true,
  • "originalConnectorId": "string",
  • "isAllowedOnAllLocations": true,
  • "config": {
    }
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "type": "4595bf66-18b2-445a-a884-1b08d0c2df0e",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "active": true,
  • "originalConnectorId": "string",
  • "isAllowedOnAllLocations": true,
  • "config": {
    },
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

Validate the given config

Validate the fiven config in the context of the given CALC connector of a customer's location.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

connectorId
required
string

id of the connector to get the data for

Request Body schema: application/json
required
formula
required
string

the formula that should be calculated; any Javascript expression that results in a number can be used

required
object

the datapoints that should be used for the calculation

object

the global variables that should be used for the calculation

dp2dpTimeSeconds
integer or null

the time in seconds that should be used for waiting for the referenced datapoints to send new data

scheduleSeconds
integer or null

the schedule in seconds between two calculations; use either this or minutesOfHour

minutesOfHour
Array of integers <int32> [ items <int32 > ]

the minutes of the hour to run the calculation; use either this or scheduleSeconds

Responses

Request samples

Content type
application/json
{
  • "formula": "U * I * cos(phi) * sqrt(3) * constA",
  • "datapoints": {
    },
  • "globals": {
    },
  • "dp2dpTimeSeconds"": 60,
  • "minutesOfHour": [
    ]
}

Response samples

Content type
application/json
{
  • "status": "ok",
  • "errors": [
    ],
  • "calculatedResult": 0,
  • "latestData": {
    }
}

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

connectorId
required
string

id of the connector to get the data for

Responses

Response samples

Content type
application/json
{ }

Get all active FLIC connectors of a customer's location.

Get all active FLIC connectors of a specific customer's location.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

strict
boolean

if set to true, only connectors directly associated with the given location will be returned; otherwise (defaul) also connectors which have "isAllowedOnAllLocation" will be returned, too

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

Responses

Response samples

Content type
application/json
{ }

Create FLIC connector for customer.

Create FLIC connector for customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

Request Body schema: application/json
required
uuid
required
string <uuid>

unique identifier for this connector

type
required
string <uuid>

the connector type's UUId the connector is an instance of.

name
required
string

the name for this Connector instance.

nameAlias1
string

the name alias 1 for this Connector instance.

nameAlias2
string

the name alias 2for this Connector instance.

location
required
string <uuid>

the location's UUId the connector is assigned to.

active
required
boolean
originalConnectorId
required
string

the optional original connector id for this connector

isAllowedOnAllLocations
boolean

if set to true, this connector may be used on devices which come from a different location of the customer than the one this connector is associated with. This is needed when the connector represents a system which aggregates data from different physical locations, e.g. via networks

required
object or null

Responses

Request samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "type": "4595bf66-18b2-445a-a884-1b08d0c2df0e",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "active": true,
  • "originalConnectorId": "string",
  • "isAllowedOnAllLocations": true,
  • "config": {
    }
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "type": "4595bf66-18b2-445a-a884-1b08d0c2df0e",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "active": true,
  • "originalConnectorId": "string",
  • "isAllowedOnAllLocations": true,
  • "config": {
    },
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

Get all FLIC connectors of a customer's location.

Get all FLIC connectors of a specific customer's location.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

strict
boolean

if set to true, only connectors directly associated with the given location will be returned; otherwise (defaul) also connectors which have "isAllowedOnAllLocation" will be returned, too

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

Responses

Response samples

Content type
application/json
{ }

Get FLIC connector of a customer's location.

Get FLIC connector of a specific customer's location.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

connectorId
required
string

id of the connector to get the data for

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "type": "4595bf66-18b2-445a-a884-1b08d0c2df0e",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "active": true,
  • "originalConnectorId": "string",
  • "isAllowedOnAllLocations": true,
  • "config": {
    },
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

connectorId
required
string

id of the connector to get the data for

Responses

Response samples

Content type
application/json
{ }

Update connector for customer's location.

Update connector for customer's location.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

connectorId
required
string

id of the connector to get the data for

Request Body schema: application/json
required
uuid
required
string <uuid>

unique identifier for this connector

type
required
string <uuid>

the connector type's UUId the connector is an instance of.

name
required
string

the name for this Connector instance.

nameAlias1
string

the name alias 1 for this Connector instance.

nameAlias2
string

the name alias 2for this Connector instance.

location
required
string <uuid>

the location's UUId the connector is assigned to.

active
required
boolean
originalConnectorId
required
string

the optional original connector id for this connector

isAllowedOnAllLocations
boolean

if set to true, this connector may be used on devices which come from a different location of the customer than the one this connector is associated with. This is needed when the connector represents a system which aggregates data from different physical locations, e.g. via networks

required
object or null

Responses

Request samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "type": "4595bf66-18b2-445a-a884-1b08d0c2df0e",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "active": true,
  • "originalConnectorId": "string",
  • "isAllowedOnAllLocations": true,
  • "config": {
    }
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "type": "4595bf66-18b2-445a-a884-1b08d0c2df0e",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "active": true,
  • "originalConnectorId": "string",
  • "isAllowedOnAllLocations": true,
  • "config": {
    },
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

Get all active AVA connectors of a customer's location.

Get all active AVA connectors of a specific customer's location.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

strict
boolean

if set to true, only connectors directly associated with the given location will be returned; otherwise (defaul) also connectors which have "isAllowedOnAllLocation" will be returned, too

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

Responses

Response samples

Content type
application/json
{ }

Create AVA connector for customer.

Create AVA connector for customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

Request Body schema: application/json
required
uuid
required
string <uuid>

unique identifier for this connector

type
required
string <uuid>

the connector type's UUId the connector is an instance of.

name
required
string

the name for this Connector instance.

nameAlias1
string

the name alias 1 for this Connector instance.

nameAlias2
string

the name alias 2for this Connector instance.

location
required
string <uuid>

the location's UUId the connector is assigned to.

active
required
boolean
originalConnectorId
string

the optional original connector id for this connector

isAllowedOnAllLocations
boolean

if set to true, this connector may be used on devices which come from a different location of the customer than the one this connector is associated with. This is needed when the connector represents a system which aggregates data from different physical locations, e.g. via networks

required
object or null

Responses

Request samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "type": "4595bf66-18b2-445a-a884-1b08d0c2df0e",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "active": true,
  • "originalConnectorId": "string",
  • "isAllowedOnAllLocations": true,
  • "config": {
    }
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "type": "4595bf66-18b2-445a-a884-1b08d0c2df0e",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "active": true,
  • "originalConnectorId": "string",
  • "isAllowedOnAllLocations": true,
  • "config": {
    },
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

Get all AVA connectors of a customer's location.

Get all AVA connectors of a specific customer's location.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

strict
boolean

if set to true, only connectors directly associated with the given location will be returned; otherwise (defaul) also connectors which have "isAllowedOnAllLocation" will be returned, too

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

Responses

Response samples

Content type
application/json
{ }

Get AVA connector of a customer's location.

Get AVA connector of a specific customer's location.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

connectorId
required
string

id of the connector to get the data for

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "type": "4595bf66-18b2-445a-a884-1b08d0c2df0e",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "active": true,
  • "originalConnectorId": "string",
  • "isAllowedOnAllLocations": true,
  • "config": {
    },
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

connectorId
required
string

id of the connector to get the data for

Responses

Response samples

Content type
application/json
{ }

Update connector for customer's location.

Update connector for customer's location.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

connectorId
required
string

id of the connector to get the data for

Request Body schema: application/json
required
uuid
required
string <uuid>

unique identifier for this connector

type
required
string <uuid>

the connector type's UUId the connector is an instance of.

name
required
string

the name for this Connector instance.

nameAlias1
string

the name alias 1 for this Connector instance.

nameAlias2
string

the name alias 2for this Connector instance.

location
required
string <uuid>

the location's UUId the connector is assigned to.

active
required
boolean
originalConnectorId
string

the optional original connector id for this connector

isAllowedOnAllLocations
boolean

if set to true, this connector may be used on devices which come from a different location of the customer than the one this connector is associated with. This is needed when the connector represents a system which aggregates data from different physical locations, e.g. via networks

required
object or null

Responses

Request samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "type": "4595bf66-18b2-445a-a884-1b08d0c2df0e",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "active": true,
  • "originalConnectorId": "string",
  • "isAllowedOnAllLocations": true,
  • "config": {
    }
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "type": "4595bf66-18b2-445a-a884-1b08d0c2df0e",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "active": true,
  • "originalConnectorId": "string",
  • "isAllowedOnAllLocations": true,
  • "config": {
    },
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

Location

Get all locations of a customer.

Get all locations of a specific customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new location of a customer.

Create a new location of a specific customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

Request Body schema: application/json
required
uuid
required
string <uuid>

unique identifier for this location

customer
required
string <uuid>

reference to the customer's uuid this location belongs to

name
required
string

the name of this location.

nameAlias1
string

the name alias 1 for this location instance.

nameAlias2
string

the name alias 2for this location instance.

active
required
boolean
object (geoPosition)

A geo position

additionalInfo
object

any kind of additional information about this location

allowAdditionalInfo
boolean

if this location allows additional info or not

allowEquivalenceMapping
boolean

if this location allows equivalence mapping or not

object

Responses

Request samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "active": true,
  • "geo": {
    },
  • "additionalInfo": { },
  • "allowAdditionalInfo": true,
  • "allowEquivalenceMapping": true,
  • "energyPricing": {
    }
}

Response samples

Content type
application/json
{
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

Responses

Response samples

Content type
application/json
{ }

Get a location of a customer.

Get a location of a specific customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

Responses

Response samples

Content type
application/json
{
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

Update an existing location of a customer.

Update an existing location of a specific customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

Request Body schema: application/json
required
uuid
required
string <uuid>

unique identifier for this location

customer
required
string <uuid>

reference to the customer's uuid this location belongs to

name
required
string

the name of this location.

nameAlias1
string

the name alias 1 for this location instance.

nameAlias2
string

the name alias 2for this location instance.

active
required
boolean
object (geoPosition)

A geo position

additionalInfo
object

any kind of additional information about this location

allowAdditionalInfo
boolean

if this location allows additional info or not

allowEquivalenceMapping
boolean

if this location allows equivalence mapping or not

object

Responses

Request samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "active": true,
  • "geo": {
    },
  • "additionalInfo": { },
  • "allowAdditionalInfo": true,
  • "allowEquivalenceMapping": true,
  • "energyPricing": {
    }
}

Response samples

Content type
application/json
{
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

Responses

Response samples

Content type
application/json
{ }

Update energy pricing for the given energy type, location, and customer

Update energy pricing for the given energy type, location, and customer

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

energyType
required
string (energyType)
Value: "electricity"

id of the location to get the data for

Request Body schema: application/json
required
Array
startTs
required
string <date-time>
exclusiveEndTs
string <date-time>

the optional end timestamp; NOTE that the actual time represented by this timestamp is NOT included - the match for the timespan to search a price for will be "time >= startTS and time < exclusiveEndTs"; only needed when the pricing has an actual end date, otherwise don't use it, which would leave the timespan open until infinity

price
required
number <float>

Price in Euro per unit (electricity: kWh)

Responses

Request samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Response samples

Content type
application/json
{
  • "ok": true
}

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

energyType
required
string (energyType)
Value: "electricity"

id of the location to get the data for

Responses

Response samples

Content type
application/json
{ }

Site

Get all sites of a location.

Get all sites that are assigned to a specific location.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new site of a location.

Create a new site of a specific location.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

Request Body schema: application/json
required
uuid
required
string <uuid>

unique identifier for this site

location
required
string <uuid>

the location's uuid the site is related to.

name
required
string

the name of the site.

nameAlias1
string

the name alias 1 for this site instance.

nameAlias2
string

the name alias 2for this site instance.

config
object or null

optional configuration object for the device

active
required
boolean
additionalInfo
object

any kind of additional information about this site

Responses

Request samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "config": { },
  • "active": true,
  • "additionalInfo": { }
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "config": { },
  • "active": true,
  • "additionalInfo": { },
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

Responses

Response samples

Content type
application/json
{ }

Get all sites of a customer.

Get all sites that are assigned to a specific customer, without the location inbetween.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

Responses

Response samples

Content type
application/json
{ }

Get a site of a location.

Get a site of a specific location.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

siteId
required
string

id of the site to get

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "config": { },
  • "active": true,
  • "additionalInfo": { },
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

Update an existing site of a location.

Update an existing site of a specific location.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

siteId
required
string

id of the site to get

Request Body schema: application/json
required
uuid
required
string <uuid>

unique identifier for this site

location
required
string <uuid>

the location's uuid the site is related to.

name
required
string

the name of the site.

nameAlias1
string

the name alias 1 for this site instance.

nameAlias2
string

the name alias 2for this site instance.

config
object or null

optional configuration object for the device

active
required
boolean
additionalInfo
object

any kind of additional information about this site

Responses

Request samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "config": { },
  • "active": true,
  • "additionalInfo": { }
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "config": { },
  • "active": true,
  • "additionalInfo": { },
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

siteId
required
string

id of the site to get

Responses

Response samples

Content type
application/json
{ }

Device

Get all active devices of a customer.

Get all active devices that are assigned to a specific customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

Responses

Response samples

Content type
application/json
{ }

Get all devices of a customer.

Get all devices that are assigned to a specific customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

Responses

Response samples

Content type
application/json
{ }

Get a device of a customer.

Get a device that is assigned to a specific customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Responses

Response samples

Content type
application/json
Example
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "active": true,
  • "originalDeviceId": "string",
  • "connector": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "site": "862ae9eb-f0eb-41b6-b3e5-39fdd26ce81c",
  • "config": { },
  • "deviceType": "dt",
  • "deviceSubType": "temperature",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Responses

Response samples

Content type
application/json
{ }

Get all active SMA devices of a customer.

Get all active SMA devices that are assigned to a specific customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

Responses

Response samples

Content type
application/json
{ }

Create a new SMA device of a customer.

Create a new SMA device of a specific customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

Request Body schema: application/json
required
uuid
required
string <uuid>

unique identifier for this device

customer
required
string <uuid>

the customer this device belongs to

name
required
string

the name of the device.

nameAlias1
string

the name alias 1 for this device instance.

nameAlias2
string

the name alias 2for this device instance.

active
required
boolean

if the device is active or not

originalDeviceId
required
string

the id for this device in the context of the device - e.g. the ID in the supplier's system

connector
required
string

the id of the connector this device belongs to

location
required
string <uuid>

the location's uuid the device can be related to.

site
string or null <uuid>

the site's uuid the device can be related to.

required
object or null

optional configuration object for the device

deviceType
required
string

the type of device

deviceSubType
string or null

the subtype of device

Responses

Request samples

Content type
application/json
"{\n \"uuid\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"customer\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"name\": \"0001-1KF1234567\",\n \"active\": true,\n \"originalDeviceId\": \"1KF1234567\",\n \"connector\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"location\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"site\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"config\": {\n \"username\": \"mqtt-username\"\n },\n \"deviceType\": \"sma\",\n}\n"

Response samples

Content type
application/json
{
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

Get all SMA devices of a customer.

Get all SMA devices that are assigned to a specific customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

Responses

Response samples

Content type
application/json
{ }

Get an SMA device of a customer.

Get an SMA device that is assigned to a specific customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Responses

Response samples

Content type
application/json
{
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Responses

Response samples

Content type
application/json
{ }

Update an SMA device of a customer.

Update an SMA device of a specific customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Request Body schema: application/json
required
uuid
required
string <uuid>

unique identifier for this device

customer
required
string <uuid>

the customer this device belongs to

name
required
string

the name of the device.

nameAlias1
string

the name alias 1 for this device instance.

nameAlias2
string

the name alias 2for this device instance.

active
required
boolean

if the device is active or not

originalDeviceId
required
string

the id for this device in the context of the device - e.g. the ID in the supplier's system

connector
required
string

the id of the connector this device belongs to

location
required
string <uuid>

the location's uuid the device can be related to.

site
string or null <uuid>

the site's uuid the device can be related to.

required
object or null

optional configuration object for the device

deviceType
required
string

the type of device

deviceSubType
string or null

the subtype of device

Responses

Request samples

Content type
application/json
"{\n \"uuid\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"customer\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"name\": \"0001-1KF1234567\",\n \"active\": true,\n \"originalDeviceId\": \"1KF1234567\",\n \"connector\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"location\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"site\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"config\": {\n \"username\": \"mqtt-username\"\n },\n \"deviceType\": \"sma\",\n}\n"

Response samples

Content type
application/json
{
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

Get all active WAGO devices of a customer.

Get all active WAGO devices that are assigned to a specific customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

Responses

Response samples

Content type
application/json
{ }

Create a new WAGO device of a customer.

Create a new WAGO device of a specific customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

Request Body schema: application/json
required
uuid
required
string <uuid>

unique identifier for this device

customer
required
string <uuid>

the customer this device belongs to

name
required
string

the name of the device.

nameAlias1
string

the name alias 1 for this device instance.

nameAlias2
string

the name alias 2for this device instance.

active
required
boolean

if the device is active or not

originalDeviceId
required
string

the id for this device in the context of the device - e.g. the ID in the supplier's system

connector
required
string

the id of the connector this device belongs to

location
required
string <uuid>

the location's uuid the device can be related to.

site
string or null <uuid>

the site's uuid the device can be related to.

required
object or null

optional configuration object for the device

deviceType
required
string

the type of device

deviceSubType
string or null

the subtype of device

Responses

Request samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "active": true,
  • "originalDeviceId": "string",
  • "connector": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "site": "862ae9eb-f0eb-41b6-b3e5-39fdd26ce81c",
  • "config": {
    },
  • "deviceType": "dt",
  • "deviceSubType": "temperature"
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "active": true,
  • "originalDeviceId": "string",
  • "connector": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "site": "862ae9eb-f0eb-41b6-b3e5-39fdd26ce81c",
  • "config": {
    },
  • "deviceType": "dt",
  • "deviceSubType": "temperature",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

Get all WAGO devices of a customer.

Get all WAGO devices that are assigned to a specific customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

Responses

Response samples

Content type
application/json
{ }

Get a WAGO device of a customer.

Get a WAGO device that is assigned to a specific customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "active": true,
  • "originalDeviceId": "string",
  • "connector": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "site": "862ae9eb-f0eb-41b6-b3e5-39fdd26ce81c",
  • "config": {
    },
  • "deviceType": "dt",
  • "deviceSubType": "temperature",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Responses

Response samples

Content type
application/json
{ }

Update a WAGO device of a customer.

Update a WAGO device of a specific customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Request Body schema: application/json
required
uuid
required
string <uuid>

unique identifier for this device

customer
required
string <uuid>

the customer this device belongs to

name
required
string

the name of the device.

nameAlias1
string

the name alias 1 for this device instance.

nameAlias2
string

the name alias 2for this device instance.

active
required
boolean

if the device is active or not

originalDeviceId
required
string

the id for this device in the context of the device - e.g. the ID in the supplier's system

connector
required
string

the id of the connector this device belongs to

location
required
string <uuid>

the location's uuid the device can be related to.

site
string or null <uuid>

the site's uuid the device can be related to.

required
object or null

optional configuration object for the device

deviceType
required
string

the type of device

deviceSubType
string or null

the subtype of device

Responses

Request samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "active": true,
  • "originalDeviceId": "string",
  • "connector": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "site": "862ae9eb-f0eb-41b6-b3e5-39fdd26ce81c",
  • "config": {
    },
  • "deviceType": "dt",
  • "deviceSubType": "temperature"
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "active": true,
  • "originalDeviceId": "string",
  • "connector": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "site": "862ae9eb-f0eb-41b6-b3e5-39fdd26ce81c",
  • "config": {
    },
  • "deviceType": "dt",
  • "deviceSubType": "temperature",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

Get all active SWARM devices of a customer.

Get all active SWARM devices that are assigned to a specific customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

Responses

Response samples

Content type
application/json
{ }

Create a new SWARM device of a customer.

Create a new SWARM device of a specific customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

Request Body schema: application/json
required
One of
uuid
required
string <uuid>

unique identifier for this device

customer
required
string <uuid>

the customer this device belongs to

name
required
string

the name of the device.

nameAlias1
string

the name alias 1 for this device instance.

nameAlias2
string

the name alias 2for this device instance.

active
required
boolean

if the device is active or not

originalDeviceId
required
string

the id for this device in the context of the device - e.g. the ID in the supplier's system

connector
required
string

the id of the connector this device belongs to

location
required
string <uuid>

the location's uuid the device can be related to.

site
string or null <uuid>

the site's uuid the device can be related to.

config
object or null

optional configuration object for the device

deviceType
required
string

the type of device

deviceSubType
string or null

the subtype of device

Responses

Request samples

Content type
application/json
Example
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "active": true,
  • "originalDeviceId": "string",
  • "connector": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "site": "862ae9eb-f0eb-41b6-b3e5-39fdd26ce81c",
  • "config": { },
  • "deviceType": "dt",
  • "deviceSubType": "temperature"
}

Response samples

Content type
application/json
Example
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "active": true,
  • "originalDeviceId": "string",
  • "connector": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "site": "862ae9eb-f0eb-41b6-b3e5-39fdd26ce81c",
  • "config": { },
  • "deviceType": "dt",
  • "deviceSubType": "temperature",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

Get all SWARM devices of a customer.

Get all SWARM devices that are assigned to a specific customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

Responses

Response samples

Content type
application/json
{ }

Get a SWARM device of a customer.

Get a SWARM device that is assigned to a specific customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Responses

Response samples

Content type
application/json
Example
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "active": true,
  • "originalDeviceId": "string",
  • "connector": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "site": "862ae9eb-f0eb-41b6-b3e5-39fdd26ce81c",
  • "config": { },
  • "deviceType": "dt",
  • "deviceSubType": "temperature",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Responses

Response samples

Content type
application/json
{ }

Update a SWARM device of a customer.

Update a SWARM device of a specific customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Request Body schema: application/json
required
One of
uuid
required
string <uuid>

unique identifier for this device

customer
required
string <uuid>

the customer this device belongs to

name
required
string

the name of the device.

nameAlias1
string

the name alias 1 for this device instance.

nameAlias2
string

the name alias 2for this device instance.

active
required
boolean

if the device is active or not

originalDeviceId
required
string

the id for this device in the context of the device - e.g. the ID in the supplier's system

connector
required
string

the id of the connector this device belongs to

location
required
string <uuid>

the location's uuid the device can be related to.

site
string or null <uuid>

the site's uuid the device can be related to.

config
object or null

optional configuration object for the device

deviceType
required
string

the type of device

deviceSubType
string or null

the subtype of device

Responses

Request samples

Content type
application/json
Example
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "active": true,
  • "originalDeviceId": "string",
  • "connector": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "site": "862ae9eb-f0eb-41b6-b3e5-39fdd26ce81c",
  • "config": { },
  • "deviceType": "dt",
  • "deviceSubType": "temperature"
}

Response samples

Content type
application/json
Example
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "active": true,
  • "originalDeviceId": "string",
  • "connector": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "site": "862ae9eb-f0eb-41b6-b3e5-39fdd26ce81c",
  • "config": { },
  • "deviceType": "dt",
  • "deviceSubType": "temperature",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

Get all active WEATHER devices of a customer.

Get all active WEATHER devices that are assigned to a specific customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

Responses

Response samples

Content type
application/json
{ }

Create a new WEATHER device of a customer.

Create a new WEATHER device of a specific customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

Request Body schema: application/json
required
One of
uuid
required
string <uuid>

unique identifier for this device

customer
required
string <uuid>

the customer this device belongs to

name
required
string

the name of the device.

nameAlias1
string

the name alias 1 for this device instance.

nameAlias2
string

the name alias 2for this device instance.

active
required
boolean

if the device is active or not

originalDeviceId
required
string

the id for this device in the context of the device - e.g. the ID in the supplier's system

connector
required
string

the id of the connector this device belongs to

location
required
string <uuid>

the location's uuid the device can be related to.

site
string or null <uuid>

the site's uuid the device can be related to.

config
object or null

optional configuration object for the device

deviceType
required
string

the type of device

deviceSubType
string or null

the subtype of device

modifiedAt
required
string <date-time>
required
object (uiUserInfo)
createdAt
required
string <date-time>
required
object (uiUserInfo)

Responses

Request samples

Content type
application/json
Example
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "active": true,
  • "originalDeviceId": "string",
  • "connector": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "site": "862ae9eb-f0eb-41b6-b3e5-39fdd26ce81c",
  • "config": { },
  • "deviceType": "dt",
  • "deviceSubType": "temperature",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

Response samples

Content type
application/json
Example
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "active": true,
  • "originalDeviceId": "string",
  • "connector": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "site": "862ae9eb-f0eb-41b6-b3e5-39fdd26ce81c",
  • "config": { },
  • "deviceType": "dt",
  • "deviceSubType": "temperature",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

Get all WEATHER devices of a customer.

Get all WEATHER devices that are assigned to a specific customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

Responses

Response samples

Content type
application/json
{ }

Get a WEATHER device of a customer.

Get a WEATHER device that is assigned to a specific customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Responses

Response samples

Content type
application/json
Example
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "active": true,
  • "originalDeviceId": "string",
  • "connector": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "site": "862ae9eb-f0eb-41b6-b3e5-39fdd26ce81c",
  • "config": { },
  • "deviceType": "dt",
  • "deviceSubType": "temperature",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Responses

Response samples

Content type
application/json
{ }

Update a WEATHER device of a customer.

Update a WEATHER device of a specific customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Request Body schema: application/json
required
One of
uuid
required
string <uuid>

unique identifier for this device

customer
required
string <uuid>

the customer this device belongs to

name
required
string

the name of the device.

nameAlias1
string

the name alias 1 for this device instance.

nameAlias2
string

the name alias 2for this device instance.

active
required
boolean

if the device is active or not

originalDeviceId
required
string

the id for this device in the context of the device - e.g. the ID in the supplier's system

connector
required
string

the id of the connector this device belongs to

location
required
string <uuid>

the location's uuid the device can be related to.

site
string or null <uuid>

the site's uuid the device can be related to.

config
object or null

optional configuration object for the device

deviceType
required
string

the type of device

deviceSubType
string or null

the subtype of device

modifiedAt
required
string <date-time>
required
object (uiUserInfo)
createdAt
required
string <date-time>
required
object (uiUserInfo)

Responses

Request samples

Content type
application/json
Example
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "active": true,
  • "originalDeviceId": "string",
  • "connector": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "site": "862ae9eb-f0eb-41b6-b3e5-39fdd26ce81c",
  • "config": { },
  • "deviceType": "dt",
  • "deviceSubType": "temperature",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

Response samples

Content type
application/json
Example
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "active": true,
  • "originalDeviceId": "string",
  • "connector": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "site": "862ae9eb-f0eb-41b6-b3e5-39fdd26ce81c",
  • "config": { },
  • "deviceType": "dt",
  • "deviceSubType": "temperature",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

Get all active WEATHERSITE devices of a customer.

Get all active WEATHERSITE devices that are assigned to a specific customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

Responses

Response samples

Content type
application/json
{ }

Create a new WEATHERSITE device of a customer.

Create a new WEATHERSITE device of a specific customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

Request Body schema: application/json
required
One of
uuid
required
string <uuid>

unique identifier for this device

customer
required
string <uuid>

the customer this device belongs to

name
required
string

the name of the device.

nameAlias1
string

the name alias 1 for this device instance.

nameAlias2
string

the name alias 2for this device instance.

active
required
boolean

if the device is active or not

originalDeviceId
required
string

the id for this device in the context of the device - e.g. the ID in the supplier's system

connector
required
string

the id of the connector this device belongs to

location
required
string <uuid>

the location's uuid the device can be related to.

site
string or null <uuid>

the site's uuid the device can be related to.

config
object or null

optional configuration object for the device

deviceType
required
string

the type of device

deviceSubType
string or null

the subtype of device

modifiedAt
required
string <date-time>
required
object (uiUserInfo)
createdAt
required
string <date-time>
required
object (uiUserInfo)

Responses

Request samples

Content type
application/json
Example
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "active": true,
  • "originalDeviceId": "string",
  • "connector": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "site": "862ae9eb-f0eb-41b6-b3e5-39fdd26ce81c",
  • "config": { },
  • "deviceType": "dt",
  • "deviceSubType": "temperature",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

Response samples

Content type
application/json
Example
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "active": true,
  • "originalDeviceId": "string",
  • "connector": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "site": "862ae9eb-f0eb-41b6-b3e5-39fdd26ce81c",
  • "config": { },
  • "deviceType": "dt",
  • "deviceSubType": "temperature",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

Get all WEATHERSITE devices of a customer.

Get all WEATHERSITE devices that are assigned to a specific customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

Responses

Response samples

Content type
application/json
{ }

Get a WEATHERSITE device of a customer.

Get a WEATHERSITE device that is assigned to a specific customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Responses

Response samples

Content type
application/json
Example
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "active": true,
  • "originalDeviceId": "string",
  • "connector": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "site": "862ae9eb-f0eb-41b6-b3e5-39fdd26ce81c",
  • "config": { },
  • "deviceType": "dt",
  • "deviceSubType": "temperature",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Responses

Response samples

Content type
application/json
{ }

Update a WEATHERSITE device of a customer.

Update a WEATHERSITE device of a specific customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Request Body schema: application/json
required
One of
uuid
required
string <uuid>

unique identifier for this device

customer
required
string <uuid>

the customer this device belongs to

name
required
string

the name of the device.

nameAlias1
string

the name alias 1 for this device instance.

nameAlias2
string

the name alias 2for this device instance.

active
required
boolean

if the device is active or not

originalDeviceId
required
string

the id for this device in the context of the device - e.g. the ID in the supplier's system

connector
required
string

the id of the connector this device belongs to

location
required
string <uuid>

the location's uuid the device can be related to.

site
string or null <uuid>

the site's uuid the device can be related to.

config
object or null

optional configuration object for the device

deviceType
required
string

the type of device

deviceSubType
string or null

the subtype of device

modifiedAt
required
string <date-time>
required
object (uiUserInfo)
createdAt
required
string <date-time>
required
object (uiUserInfo)

Responses

Request samples

Content type
application/json
Example
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "active": true,
  • "originalDeviceId": "string",
  • "connector": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "site": "862ae9eb-f0eb-41b6-b3e5-39fdd26ce81c",
  • "config": { },
  • "deviceType": "dt",
  • "deviceSubType": "temperature",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

Response samples

Content type
application/json
Example
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "active": true,
  • "originalDeviceId": "string",
  • "connector": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "site": "862ae9eb-f0eb-41b6-b3e5-39fdd26ce81c",
  • "config": { },
  • "deviceType": "dt",
  • "deviceSubType": "temperature",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

Get all active SOLAREDGE devices of a customer.

Get all active SOLAREDGE devices that are assigned to a specific customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

Responses

Response samples

Content type
application/json
{ }

Create a new SOLAREDGE device of a customer.

Create a new SOLAREDGE device of a specific customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

Request Body schema: application/json
required
uuid
required
string <uuid>

unique identifier for this device

customer
required
string <uuid>

the customer this device belongs to

name
required
string

the name of the device.

nameAlias1
string

the name alias 1 for this device instance.

nameAlias2
string

the name alias 2for this device instance.

active
required
boolean

if the device is active or not

originalDeviceId
required
string

the id for this device in the context of the device - e.g. the ID in the supplier's system

connector
required
string

the id of the connector this device belongs to

location
required
string <uuid>

the location's uuid the device can be related to.

site
string or null <uuid>

the site's uuid the device can be related to.

required
object or null

optional configuration object for the device

deviceType
required
string

the type of device

deviceSubType
string or null

the subtype of device

Responses

Request samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "active": true,
  • "originalDeviceId": "string",
  • "connector": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "site": "862ae9eb-f0eb-41b6-b3e5-39fdd26ce81c",
  • "config": {
    },
  • "deviceType": "dt",
  • "deviceSubType": "temperature"
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "active": true,
  • "originalDeviceId": "string",
  • "connector": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "site": "862ae9eb-f0eb-41b6-b3e5-39fdd26ce81c",
  • "config": {
    },
  • "deviceType": "dt",
  • "deviceSubType": "temperature",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

Get all SOLAREDGE devices of a customer.

Get all SOLAREDGE devices that are assigned to a specific customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

Responses

Response samples

Content type
application/json
{ }

Get a SOLAREDGE device of a customer.

Get a SOLAREDGE device that is assigned to a specific customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "active": true,
  • "originalDeviceId": "string",
  • "connector": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "site": "862ae9eb-f0eb-41b6-b3e5-39fdd26ce81c",
  • "config": {
    },
  • "deviceType": "dt",
  • "deviceSubType": "temperature",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Responses

Response samples

Content type
application/json
{ }

Update a SOLAREDGE device of a customer.

Update a SOLAREDGE device of a specific customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Request Body schema: application/json
required
uuid
required
string <uuid>

unique identifier for this device

customer
required
string <uuid>

the customer this device belongs to

name
required
string

the name of the device.

nameAlias1
string

the name alias 1 for this device instance.

nameAlias2
string

the name alias 2for this device instance.

active
required
boolean

if the device is active or not

originalDeviceId
required
string

the id for this device in the context of the device - e.g. the ID in the supplier's system

connector
required
string

the id of the connector this device belongs to

location
required
string <uuid>

the location's uuid the device can be related to.

site
string or null <uuid>

the site's uuid the device can be related to.

required
object or null

optional configuration object for the device

deviceType
required
string

the type of device

deviceSubType
string or null

the subtype of device

Responses

Request samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "active": true,
  • "originalDeviceId": "string",
  • "connector": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "site": "862ae9eb-f0eb-41b6-b3e5-39fdd26ce81c",
  • "config": {
    },
  • "deviceType": "dt",
  • "deviceSubType": "temperature"
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "active": true,
  • "originalDeviceId": "string",
  • "connector": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "site": "862ae9eb-f0eb-41b6-b3e5-39fdd26ce81c",
  • "config": {
    },
  • "deviceType": "dt",
  • "deviceSubType": "temperature",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

Get all active DT devices of a customer.

Get all active DT devices that are assigned to a specific customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

Responses

Response samples

Content type
application/json
{ }

Create a new DT device of a customer.

Create a new DT device of a specific customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

Request Body schema: application/json
required
uuid
required
string <uuid>

unique identifier for this device

customer
required
string <uuid>

the customer this device belongs to

name
required
string

the name of the device.

nameAlias1
string

the name alias 1 for this device instance.

nameAlias2
string

the name alias 2for this device instance.

active
required
boolean

if the device is active or not

originalDeviceId
required
string

the id for this device in the context of the device - e.g. the ID in the supplier's system

connector
required
string

the id of the connector this device belongs to

location
required
string <uuid>

the location's uuid the device can be related to.

site
string or null <uuid>

the site's uuid the device can be related to.

object or null

optional configuration object for the device

deviceType
required
string

the type of device

deviceSubType
string or null

the subtype of device

Responses

Request samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "active": true,
  • "originalDeviceId": "string",
  • "connector": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "site": "862ae9eb-f0eb-41b6-b3e5-39fdd26ce81c",
  • "config": {
    },
  • "deviceType": "dt",
  • "deviceSubType": "temperature"
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "active": true,
  • "originalDeviceId": "string",
  • "connector": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "site": "862ae9eb-f0eb-41b6-b3e5-39fdd26ce81c",
  • "config": {
    },
  • "deviceType": "dt",
  • "deviceSubType": "temperature",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

Get all DT devices of a customer.

Get all DT devices that are assigned to a specific customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

Responses

Response samples

Content type
application/json
{ }

Get a DT device of a customer.

Get a DT device that is assigned to a specific customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "active": true,
  • "originalDeviceId": "string",
  • "connector": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "site": "862ae9eb-f0eb-41b6-b3e5-39fdd26ce81c",
  • "config": {
    },
  • "deviceType": "dt",
  • "deviceSubType": "temperature",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Responses

Response samples

Content type
application/json
{ }

Update a DT device of a customer.

Update a DT device of a specific customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Request Body schema: application/json
required
uuid
required
string <uuid>

unique identifier for this device

customer
required
string <uuid>

the customer this device belongs to

name
required
string

the name of the device.

nameAlias1
string

the name alias 1 for this device instance.

nameAlias2
string

the name alias 2for this device instance.

active
required
boolean

if the device is active or not

originalDeviceId
required
string

the id for this device in the context of the device - e.g. the ID in the supplier's system

connector
required
string

the id of the connector this device belongs to

location
required
string <uuid>

the location's uuid the device can be related to.

site
string or null <uuid>

the site's uuid the device can be related to.

object or null

optional configuration object for the device

deviceType
required
string

the type of device

deviceSubType
string or null

the subtype of device

Responses

Request samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "active": true,
  • "originalDeviceId": "string",
  • "connector": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "site": "862ae9eb-f0eb-41b6-b3e5-39fdd26ce81c",
  • "config": {
    },
  • "deviceType": "dt",
  • "deviceSubType": "temperature"
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "active": true,
  • "originalDeviceId": "string",
  • "connector": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "site": "862ae9eb-f0eb-41b6-b3e5-39fdd26ce81c",
  • "config": {
    },
  • "deviceType": "dt",
  • "deviceSubType": "temperature",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

Get all active GENERIC devices of a customer.

Get all active GENERIC devices that are assigned to a specific customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

Responses

Response samples

Content type
application/json
{ }

Create a new GENERIC device of a customer.

Create a new GENERIC device of a specific customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

Request Body schema: application/json
required
uuid
required
string <uuid>

unique identifier for this device

customer
required
string <uuid>

the customer this device belongs to

name
required
string

the name of the device.

nameAlias1
string

the name alias 1 for this device instance.

nameAlias2
string

the name alias 2for this device instance.

active
required
boolean

if the device is active or not

originalDeviceId
required
string

the id for this device in the context of the device - e.g. the ID in the supplier's system

connector
required
string

the id of the connector this device belongs to

location
required
string <uuid>

the location's uuid the device can be related to.

site
string or null <uuid>

the site's uuid the device can be related to.

config
object or null

optional configuration object for the device

deviceType
required
string

the type of device

deviceSubType
string or null

the subtype of device

Responses

Request samples

Content type
application/json
"{\n \"uuid\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"customer\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"name\": \"0001-1KF1234567\",\n \"active\": true,\n \"originalDeviceId\": \"1KF1234567\",\n \"connector\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"location\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"site\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"config\": {},\n \"deviceType\": \"generic\",\n}\n"

Response samples

Content type
application/json
{
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

Get all GENERIC devices of a customer.

Get all GENERIC devices that are assigned to a specific customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

Responses

Response samples

Content type
application/json
{ }

Get an GENERIC device of a customer.

Get an GENERIC device that is assigned to a specific customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Responses

Response samples

Content type
application/json
{
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Responses

Response samples

Content type
application/json
{ }

Update an GENERIC device of a customer.

Update an GENERIC device of a specific customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Request Body schema: application/json
required
uuid
required
string <uuid>

unique identifier for this device

customer
required
string <uuid>

the customer this device belongs to

name
required
string

the name of the device.

nameAlias1
string

the name alias 1 for this device instance.

nameAlias2
string

the name alias 2for this device instance.

active
required
boolean

if the device is active or not

originalDeviceId
required
string

the id for this device in the context of the device - e.g. the ID in the supplier's system

connector
required
string

the id of the connector this device belongs to

location
required
string <uuid>

the location's uuid the device can be related to.

site
string or null <uuid>

the site's uuid the device can be related to.

config
object or null

optional configuration object for the device

deviceType
required
string

the type of device

deviceSubType
string or null

the subtype of device

Responses

Request samples

Content type
application/json
"{\n \"uuid\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"customer\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"name\": \"0001-1KF1234567\",\n \"active\": true,\n \"originalDeviceId\": \"1KF1234567\",\n \"connector\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"location\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"site\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"config\": {},\n \"deviceType\": \"generic\",\n}\n"

Response samples

Content type
application/json
{
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

Get all active OPCUA devices of a customer.

Get all active OPCUA devices that are assigned to a specific customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

Responses

Response samples

Content type
application/json
{ }

Create a new OPCUA device of a customer.

Create a new OPCUA device of a specific customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

Request Body schema: application/json
required
uuid
required
string <uuid>

unique identifier for this device

customer
required
string <uuid>

the customer this device belongs to

name
required
string

the name of the device.

nameAlias1
string

the name alias 1 for this device instance.

nameAlias2
string

the name alias 2for this device instance.

active
required
boolean

if the device is active or not

originalDeviceId
required
string

the id for this device in the context of the device - e.g. the ID in the supplier's system

connector
required
string

the id of the connector this device belongs to

location
required
string <uuid>

the location's uuid the device can be related to.

site
string or null <uuid>

the site's uuid the device can be related to.

config
object or null

optional configuration object for the device

deviceType
required
string

the type of device

deviceSubType
string or null

the subtype of device

Responses

Request samples

Content type
application/json
"{\n \"uuid\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"customer\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"name\": \"0001-1KF1234567\",\n \"active\": true,\n \"originalDeviceId\": \"1KF1234567\",\n \"connector\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"location\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"site\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"config\": {},\n \"deviceType\": \"opcua\",\n}\n"

Response samples

Content type
application/json
{
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

Get all OPCUA devices of a customer.

Get all OPCUA devices that are assigned to a specific customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

Responses

Response samples

Content type
application/json
{ }

Get an OPCUA device of a customer.

Get an OPCUA device that is assigned to a specific customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Responses

Response samples

Content type
application/json
{
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Responses

Response samples

Content type
application/json
{ }

Update an OPCUA device of a customer.

Update an OPCUA device of a specific customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Request Body schema: application/json
required
uuid
required
string <uuid>

unique identifier for this device

customer
required
string <uuid>

the customer this device belongs to

name
required
string

the name of the device.

nameAlias1
string

the name alias 1 for this device instance.

nameAlias2
string

the name alias 2for this device instance.

active
required
boolean

if the device is active or not

originalDeviceId
required
string

the id for this device in the context of the device - e.g. the ID in the supplier's system

connector
required
string

the id of the connector this device belongs to

location
required
string <uuid>

the location's uuid the device can be related to.

site
string or null <uuid>

the site's uuid the device can be related to.

config
object or null

optional configuration object for the device

deviceType
required
string

the type of device

deviceSubType
string or null

the subtype of device

Responses

Request samples

Content type
application/json
"{\n \"uuid\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"customer\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"name\": \"0001-1KF1234567\",\n \"active\": true,\n \"originalDeviceId\": \"1KF1234567\",\n \"connector\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"location\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"site\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"config\": {},\n \"deviceType\": \"opcua\",\n}\n"

Response samples

Content type
application/json
{
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

Get all active CALC devices of a customer.

Get all active CALC devices that are assigned to a specific customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

Responses

Response samples

Content type
application/json
[
  • "{\n \"uuid\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"customer\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"name\": \"0001-1KF1234567\",\n \"active\": true,\n \"originalDeviceId\": \"1KF1234567\",\n \"connector\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"location\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"site\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"config\": {},\n \"deviceType\": \"generic\",\n}\n"
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

Responses

Response samples

Content type
application/json
{ }

Create a new CALC device of a customer.

Create a new CALC device of a specific customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

Request Body schema: application/json
required
uuid
required
string <uuid>

unique identifier for this device

customer
required
string <uuid>

the customer this device belongs to

name
required
string

the name of the device.

nameAlias1
string

the name alias 1 for this device instance.

nameAlias2
string

the name alias 2for this device instance.

active
required
boolean

if the device is active or not

originalDeviceId
required
string

the id for this device in the context of the device - e.g. the ID in the supplier's system

connector
required
string

the id of the connector this device belongs to

location
required
string <uuid>

the location's uuid the device can be related to.

site
string or null <uuid>

the site's uuid the device can be related to.

config
object or null

optional configuration object for the device

deviceType
required
string

the type of device

deviceSubType
string or null

the subtype of device

Responses

Request samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "active": true,
  • "originalDeviceId": "string",
  • "connector": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "site": "862ae9eb-f0eb-41b6-b3e5-39fdd26ce81c",
  • "config": { },
  • "deviceType": "dt",
  • "deviceSubType": "temperature"
}

Response samples

Content type
application/json
"{\n \"uuid\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"customer\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"name\": \"0001-1KF1234567\",\n \"active\": true,\n \"originalDeviceId\": \"1KF1234567\",\n \"connector\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"location\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"site\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"config\": {},\n \"deviceType\": \"generic\",\n}\n"

Get all CALC devices of a customer.

Get all CALC devices that are assigned to a specific customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

Responses

Response samples

Content type
application/json
[
  • "{\n \"uuid\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"customer\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"name\": \"0001-1KF1234567\",\n \"active\": true,\n \"originalDeviceId\": \"1KF1234567\",\n \"connector\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"location\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"site\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"config\": {},\n \"deviceType\": \"generic\",\n}\n"
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

Responses

Response samples

Content type
application/json
{ }

Get an CALC device of a customer.

Get an CALC device that is assigned to a specific customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Responses

Response samples

Content type
application/json
"{\n \"uuid\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"customer\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"name\": \"0001-1KF1234567\",\n \"active\": true,\n \"originalDeviceId\": \"1KF1234567\",\n \"connector\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"location\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"site\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"config\": {},\n \"deviceType\": \"generic\",\n}\n"

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Responses

Response samples

Content type
application/json
{ }

Update an CALC device of a customer.

Update an CALC device of a specific customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Request Body schema: application/json
required
uuid
required
string <uuid>

unique identifier for this device

customer
required
string <uuid>

the customer this device belongs to

name
required
string

the name of the device.

nameAlias1
string

the name alias 1 for this device instance.

nameAlias2
string

the name alias 2for this device instance.

active
required
boolean

if the device is active or not

originalDeviceId
required
string

the id for this device in the context of the device - e.g. the ID in the supplier's system

connector
required
string

the id of the connector this device belongs to

location
required
string <uuid>

the location's uuid the device can be related to.

site
string or null <uuid>

the site's uuid the device can be related to.

config
object or null

optional configuration object for the device

deviceType
required
string

the type of device

deviceSubType
string or null

the subtype of device

Responses

Request samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "active": true,
  • "originalDeviceId": "string",
  • "connector": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "site": "862ae9eb-f0eb-41b6-b3e5-39fdd26ce81c",
  • "config": { },
  • "deviceType": "dt",
  • "deviceSubType": "temperature"
}

Response samples

Content type
application/json
"{\n \"uuid\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"customer\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"name\": \"0001-1KF1234567\",\n \"active\": true,\n \"originalDeviceId\": \"1KF1234567\",\n \"connector\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"location\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"site\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"config\": {},\n \"deviceType\": \"generic\",\n}\n"

Get all active FLIC devices of a customer.

Get all active FLIC devices that are assigned to a specific customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

Responses

Response samples

Content type
application/json
{ }

Create a new FLIC device of a customer.

Create a new FLIC device of a specific customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

Request Body schema: application/json
required
uuid
required
string <uuid>

unique identifier for this device

customer
required
string <uuid>

the customer this device belongs to

name
required
string

the name of the device.

nameAlias1
string

the name alias 1 for this device instance.

nameAlias2
string

the name alias 2for this device instance.

active
required
boolean

if the device is active or not

originalDeviceId
required
string

the id for this device in the context of the device - e.g. the ID in the supplier's system

connector
required
string

the id of the connector this device belongs to

location
required
string <uuid>

the location's uuid the device can be related to.

site
string or null <uuid>

the site's uuid the device can be related to.

config
object or null

optional configuration object for the device

deviceType
required
string

the type of device

deviceSubType
string or null

the subtype of device

Responses

Request samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "active": true,
  • "originalDeviceId": "string",
  • "connector": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "site": "862ae9eb-f0eb-41b6-b3e5-39fdd26ce81c",
  • "config": { },
  • "deviceType": "dt",
  • "deviceSubType": "temperature"
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "active": true,
  • "originalDeviceId": "string",
  • "connector": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "site": "862ae9eb-f0eb-41b6-b3e5-39fdd26ce81c",
  • "config": { },
  • "deviceType": "dt",
  • "deviceSubType": "temperature",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

Get all FLIC devices of a customer.

Get all FLIC devices that are assigned to a specific customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

Responses

Response samples

Content type
application/json
{ }

Get a FLIC device of a customer.

Get a FLIC device that is assigned to a specific customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "active": true,
  • "originalDeviceId": "string",
  • "connector": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "site": "862ae9eb-f0eb-41b6-b3e5-39fdd26ce81c",
  • "config": { },
  • "deviceType": "dt",
  • "deviceSubType": "temperature",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Responses

Response samples

Content type
application/json
{ }

Update a FLIC device of a customer.

Update a FLIC device of a specific customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Request Body schema: application/json
required
uuid
required
string <uuid>

unique identifier for this device

customer
required
string <uuid>

the customer this device belongs to

name
required
string

the name of the device.

nameAlias1
string

the name alias 1 for this device instance.

nameAlias2
string

the name alias 2for this device instance.

active
required
boolean

if the device is active or not

originalDeviceId
required
string

the id for this device in the context of the device - e.g. the ID in the supplier's system

connector
required
string

the id of the connector this device belongs to

location
required
string <uuid>

the location's uuid the device can be related to.

site
string or null <uuid>

the site's uuid the device can be related to.

config
object or null

optional configuration object for the device

deviceType
required
string

the type of device

deviceSubType
string or null

the subtype of device

Responses

Request samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "active": true,
  • "originalDeviceId": "string",
  • "connector": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "site": "862ae9eb-f0eb-41b6-b3e5-39fdd26ce81c",
  • "config": { },
  • "deviceType": "dt",
  • "deviceSubType": "temperature"
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "active": true,
  • "originalDeviceId": "string",
  • "connector": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "site": "862ae9eb-f0eb-41b6-b3e5-39fdd26ce81c",
  • "config": { },
  • "deviceType": "dt",
  • "deviceSubType": "temperature",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

Get all active AVA devices of a customer.

Get all active AVA devices that are assigned to a specific customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

Responses

Response samples

Content type
application/json
{ }

Create a new AVA device of a customer.

Create a new AVA device of a specific customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

Request Body schema: application/json
required
uuid
required
string <uuid>

unique identifier for this device

customer
required
string <uuid>

the customer this device belongs to

name
required
string

the name of the device.

nameAlias1
string

the name alias 1 for this device instance.

nameAlias2
string

the name alias 2for this device instance.

active
required
boolean

if the device is active or not

originalDeviceId
required
string

the id for this device in the context of the device - e.g. the ID in the supplier's system

connector
required
string

the id of the connector this device belongs to

location
required
string <uuid>

the location's uuid the device can be related to.

site
string or null <uuid>

the site's uuid the device can be related to.

config
object or null

optional configuration object for the device

deviceType
required
string

the type of device

deviceSubType
required
string or null
Enum: "LPR" "COUNTS"

the subtype of device

lastSeen
number

Last seen timestamp in milliseconds, will be used internally and is not intended to be set by user

Responses

Request samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "active": true,
  • "originalDeviceId": "string",
  • "connector": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "site": "862ae9eb-f0eb-41b6-b3e5-39fdd26ce81c",
  • "config": { },
  • "deviceType": "dt",
  • "deviceSubType": "LPR",
  • "lastSeen": 0
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "active": true,
  • "originalDeviceId": "string",
  • "connector": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "site": "862ae9eb-f0eb-41b6-b3e5-39fdd26ce81c",
  • "config": { },
  • "deviceType": "dt",
  • "deviceSubType": "LPR",
  • "lastSeen": 0,
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

Get all AVA devices of a customer.

Get all AVA devices that are assigned to a specific customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

Responses

Response samples

Content type
application/json
{ }

Get a AVA device of a customer.

Get a AVA device that is assigned to a specific customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "active": true,
  • "originalDeviceId": "string",
  • "connector": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "site": "862ae9eb-f0eb-41b6-b3e5-39fdd26ce81c",
  • "config": { },
  • "deviceType": "dt",
  • "deviceSubType": "LPR",
  • "lastSeen": 0,
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Responses

Response samples

Content type
application/json
{ }

Update a AVA device of a customer.

Update a AVA device of a specific customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Request Body schema: application/json
required
uuid
required
string <uuid>

unique identifier for this device

customer
required
string <uuid>

the customer this device belongs to

name
required
string

the name of the device.

nameAlias1
string

the name alias 1 for this device instance.

nameAlias2
string

the name alias 2for this device instance.

active
required
boolean

if the device is active or not

originalDeviceId
required
string

the id for this device in the context of the device - e.g. the ID in the supplier's system

connector
required
string

the id of the connector this device belongs to

location
required
string <uuid>

the location's uuid the device can be related to.

site
string or null <uuid>

the site's uuid the device can be related to.

config
object or null

optional configuration object for the device

deviceType
required
string

the type of device

deviceSubType
required
string or null
Enum: "LPR" "COUNTS"

the subtype of device

lastSeen
number

Last seen timestamp in milliseconds, will be used internally and is not intended to be set by user

Responses

Request samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "active": true,
  • "originalDeviceId": "string",
  • "connector": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "site": "862ae9eb-f0eb-41b6-b3e5-39fdd26ce81c",
  • "config": { },
  • "deviceType": "dt",
  • "deviceSubType": "LPR",
  • "lastSeen": 0
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "active": true,
  • "originalDeviceId": "string",
  • "connector": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "site": "862ae9eb-f0eb-41b6-b3e5-39fdd26ce81c",
  • "config": { },
  • "deviceType": "dt",
  • "deviceSubType": "LPR",
  • "lastSeen": 0,
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

Datapoint

Get all active datapoints of a device.

Get all active datapoints that are assigned to a specific device.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Responses

Response samples

Content type
application/json
{ }

Get all datapoints for a device of a customer.

Get all datapoints that are assigned to a specific device of a customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Responses

Response samples

Content type
application/json
{ }

Get a datapoint for a device of a customer.

Get a datapoint that is assigned to a specific device and customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

datapointId
required
string

id of the datapoint to get the data for

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "device": "8dca31e6-c85b-4a6b-bfb4-205d45d9b3bd",
  • "active": true,
  • "originalDatapointId": "string",
  • "datapointSubType": "string",
  • "datapointType": "string",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "config": { },
  • "correctionFactor": 0,
  • "category": "weather",
  • "measurementType": "unknown",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

datapointId
required
string

id of the datapoint to get the data for

Responses

Response samples

Content type
application/json
{ }

Get all active SMA datapoints of an SMA device.

Get all active SMA datapoints that are assigned to a specific SMA device.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Responses

Response samples

Content type
application/json
{ }

Create a new SMA datapoint for an SMA device of a customer.

Create a new SMA datapoint for an SMA device of a specific customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Request Body schema: application/json
required
uuid
required
string <uuid>

unique identifier for this datapoint.

name
required
string

the name of the datapoint.

nameAlias1
string

the name alias 1 for this datapoint instance.

nameAlias2
string

the name alias 2for this datapoint instance.

device
required
string <uuid>

the device's uuid the object is related to.

active
required
boolean

if the datapoint is active or not

originalDatapointId
required
string

the id for this datapoint in the context of the remote datapoint - e.g. the ID in the supplier's system

datapointSubType
required
string

the subtype of datapoint, how the supplier of the connector would call it

datapointType
required
string

the type of datapoint, usually matches the connector type key where this datapoint receives data from

customer
required
string <uuid>

the customer this datapoint belongs to

config
object or null
correctionFactor
number
category
required
string
Enum: "weather" "energy" "environment" "status" "recognition" "unknown"
measurementType
required
string
Enum: "unknown" "temperature" "humidity" "pressure" "co2" "voltage" "voltagep1" "voltagep2" "voltagep3" "current" "currentp1" "currentp2" "currentp3" "totalcurrent" "totalactivepower" "totalreactivepower" "totalapparentpower" "totalpowerfactor" "totalactiveenergy" "totalreactiveenergy" "totalapparentenergy" "activepowerp1" "activepowerp2" "activepowerp3" "reactivepowerp1" "reactivepowerp2" "reactivepowerp3" "apparentpowerp1" "apparentpowerp2" "apparentpowerp3" "cosphip1" "cosphip2" "cosphip3" "powerfactorp1" "powerfactorp2" "powerfactorp3" "frequenzyp1" "frequenzyp2" "frequenzyp3" "energyproduction" "energyconsumption" "energyexport" "energyselfconsumption" "energyimport" "powerproduction" "powerexport" "powerconsumption" "powerimport" "powerselfconsumption" "contact" "touch" "touchcount" "presence" "presencecount" "waterdetector" "motion" "occupancy" "weatherprecipitation" "weatherprecipitationduration" "weatherhumidity" "weathercglo" "weatherwindspeed" "weatherwindgustspeed" "weatherwindgusttimestamp" "weatherwindheading" "weatherwindgustheading" "weatherhumidityrelative" "weathertemperatureair" "weatherpressure" "weatherpressurereduced" "weathersnowheight" "weathersunshineduration" "weatherdewpoint" "weathertemperaturesoil10" "weathertemperaturesoil100" "weathertemperaturewater" "personcountinside" "personcountin" "personcountout" "vehiclecountinside" "vehiclecountin" "vehiclecountout" "licenseplate" "county"

Responses

Request samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "device": "8dca31e6-c85b-4a6b-bfb4-205d45d9b3bd",
  • "active": true,
  • "originalDatapointId": "string",
  • "datapointSubType": "string",
  • "datapointType": "string",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "config": { },
  • "correctionFactor": 0,
  • "category": "weather",
  • "measurementType": "unknown"
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "device": "8dca31e6-c85b-4a6b-bfb4-205d45d9b3bd",
  • "active": true,
  • "originalDatapointId": "string",
  • "datapointSubType": "string",
  • "datapointType": "string",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "config": { },
  • "correctionFactor": 0,
  • "category": "weather",
  • "measurementType": "unknown",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

Get all SMA datapoints for an SMA device of a customer.

Get all SMA datapoints that are assigned to a specific SMA device of a customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Responses

Response samples

Content type
application/json
{ }

Get an SMA datapoint for an SMA device of a customer.

Get an SMA datapoint that is assigned to a specific SMA device and customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

datapointId
required
string

id of the datapoint to get the data for

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "device": "8dca31e6-c85b-4a6b-bfb4-205d45d9b3bd",
  • "active": true,
  • "originalDatapointId": "string",
  • "datapointSubType": "string",
  • "datapointType": "string",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "config": { },
  • "correctionFactor": 0,
  • "category": "weather",
  • "measurementType": "unknown",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

datapointId
required
string

id of the datapoint to get the data for

Responses

Response samples

Content type
application/json
{ }

Update an SMA datapoint for an SMA device of a customer.

Update an SMA datapoint of a specific SMA device and customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

datapointId
required
string

id of the datapoint to get the data for

Request Body schema: application/json
required
uuid
required
string <uuid>

unique identifier for this datapoint.

name
required
string

the name of the datapoint.

nameAlias1
string

the name alias 1 for this datapoint instance.

nameAlias2
string

the name alias 2for this datapoint instance.

device
required
string <uuid>

the device's uuid the object is related to.

active
required
boolean

if the datapoint is active or not

originalDatapointId
required
string

the id for this datapoint in the context of the remote datapoint - e.g. the ID in the supplier's system

datapointSubType
required
string

the subtype of datapoint, how the supplier of the connector would call it

datapointType
required
string

the type of datapoint, usually matches the connector type key where this datapoint receives data from

customer
required
string <uuid>

the customer this datapoint belongs to

config
object or null
correctionFactor
number
category
required
string
Enum: "weather" "energy" "environment" "status" "recognition" "unknown"
measurementType
required
string
Enum: "unknown" "temperature" "humidity" "pressure" "co2" "voltage" "voltagep1" "voltagep2" "voltagep3" "current" "currentp1" "currentp2" "currentp3" "totalcurrent" "totalactivepower" "totalreactivepower" "totalapparentpower" "totalpowerfactor" "totalactiveenergy" "totalreactiveenergy" "totalapparentenergy" "activepowerp1" "activepowerp2" "activepowerp3" "reactivepowerp1" "reactivepowerp2" "reactivepowerp3" "apparentpowerp1" "apparentpowerp2" "apparentpowerp3" "cosphip1" "cosphip2" "cosphip3" "powerfactorp1" "powerfactorp2" "powerfactorp3" "frequenzyp1" "frequenzyp2" "frequenzyp3" "energyproduction" "energyconsumption" "energyexport" "energyselfconsumption" "energyimport" "powerproduction" "powerexport" "powerconsumption" "powerimport" "powerselfconsumption" "contact" "touch" "touchcount" "presence" "presencecount" "waterdetector" "motion" "occupancy" "weatherprecipitation" "weatherprecipitationduration" "weatherhumidity" "weathercglo" "weatherwindspeed" "weatherwindgustspeed" "weatherwindgusttimestamp" "weatherwindheading" "weatherwindgustheading" "weatherhumidityrelative" "weathertemperatureair" "weatherpressure" "weatherpressurereduced" "weathersnowheight" "weathersunshineduration" "weatherdewpoint" "weathertemperaturesoil10" "weathertemperaturesoil100" "weathertemperaturewater" "personcountinside" "personcountin" "personcountout" "vehiclecountinside" "vehiclecountin" "vehiclecountout" "licenseplate" "county"

Responses

Request samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "device": "8dca31e6-c85b-4a6b-bfb4-205d45d9b3bd",
  • "active": true,
  • "originalDatapointId": "string",
  • "datapointSubType": "string",
  • "datapointType": "string",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "config": { },
  • "correctionFactor": 0,
  • "category": "weather",
  • "measurementType": "unknown"
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "device": "8dca31e6-c85b-4a6b-bfb4-205d45d9b3bd",
  • "active": true,
  • "originalDatapointId": "string",
  • "datapointSubType": "string",
  • "datapointType": "string",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "config": { },
  • "correctionFactor": 0,
  • "category": "weather",
  • "measurementType": "unknown",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

Get all active WAGO datapoints of a WAGO device.

Get all active WAGO datapoints that are assigned to a specific WAGO device.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Responses

Response samples

Content type
application/json
{ }

Create a new WAGO datapoint for an WAGO device of a customer.

Create a new WAGO datapoint for an WAGO device of a specific customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Request Body schema: application/json
required
uuid
required
string <uuid>

unique identifier for this datapoint.

name
required
string

the name of the datapoint.

nameAlias1
string

the name alias 1 for this datapoint instance.

nameAlias2
string

the name alias 2for this datapoint instance.

device
required
string <uuid>

the device's uuid the object is related to.

active
required
boolean

if the datapoint is active or not

originalDatapointId
required
string

the id for this datapoint in the context of the remote datapoint - e.g. the ID in the supplier's system

datapointSubType
string

the subtype of datapoint, how the supplier of the connector would call it

datapointType
string

the type of datapoint, usually matches the connector type key where this datapoint receives data from

customer
required
string <uuid>

the customer this datapoint belongs to

config
object or null
correctionFactor
number
category
required
string (measureDataCategory)
Enum: "weather" "energy" "environment" "status" "recognition" "unknown"
measurementType
required
string (measureDataType)
Enum: "unknown" "temperature" "humidity" "pressure" "co2" "voltage" "voltagep1" "voltagep2" "voltagep3" "current" "currentp1" "currentp2" "currentp3" "totalcurrent" "totalactivepower" "totalreactivepower" "totalapparentpower" "totalpowerfactor" "totalactiveenergy" "totalreactiveenergy" "totalapparentenergy" "activepowerp1" "activepowerp2" "activepowerp3" "reactivepowerp1" "reactivepowerp2" "reactivepowerp3" "apparentpowerp1" "apparentpowerp2" "apparentpowerp3" "cosphip1" "cosphip2" "cosphip3" "powerfactorp1" "powerfactorp2" "powerfactorp3" "frequenzyp1" "frequenzyp2" "frequenzyp3" "energyproduction" "energyconsumption" "energyexport" "energyselfconsumption" "energyimport" "powerproduction" "powerexport" "powerconsumption" "powerimport" "powerselfconsumption" "contact" "touch" "touchcount" "presence" "presencecount" "waterdetector" "motion" "occupancy" "weatherprecipitation" "weatherprecipitationduration" "weatherhumidity" "weathercglo" "weatherwindspeed" "weatherwindgustspeed" "weatherwindgusttimestamp" "weatherwindheading" "weatherwindgustheading" "weatherhumidityrelative" "weathertemperatureair" "weatherpressure" "weatherpressurereduced" "weathersnowheight" "weathersunshineduration" "weatherdewpoint" "weathertemperaturesoil10" "weathertemperaturesoil100" "weathertemperaturewater" "personcountinside" "personcountin" "personcountout" "vehiclecountinside" "vehiclecountin" "vehiclecountout" "licenseplate" "county"

Responses

Request samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "device": "8dca31e6-c85b-4a6b-bfb4-205d45d9b3bd",
  • "active": true,
  • "originalDatapointId": "string",
  • "datapointSubType": "string",
  • "datapointType": "string",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "config": { },
  • "correctionFactor": 0,
  • "category": "weather",
  • "measurementType": "unknown"
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "device": "8dca31e6-c85b-4a6b-bfb4-205d45d9b3bd",
  • "active": true,
  • "originalDatapointId": "string",
  • "datapointSubType": "string",
  • "datapointType": "string",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "config": { },
  • "correctionFactor": 0,
  • "category": "weather",
  • "measurementType": "unknown",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

Get all WAGO datapoints for a WAGO device of a customer.

Get all WAGO datapoints that are assigned to a specific WAGO device of a customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Responses

Response samples

Content type
application/json
{ }

Get a WAGO datapoint for a WAGO device of a customer.

Get a WAGO datapoint that is assigned to a specific WAGO device and customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

datapointId
required
string

id of the datapoint to get the data for

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "device": "8dca31e6-c85b-4a6b-bfb4-205d45d9b3bd",
  • "active": true,
  • "originalDatapointId": "string",
  • "datapointSubType": "string",
  • "datapointType": "string",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "config": { },
  • "correctionFactor": 0,
  • "category": "weather",
  • "measurementType": "unknown",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

datapointId
required
string

id of the datapoint to get the data for

Responses

Response samples

Content type
application/json
{ }

Update a WAGO datapoint for a WAGO device of a customer.

Update a WAGO datapoint of a specific WAGO device and customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

datapointId
required
string

id of the datapoint to get the data for

Request Body schema: application/json
required
uuid
required
string <uuid>

unique identifier for this datapoint.

name
required
string

the name of the datapoint.

nameAlias1
string

the name alias 1 for this datapoint instance.

nameAlias2
string

the name alias 2for this datapoint instance.

device
required
string <uuid>

the device's uuid the object is related to.

active
required
boolean

if the datapoint is active or not

originalDatapointId
required
string

the id for this datapoint in the context of the remote datapoint - e.g. the ID in the supplier's system

datapointSubType
required
string

the subtype of datapoint, how the supplier of the connector would call it

datapointType
required
string

the type of datapoint, usually matches the connector type key where this datapoint receives data from

customer
required
string <uuid>

the customer this datapoint belongs to

config
object or null
correctionFactor
number
category
required
string
Enum: "weather" "energy" "environment" "status" "recognition" "unknown"
measurementType
required
string
Enum: "unknown" "temperature" "humidity" "pressure" "co2" "voltage" "voltagep1" "voltagep2" "voltagep3" "current" "currentp1" "currentp2" "currentp3" "totalcurrent" "totalactivepower" "totalreactivepower" "totalapparentpower" "totalpowerfactor" "totalactiveenergy" "totalreactiveenergy" "totalapparentenergy" "activepowerp1" "activepowerp2" "activepowerp3" "reactivepowerp1" "reactivepowerp2" "reactivepowerp3" "apparentpowerp1" "apparentpowerp2" "apparentpowerp3" "cosphip1" "cosphip2" "cosphip3" "powerfactorp1" "powerfactorp2" "powerfactorp3" "frequenzyp1" "frequenzyp2" "frequenzyp3" "energyproduction" "energyconsumption" "energyexport" "energyselfconsumption" "energyimport" "powerproduction" "powerexport" "powerconsumption" "powerimport" "powerselfconsumption" "contact" "touch" "touchcount" "presence" "presencecount" "waterdetector" "motion" "occupancy" "weatherprecipitation" "weatherprecipitationduration" "weatherhumidity" "weathercglo" "weatherwindspeed" "weatherwindgustspeed" "weatherwindgusttimestamp" "weatherwindheading" "weatherwindgustheading" "weatherhumidityrelative" "weathertemperatureair" "weatherpressure" "weatherpressurereduced" "weathersnowheight" "weathersunshineduration" "weatherdewpoint" "weathertemperaturesoil10" "weathertemperaturesoil100" "weathertemperaturewater" "personcountinside" "personcountin" "personcountout" "vehiclecountinside" "vehiclecountin" "vehiclecountout" "licenseplate" "county"

Responses

Request samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "device": "8dca31e6-c85b-4a6b-bfb4-205d45d9b3bd",
  • "active": true,
  • "originalDatapointId": "string",
  • "datapointSubType": "string",
  • "datapointType": "string",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "config": { },
  • "correctionFactor": 0,
  • "category": "weather",
  • "measurementType": "unknown"
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "device": "8dca31e6-c85b-4a6b-bfb4-205d45d9b3bd",
  • "active": true,
  • "originalDatapointId": "string",
  • "datapointSubType": "string",
  • "datapointType": "string",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "config": { },
  • "correctionFactor": 0,
  • "category": "weather",
  • "measurementType": "unknown",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

Get all active SWARM datapoints of a SWARM device.

Get all active SWARM datapoints that are assigned to a specific SWARM device.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Responses

Response samples

Content type
application/json
{ }

Create a new SWARM datapoint for an SWARM device of a customer.

Create a new SWARM datapoint for an SWARM device of a specific customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Request Body schema: application/json
required
uuid
required
string <uuid>

unique identifier for this datapoint.

name
required
string

the name of the datapoint.

nameAlias1
string

the name alias 1 for this datapoint instance.

nameAlias2
string

the name alias 2for this datapoint instance.

device
required
string <uuid>

the device's uuid the object is related to.

active
required
boolean

if the datapoint is active or not

originalDatapointId
required
string

the id for this datapoint in the context of the remote datapoint - e.g. the ID in the supplier's system

datapointType
required
string

the type of datapoint, usually matches the connector type key where this datapoint receives data from

customer
required
string <uuid>

the customer this datapoint belongs to

config
object or null
correctionFactor
number

Responses

Request samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "device": "8dca31e6-c85b-4a6b-bfb4-205d45d9b3bd",
  • "active": true,
  • "originalDatapointId": "string",
  • "datapointType": "string",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "config": { },
  • "correctionFactor": 0
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "device": "8dca31e6-c85b-4a6b-bfb4-205d45d9b3bd",
  • "active": true,
  • "originalDatapointId": "string",
  • "datapointSubType": "string",
  • "datapointType": "string",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "config": { },
  • "correctionFactor": 0,
  • "category": "weather",
  • "measurementType": "unknown",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

Get all SWARM datapoints for a SWARM device of a customer.

Get all SWARM datapoints that are assigned to a specific SWARM device of a customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Responses

Response samples

Content type
application/json
{ }

Get a SWARM datapoint for a SWARM device of a customer.

Get a SWARM datapoint that is assigned to a specific SWARM device and customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

datapointId
required
string

id of the datapoint to get the data for

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "device": "8dca31e6-c85b-4a6b-bfb4-205d45d9b3bd",
  • "active": true,
  • "originalDatapointId": "string",
  • "datapointSubType": "string",
  • "datapointType": "string",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "config": { },
  • "correctionFactor": 0,
  • "category": "weather",
  • "measurementType": "unknown",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

datapointId
required
string

id of the datapoint to get the data for

Responses

Response samples

Content type
application/json
{ }

Update a SWARM datapoint for a SWARM device of a customer.

Update a SWARM datapoint of a specific SWARM device and customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

datapointId
required
string

id of the datapoint to get the data for

Request Body schema: application/json
required
uuid
required
string <uuid>

unique identifier for this datapoint.

name
required
string

the name of the datapoint.

nameAlias1
string

the name alias 1 for this datapoint instance.

nameAlias2
string

the name alias 2for this datapoint instance.

device
required
string <uuid>

the device's uuid the object is related to.

active
required
boolean

if the datapoint is active or not

originalDatapointId
required
string

the id for this datapoint in the context of the remote datapoint - e.g. the ID in the supplier's system

datapointType
required
string

the type of datapoint, usually matches the connector type key where this datapoint receives data from

customer
required
string <uuid>

the customer this datapoint belongs to

config
object or null
correctionFactor
number

Responses

Request samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "device": "8dca31e6-c85b-4a6b-bfb4-205d45d9b3bd",
  • "active": true,
  • "originalDatapointId": "string",
  • "datapointType": "string",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "config": { },
  • "correctionFactor": 0
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "device": "8dca31e6-c85b-4a6b-bfb4-205d45d9b3bd",
  • "active": true,
  • "originalDatapointId": "string",
  • "datapointSubType": "string",
  • "datapointType": "string",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "config": { },
  • "correctionFactor": 0,
  • "category": "weather",
  • "measurementType": "unknown",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

Get all active WEATHER datapoints of a WEATHER device.

Get all active WEATHER datapoints that are assigned to a specific WEATHER device.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Responses

Response samples

Content type
application/json
{ }

Create a new WEATHER datapoint for an WEATHER device of a customer.

Create a new WEATHER datapoint for an WEATHER device of a specific customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Request Body schema: application/json
required
uuid
required
string <uuid>

unique identifier for this datapoint.

name
required
string

the name of the datapoint.

nameAlias1
string

the name alias 1 for this datapoint instance.

nameAlias2
string

the name alias 2for this datapoint instance.

device
required
string <uuid>

the device's uuid the object is related to.

active
required
boolean

if the datapoint is active or not

originalDatapointId
required
string

the id for this datapoint in the context of the remote datapoint - e.g. the ID in the supplier's system

datapointType
required
string

the type of datapoint, usually matches the connector type key where this datapoint receives data from

customer
required
string <uuid>

the customer this datapoint belongs to

config
object or null
correctionFactor
number

Responses

Request samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "device": "8dca31e6-c85b-4a6b-bfb4-205d45d9b3bd",
  • "active": true,
  • "originalDatapointId": "string",
  • "datapointType": "string",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "config": { },
  • "correctionFactor": 0
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "device": "8dca31e6-c85b-4a6b-bfb4-205d45d9b3bd",
  • "active": true,
  • "originalDatapointId": "string",
  • "datapointSubType": "string",
  • "datapointType": "string",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "config": { },
  • "correctionFactor": 0,
  • "category": "weather",
  • "measurementType": "unknown",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

Get all WEATHER datapoints for a WEATHER device of a customer.

Get all WEATHER datapoints that are assigned to a specific WEATHER device of a customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Responses

Response samples

Content type
application/json
{ }

Get a WEATHER datapoint for a WEATHER device of a customer.

Get a WEATHER datapoint that is assigned to a specific WEATHER device and customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

datapointId
required
string

id of the datapoint to get the data for

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "device": "8dca31e6-c85b-4a6b-bfb4-205d45d9b3bd",
  • "active": true,
  • "originalDatapointId": "string",
  • "datapointSubType": "string",
  • "datapointType": "string",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "config": { },
  • "correctionFactor": 0,
  • "category": "weather",
  • "measurementType": "unknown",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

datapointId
required
string

id of the datapoint to get the data for

Responses

Response samples

Content type
application/json
{ }

Update a WEATHER datapoint for a WEATHER device of a customer.

Update a WEATHER datapoint of a specific WEATHER device and customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

datapointId
required
string

id of the datapoint to get the data for

Request Body schema: application/json
required
uuid
required
string <uuid>

unique identifier for this datapoint.

name
required
string

the name of the datapoint.

nameAlias1
string

the name alias 1 for this datapoint instance.

nameAlias2
string

the name alias 2for this datapoint instance.

device
required
string <uuid>

the device's uuid the object is related to.

active
required
boolean

if the datapoint is active or not

originalDatapointId
required
string

the id for this datapoint in the context of the remote datapoint - e.g. the ID in the supplier's system

datapointType
required
string

the type of datapoint, usually matches the connector type key where this datapoint receives data from

customer
required
string <uuid>

the customer this datapoint belongs to

config
object or null
correctionFactor
number

Responses

Request samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "device": "8dca31e6-c85b-4a6b-bfb4-205d45d9b3bd",
  • "active": true,
  • "originalDatapointId": "string",
  • "datapointType": "string",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "config": { },
  • "correctionFactor": 0
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "device": "8dca31e6-c85b-4a6b-bfb4-205d45d9b3bd",
  • "active": true,
  • "originalDatapointId": "string",
  • "datapointSubType": "string",
  • "datapointType": "string",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "config": { },
  • "correctionFactor": 0,
  • "category": "weather",
  • "measurementType": "unknown",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

Get all active WEATHERSITE datapoints of a WEATHERSITE device.

Get all active WEATHERSITE datapoints that are assigned to a specific WEATHERSITE device.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Responses

Response samples

Content type
application/json
{ }

Create a new WEATHERSITE datapoint for an WEATHERSITE device of a customer.

Create a new WEATHERSITE datapoint for an WEATHERSITE device of a specific customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Request Body schema: application/json
required
uuid
required
string <uuid>

unique identifier for this datapoint.

name
required
string

the name of the datapoint.

nameAlias1
string

the name alias 1 for this datapoint instance.

nameAlias2
string

the name alias 2for this datapoint instance.

device
required
string <uuid>

the device's uuid the object is related to.

active
required
boolean

if the datapoint is active or not

originalDatapointId
required
string

the id for this datapoint in the context of the remote datapoint - e.g. the ID in the supplier's system

datapointType
required
string

the type of datapoint, usually matches the connector type key where this datapoint receives data from

customer
required
string <uuid>

the customer this datapoint belongs to

config
object or null
correctionFactor
number

Responses

Request samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "device": "8dca31e6-c85b-4a6b-bfb4-205d45d9b3bd",
  • "active": true,
  • "originalDatapointId": "string",
  • "datapointType": "string",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "config": { },
  • "correctionFactor": 0
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "device": "8dca31e6-c85b-4a6b-bfb4-205d45d9b3bd",
  • "active": true,
  • "originalDatapointId": "string",
  • "datapointSubType": "string",
  • "datapointType": "string",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "config": { },
  • "correctionFactor": 0,
  • "category": "weather",
  • "measurementType": "unknown",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

Get all WEATHERSITE datapoints for a WEATHERSITE device of a customer.

Get all WEATHERSITE datapoints that are assigned to a specific WEATHERSITE device of a customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Responses

Response samples

Content type
application/json
{ }

Get a WEATHERSITE datapoint for a WEATHERSITE device of a customer.

Get a WEATHERSITE datapoint that is assigned to a specific WEATHERSITE device and customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

datapointId
required
string

id of the datapoint to get the data for

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "device": "8dca31e6-c85b-4a6b-bfb4-205d45d9b3bd",
  • "active": true,
  • "originalDatapointId": "string",
  • "datapointSubType": "string",
  • "datapointType": "string",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "config": { },
  • "correctionFactor": 0,
  • "category": "weather",
  • "measurementType": "unknown",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

datapointId
required
string

id of the datapoint to get the data for

Responses

Response samples

Content type
application/json
{ }

Update a WEATHERSITE datapoint for a WEATHERSITE device of a customer.

Update a WEATHERSITE datapoint of a specific WEATHERSITE device and customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

datapointId
required
string

id of the datapoint to get the data for

Request Body schema: application/json
required
uuid
required
string <uuid>

unique identifier for this datapoint.

name
required
string

the name of the datapoint.

nameAlias1
string

the name alias 1 for this datapoint instance.

nameAlias2
string

the name alias 2for this datapoint instance.

device
required
string <uuid>

the device's uuid the object is related to.

active
required
boolean

if the datapoint is active or not

originalDatapointId
required
string

the id for this datapoint in the context of the remote datapoint - e.g. the ID in the supplier's system

datapointType
required
string

the type of datapoint, usually matches the connector type key where this datapoint receives data from

customer
required
string <uuid>

the customer this datapoint belongs to

config
object or null
correctionFactor
number

Responses

Request samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "device": "8dca31e6-c85b-4a6b-bfb4-205d45d9b3bd",
  • "active": true,
  • "originalDatapointId": "string",
  • "datapointType": "string",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "config": { },
  • "correctionFactor": 0
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "device": "8dca31e6-c85b-4a6b-bfb4-205d45d9b3bd",
  • "active": true,
  • "originalDatapointId": "string",
  • "datapointSubType": "string",
  • "datapointType": "string",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "config": { },
  • "correctionFactor": 0,
  • "category": "weather",
  • "measurementType": "unknown",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

Get all active SOLAREDGE datapoints of a SOLAREDGE device.

Get all active SOLAREDGE datapoints that are assigned to a specific SOLAREDGE device.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Responses

Response samples

Content type
application/json
{ }

Create a new SOLAREDGE datapoint for an SOLAREDGE device of a customer.

Create a new SOLAREDGE datapoint for an SOLAREDGE device of a specific customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Request Body schema: application/json
required
uuid
required
string <uuid>

unique identifier for this datapoint.

name
required
string

the name of the datapoint.

nameAlias1
string

the name alias 1 for this datapoint instance.

nameAlias2
string

the name alias 2for this datapoint instance.

device
required
string <uuid>

the device's uuid the object is related to.

active
required
boolean

if the datapoint is active or not

originalDatapointId
required
string
Enum: "powerConsumption" "powerProduction" "powerSelfConsumption" "powerExport" "powerImport" "energyConsumption" "energyProduction" "energySelfConsumption" "energyExport" "energyImport"

the id for this datapoint in the context of the remote datapoint - e.g. the ID in the supplier's system

datapointSubType
required
string
Enum: "powerConsumption" "powerProduction" "powerSelfConsumption" "powerExport" "powerImport" "energyConsumption" "energyProduction" "energySelfConsumption" "energyExport" "energyImport"

the subtype of datapoint, how the supplier of the connector would call it

datapointType
required
string

the type of datapoint, usually matches the connector type key where this datapoint receives data from

customer
required
string <uuid>

the customer this datapoint belongs to

config
object or null
correctionFactor
number
category
required
string
Enum: "weather" "energy" "environment" "status" "recognition" "unknown"
measurementType
required
string
Enum: "unknown" "temperature" "humidity" "pressure" "co2" "voltage" "voltagep1" "voltagep2" "voltagep3" "current" "currentp1" "currentp2" "currentp3" "totalcurrent" "totalactivepower" "totalreactivepower" "totalapparentpower" "totalpowerfactor" "totalactiveenergy" "totalreactiveenergy" "totalapparentenergy" "activepowerp1" "activepowerp2" "activepowerp3" "reactivepowerp1" "reactivepowerp2" "reactivepowerp3" "apparentpowerp1" "apparentpowerp2" "apparentpowerp3" "cosphip1" "cosphip2" "cosphip3" "powerfactorp1" "powerfactorp2" "powerfactorp3" "frequenzyp1" "frequenzyp2" "frequenzyp3" "energyproduction" "energyconsumption" "energyexport" "energyselfconsumption" "energyimport" "powerproduction" "powerexport" "powerconsumption" "powerimport" "powerselfconsumption" "contact" "touch" "touchcount" "presence" "presencecount" "waterdetector" "motion" "occupancy" "weatherprecipitation" "weatherprecipitationduration" "weatherhumidity" "weathercglo" "weatherwindspeed" "weatherwindgustspeed" "weatherwindgusttimestamp" "weatherwindheading" "weatherwindgustheading" "weatherhumidityrelative" "weathertemperatureair" "weatherpressure" "weatherpressurereduced" "weathersnowheight" "weathersunshineduration" "weatherdewpoint" "weathertemperaturesoil10" "weathertemperaturesoil100" "weathertemperaturewater" "personcountinside" "personcountin" "personcountout" "vehiclecountinside" "vehiclecountin" "vehiclecountout" "licenseplate" "county"

Responses

Request samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "device": "8dca31e6-c85b-4a6b-bfb4-205d45d9b3bd",
  • "active": true,
  • "originalDatapointId": "powerConsumption",
  • "datapointSubType": "powerConsumption",
  • "datapointType": "string",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "config": { },
  • "correctionFactor": 0,
  • "category": "weather",
  • "measurementType": "unknown"
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "device": "8dca31e6-c85b-4a6b-bfb4-205d45d9b3bd",
  • "active": true,
  • "originalDatapointId": "powerConsumption",
  • "datapointSubType": "powerConsumption",
  • "datapointType": "string",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "config": { },
  • "correctionFactor": 0,
  • "category": "weather",
  • "measurementType": "unknown",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

Get all SOLAREDGE datapoints for a SOLAREDGE device of a customer.

Get all SOLAREDGE datapoints that are assigned to a specific SOLAREDGE device of a customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Responses

Response samples

Content type
application/json
{ }

Get a SOLAREDGE datapoint for a SOLAREDGE device of a customer.

Get a SOLAREDGE datapoint that is assigned to a specific SOLAREDGE device and customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

datapointId
required
string

id of the datapoint to get the data for

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "device": "8dca31e6-c85b-4a6b-bfb4-205d45d9b3bd",
  • "active": true,
  • "originalDatapointId": "powerConsumption",
  • "datapointSubType": "powerConsumption",
  • "datapointType": "string",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "config": { },
  • "correctionFactor": 0,
  • "category": "weather",
  • "measurementType": "unknown",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

datapointId
required
string

id of the datapoint to get the data for

Responses

Response samples

Content type
application/json
{ }

Update a SOLAREDGE datapoint for a SOLAREDGE device of a customer.

Update a SOLAREDGE datapoint of a specific SOLAREDGE device and customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

datapointId
required
string

id of the datapoint to get the data for

Request Body schema: application/json
required
uuid
required
string <uuid>

unique identifier for this datapoint.

name
required
string

the name of the datapoint.

nameAlias1
string

the name alias 1 for this datapoint instance.

nameAlias2
string

the name alias 2for this datapoint instance.

device
required
string <uuid>

the device's uuid the object is related to.

active
required
boolean

if the datapoint is active or not

originalDatapointId
required
string
Enum: "powerConsumption" "powerProduction" "powerSelfConsumption" "powerExport" "powerImport" "energyConsumption" "energyProduction" "energySelfConsumption" "energyExport" "energyImport"

the id for this datapoint in the context of the remote datapoint - e.g. the ID in the supplier's system

datapointSubType
required
string
Enum: "powerConsumption" "powerProduction" "powerSelfConsumption" "powerExport" "powerImport" "energyConsumption" "energyProduction" "energySelfConsumption" "energyExport" "energyImport"

the subtype of datapoint, how the supplier of the connector would call it

datapointType
required
string

the type of datapoint, usually matches the connector type key where this datapoint receives data from

customer
required
string <uuid>

the customer this datapoint belongs to

config
object or null
correctionFactor
number
category
required
string
Enum: "weather" "energy" "environment" "status" "recognition" "unknown"
measurementType
required
string
Enum: "unknown" "temperature" "humidity" "pressure" "co2" "voltage" "voltagep1" "voltagep2" "voltagep3" "current" "currentp1" "currentp2" "currentp3" "totalcurrent" "totalactivepower" "totalreactivepower" "totalapparentpower" "totalpowerfactor" "totalactiveenergy" "totalreactiveenergy" "totalapparentenergy" "activepowerp1" "activepowerp2" "activepowerp3" "reactivepowerp1" "reactivepowerp2" "reactivepowerp3" "apparentpowerp1" "apparentpowerp2" "apparentpowerp3" "cosphip1" "cosphip2" "cosphip3" "powerfactorp1" "powerfactorp2" "powerfactorp3" "frequenzyp1" "frequenzyp2" "frequenzyp3" "energyproduction" "energyconsumption" "energyexport" "energyselfconsumption" "energyimport" "powerproduction" "powerexport" "powerconsumption" "powerimport" "powerselfconsumption" "contact" "touch" "touchcount" "presence" "presencecount" "waterdetector" "motion" "occupancy" "weatherprecipitation" "weatherprecipitationduration" "weatherhumidity" "weathercglo" "weatherwindspeed" "weatherwindgustspeed" "weatherwindgusttimestamp" "weatherwindheading" "weatherwindgustheading" "weatherhumidityrelative" "weathertemperatureair" "weatherpressure" "weatherpressurereduced" "weathersnowheight" "weathersunshineduration" "weatherdewpoint" "weathertemperaturesoil10" "weathertemperaturesoil100" "weathertemperaturewater" "personcountinside" "personcountin" "personcountout" "vehiclecountinside" "vehiclecountin" "vehiclecountout" "licenseplate" "county"

Responses

Request samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "device": "8dca31e6-c85b-4a6b-bfb4-205d45d9b3bd",
  • "active": true,
  • "originalDatapointId": "powerConsumption",
  • "datapointSubType": "powerConsumption",
  • "datapointType": "string",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "config": { },
  • "correctionFactor": 0,
  • "category": "weather",
  • "measurementType": "unknown"
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "device": "8dca31e6-c85b-4a6b-bfb4-205d45d9b3bd",
  • "active": true,
  • "originalDatapointId": "powerConsumption",
  • "datapointSubType": "powerConsumption",
  • "datapointType": "string",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "config": { },
  • "correctionFactor": 0,
  • "category": "weather",
  • "measurementType": "unknown",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

Get all active DT datapoints of a DT device.

Get all active DT datapoints that are assigned to a specific DT device.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Responses

Response samples

Content type
application/json
{ }

Create a new DT datapoint for a DT device of a customer.

Create a new DT datapoint for a DT device of a specific customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Request Body schema: application/json
required
uuid
required
string <uuid>

unique identifier for this datapoint.

name
required
string

the name of the datapoint.

nameAlias1
string

the name alias 1 for this datapoint instance.

nameAlias2
string

the name alias 2for this datapoint instance.

device
required
string <uuid>

the device's uuid the object is related to.

active
required
boolean

if the datapoint is active or not

originalDatapointId
required
string

the id for this datapoint in the context of the remote datapoint - e.g. the ID in the supplier's system

datapointSubType
required
string

the subtype of datapoint, how the supplier of the connector would call it

datapointType
required
string

the type of datapoint, usually matches the connector type key where this datapoint receives data from

customer
required
string <uuid>

the customer this datapoint belongs to

config
object or null
correctionFactor
number
category
required
string
Enum: "weather" "energy" "environment" "status" "recognition" "unknown"
measurementType
required
string
Enum: "unknown" "temperature" "humidity" "pressure" "co2" "voltage" "voltagep1" "voltagep2" "voltagep3" "current" "currentp1" "currentp2" "currentp3" "totalcurrent" "totalactivepower" "totalreactivepower" "totalapparentpower" "totalpowerfactor" "totalactiveenergy" "totalreactiveenergy" "totalapparentenergy" "activepowerp1" "activepowerp2" "activepowerp3" "reactivepowerp1" "reactivepowerp2" "reactivepowerp3" "apparentpowerp1" "apparentpowerp2" "apparentpowerp3" "cosphip1" "cosphip2" "cosphip3" "powerfactorp1" "powerfactorp2" "powerfactorp3" "frequenzyp1" "frequenzyp2" "frequenzyp3" "energyproduction" "energyconsumption" "energyexport" "energyselfconsumption" "energyimport" "powerproduction" "powerexport" "powerconsumption" "powerimport" "powerselfconsumption" "contact" "touch" "touchcount" "presence" "presencecount" "waterdetector" "motion" "occupancy" "weatherprecipitation" "weatherprecipitationduration" "weatherhumidity" "weathercglo" "weatherwindspeed" "weatherwindgustspeed" "weatherwindgusttimestamp" "weatherwindheading" "weatherwindgustheading" "weatherhumidityrelative" "weathertemperatureair" "weatherpressure" "weatherpressurereduced" "weathersnowheight" "weathersunshineduration" "weatherdewpoint" "weathertemperaturesoil10" "weathertemperaturesoil100" "weathertemperaturewater" "personcountinside" "personcountin" "personcountout" "vehiclecountinside" "vehiclecountin" "vehiclecountout" "licenseplate" "county"

Responses

Request samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "device": "8dca31e6-c85b-4a6b-bfb4-205d45d9b3bd",
  • "active": true,
  • "originalDatapointId": "string",
  • "datapointSubType": "string",
  • "datapointType": "string",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "config": { },
  • "correctionFactor": 0,
  • "category": "weather",
  • "measurementType": "unknown"
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "device": "8dca31e6-c85b-4a6b-bfb4-205d45d9b3bd",
  • "active": true,
  • "originalDatapointId": "string",
  • "datapointSubType": "string",
  • "datapointType": "string",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "config": { },
  • "correctionFactor": 0,
  • "category": "weather",
  • "measurementType": "unknown",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

Get all DT datapoints for a DT device of a customer.

Get all DT datapoints that are assigned to a specific DT device of a customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Responses

Response samples

Content type
application/json
{ }

Get a DT datapoint for a DT device of a customer.

Get a DT datapoint that is assigned to a specific DT device and customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

datapointId
required
string

id of the datapoint to get the data for

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "device": "8dca31e6-c85b-4a6b-bfb4-205d45d9b3bd",
  • "active": true,
  • "originalDatapointId": "string",
  • "datapointSubType": "string",
  • "datapointType": "string",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "config": { },
  • "correctionFactor": 0,
  • "category": "weather",
  • "measurementType": "unknown",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

datapointId
required
string

id of the datapoint to get the data for

Responses

Response samples

Content type
application/json
{ }

Update a DT datapoint for a DT device of a customer.

Update a DT datapointice of a specific DT device and customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

datapointId
required
string

id of the datapoint to get the data for

Request Body schema: application/json
required
uuid
required
string <uuid>

unique identifier for this datapoint.

name
required
string

the name of the datapoint.

nameAlias1
string

the name alias 1 for this datapoint instance.

nameAlias2
string

the name alias 2for this datapoint instance.

device
required
string <uuid>

the device's uuid the object is related to.

active
required
boolean

if the datapoint is active or not

originalDatapointId
required
string

the id for this datapoint in the context of the remote datapoint - e.g. the ID in the supplier's system

datapointSubType
required
string

the subtype of datapoint, how the supplier of the connector would call it

datapointType
required
string

the type of datapoint, usually matches the connector type key where this datapoint receives data from

customer
required
string <uuid>

the customer this datapoint belongs to

config
object or null
correctionFactor
number
category
required
string
Enum: "weather" "energy" "environment" "status" "recognition" "unknown"
measurementType
required
string
Enum: "unknown" "temperature" "humidity" "pressure" "co2" "voltage" "voltagep1" "voltagep2" "voltagep3" "current" "currentp1" "currentp2" "currentp3" "totalcurrent" "totalactivepower" "totalreactivepower" "totalapparentpower" "totalpowerfactor" "totalactiveenergy" "totalreactiveenergy" "totalapparentenergy" "activepowerp1" "activepowerp2" "activepowerp3" "reactivepowerp1" "reactivepowerp2" "reactivepowerp3" "apparentpowerp1" "apparentpowerp2" "apparentpowerp3" "cosphip1" "cosphip2" "cosphip3" "powerfactorp1" "powerfactorp2" "powerfactorp3" "frequenzyp1" "frequenzyp2" "frequenzyp3" "energyproduction" "energyconsumption" "energyexport" "energyselfconsumption" "energyimport" "powerproduction" "powerexport" "powerconsumption" "powerimport" "powerselfconsumption" "contact" "touch" "touchcount" "presence" "presencecount" "waterdetector" "motion" "occupancy" "weatherprecipitation" "weatherprecipitationduration" "weatherhumidity" "weathercglo" "weatherwindspeed" "weatherwindgustspeed" "weatherwindgusttimestamp" "weatherwindheading" "weatherwindgustheading" "weatherhumidityrelative" "weathertemperatureair" "weatherpressure" "weatherpressurereduced" "weathersnowheight" "weathersunshineduration" "weatherdewpoint" "weathertemperaturesoil10" "weathertemperaturesoil100" "weathertemperaturewater" "personcountinside" "personcountin" "personcountout" "vehiclecountinside" "vehiclecountin" "vehiclecountout" "licenseplate" "county"

Responses

Request samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "device": "8dca31e6-c85b-4a6b-bfb4-205d45d9b3bd",
  • "active": true,
  • "originalDatapointId": "string",
  • "datapointSubType": "string",
  • "datapointType": "string",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "config": { },
  • "correctionFactor": 0,
  • "category": "weather",
  • "measurementType": "unknown"
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "device": "8dca31e6-c85b-4a6b-bfb4-205d45d9b3bd",
  • "active": true,
  • "originalDatapointId": "string",
  • "datapointSubType": "string",
  • "datapointType": "string",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "config": { },
  • "correctionFactor": 0,
  • "category": "weather",
  • "measurementType": "unknown",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

Get all active GENERIC datapoints of an GENERIC device.

Get all active GENERIC datapoints that are assigned to a specific GENERIC device.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Responses

Response samples

Content type
application/json
{ }

Create a new GENERIC datapoint for an GENERIC device of a customer.

Create a new GENERIC datapoint for an GENERIC device of a specific customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Request Body schema: application/json
required
uuid
required
string <uuid>

unique identifier for this datapoint.

name
required
string

the name of the datapoint.

nameAlias1
string

the name alias 1 for this datapoint instance.

nameAlias2
string

the name alias 2for this datapoint instance.

device
required
string <uuid>

the device's uuid the object is related to.

active
required
boolean

if the datapoint is active or not

originalDatapointId
required
string

the id for this datapoint in the context of the remote datapoint - e.g. the ID in the supplier's system

datapointSubType
required
string

the subtype of datapoint, how the supplier of the connector would call it

datapointType
required
string

the type of datapoint, usually matches the connector type key where this datapoint receives data from

customer
required
string <uuid>

the customer this datapoint belongs to

config
object or null
correctionFactor
number
category
required
string
Enum: "weather" "energy" "environment" "status" "recognition" "unknown"
measurementType
required
string
Enum: "unknown" "temperature" "humidity" "pressure" "co2" "voltage" "voltagep1" "voltagep2" "voltagep3" "current" "currentp1" "currentp2" "currentp3" "totalcurrent" "totalactivepower" "totalreactivepower" "totalapparentpower" "totalpowerfactor" "totalactiveenergy" "totalreactiveenergy" "totalapparentenergy" "activepowerp1" "activepowerp2" "activepowerp3" "reactivepowerp1" "reactivepowerp2" "reactivepowerp3" "apparentpowerp1" "apparentpowerp2" "apparentpowerp3" "cosphip1" "cosphip2" "cosphip3" "powerfactorp1" "powerfactorp2" "powerfactorp3" "frequenzyp1" "frequenzyp2" "frequenzyp3" "energyproduction" "energyconsumption" "energyexport" "energyselfconsumption" "energyimport" "powerproduction" "powerexport" "powerconsumption" "powerimport" "powerselfconsumption" "contact" "touch" "touchcount" "presence" "presencecount" "waterdetector" "motion" "occupancy" "weatherprecipitation" "weatherprecipitationduration" "weatherhumidity" "weathercglo" "weatherwindspeed" "weatherwindgustspeed" "weatherwindgusttimestamp" "weatherwindheading" "weatherwindgustheading" "weatherhumidityrelative" "weathertemperatureair" "weatherpressure" "weatherpressurereduced" "weathersnowheight" "weathersunshineduration" "weatherdewpoint" "weathertemperaturesoil10" "weathertemperaturesoil100" "weathertemperaturewater" "personcountinside" "personcountin" "personcountout" "vehiclecountinside" "vehiclecountin" "vehiclecountout" "licenseplate" "county"

Responses

Request samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "device": "8dca31e6-c85b-4a6b-bfb4-205d45d9b3bd",
  • "active": true,
  • "originalDatapointId": "string",
  • "datapointSubType": "string",
  • "datapointType": "string",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "config": { },
  • "correctionFactor": 0,
  • "category": "weather",
  • "measurementType": "unknown"
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "device": "8dca31e6-c85b-4a6b-bfb4-205d45d9b3bd",
  • "active": true,
  • "originalDatapointId": "string",
  • "datapointSubType": "string",
  • "datapointType": "string",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "config": { },
  • "correctionFactor": 0,
  • "category": "weather",
  • "measurementType": "unknown",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

Get all GENERIC datapoints for an GENERIC device of a customer.

Get all GENERIC datapoints that are assigned to a specific GENERIC device of a customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Responses

Response samples

Content type
application/json
{ }

Get an GENERIC datapoint for an GENERIC device of a customer.

Get an GENERIC datapoint that is assigned to a specific GENERIC device and customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

datapointId
required
string

id of the datapoint to get the data for

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "device": "8dca31e6-c85b-4a6b-bfb4-205d45d9b3bd",
  • "active": true,
  • "originalDatapointId": "string",
  • "datapointSubType": "string",
  • "datapointType": "string",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "config": { },
  • "correctionFactor": 0,
  • "category": "weather",
  • "measurementType": "unknown",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

datapointId
required
string

id of the datapoint to get the data for

Responses

Response samples

Content type
application/json
{ }

Update an GENERIC datapoint for an GENERIC device of a customer.

Update an GENERIC datapoint of a specific GENERIC device and customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

datapointId
required
string

id of the datapoint to get the data for

Request Body schema: application/json
required
uuid
required
string <uuid>

unique identifier for this datapoint.

name
required
string

the name of the datapoint.

nameAlias1
string

the name alias 1 for this datapoint instance.

nameAlias2
string

the name alias 2for this datapoint instance.

device
required
string <uuid>

the device's uuid the object is related to.

active
required
boolean

if the datapoint is active or not

originalDatapointId
required
string

the id for this datapoint in the context of the remote datapoint - e.g. the ID in the supplier's system

datapointSubType
required
string

the subtype of datapoint, how the supplier of the connector would call it

datapointType
required
string

the type of datapoint, usually matches the connector type key where this datapoint receives data from

customer
required
string <uuid>

the customer this datapoint belongs to

config
object or null
correctionFactor
number
category
required
string
Enum: "weather" "energy" "environment" "status" "recognition" "unknown"
measurementType
required
string
Enum: "unknown" "temperature" "humidity" "pressure" "co2" "voltage" "voltagep1" "voltagep2" "voltagep3" "current" "currentp1" "currentp2" "currentp3" "totalcurrent" "totalactivepower" "totalreactivepower" "totalapparentpower" "totalpowerfactor" "totalactiveenergy" "totalreactiveenergy" "totalapparentenergy" "activepowerp1" "activepowerp2" "activepowerp3" "reactivepowerp1" "reactivepowerp2" "reactivepowerp3" "apparentpowerp1" "apparentpowerp2" "apparentpowerp3" "cosphip1" "cosphip2" "cosphip3" "powerfactorp1" "powerfactorp2" "powerfactorp3" "frequenzyp1" "frequenzyp2" "frequenzyp3" "energyproduction" "energyconsumption" "energyexport" "energyselfconsumption" "energyimport" "powerproduction" "powerexport" "powerconsumption" "powerimport" "powerselfconsumption" "contact" "touch" "touchcount" "presence" "presencecount" "waterdetector" "motion" "occupancy" "weatherprecipitation" "weatherprecipitationduration" "weatherhumidity" "weathercglo" "weatherwindspeed" "weatherwindgustspeed" "weatherwindgusttimestamp" "weatherwindheading" "weatherwindgustheading" "weatherhumidityrelative" "weathertemperatureair" "weatherpressure" "weatherpressurereduced" "weathersnowheight" "weathersunshineduration" "weatherdewpoint" "weathertemperaturesoil10" "weathertemperaturesoil100" "weathertemperaturewater" "personcountinside" "personcountin" "personcountout" "vehiclecountinside" "vehiclecountin" "vehiclecountout" "licenseplate" "county"

Responses

Request samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "device": "8dca31e6-c85b-4a6b-bfb4-205d45d9b3bd",
  • "active": true,
  • "originalDatapointId": "string",
  • "datapointSubType": "string",
  • "datapointType": "string",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "config": { },
  • "correctionFactor": 0,
  • "category": "weather",
  • "measurementType": "unknown"
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "device": "8dca31e6-c85b-4a6b-bfb4-205d45d9b3bd",
  • "active": true,
  • "originalDatapointId": "string",
  • "datapointSubType": "string",
  • "datapointType": "string",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "config": { },
  • "correctionFactor": 0,
  • "category": "weather",
  • "measurementType": "unknown",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

Get a generic connector datapoint by its id

Get a generic connector datapoint by its id for updating the current measurement value

Authorizations:
custom-auth

Responses

Response samples

Content type
application/json
{
  • "datapoint": {
    },
  • "device": {
    },
  • "connector": {
    },
  • "customer": {
    }
}

for CORS

Authorizations:
custom-auth

Responses

Response samples

Content type
application/json
{ }

Get all active OPCUA datapoints of an OPCUA device.

Get all active OPCUA datapoints that are assigned to a specific OPCUA device.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Responses

Response samples

Content type
application/json
{ }

Create a new OPCUA datapoint for an OPCUA device of a customer.

Create a new OPCUA datapoint for an OPCUA device of a specific customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Request Body schema: application/json
required
uuid
required
string <uuid>

unique identifier for this datapoint.

name
required
string

the name of the datapoint.

nameAlias1
string

the name alias 1 for this datapoint instance.

nameAlias2
string

the name alias 2for this datapoint instance.

device
required
string <uuid>

the device's uuid the object is related to.

active
required
boolean

if the datapoint is active or not

originalDatapointId
required
string

the id for this datapoint in the context of the remote datapoint - e.g. the ID in the supplier's system

datapointSubType
required
string

the subtype of datapoint, how the supplier of the connector would call it

datapointType
required
string

the type of datapoint, usually matches the connector type key where this datapoint receives data from

customer
required
string <uuid>

the customer this datapoint belongs to

config
object or null
correctionFactor
number
category
required
string
Enum: "weather" "energy" "environment" "status" "recognition" "unknown"
measurementType
required
string
Enum: "unknown" "temperature" "humidity" "pressure" "co2" "voltage" "voltagep1" "voltagep2" "voltagep3" "current" "currentp1" "currentp2" "currentp3" "totalcurrent" "totalactivepower" "totalreactivepower" "totalapparentpower" "totalpowerfactor" "totalactiveenergy" "totalreactiveenergy" "totalapparentenergy" "activepowerp1" "activepowerp2" "activepowerp3" "reactivepowerp1" "reactivepowerp2" "reactivepowerp3" "apparentpowerp1" "apparentpowerp2" "apparentpowerp3" "cosphip1" "cosphip2" "cosphip3" "powerfactorp1" "powerfactorp2" "powerfactorp3" "frequenzyp1" "frequenzyp2" "frequenzyp3" "energyproduction" "energyconsumption" "energyexport" "energyselfconsumption" "energyimport" "powerproduction" "powerexport" "powerconsumption" "powerimport" "powerselfconsumption" "contact" "touch" "touchcount" "presence" "presencecount" "waterdetector" "motion" "occupancy" "weatherprecipitation" "weatherprecipitationduration" "weatherhumidity" "weathercglo" "weatherwindspeed" "weatherwindgustspeed" "weatherwindgusttimestamp" "weatherwindheading" "weatherwindgustheading" "weatherhumidityrelative" "weathertemperatureair" "weatherpressure" "weatherpressurereduced" "weathersnowheight" "weathersunshineduration" "weatherdewpoint" "weathertemperaturesoil10" "weathertemperaturesoil100" "weathertemperaturewater" "personcountinside" "personcountin" "personcountout" "vehiclecountinside" "vehiclecountin" "vehiclecountout" "licenseplate" "county"

Responses

Request samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "device": "8dca31e6-c85b-4a6b-bfb4-205d45d9b3bd",
  • "active": true,
  • "originalDatapointId": "string",
  • "datapointSubType": "string",
  • "datapointType": "string",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "config": { },
  • "correctionFactor": 0,
  • "category": "weather",
  • "measurementType": "unknown"
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "device": "8dca31e6-c85b-4a6b-bfb4-205d45d9b3bd",
  • "active": true,
  • "originalDatapointId": "string",
  • "datapointSubType": "string",
  • "datapointType": "string",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "config": { },
  • "correctionFactor": 0,
  • "category": "weather",
  • "measurementType": "unknown",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

Get all OPCUA datapoints for an OPCUA device of a customer.

Get all OPCUA datapoints that are assigned to a specific OPCUA device of a customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Responses

Response samples

Content type
application/json
{ }

Get an OPCUA datapoint for an OPCUA device of a customer.

Get an OPCUA datapoint that is assigned to a specific OPCUA device and customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

datapointId
required
string

id of the datapoint to get the data for

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "device": "8dca31e6-c85b-4a6b-bfb4-205d45d9b3bd",
  • "active": true,
  • "originalDatapointId": "string",
  • "datapointSubType": "string",
  • "datapointType": "string",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "config": { },
  • "correctionFactor": 0,
  • "category": "weather",
  • "measurementType": "unknown",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

datapointId
required
string

id of the datapoint to get the data for

Responses

Response samples

Content type
application/json
{ }

Update an OPCUA datapoint for an OPCUA device of a customer.

Update an OPCUA datapoint of a specific OPCUA device and customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

datapointId
required
string

id of the datapoint to get the data for

Request Body schema: application/json
required
uuid
required
string <uuid>

unique identifier for this datapoint.

name
required
string

the name of the datapoint.

nameAlias1
string

the name alias 1 for this datapoint instance.

nameAlias2
string

the name alias 2for this datapoint instance.

device
required
string <uuid>

the device's uuid the object is related to.

active
required
boolean

if the datapoint is active or not

originalDatapointId
required
string

the id for this datapoint in the context of the remote datapoint - e.g. the ID in the supplier's system

datapointSubType
required
string

the subtype of datapoint, how the supplier of the connector would call it

datapointType
required
string

the type of datapoint, usually matches the connector type key where this datapoint receives data from

customer
required
string <uuid>

the customer this datapoint belongs to

config
object or null
correctionFactor
number
category
required
string
Enum: "weather" "energy" "environment" "status" "recognition" "unknown"
measurementType
required
string
Enum: "unknown" "temperature" "humidity" "pressure" "co2" "voltage" "voltagep1" "voltagep2" "voltagep3" "current" "currentp1" "currentp2" "currentp3" "totalcurrent" "totalactivepower" "totalreactivepower" "totalapparentpower" "totalpowerfactor" "totalactiveenergy" "totalreactiveenergy" "totalapparentenergy" "activepowerp1" "activepowerp2" "activepowerp3" "reactivepowerp1" "reactivepowerp2" "reactivepowerp3" "apparentpowerp1" "apparentpowerp2" "apparentpowerp3" "cosphip1" "cosphip2" "cosphip3" "powerfactorp1" "powerfactorp2" "powerfactorp3" "frequenzyp1" "frequenzyp2" "frequenzyp3" "energyproduction" "energyconsumption" "energyexport" "energyselfconsumption" "energyimport" "powerproduction" "powerexport" "powerconsumption" "powerimport" "powerselfconsumption" "contact" "touch" "touchcount" "presence" "presencecount" "waterdetector" "motion" "occupancy" "weatherprecipitation" "weatherprecipitationduration" "weatherhumidity" "weathercglo" "weatherwindspeed" "weatherwindgustspeed" "weatherwindgusttimestamp" "weatherwindheading" "weatherwindgustheading" "weatherhumidityrelative" "weathertemperatureair" "weatherpressure" "weatherpressurereduced" "weathersnowheight" "weathersunshineduration" "weatherdewpoint" "weathertemperaturesoil10" "weathertemperaturesoil100" "weathertemperaturewater" "personcountinside" "personcountin" "personcountout" "vehiclecountinside" "vehiclecountin" "vehiclecountout" "licenseplate" "county"

Responses

Request samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "device": "8dca31e6-c85b-4a6b-bfb4-205d45d9b3bd",
  • "active": true,
  • "originalDatapointId": "string",
  • "datapointSubType": "string",
  • "datapointType": "string",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "config": { },
  • "correctionFactor": 0,
  • "category": "weather",
  • "measurementType": "unknown"
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "device": "8dca31e6-c85b-4a6b-bfb4-205d45d9b3bd",
  • "active": true,
  • "originalDatapointId": "string",
  • "datapointSubType": "string",
  • "datapointType": "string",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "config": { },
  • "correctionFactor": 0,
  • "category": "weather",
  • "measurementType": "unknown",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

Get all active CALC datapoints of an CALC device.

Get all active CALC datapoints that are assigned to a specific CALC device.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Responses

Response samples

Content type
application/json
{ }

Create a new CALC datapoint for an CALC device of a customer.

Create a new CALC datapoint for an CALC device of a specific customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Request Body schema: application/json
required
uuid
required
string <uuid>

unique identifier for this datapoint.

name
required
string

the name of the datapoint.

nameAlias1
string

the name alias 1 for this datapoint instance.

nameAlias2
string

the name alias 2for this datapoint instance.

device
required
string <uuid>

the device's uuid the object is related to.

active
required
boolean

if the datapoint is active or not

originalDatapointId
required
string

the id for this datapoint in the context of the remote datapoint - e.g. the ID in the supplier's system

datapointSubType
required
string

the subtype of datapoint, how the supplier of the connector would call it

datapointType
required
string

the type of datapoint, usually matches the connector type key where this datapoint receives data from

customer
required
string <uuid>

the customer this datapoint belongs to

object or null

Configuration of a calculated datapoint (the formula and its parameters)

correctionFactor
number
category
required
string
Enum: "weather" "energy" "environment" "status" "recognition" "unknown"
measurementType
required
string
Enum: "unknown" "temperature" "humidity" "pressure" "co2" "voltage" "voltagep1" "voltagep2" "voltagep3" "current" "currentp1" "currentp2" "currentp3" "totalcurrent" "totalactivepower" "totalreactivepower" "totalapparentpower" "totalpowerfactor" "totalactiveenergy" "totalreactiveenergy" "totalapparentenergy" "activepowerp1" "activepowerp2" "activepowerp3" "reactivepowerp1" "reactivepowerp2" "reactivepowerp3" "apparentpowerp1" "apparentpowerp2" "apparentpowerp3" "cosphip1" "cosphip2" "cosphip3" "powerfactorp1" "powerfactorp2" "powerfactorp3" "frequenzyp1" "frequenzyp2" "frequenzyp3" "energyproduction" "energyconsumption" "energyexport" "energyselfconsumption" "energyimport" "powerproduction" "powerexport" "powerconsumption" "powerimport" "powerselfconsumption" "contact" "touch" "touchcount" "presence" "presencecount" "waterdetector" "motion" "occupancy" "weatherprecipitation" "weatherprecipitationduration" "weatherhumidity" "weathercglo" "weatherwindspeed" "weatherwindgustspeed" "weatherwindgusttimestamp" "weatherwindheading" "weatherwindgustheading" "weatherhumidityrelative" "weathertemperatureair" "weatherpressure" "weatherpressurereduced" "weathersnowheight" "weathersunshineduration" "weatherdewpoint" "weathertemperaturesoil10" "weathertemperaturesoil100" "weathertemperaturewater" "personcountinside" "personcountin" "personcountout" "vehiclecountinside" "vehiclecountin" "vehiclecountout" "licenseplate" "county"

Responses

Request samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "device": "8dca31e6-c85b-4a6b-bfb4-205d45d9b3bd",
  • "active": true,
  • "originalDatapointId": "string",
  • "datapointSubType": "string",
  • "datapointType": "string",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "config": {
    },
  • "correctionFactor": 0,
  • "category": "weather",
  • "measurementType": "unknown"
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "device": "8dca31e6-c85b-4a6b-bfb4-205d45d9b3bd",
  • "active": true,
  • "originalDatapointId": "string",
  • "datapointSubType": "string",
  • "datapointType": "string",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "config": {
    },
  • "correctionFactor": 0,
  • "category": "weather",
  • "measurementType": "unknown",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

Get all CALC datapoints for an CALC device of a customer.

Get all CALC datapoints that are assigned to a specific CALC device of a customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Responses

Response samples

Content type
application/json
{ }

Get an CALC datapoint for an CALC device of a customer.

Get an CALC datapoint that is assigned to a specific CALC device and customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

datapointId
required
string

id of the datapoint to get the data for

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "device": "8dca31e6-c85b-4a6b-bfb4-205d45d9b3bd",
  • "active": true,
  • "originalDatapointId": "string",
  • "datapointSubType": "string",
  • "datapointType": "string",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "config": {
    },
  • "correctionFactor": 0,
  • "category": "weather",
  • "measurementType": "unknown",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

datapointId
required
string

id of the datapoint to get the data for

Responses

Response samples

Content type
application/json
{ }

Update an CALC datapoint for an CALC device of a customer.

Update an CALC datapoint of a specific CALC device and customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

datapointId
required
string

id of the datapoint to get the data for

Request Body schema: application/json
required
uuid
required
string <uuid>

unique identifier for this datapoint.

name
required
string

the name of the datapoint.

nameAlias1
string

the name alias 1 for this datapoint instance.

nameAlias2
string

the name alias 2for this datapoint instance.

device
required
string <uuid>

the device's uuid the object is related to.

active
required
boolean

if the datapoint is active or not

originalDatapointId
required
string

the id for this datapoint in the context of the remote datapoint - e.g. the ID in the supplier's system

datapointSubType
required
string

the subtype of datapoint, how the supplier of the connector would call it

datapointType
required
string

the type of datapoint, usually matches the connector type key where this datapoint receives data from

customer
required
string <uuid>

the customer this datapoint belongs to

object or null

Configuration of a calculated datapoint (the formula and its parameters)

correctionFactor
number
category
required
string
Enum: "weather" "energy" "environment" "status" "recognition" "unknown"
measurementType
required
string
Enum: "unknown" "temperature" "humidity" "pressure" "co2" "voltage" "voltagep1" "voltagep2" "voltagep3" "current" "currentp1" "currentp2" "currentp3" "totalcurrent" "totalactivepower" "totalreactivepower" "totalapparentpower" "totalpowerfactor" "totalactiveenergy" "totalreactiveenergy" "totalapparentenergy" "activepowerp1" "activepowerp2" "activepowerp3" "reactivepowerp1" "reactivepowerp2" "reactivepowerp3" "apparentpowerp1" "apparentpowerp2" "apparentpowerp3" "cosphip1" "cosphip2" "cosphip3" "powerfactorp1" "powerfactorp2" "powerfactorp3" "frequenzyp1" "frequenzyp2" "frequenzyp3" "energyproduction" "energyconsumption" "energyexport" "energyselfconsumption" "energyimport" "powerproduction" "powerexport" "powerconsumption" "powerimport" "powerselfconsumption" "contact" "touch" "touchcount" "presence" "presencecount" "waterdetector" "motion" "occupancy" "weatherprecipitation" "weatherprecipitationduration" "weatherhumidity" "weathercglo" "weatherwindspeed" "weatherwindgustspeed" "weatherwindgusttimestamp" "weatherwindheading" "weatherwindgustheading" "weatherhumidityrelative" "weathertemperatureair" "weatherpressure" "weatherpressurereduced" "weathersnowheight" "weathersunshineduration" "weatherdewpoint" "weathertemperaturesoil10" "weathertemperaturesoil100" "weathertemperaturewater" "personcountinside" "personcountin" "personcountout" "vehiclecountinside" "vehiclecountin" "vehiclecountout" "licenseplate" "county"

Responses

Request samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "device": "8dca31e6-c85b-4a6b-bfb4-205d45d9b3bd",
  • "active": true,
  • "originalDatapointId": "string",
  • "datapointSubType": "string",
  • "datapointType": "string",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "config": {
    },
  • "correctionFactor": 0,
  • "category": "weather",
  • "measurementType": "unknown"
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "device": "8dca31e6-c85b-4a6b-bfb4-205d45d9b3bd",
  • "active": true,
  • "originalDatapointId": "string",
  • "datapointSubType": "string",
  • "datapointType": "string",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "config": {
    },
  • "correctionFactor": 0,
  • "category": "weather",
  • "measurementType": "unknown",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

Get all active FLIC datapoints of a FLIC device.

Get all active FLIC datapoints that are assigned to a specific FLIC device.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Responses

Response samples

Content type
application/json
{ }

Create a new FLIC datapoint for an FLIC device of a customer.

Create a new FLIC datapoint for an FLIC device of a specific customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Request Body schema: application/json
required
uuid
required
string <uuid>

unique identifier for this datapoint.

name
required
string

the name of the datapoint.

nameAlias1
string

the name alias 1 for this datapoint instance.

nameAlias2
string

the name alias 2for this datapoint instance.

device
required
string <uuid>

the device's uuid the object is related to.

active
required
boolean

if the datapoint is active or not

originalDatapointId
required
string

the id for this datapoint in the context of the remote datapoint - e.g. the ID in the supplier's system

datapointSubType
required
string

the subtype of datapoint, how the supplier of the connector would call it

datapointType
required
string

the type of datapoint, usually matches the connector type key where this datapoint receives data from

customer
required
string <uuid>

the customer this datapoint belongs to

config
object or null
correctionFactor
number
category
required
string
Enum: "weather" "energy" "environment" "status" "recognition" "unknown"
measurementType
required
string
Enum: "unknown" "temperature" "humidity" "pressure" "co2" "voltage" "voltagep1" "voltagep2" "voltagep3" "current" "currentp1" "currentp2" "currentp3" "totalcurrent" "totalactivepower" "totalreactivepower" "totalapparentpower" "totalpowerfactor" "totalactiveenergy" "totalreactiveenergy" "totalapparentenergy" "activepowerp1" "activepowerp2" "activepowerp3" "reactivepowerp1" "reactivepowerp2" "reactivepowerp3" "apparentpowerp1" "apparentpowerp2" "apparentpowerp3" "cosphip1" "cosphip2" "cosphip3" "powerfactorp1" "powerfactorp2" "powerfactorp3" "frequenzyp1" "frequenzyp2" "frequenzyp3" "energyproduction" "energyconsumption" "energyexport" "energyselfconsumption" "energyimport" "powerproduction" "powerexport" "powerconsumption" "powerimport" "powerselfconsumption" "contact" "touch" "touchcount" "presence" "presencecount" "waterdetector" "motion" "occupancy" "weatherprecipitation" "weatherprecipitationduration" "weatherhumidity" "weathercglo" "weatherwindspeed" "weatherwindgustspeed" "weatherwindgusttimestamp" "weatherwindheading" "weatherwindgustheading" "weatherhumidityrelative" "weathertemperatureair" "weatherpressure" "weatherpressurereduced" "weathersnowheight" "weathersunshineduration" "weatherdewpoint" "weathertemperaturesoil10" "weathertemperaturesoil100" "weathertemperaturewater" "personcountinside" "personcountin" "personcountout" "vehiclecountinside" "vehiclecountin" "vehiclecountout" "licenseplate" "county"

Responses

Request samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "device": "8dca31e6-c85b-4a6b-bfb4-205d45d9b3bd",
  • "active": true,
  • "originalDatapointId": "string",
  • "datapointSubType": "string",
  • "datapointType": "string",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "config": { },
  • "correctionFactor": 0,
  • "category": "weather",
  • "measurementType": "unknown"
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "device": "8dca31e6-c85b-4a6b-bfb4-205d45d9b3bd",
  • "active": true,
  • "originalDatapointId": "string",
  • "datapointSubType": "string",
  • "datapointType": "string",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "config": { },
  • "correctionFactor": 0,
  • "category": "weather",
  • "measurementType": "unknown",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

Get all FLIC datapoints for a FLIC device of a customer.

Get all FLIC datapoints that are assigned to a specific FLIC device of a customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Responses

Response samples

Content type
application/json
{ }

Get a FLIC datapoint for a FLIC device of a customer.

Get a FLIC datapoint that is assigned to a specific FLIC device and customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

datapointId
required
string

id of the datapoint to get the data for

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "device": "8dca31e6-c85b-4a6b-bfb4-205d45d9b3bd",
  • "active": true,
  • "originalDatapointId": "string",
  • "datapointSubType": "string",
  • "datapointType": "string",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "config": { },
  • "correctionFactor": 0,
  • "category": "weather",
  • "measurementType": "unknown",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

datapointId
required
string

id of the datapoint to get the data for

Responses

Response samples

Content type
application/json
{ }

Update a FLIC datapoint for a FLIC device of a customer.

Update a FLIC datapoint of a specific FLIC device and customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

datapointId
required
string

id of the datapoint to get the data for

Request Body schema: application/json
required
uuid
required
string <uuid>

unique identifier for this datapoint.

name
required
string

the name of the datapoint.

nameAlias1
string

the name alias 1 for this datapoint instance.

nameAlias2
string

the name alias 2for this datapoint instance.

device
required
string <uuid>

the device's uuid the object is related to.

active
required
boolean

if the datapoint is active or not

originalDatapointId
required
string

the id for this datapoint in the context of the remote datapoint - e.g. the ID in the supplier's system

datapointSubType
required
string

the subtype of datapoint, how the supplier of the connector would call it

datapointType
required
string

the type of datapoint, usually matches the connector type key where this datapoint receives data from

customer
required
string <uuid>

the customer this datapoint belongs to

config
object or null
correctionFactor
number
category
required
string
Enum: "weather" "energy" "environment" "status" "recognition" "unknown"
measurementType
required
string
Enum: "unknown" "temperature" "humidity" "pressure" "co2" "voltage" "voltagep1" "voltagep2" "voltagep3" "current" "currentp1" "currentp2" "currentp3" "totalcurrent" "totalactivepower" "totalreactivepower" "totalapparentpower" "totalpowerfactor" "totalactiveenergy" "totalreactiveenergy" "totalapparentenergy" "activepowerp1" "activepowerp2" "activepowerp3" "reactivepowerp1" "reactivepowerp2" "reactivepowerp3" "apparentpowerp1" "apparentpowerp2" "apparentpowerp3" "cosphip1" "cosphip2" "cosphip3" "powerfactorp1" "powerfactorp2" "powerfactorp3" "frequenzyp1" "frequenzyp2" "frequenzyp3" "energyproduction" "energyconsumption" "energyexport" "energyselfconsumption" "energyimport" "powerproduction" "powerexport" "powerconsumption" "powerimport" "powerselfconsumption" "contact" "touch" "touchcount" "presence" "presencecount" "waterdetector" "motion" "occupancy" "weatherprecipitation" "weatherprecipitationduration" "weatherhumidity" "weathercglo" "weatherwindspeed" "weatherwindgustspeed" "weatherwindgusttimestamp" "weatherwindheading" "weatherwindgustheading" "weatherhumidityrelative" "weathertemperatureair" "weatherpressure" "weatherpressurereduced" "weathersnowheight" "weathersunshineduration" "weatherdewpoint" "weathertemperaturesoil10" "weathertemperaturesoil100" "weathertemperaturewater" "personcountinside" "personcountin" "personcountout" "vehiclecountinside" "vehiclecountin" "vehiclecountout" "licenseplate" "county"

Responses

Request samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "device": "8dca31e6-c85b-4a6b-bfb4-205d45d9b3bd",
  • "active": true,
  • "originalDatapointId": "string",
  • "datapointSubType": "string",
  • "datapointType": "string",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "config": { },
  • "correctionFactor": 0,
  • "category": "weather",
  • "measurementType": "unknown"
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "device": "8dca31e6-c85b-4a6b-bfb4-205d45d9b3bd",
  • "active": true,
  • "originalDatapointId": "string",
  • "datapointSubType": "string",
  • "datapointType": "string",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "config": { },
  • "correctionFactor": 0,
  • "category": "weather",
  • "measurementType": "unknown",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

Get all active AVA datapoints of a AVA device.

Get all active AVA datapoints that are assigned to a specific AVA device.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Responses

Response samples

Content type
application/json
{ }

Create a new AVA datapoint for an AVA device of a customer.

Create a new AVA datapoint for an AVA device of a specific customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Request Body schema: application/json
required
uuid
required
string <uuid>

unique identifier for this datapoint.

name
required
string

the name of the datapoint.

nameAlias1
string

the name alias 1 for this datapoint instance.

nameAlias2
string

the name alias 2for this datapoint instance.

device
required
string <uuid>

the device's uuid the object is related to.

active
required
boolean

if the datapoint is active or not

originalDatapointId
required
string

the id for this datapoint in the context of the remote datapoint - e.g. the ID in the supplier's system

datapointSubType
required
string

the subtype of datapoint, how the supplier of the connector would call it

datapointType
required
string

the type of datapoint, usually matches the connector type key where this datapoint receives data from

customer
required
string <uuid>

the customer this datapoint belongs to

config
object or null
correctionFactor
number
category
required
string
Enum: "weather" "energy" "environment" "status" "recognition" "unknown"
measurementType
required
string
Enum: "unknown" "temperature" "humidity" "pressure" "co2" "voltage" "voltagep1" "voltagep2" "voltagep3" "current" "currentp1" "currentp2" "currentp3" "totalcurrent" "totalactivepower" "totalreactivepower" "totalapparentpower" "totalpowerfactor" "totalactiveenergy" "totalreactiveenergy" "totalapparentenergy" "activepowerp1" "activepowerp2" "activepowerp3" "reactivepowerp1" "reactivepowerp2" "reactivepowerp3" "apparentpowerp1" "apparentpowerp2" "apparentpowerp3" "cosphip1" "cosphip2" "cosphip3" "powerfactorp1" "powerfactorp2" "powerfactorp3" "frequenzyp1" "frequenzyp2" "frequenzyp3" "energyproduction" "energyconsumption" "energyexport" "energyselfconsumption" "energyimport" "powerproduction" "powerexport" "powerconsumption" "powerimport" "powerselfconsumption" "contact" "touch" "touchcount" "presence" "presencecount" "waterdetector" "motion" "occupancy" "weatherprecipitation" "weatherprecipitationduration" "weatherhumidity" "weathercglo" "weatherwindspeed" "weatherwindgustspeed" "weatherwindgusttimestamp" "weatherwindheading" "weatherwindgustheading" "weatherhumidityrelative" "weathertemperatureair" "weatherpressure" "weatherpressurereduced" "weathersnowheight" "weathersunshineduration" "weatherdewpoint" "weathertemperaturesoil10" "weathertemperaturesoil100" "weathertemperaturewater" "personcountinside" "personcountin" "personcountout" "vehiclecountinside" "vehiclecountin" "vehiclecountout" "licenseplate" "county"

Responses

Request samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "device": "8dca31e6-c85b-4a6b-bfb4-205d45d9b3bd",
  • "active": true,
  • "originalDatapointId": "string",
  • "datapointSubType": "string",
  • "datapointType": "string",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "config": { },
  • "correctionFactor": 0,
  • "category": "weather",
  • "measurementType": "unknown"
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "active": true,
  • "originalDeviceId": "string",
  • "connector": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "site": "862ae9eb-f0eb-41b6-b3e5-39fdd26ce81c",
  • "config": { },
  • "deviceType": "dt",
  • "deviceSubType": "LPR",
  • "lastSeen": 0,
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

Get all AVA datapoints for a AVA device of a customer.

Get all AVA datapoints that are assigned to a specific AVA device of a customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Responses

Response samples

Content type
application/json
{ }

Get a AVA datapoint for a AVA device of a customer.

Get a AVA datapoint that is assigned to a specific AVA device and customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

datapointId
required
string

id of the datapoint to get the data for

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "active": true,
  • "originalDeviceId": "string",
  • "connector": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "site": "862ae9eb-f0eb-41b6-b3e5-39fdd26ce81c",
  • "config": { },
  • "deviceType": "dt",
  • "deviceSubType": "LPR",
  • "lastSeen": 0,
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

datapointId
required
string

id of the datapoint to get the data for

Responses

Response samples

Content type
application/json
{ }

Update a AVA datapoint for a AVA device of a customer.

Update a AVA datapoint of a specific AVA device and customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

datapointId
required
string

id of the datapoint to get the data for

Request Body schema: application/json
required
uuid
required
string <uuid>

unique identifier for this datapoint.

name
required
string

the name of the datapoint.

nameAlias1
string

the name alias 1 for this datapoint instance.

nameAlias2
string

the name alias 2for this datapoint instance.

device
required
string <uuid>

the device's uuid the object is related to.

active
required
boolean

if the datapoint is active or not

originalDatapointId
required
string

the id for this datapoint in the context of the remote datapoint - e.g. the ID in the supplier's system

datapointSubType
required
string

the subtype of datapoint, how the supplier of the connector would call it

datapointType
required
string

the type of datapoint, usually matches the connector type key where this datapoint receives data from

customer
required
string <uuid>

the customer this datapoint belongs to

config
object or null
correctionFactor
number
category
required
string
Enum: "weather" "energy" "environment" "status" "recognition" "unknown"
measurementType
required
string
Enum: "unknown" "temperature" "humidity" "pressure" "co2" "voltage" "voltagep1" "voltagep2" "voltagep3" "current" "currentp1" "currentp2" "currentp3" "totalcurrent" "totalactivepower" "totalreactivepower" "totalapparentpower" "totalpowerfactor" "totalactiveenergy" "totalreactiveenergy" "totalapparentenergy" "activepowerp1" "activepowerp2" "activepowerp3" "reactivepowerp1" "reactivepowerp2" "reactivepowerp3" "apparentpowerp1" "apparentpowerp2" "apparentpowerp3" "cosphip1" "cosphip2" "cosphip3" "powerfactorp1" "powerfactorp2" "powerfactorp3" "frequenzyp1" "frequenzyp2" "frequenzyp3" "energyproduction" "energyconsumption" "energyexport" "energyselfconsumption" "energyimport" "powerproduction" "powerexport" "powerconsumption" "powerimport" "powerselfconsumption" "contact" "touch" "touchcount" "presence" "presencecount" "waterdetector" "motion" "occupancy" "weatherprecipitation" "weatherprecipitationduration" "weatherhumidity" "weathercglo" "weatherwindspeed" "weatherwindgustspeed" "weatherwindgusttimestamp" "weatherwindheading" "weatherwindgustheading" "weatherhumidityrelative" "weathertemperatureair" "weatherpressure" "weatherpressurereduced" "weathersnowheight" "weathersunshineduration" "weatherdewpoint" "weathertemperaturesoil10" "weathertemperaturesoil100" "weathertemperaturewater" "personcountinside" "personcountin" "personcountout" "vehiclecountinside" "vehiclecountin" "vehiclecountout" "licenseplate" "county"

Responses

Request samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "device": "8dca31e6-c85b-4a6b-bfb4-205d45d9b3bd",
  • "active": true,
  • "originalDatapointId": "string",
  • "datapointSubType": "string",
  • "datapointType": "string",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "config": { },
  • "correctionFactor": 0,
  • "category": "weather",
  • "measurementType": "unknown"
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "active": true,
  • "originalDeviceId": "string",
  • "connector": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "site": "862ae9eb-f0eb-41b6-b3e5-39fdd26ce81c",
  • "config": { },
  • "deviceType": "dt",
  • "deviceSubType": "LPR",
  • "lastSeen": 0,
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

DisruptiveTechnologies

Receives data for webhooks from Disruptive Technologies.

Receives data for webhooks from Disruptive Technologies.

Authorizations:
None

Responses

Receives data for webhooks from Disruptive Technologies.

Receives data for webhooks from Disruptive Technologies.

Authorizations:
None
path Parameters
proxy+
required
string

Responses

Gets all the used labels and their values for a given customer and connector, if given

Gets all the used labels and their values for a given customer and connector, if given

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

connectorId
required
string

id of the connector

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

connectorId
required
string

id of the connector

Responses

Response samples

Content type
application/json
{ }

Weather

get weather summary per day

get weather summary per day

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

query Parameters
startdate
required
string <date>

start date for the summary

enddate
string <date>

end date for the summary - if skipped/not used, only the day represented by startdate will be returned

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

Responses

Response samples

Content type
application/json
{ }

get weather details (hourly)

get weather details (hourly)

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

query Parameters
startdatetime
required
string <date-time>

start date and time for the summary

enddatetime
required
string <date-time>

end date and time for the details

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

Responses

Response samples

Content type
application/json
{ }

get weather site data (hourly)

get weather site data (hourly)

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

query Parameters
startdatetime
required
string <date-time>

start date and time for the summary

enddatetime
required
string <date-time>

end date and time for the details

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

Responses

Response samples

Content type
application/json
{ }

get weather site sites

get weather site sites

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

Responses

Response samples

Content type
application/json
{ }

Swarm

get Swarm data per time and date

get Swarm data per time and date

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

query Parameters
datapointIds
required
string
Example: datapointIds=1234567,8901234,5678901

datapointIds as a comma-separated list

startdatetime
required
string <date-time>

start date and time for the summary

enddatetime
required
string <date-time>

end date and time for the summary

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Responses

Response samples

Content type
application/json
{ }

WAGO

get Wago thing by thingId

get Wago thing by thingId

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

thingId
required
string

id of the thing to work with

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "thingName": "string",
  • "active": true,
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "thingArn": "string",
  • "thingId": "string",
  • "certificateArn": "string",
  • "certificateId": "string",
  • "certificatePresignedUrl": "string",
  • "publicKeyPresignedUrl": "string",
  • "privateKeyPresignedUrl": "string",
  • "zippedCertKeysPresignedUrl": "string",
  • "signedUrlExpiresAt": 0,
  • "connector": "ae3e6c6f-6542-43ae-8e3b-4654639f6b5f",
  • "macId": "string"
}

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

thingId
required
string

id of the thing to work with

Responses

Response samples

Content type
application/json
{ }

get Wago thing by connectorId

get Wago thing by connectorId

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

connectorId
required
string

id of the connector to get the data for

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "thingName": "string",
  • "active": true,
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "thingArn": "string",
  • "thingId": "string",
  • "certificateArn": "string",
  • "certificateId": "string",
  • "certificatePresignedUrl": "string",
  • "publicKeyPresignedUrl": "string",
  • "privateKeyPresignedUrl": "string",
  • "zippedCertKeysPresignedUrl": "string",
  • "signedUrlExpiresAt": 0,
  • "connector": "ae3e6c6f-6542-43ae-8e3b-4654639f6b5f",
  • "macId": "string"
}

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

connectorId
required
string

id of the connector to get the data for

Responses

Response samples

Content type
application/json
{ }

regen cert and keys for Wago thing by connectorId

regen cert and keys for Wago thing by connectorId

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

connectorId
required
string

id of the connector to get the data for

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "thingName": "string",
  • "active": true,
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "thingArn": "string",
  • "thingId": "string",
  • "certificateArn": "string",
  • "certificateId": "string",
  • "certificatePresignedUrl": "string",
  • "publicKeyPresignedUrl": "string",
  • "privateKeyPresignedUrl": "string",
  • "zippedCertKeysPresignedUrl": "string",
  • "signedUrlExpiresAt": 0,
  • "connector": "ae3e6c6f-6542-43ae-8e3b-4654639f6b5f",
  • "macId": "string"
}

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

connectorId
required
string

id of the connector to get the data for

Responses

Response samples

Content type
application/json
{ }

get Wago Types to Unit Map

get Wago Types to Unit Map

Authorizations:
custom-auth

Responses

Response samples

Content type
application/json
{
  • "1": "W",
  • "2": "var",
  • "3": "VA"
}

for CORS

Authorizations:
custom-auth

Responses

Response samples

Content type
application/json
{ }

get Wago Units

get Wago Units

Authorizations:
custom-auth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth

Responses

Response samples

Content type
application/json
{ }

get Wago Datapoint Types

get Wago Datapoint Types

Authorizations:
custom-auth

Responses

Response samples

Content type
application/json
{
  • "Io750_494": [
    ],
  • "Io750_495": [
    ]
}

for CORS

Authorizations:
custom-auth

Responses

Response samples

Content type
application/json
{ }

get Wago Module Types

get Wago Module Types

Authorizations:
custom-auth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth

Responses

Response samples

Content type
application/json
{ }

Get all active WAGO connectors of a customer's location.

Get all active WAGO connectors of a specific customer's location.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

strict
boolean

if set to true, only connectors directly associated with the given location will be returned; otherwise (defaul) also connectors which have "isAllowedOnAllLocation" will be returned, too

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

Responses

Response samples

Content type
application/json
{ }

Create WAGO connector for customer.

Create WAGO connector for customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

Request Body schema: application/json
required
uuid
required
string <uuid>

unique identifier for this connector

type
required
string <uuid>

the connector type's UUId the connector is an instance of.

name
required
string

the name for this Connector instance.

nameAlias1
string

the name alias 1 for this Connector instance.

nameAlias2
string

the name alias 2for this Connector instance.

location
required
string <uuid>

the location's UUId the connector is assigned to.

active
required
boolean
originalConnectorId
required
string

the optional original connector id for this connector

isAllowedOnAllLocations
boolean

if set to true, this connector may be used on devices which come from a different location of the customer than the one this connector is associated with. This is needed when the connector represents a system which aggregates data from different physical locations, e.g. via networks

required
object or null

Responses

Request samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "type": "4595bf66-18b2-445a-a884-1b08d0c2df0e",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "active": true,
  • "originalConnectorId": "string",
  • "isAllowedOnAllLocations": true,
  • "config": {
    }
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "type": "4595bf66-18b2-445a-a884-1b08d0c2df0e",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "active": true,
  • "originalConnectorId": "string",
  • "isAllowedOnAllLocations": true,
  • "config": {
    },
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

Get all WAGO connectors of a customer's location.

Get all WAGO connectors of a specific customer's location.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

strict
boolean

if set to true, only connectors directly associated with the given location will be returned; otherwise (defaul) also connectors which have "isAllowedOnAllLocation" will be returned, too

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

Responses

Response samples

Content type
application/json
{ }

Get WAGO connector of a customer's location.

Get WAGO connector of a specific customer's location.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

connectorId
required
string

id of the connector to get the data for

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "type": "4595bf66-18b2-445a-a884-1b08d0c2df0e",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "active": true,
  • "originalConnectorId": "string",
  • "isAllowedOnAllLocations": true,
  • "config": {
    },
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

connectorId
required
string

id of the connector to get the data for

Responses

Response samples

Content type
application/json
{ }

Update connector for customer's location.

Update connector for customer's location.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

connectorId
required
string

id of the connector to get the data for

Request Body schema: application/json
required
uuid
required
string <uuid>

unique identifier for this connector

type
required
string <uuid>

the connector type's UUId the connector is an instance of.

name
required
string

the name for this Connector instance.

nameAlias1
string

the name alias 1 for this Connector instance.

nameAlias2
string

the name alias 2for this Connector instance.

location
required
string <uuid>

the location's UUId the connector is assigned to.

active
required
boolean
originalConnectorId
required
string

the optional original connector id for this connector

isAllowedOnAllLocations
boolean

if set to true, this connector may be used on devices which come from a different location of the customer than the one this connector is associated with. This is needed when the connector represents a system which aggregates data from different physical locations, e.g. via networks

required
object or null

Responses

Request samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "type": "4595bf66-18b2-445a-a884-1b08d0c2df0e",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "active": true,
  • "originalConnectorId": "string",
  • "isAllowedOnAllLocations": true,
  • "config": {
    }
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "type": "4595bf66-18b2-445a-a884-1b08d0c2df0e",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "active": true,
  • "originalConnectorId": "string",
  • "isAllowedOnAllLocations": true,
  • "config": {
    },
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

Get all active WAGO devices of a customer.

Get all active WAGO devices that are assigned to a specific customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

Responses

Response samples

Content type
application/json
{ }

Create a new WAGO device of a customer.

Create a new WAGO device of a specific customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

Request Body schema: application/json
required
uuid
required
string <uuid>

unique identifier for this device

customer
required
string <uuid>

the customer this device belongs to

name
required
string

the name of the device.

nameAlias1
string

the name alias 1 for this device instance.

nameAlias2
string

the name alias 2for this device instance.

active
required
boolean

if the device is active or not

originalDeviceId
required
string

the id for this device in the context of the device - e.g. the ID in the supplier's system

connector
required
string

the id of the connector this device belongs to

location
required
string <uuid>

the location's uuid the device can be related to.

site
string or null <uuid>

the site's uuid the device can be related to.

required
object or null

optional configuration object for the device

deviceType
required
string

the type of device

deviceSubType
string or null

the subtype of device

Responses

Request samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "active": true,
  • "originalDeviceId": "string",
  • "connector": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "site": "862ae9eb-f0eb-41b6-b3e5-39fdd26ce81c",
  • "config": {
    },
  • "deviceType": "dt",
  • "deviceSubType": "temperature"
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "active": true,
  • "originalDeviceId": "string",
  • "connector": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "site": "862ae9eb-f0eb-41b6-b3e5-39fdd26ce81c",
  • "config": {
    },
  • "deviceType": "dt",
  • "deviceSubType": "temperature",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

Get all WAGO devices of a customer.

Get all WAGO devices that are assigned to a specific customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

Responses

Response samples

Content type
application/json
{ }

Get a WAGO device of a customer.

Get a WAGO device that is assigned to a specific customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "active": true,
  • "originalDeviceId": "string",
  • "connector": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "site": "862ae9eb-f0eb-41b6-b3e5-39fdd26ce81c",
  • "config": {
    },
  • "deviceType": "dt",
  • "deviceSubType": "temperature",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Responses

Response samples

Content type
application/json
{ }

Update a WAGO device of a customer.

Update a WAGO device of a specific customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Request Body schema: application/json
required
uuid
required
string <uuid>

unique identifier for this device

customer
required
string <uuid>

the customer this device belongs to

name
required
string

the name of the device.

nameAlias1
string

the name alias 1 for this device instance.

nameAlias2
string

the name alias 2for this device instance.

active
required
boolean

if the device is active or not

originalDeviceId
required
string

the id for this device in the context of the device - e.g. the ID in the supplier's system

connector
required
string

the id of the connector this device belongs to

location
required
string <uuid>

the location's uuid the device can be related to.

site
string or null <uuid>

the site's uuid the device can be related to.

required
object or null

optional configuration object for the device

deviceType
required
string

the type of device

deviceSubType
string or null

the subtype of device

Responses

Request samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "active": true,
  • "originalDeviceId": "string",
  • "connector": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "site": "862ae9eb-f0eb-41b6-b3e5-39fdd26ce81c",
  • "config": {
    },
  • "deviceType": "dt",
  • "deviceSubType": "temperature"
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "active": true,
  • "originalDeviceId": "string",
  • "connector": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "site": "862ae9eb-f0eb-41b6-b3e5-39fdd26ce81c",
  • "config": {
    },
  • "deviceType": "dt",
  • "deviceSubType": "temperature",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

Get all active WAGO datapoints of a WAGO device.

Get all active WAGO datapoints that are assigned to a specific WAGO device.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Responses

Response samples

Content type
application/json
{ }

Create a new WAGO datapoint for an WAGO device of a customer.

Create a new WAGO datapoint for an WAGO device of a specific customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Request Body schema: application/json
required
uuid
required
string <uuid>

unique identifier for this datapoint.

name
required
string

the name of the datapoint.

nameAlias1
string

the name alias 1 for this datapoint instance.

nameAlias2
string

the name alias 2for this datapoint instance.

device
required
string <uuid>

the device's uuid the object is related to.

active
required
boolean

if the datapoint is active or not

originalDatapointId
required
string

the id for this datapoint in the context of the remote datapoint - e.g. the ID in the supplier's system

datapointSubType
string

the subtype of datapoint, how the supplier of the connector would call it

datapointType
string

the type of datapoint, usually matches the connector type key where this datapoint receives data from

customer
required
string <uuid>

the customer this datapoint belongs to

config
object or null
correctionFactor
number
category
required
string (measureDataCategory)
Enum: "weather" "energy" "environment" "status" "recognition" "unknown"
measurementType
required
string (measureDataType)
Enum: "unknown" "temperature" "humidity" "pressure" "co2" "voltage" "voltagep1" "voltagep2" "voltagep3" "current" "currentp1" "currentp2" "currentp3" "totalcurrent" "totalactivepower" "totalreactivepower" "totalapparentpower" "totalpowerfactor" "totalactiveenergy" "totalreactiveenergy" "totalapparentenergy" "activepowerp1" "activepowerp2" "activepowerp3" "reactivepowerp1" "reactivepowerp2" "reactivepowerp3" "apparentpowerp1" "apparentpowerp2" "apparentpowerp3" "cosphip1" "cosphip2" "cosphip3" "powerfactorp1" "powerfactorp2" "powerfactorp3" "frequenzyp1" "frequenzyp2" "frequenzyp3" "energyproduction" "energyconsumption" "energyexport" "energyselfconsumption" "energyimport" "powerproduction" "powerexport" "powerconsumption" "powerimport" "powerselfconsumption" "contact" "touch" "touchcount" "presence" "presencecount" "waterdetector" "motion" "occupancy" "weatherprecipitation" "weatherprecipitationduration" "weatherhumidity" "weathercglo" "weatherwindspeed" "weatherwindgustspeed" "weatherwindgusttimestamp" "weatherwindheading" "weatherwindgustheading" "weatherhumidityrelative" "weathertemperatureair" "weatherpressure" "weatherpressurereduced" "weathersnowheight" "weathersunshineduration" "weatherdewpoint" "weathertemperaturesoil10" "weathertemperaturesoil100" "weathertemperaturewater" "personcountinside" "personcountin" "personcountout" "vehiclecountinside" "vehiclecountin" "vehiclecountout" "licenseplate" "county"

Responses

Request samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "device": "8dca31e6-c85b-4a6b-bfb4-205d45d9b3bd",
  • "active": true,
  • "originalDatapointId": "string",
  • "datapointSubType": "string",
  • "datapointType": "string",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "config": { },
  • "correctionFactor": 0,
  • "category": "weather",
  • "measurementType": "unknown"
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "device": "8dca31e6-c85b-4a6b-bfb4-205d45d9b3bd",
  • "active": true,
  • "originalDatapointId": "string",
  • "datapointSubType": "string",
  • "datapointType": "string",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "config": { },
  • "correctionFactor": 0,
  • "category": "weather",
  • "measurementType": "unknown",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

Get all WAGO datapoints for a WAGO device of a customer.

Get all WAGO datapoints that are assigned to a specific WAGO device of a customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Responses

Response samples

Content type
application/json
{ }

Get a WAGO datapoint for a WAGO device of a customer.

Get a WAGO datapoint that is assigned to a specific WAGO device and customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

datapointId
required
string

id of the datapoint to get the data for

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "device": "8dca31e6-c85b-4a6b-bfb4-205d45d9b3bd",
  • "active": true,
  • "originalDatapointId": "string",
  • "datapointSubType": "string",
  • "datapointType": "string",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "config": { },
  • "correctionFactor": 0,
  • "category": "weather",
  • "measurementType": "unknown",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

datapointId
required
string

id of the datapoint to get the data for

Responses

Response samples

Content type
application/json
{ }

Update a WAGO datapoint for a WAGO device of a customer.

Update a WAGO datapoint of a specific WAGO device and customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

datapointId
required
string

id of the datapoint to get the data for

Request Body schema: application/json
required
uuid
required
string <uuid>

unique identifier for this datapoint.

name
required
string

the name of the datapoint.

nameAlias1
string

the name alias 1 for this datapoint instance.

nameAlias2
string

the name alias 2for this datapoint instance.

device
required
string <uuid>

the device's uuid the object is related to.

active
required
boolean

if the datapoint is active or not

originalDatapointId
required
string

the id for this datapoint in the context of the remote datapoint - e.g. the ID in the supplier's system

datapointSubType
required
string

the subtype of datapoint, how the supplier of the connector would call it

datapointType
required
string

the type of datapoint, usually matches the connector type key where this datapoint receives data from

customer
required
string <uuid>

the customer this datapoint belongs to

config
object or null
correctionFactor
number
category
required
string
Enum: "weather" "energy" "environment" "status" "recognition" "unknown"
measurementType
required
string
Enum: "unknown" "temperature" "humidity" "pressure" "co2" "voltage" "voltagep1" "voltagep2" "voltagep3" "current" "currentp1" "currentp2" "currentp3" "totalcurrent" "totalactivepower" "totalreactivepower" "totalapparentpower" "totalpowerfactor" "totalactiveenergy" "totalreactiveenergy" "totalapparentenergy" "activepowerp1" "activepowerp2" "activepowerp3" "reactivepowerp1" "reactivepowerp2" "reactivepowerp3" "apparentpowerp1" "apparentpowerp2" "apparentpowerp3" "cosphip1" "cosphip2" "cosphip3" "powerfactorp1" "powerfactorp2" "powerfactorp3" "frequenzyp1" "frequenzyp2" "frequenzyp3" "energyproduction" "energyconsumption" "energyexport" "energyselfconsumption" "energyimport" "powerproduction" "powerexport" "powerconsumption" "powerimport" "powerselfconsumption" "contact" "touch" "touchcount" "presence" "presencecount" "waterdetector" "motion" "occupancy" "weatherprecipitation" "weatherprecipitationduration" "weatherhumidity" "weathercglo" "weatherwindspeed" "weatherwindgustspeed" "weatherwindgusttimestamp" "weatherwindheading" "weatherwindgustheading" "weatherhumidityrelative" "weathertemperatureair" "weatherpressure" "weatherpressurereduced" "weathersnowheight" "weathersunshineduration" "weatherdewpoint" "weathertemperaturesoil10" "weathertemperaturesoil100" "weathertemperaturewater" "personcountinside" "personcountin" "personcountout" "vehiclecountinside" "vehiclecountin" "vehiclecountout" "licenseplate" "county"

Responses

Request samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "device": "8dca31e6-c85b-4a6b-bfb4-205d45d9b3bd",
  • "active": true,
  • "originalDatapointId": "string",
  • "datapointSubType": "string",
  • "datapointType": "string",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "config": { },
  • "correctionFactor": 0,
  • "category": "weather",
  • "measurementType": "unknown"
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "device": "8dca31e6-c85b-4a6b-bfb4-205d45d9b3bd",
  • "active": true,
  • "originalDatapointId": "string",
  • "datapointSubType": "string",
  • "datapointType": "string",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "config": { },
  • "correctionFactor": 0,
  • "category": "weather",
  • "measurementType": "unknown",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

UI

Get all active dashboard configurations.

Get all active dashboard configurations.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

Responses

Response samples

Content type
application/json
{ }

Create dashboard config.

Create existing dashboard config.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to work with

Request Body schema: application/json
required
uuid
required
string <uuid>
customer
required
string <uuid>
name
required
string
active
required
boolean
isMain
boolean or null
location
required
string

the location this dashboard is associated with

config
string or null

A "stringified" JSON is expected here

Responses

Request samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "name": "string",
  • "active": true,
  • "isMain": true,
  • "location": "string",
  • "config": "{\"test\": \"value\",\"test2\": \"value2\",\"test3\": [\"a\", \"b\", \"c\"],\"test4\": {\"test5\": \"value5\"}}"
}

Response samples

Content type
application/json
{ }

Get all dashboard configurations.

Get all dashboard configurations.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

Responses

Response samples

Content type
application/json
{ }

Get a dashboard configuration.

Get a dashboard configuration.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

dashboardConfigId
required
string

id of the dashboard config

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "name": "string",
  • "active": true,
  • "isMain": true,
  • "location": "string",
  • "config": "{\"test\": \"value\",\"test2\": \"value2\",\"test3\": [\"a\", \"b\", \"c\"],\"test4\": {\"test5\": \"value5\"}}"
}

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

dashboardConfigId
required
string

id of the dashboard config

Responses

Response samples

Content type
application/json
{ }

Update existing dashboard config.

Update existing dashboard config.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

dashboardConfigId
required
string

id of the dashboard config

Request Body schema: application/json
required
uuid
required
string <uuid>
customer
required
string <uuid>
name
required
string
active
required
boolean
isMain
boolean or null
location
required
string

the location this dashboard is associated with

config
string or null

A "stringified" JSON is expected here

Responses

Request samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "name": "string",
  • "active": true,
  • "isMain": true,
  • "location": "string",
  • "config": "{\"test\": \"value\",\"test2\": \"value2\",\"test3\": [\"a\", \"b\", \"c\"],\"test4\": {\"test5\": \"value5\"}}"
}

Response samples

Content type
application/json
{ }

Delete a dashboard configuration.

Delete a dashboard configuration.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

dashboardConfigId
required
string

id of the dashboard config

Responses

Response samples

Content type
application/json
{ }

ConnectorType

Get all active connector types.

Get all active connector types.

Authorizations:
custom-auth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth

Responses

Response samples

Content type
application/json
{ }

Create connector type.

Create connector type.

Authorizations:
custom-auth
Request Body schema: application/json
required
uuid
required
string <uuid>

unique identifier for this conenctor type

name
required
string

The name of this connector type.

key
required
string

A unique identifier for this specific type, e.g. AVA for AVA Security

active
required
boolean

A boolean indicating if this type is active or not - if not, no new connectors of this type can be created.

config
object or null

The config object that is dependent of the connector type instance itself, so no schema for this.

Responses

Request samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "key": "string",
  • "active": true,
  • "config": { }
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "key": "string",
  • "active": true,
  • "config": { },
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

Get all connector types.

Get all connector types.

Authorizations:
custom-auth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth

Responses

Response samples

Content type
application/json
{ }

Get a specific connector type.

Get a specific connector type.

Authorizations:
custom-auth
path Parameters
connectorTypeId
required
string

id of the connector type to work with

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "key": "string",
  • "active": true,
  • "config": { },
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

for CORS

Authorizations:
custom-auth
path Parameters
connectorTypeId
required
string

id of the connector type to work with

Responses

Response samples

Content type
application/json
{ }

Update connector type.

Update connector type.

Authorizations:
custom-auth
path Parameters
connectorTypeId
required
string

id of the connector type to work with

Request Body schema: application/json
required
uuid
required
string <uuid>

unique identifier for this conenctor type

name
required
string

The name of this connector type.

key
required
string

A unique identifier for this specific type, e.g. AVA for AVA Security

active
required
boolean

A boolean indicating if this type is active or not - if not, no new connectors of this type can be created.

config
object or null

The config object that is dependent of the connector type instance itself, so no schema for this.

Responses

Request samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "key": "string",
  • "active": true,
  • "config": { }
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "key": "string",
  • "active": true,
  • "config": { },
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

Crypto

Encrypts a given value

Encrypts a given value

Authorizations:
custom-auth
Request Body schema: application/json
required
value
required
string

The value to encrypt

Responses

Request samples

Content type
application/json
{
  • "value": "a_secret_password"
}

Response samples

Content type
application/json
{
  • "encrypted": "string"
}

for CORS

Authorizations:
custom-auth

Responses

Response samples

Content type
application/json
{ }

SMA

Get all active SMA connectors of a customer's location.

Get all active SMA connectors of a specific customer's location.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

strict
boolean

if set to true, only connectors directly associated with the given location will be returned; otherwise (defaul) also connectors which have "isAllowedOnAllLocation" will be returned, too

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

Responses

Response samples

Content type
application/json
{ }

Create SMA connector for customer.

Create SMA connector for customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

Request Body schema: application/json
required
uuid
required
string <uuid>

unique identifier for this connector

type
required
string <uuid>

the connector type's UUId the connector is an instance of.

name
required
string

the name for this Connector instance.

nameAlias1
string

the name alias 1 for this Connector instance.

nameAlias2
string

the name alias 2for this Connector instance.

location
required
string <uuid>

the location's UUId the connector is assigned to.

active
required
boolean
originalConnectorId
string

the optional original connector id for this connector

isAllowedOnAllLocations
boolean

if set to true, this connector may be used on devices which come from a different location of the customer than the one this connector is associated with. This is needed when the connector represents a system which aggregates data from different physical locations, e.g. via networks

Responses

Request samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "type": "4595bf66-18b2-445a-a884-1b08d0c2df0e",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "active": true,
  • "originalConnectorId": "string",
  • "isAllowedOnAllLocations": true
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "type": "4595bf66-18b2-445a-a884-1b08d0c2df0e",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "active": true,
  • "originalConnectorId": "string",
  • "isAllowedOnAllLocations": true,
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

Get all SMA connectors of a customer's location.

Get all SMA connectors of a specific customer's location.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

strict
boolean

if set to true, only connectors directly associated with the given location will be returned; otherwise (defaul) also connectors which have "isAllowedOnAllLocation" will be returned, too

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

Responses

Response samples

Content type
application/json
{ }

Get SMA connector of a customer's location.

Get SMA connector of a specific customer's location.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

connectorId
required
string

id of the connector to get the data for

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "type": "4595bf66-18b2-445a-a884-1b08d0c2df0e",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "active": true,
  • "originalConnectorId": "string",
  • "isAllowedOnAllLocations": true,
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

connectorId
required
string

id of the connector to get the data for

Responses

Response samples

Content type
application/json
{ }

Update connector for customer's location.

Update connector for customer's location.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

connectorId
required
string

id of the connector to get the data for

Request Body schema: application/json
required
uuid
required
string <uuid>

unique identifier for this connector

type
required
string <uuid>

the connector type's UUId the connector is an instance of.

name
required
string

the name for this Connector instance.

nameAlias1
string

the name alias 1 for this Connector instance.

nameAlias2
string

the name alias 2for this Connector instance.

location
required
string <uuid>

the location's UUId the connector is assigned to.

active
required
boolean
originalConnectorId
string

the optional original connector id for this connector

isAllowedOnAllLocations
boolean

if set to true, this connector may be used on devices which come from a different location of the customer than the one this connector is associated with. This is needed when the connector represents a system which aggregates data from different physical locations, e.g. via networks

Responses

Request samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "type": "4595bf66-18b2-445a-a884-1b08d0c2df0e",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "active": true,
  • "originalConnectorId": "string",
  • "isAllowedOnAllLocations": true
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "type": "4595bf66-18b2-445a-a884-1b08d0c2df0e",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "active": true,
  • "originalConnectorId": "string",
  • "isAllowedOnAllLocations": true,
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

Get all active SMA devices of a customer.

Get all active SMA devices that are assigned to a specific customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

Responses

Response samples

Content type
application/json
{ }

Create a new SMA device of a customer.

Create a new SMA device of a specific customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

Request Body schema: application/json
required
uuid
required
string <uuid>

unique identifier for this device

customer
required
string <uuid>

the customer this device belongs to

name
required
string

the name of the device.

nameAlias1
string

the name alias 1 for this device instance.

nameAlias2
string

the name alias 2for this device instance.

active
required
boolean

if the device is active or not

originalDeviceId
required
string

the id for this device in the context of the device - e.g. the ID in the supplier's system

connector
required
string

the id of the connector this device belongs to

location
required
string <uuid>

the location's uuid the device can be related to.

site
string or null <uuid>

the site's uuid the device can be related to.

required
object or null

optional configuration object for the device

deviceType
required
string

the type of device

deviceSubType
string or null

the subtype of device

Responses

Request samples

Content type
application/json
"{\n \"uuid\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"customer\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"name\": \"0001-1KF1234567\",\n \"active\": true,\n \"originalDeviceId\": \"1KF1234567\",\n \"connector\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"location\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"site\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"config\": {\n \"username\": \"mqtt-username\"\n },\n \"deviceType\": \"sma\",\n}\n"

Response samples

Content type
application/json
{
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

Get all SMA devices of a customer.

Get all SMA devices that are assigned to a specific customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

Responses

Response samples

Content type
application/json
{ }

Get an SMA device of a customer.

Get an SMA device that is assigned to a specific customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Responses

Response samples

Content type
application/json
{
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Responses

Response samples

Content type
application/json
{ }

Update an SMA device of a customer.

Update an SMA device of a specific customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Request Body schema: application/json
required
uuid
required
string <uuid>

unique identifier for this device

customer
required
string <uuid>

the customer this device belongs to

name
required
string

the name of the device.

nameAlias1
string

the name alias 1 for this device instance.

nameAlias2
string

the name alias 2for this device instance.

active
required
boolean

if the device is active or not

originalDeviceId
required
string

the id for this device in the context of the device - e.g. the ID in the supplier's system

connector
required
string

the id of the connector this device belongs to

location
required
string <uuid>

the location's uuid the device can be related to.

site
string or null <uuid>

the site's uuid the device can be related to.

required
object or null

optional configuration object for the device

deviceType
required
string

the type of device

deviceSubType
string or null

the subtype of device

Responses

Request samples

Content type
application/json
"{\n \"uuid\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"customer\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"name\": \"0001-1KF1234567\",\n \"active\": true,\n \"originalDeviceId\": \"1KF1234567\",\n \"connector\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"location\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"site\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"config\": {\n \"username\": \"mqtt-username\"\n },\n \"deviceType\": \"sma\",\n}\n"

Response samples

Content type
application/json
{
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

Get all active SMA datapoints of an SMA device.

Get all active SMA datapoints that are assigned to a specific SMA device.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Responses

Response samples

Content type
application/json
{ }

Create a new SMA datapoint for an SMA device of a customer.

Create a new SMA datapoint for an SMA device of a specific customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Request Body schema: application/json
required
uuid
required
string <uuid>

unique identifier for this datapoint.

name
required
string

the name of the datapoint.

nameAlias1
string

the name alias 1 for this datapoint instance.

nameAlias2
string

the name alias 2for this datapoint instance.

device
required
string <uuid>

the device's uuid the object is related to.

active
required
boolean

if the datapoint is active or not

originalDatapointId
required
string

the id for this datapoint in the context of the remote datapoint - e.g. the ID in the supplier's system

datapointSubType
required
string

the subtype of datapoint, how the supplier of the connector would call it

datapointType
required
string

the type of datapoint, usually matches the connector type key where this datapoint receives data from

customer
required
string <uuid>

the customer this datapoint belongs to

config
object or null
correctionFactor
number
category
required
string
Enum: "weather" "energy" "environment" "status" "recognition" "unknown"
measurementType
required
string
Enum: "unknown" "temperature" "humidity" "pressure" "co2" "voltage" "voltagep1" "voltagep2" "voltagep3" "current" "currentp1" "currentp2" "currentp3" "totalcurrent" "totalactivepower" "totalreactivepower" "totalapparentpower" "totalpowerfactor" "totalactiveenergy" "totalreactiveenergy" "totalapparentenergy" "activepowerp1" "activepowerp2" "activepowerp3" "reactivepowerp1" "reactivepowerp2" "reactivepowerp3" "apparentpowerp1" "apparentpowerp2" "apparentpowerp3" "cosphip1" "cosphip2" "cosphip3" "powerfactorp1" "powerfactorp2" "powerfactorp3" "frequenzyp1" "frequenzyp2" "frequenzyp3" "energyproduction" "energyconsumption" "energyexport" "energyselfconsumption" "energyimport" "powerproduction" "powerexport" "powerconsumption" "powerimport" "powerselfconsumption" "contact" "touch" "touchcount" "presence" "presencecount" "waterdetector" "motion" "occupancy" "weatherprecipitation" "weatherprecipitationduration" "weatherhumidity" "weathercglo" "weatherwindspeed" "weatherwindgustspeed" "weatherwindgusttimestamp" "weatherwindheading" "weatherwindgustheading" "weatherhumidityrelative" "weathertemperatureair" "weatherpressure" "weatherpressurereduced" "weathersnowheight" "weathersunshineduration" "weatherdewpoint" "weathertemperaturesoil10" "weathertemperaturesoil100" "weathertemperaturewater" "personcountinside" "personcountin" "personcountout" "vehiclecountinside" "vehiclecountin" "vehiclecountout" "licenseplate" "county"

Responses

Request samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "device": "8dca31e6-c85b-4a6b-bfb4-205d45d9b3bd",
  • "active": true,
  • "originalDatapointId": "string",
  • "datapointSubType": "string",
  • "datapointType": "string",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "config": { },
  • "correctionFactor": 0,
  • "category": "weather",
  • "measurementType": "unknown"
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "device": "8dca31e6-c85b-4a6b-bfb4-205d45d9b3bd",
  • "active": true,
  • "originalDatapointId": "string",
  • "datapointSubType": "string",
  • "datapointType": "string",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "config": { },
  • "correctionFactor": 0,
  • "category": "weather",
  • "measurementType": "unknown",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

Get all SMA datapoints for an SMA device of a customer.

Get all SMA datapoints that are assigned to a specific SMA device of a customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Responses

Response samples

Content type
application/json
{ }

Get an SMA datapoint for an SMA device of a customer.

Get an SMA datapoint that is assigned to a specific SMA device and customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

datapointId
required
string

id of the datapoint to get the data for

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "device": "8dca31e6-c85b-4a6b-bfb4-205d45d9b3bd",
  • "active": true,
  • "originalDatapointId": "string",
  • "datapointSubType": "string",
  • "datapointType": "string",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "config": { },
  • "correctionFactor": 0,
  • "category": "weather",
  • "measurementType": "unknown",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

datapointId
required
string

id of the datapoint to get the data for

Responses

Response samples

Content type
application/json
{ }

Update an SMA datapoint for an SMA device of a customer.

Update an SMA datapoint of a specific SMA device and customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

datapointId
required
string

id of the datapoint to get the data for

Request Body schema: application/json
required
uuid
required
string <uuid>

unique identifier for this datapoint.

name
required
string

the name of the datapoint.

nameAlias1
string

the name alias 1 for this datapoint instance.

nameAlias2
string

the name alias 2for this datapoint instance.

device
required
string <uuid>

the device's uuid the object is related to.

active
required
boolean

if the datapoint is active or not

originalDatapointId
required
string

the id for this datapoint in the context of the remote datapoint - e.g. the ID in the supplier's system

datapointSubType
required
string

the subtype of datapoint, how the supplier of the connector would call it

datapointType
required
string

the type of datapoint, usually matches the connector type key where this datapoint receives data from

customer
required
string <uuid>

the customer this datapoint belongs to

config
object or null
correctionFactor
number
category
required
string
Enum: "weather" "energy" "environment" "status" "recognition" "unknown"
measurementType
required
string
Enum: "unknown" "temperature" "humidity" "pressure" "co2" "voltage" "voltagep1" "voltagep2" "voltagep3" "current" "currentp1" "currentp2" "currentp3" "totalcurrent" "totalactivepower" "totalreactivepower" "totalapparentpower" "totalpowerfactor" "totalactiveenergy" "totalreactiveenergy" "totalapparentenergy" "activepowerp1" "activepowerp2" "activepowerp3" "reactivepowerp1" "reactivepowerp2" "reactivepowerp3" "apparentpowerp1" "apparentpowerp2" "apparentpowerp3" "cosphip1" "cosphip2" "cosphip3" "powerfactorp1" "powerfactorp2" "powerfactorp3" "frequenzyp1" "frequenzyp2" "frequenzyp3" "energyproduction" "energyconsumption" "energyexport" "energyselfconsumption" "energyimport" "powerproduction" "powerexport" "powerconsumption" "powerimport" "powerselfconsumption" "contact" "touch" "touchcount" "presence" "presencecount" "waterdetector" "motion" "occupancy" "weatherprecipitation" "weatherprecipitationduration" "weatherhumidity" "weathercglo" "weatherwindspeed" "weatherwindgustspeed" "weatherwindgusttimestamp" "weatherwindheading" "weatherwindgustheading" "weatherhumidityrelative" "weathertemperatureair" "weatherpressure" "weatherpressurereduced" "weathersnowheight" "weathersunshineduration" "weatherdewpoint" "weathertemperaturesoil10" "weathertemperaturesoil100" "weathertemperaturewater" "personcountinside" "personcountin" "personcountout" "vehiclecountinside" "vehiclecountin" "vehiclecountout" "licenseplate" "county"

Responses

Request samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "device": "8dca31e6-c85b-4a6b-bfb4-205d45d9b3bd",
  • "active": true,
  • "originalDatapointId": "string",
  • "datapointSubType": "string",
  • "datapointType": "string",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "config": { },
  • "correctionFactor": 0,
  • "category": "weather",
  • "measurementType": "unknown"
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "device": "8dca31e6-c85b-4a6b-bfb4-205d45d9b3bd",
  • "active": true,
  • "originalDatapointId": "string",
  • "datapointSubType": "string",
  • "datapointType": "string",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "config": { },
  • "correctionFactor": 0,
  • "category": "weather",
  • "measurementType": "unknown",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

Get an SMA AWS IoT thing for an SMA device of a customer.

Get an SMA AWS IoT thing that is assigned to a specific SMA device and customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "thingName": "string",
  • "active": true,
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "thingArn": "string",
  • "thingId": "string",
  • "username": "string",
  • "device": "8dca31e6-c85b-4a6b-bfb4-205d45d9b3bd",
  • "smaId": "string",
  • "adapterConfig": {
    }
}

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Responses

Response samples

Content type
application/json
{ }

get SMA Types to Unit Map

get SMA Types to Unit Map

Authorizations:
custom-auth

Responses

Response samples

Content type
application/json
{
  • "1": "W",
  • "2": "var",
  • "3": "VA"
}

for CORS

Authorizations:
custom-auth

Responses

Response samples

Content type
application/json
{ }

get SMA Units

get SMA Units

Authorizations:
custom-auth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth

Responses

Response samples

Content type
application/json
{ }

get SMADatapoint Types

get SMA Datapoint Types

Authorizations:
custom-auth

Responses

Response samples

Content type
application/json
"[\"voltageP1\", \"currentP1\"]\n"

for CORS

Authorizations:
custom-auth

Responses

Response samples

Content type
application/json
{ }

IotThing

Get an SMA AWS IoT thing for an SMA device of a customer.

Get an SMA AWS IoT thing that is assigned to a specific SMA device and customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "thingName": "string",
  • "active": true,
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "thingArn": "string",
  • "thingId": "string",
  • "username": "string",
  • "device": "8dca31e6-c85b-4a6b-bfb4-205d45d9b3bd",
  • "smaId": "string",
  • "adapterConfig": {
    }
}

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Responses

Response samples

Content type
application/json
{ }

Get a FLIC AWS IoT thing for a FLIC connector of a customer.

Get a FLIC AWS IoT thing for a FLIC connector of a customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

connectorId
required
string

id of the connector to get the data for

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "thingName": "string",
  • "active": true,
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "thingArn": "string",
  • "thingId": "string",
  • "username": "string",
  • "connector": "ae3e6c6f-6542-43ae-8e3b-4654639f6b5f",
  • "flicId": "string",
  • "adapterConfig": {
    }
}

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

connectorId
required
string

id of the connector to get the data for

Responses

Response samples

Content type
application/json
{ }

Datapoints

get SMADatapoint Types

get SMA Datapoint Types

Authorizations:
custom-auth

Responses

Response samples

Content type
application/json
"[\"voltageP1\", \"currentP1\"]\n"

SWARM

Get all active SWARM connectors of a customer's location.

Get all active SWARM connectors of a specific customer's location.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

strict
boolean

if set to true, only connectors directly associated with the given location will be returned; otherwise (defaul) also connectors which have "isAllowedOnAllLocation" will be returned, too

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

Responses

Response samples

Content type
application/json
{ }

Create SWARM connector for customer.

Create SWARM connector for customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

Request Body schema: application/json
required
uuid
required
string <uuid>

unique identifier for this connector

type
required
string <uuid>

the connector type's UUId the connector is an instance of.

name
required
string

the name for this Connector instance.

nameAlias1
string

the name alias 1 for this Connector instance.

nameAlias2
string

the name alias 2for this Connector instance.

location
required
string <uuid>

the location's UUId the connector is assigned to.

active
required
boolean
originalConnectorId
string

the optional original connector id for this connector

isAllowedOnAllLocations
boolean

if set to true, this connector may be used on devices which come from a different location of the customer than the one this connector is associated with. This is needed when the connector represents a system which aggregates data from different physical locations, e.g. via networks

required
object or null

Responses

Request samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "type": "4595bf66-18b2-445a-a884-1b08d0c2df0e",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "active": true,
  • "originalConnectorId": "string",
  • "isAllowedOnAllLocations": true,
  • "config": {
    }
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "type": "4595bf66-18b2-445a-a884-1b08d0c2df0e",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "active": true,
  • "originalConnectorId": "string",
  • "isAllowedOnAllLocations": true,
  • "config": {
    },
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

Get all SWARM connectors of a customer's location.

Get all SWARM connectors of a specific customer's location.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

strict
boolean

if set to true, only connectors directly associated with the given location will be returned; otherwise (defaul) also connectors which have "isAllowedOnAllLocation" will be returned, too

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

Responses

Response samples

Content type
application/json
{ }

Get SWARM connector of a customer's location.

Get SWARM connector of a specific customer's location.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

connectorId
required
string

id of the connector to get the data for

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "type": "4595bf66-18b2-445a-a884-1b08d0c2df0e",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "active": true,
  • "originalConnectorId": "string",
  • "isAllowedOnAllLocations": true,
  • "config": {
    },
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

connectorId
required
string

id of the connector to get the data for

Responses

Response samples

Content type
application/json
{ }

Update connector for customer's location.

Update connector for customer's location.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

connectorId
required
string

id of the connector to get the data for

Request Body schema: application/json
required
uuid
required
string <uuid>

unique identifier for this connector

type
required
string <uuid>

the connector type's UUId the connector is an instance of.

name
required
string

the name for this Connector instance.

nameAlias1
string

the name alias 1 for this Connector instance.

nameAlias2
string

the name alias 2for this Connector instance.

location
required
string <uuid>

the location's UUId the connector is assigned to.

active
required
boolean
originalConnectorId
string

the optional original connector id for this connector

isAllowedOnAllLocations
boolean

if set to true, this connector may be used on devices which come from a different location of the customer than the one this connector is associated with. This is needed when the connector represents a system which aggregates data from different physical locations, e.g. via networks

required
object or null

Responses

Request samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "type": "4595bf66-18b2-445a-a884-1b08d0c2df0e",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "active": true,
  • "originalConnectorId": "string",
  • "isAllowedOnAllLocations": true,
  • "config": {
    }
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "type": "4595bf66-18b2-445a-a884-1b08d0c2df0e",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "active": true,
  • "originalConnectorId": "string",
  • "isAllowedOnAllLocations": true,
  • "config": {
    },
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

Get all active SWARM devices of a customer.

Get all active SWARM devices that are assigned to a specific customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

Responses

Response samples

Content type
application/json
{ }

Create a new SWARM device of a customer.

Create a new SWARM device of a specific customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

Request Body schema: application/json
required
One of
uuid
required
string <uuid>

unique identifier for this device

customer
required
string <uuid>

the customer this device belongs to

name
required
string

the name of the device.

nameAlias1
string

the name alias 1 for this device instance.

nameAlias2
string

the name alias 2for this device instance.

active
required
boolean

if the device is active or not

originalDeviceId
required
string

the id for this device in the context of the device - e.g. the ID in the supplier's system

connector
required
string

the id of the connector this device belongs to

location
required
string <uuid>

the location's uuid the device can be related to.

site
string or null <uuid>

the site's uuid the device can be related to.

config
object or null

optional configuration object for the device

deviceType
required
string

the type of device

deviceSubType
string or null

the subtype of device

Responses

Request samples

Content type
application/json
Example
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "active": true,
  • "originalDeviceId": "string",
  • "connector": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "site": "862ae9eb-f0eb-41b6-b3e5-39fdd26ce81c",
  • "config": { },
  • "deviceType": "dt",
  • "deviceSubType": "temperature"
}

Response samples

Content type
application/json
Example
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "active": true,
  • "originalDeviceId": "string",
  • "connector": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "site": "862ae9eb-f0eb-41b6-b3e5-39fdd26ce81c",
  • "config": { },
  • "deviceType": "dt",
  • "deviceSubType": "temperature",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

Get all SWARM devices of a customer.

Get all SWARM devices that are assigned to a specific customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

Responses

Response samples

Content type
application/json
{ }

Get a SWARM device of a customer.

Get a SWARM device that is assigned to a specific customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Responses

Response samples

Content type
application/json
Example
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "active": true,
  • "originalDeviceId": "string",
  • "connector": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "site": "862ae9eb-f0eb-41b6-b3e5-39fdd26ce81c",
  • "config": { },
  • "deviceType": "dt",
  • "deviceSubType": "temperature",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Responses

Response samples

Content type
application/json
{ }

Update a SWARM device of a customer.

Update a SWARM device of a specific customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Request Body schema: application/json
required
One of
uuid
required
string <uuid>

unique identifier for this device

customer
required
string <uuid>

the customer this device belongs to

name
required
string

the name of the device.

nameAlias1
string

the name alias 1 for this device instance.

nameAlias2
string

the name alias 2for this device instance.

active
required
boolean

if the device is active or not

originalDeviceId
required
string

the id for this device in the context of the device - e.g. the ID in the supplier's system

connector
required
string

the id of the connector this device belongs to

location
required
string <uuid>

the location's uuid the device can be related to.

site
string or null <uuid>

the site's uuid the device can be related to.

config
object or null

optional configuration object for the device

deviceType
required
string

the type of device

deviceSubType
string or null

the subtype of device

Responses

Request samples

Content type
application/json
Example
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "active": true,
  • "originalDeviceId": "string",
  • "connector": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "site": "862ae9eb-f0eb-41b6-b3e5-39fdd26ce81c",
  • "config": { },
  • "deviceType": "dt",
  • "deviceSubType": "temperature"
}

Response samples

Content type
application/json
Example
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "active": true,
  • "originalDeviceId": "string",
  • "connector": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "site": "862ae9eb-f0eb-41b6-b3e5-39fdd26ce81c",
  • "config": { },
  • "deviceType": "dt",
  • "deviceSubType": "temperature",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

Get all active SWARM datapoints of a SWARM device.

Get all active SWARM datapoints that are assigned to a specific SWARM device.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Responses

Response samples

Content type
application/json
{ }

Create a new SWARM datapoint for an SWARM device of a customer.

Create a new SWARM datapoint for an SWARM device of a specific customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Request Body schema: application/json
required
uuid
required
string <uuid>

unique identifier for this datapoint.

name
required
string

the name of the datapoint.

nameAlias1
string

the name alias 1 for this datapoint instance.

nameAlias2
string

the name alias 2for this datapoint instance.

device
required
string <uuid>

the device's uuid the object is related to.

active
required
boolean

if the datapoint is active or not

originalDatapointId
required
string

the id for this datapoint in the context of the remote datapoint - e.g. the ID in the supplier's system

datapointType
required
string

the type of datapoint, usually matches the connector type key where this datapoint receives data from

customer
required
string <uuid>

the customer this datapoint belongs to

config
object or null
correctionFactor
number

Responses

Request samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "device": "8dca31e6-c85b-4a6b-bfb4-205d45d9b3bd",
  • "active": true,
  • "originalDatapointId": "string",
  • "datapointType": "string",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "config": { },
  • "correctionFactor": 0
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "device": "8dca31e6-c85b-4a6b-bfb4-205d45d9b3bd",
  • "active": true,
  • "originalDatapointId": "string",
  • "datapointSubType": "string",
  • "datapointType": "string",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "config": { },
  • "correctionFactor": 0,
  • "category": "weather",
  • "measurementType": "unknown",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

Get all SWARM datapoints for a SWARM device of a customer.

Get all SWARM datapoints that are assigned to a specific SWARM device of a customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Responses

Response samples

Content type
application/json
{ }

Get a SWARM datapoint for a SWARM device of a customer.

Get a SWARM datapoint that is assigned to a specific SWARM device and customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

datapointId
required
string

id of the datapoint to get the data for

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "device": "8dca31e6-c85b-4a6b-bfb4-205d45d9b3bd",
  • "active": true,
  • "originalDatapointId": "string",
  • "datapointSubType": "string",
  • "datapointType": "string",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "config": { },
  • "correctionFactor": 0,
  • "category": "weather",
  • "measurementType": "unknown",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

datapointId
required
string

id of the datapoint to get the data for

Responses

Response samples

Content type
application/json
{ }

Update a SWARM datapoint for a SWARM device of a customer.

Update a SWARM datapoint of a specific SWARM device and customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

datapointId
required
string

id of the datapoint to get the data for

Request Body schema: application/json
required
uuid
required
string <uuid>

unique identifier for this datapoint.

name
required
string

the name of the datapoint.

nameAlias1
string

the name alias 1 for this datapoint instance.

nameAlias2
string

the name alias 2for this datapoint instance.

device
required
string <uuid>

the device's uuid the object is related to.

active
required
boolean

if the datapoint is active or not

originalDatapointId
required
string

the id for this datapoint in the context of the remote datapoint - e.g. the ID in the supplier's system

datapointType
required
string

the type of datapoint, usually matches the connector type key where this datapoint receives data from

customer
required
string <uuid>

the customer this datapoint belongs to

config
object or null
correctionFactor
number

Responses

Request samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "device": "8dca31e6-c85b-4a6b-bfb4-205d45d9b3bd",
  • "active": true,
  • "originalDatapointId": "string",
  • "datapointType": "string",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "config": { },
  • "correctionFactor": 0
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "device": "8dca31e6-c85b-4a6b-bfb4-205d45d9b3bd",
  • "active": true,
  • "originalDatapointId": "string",
  • "datapointSubType": "string",
  • "datapointType": "string",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "config": { },
  • "correctionFactor": 0,
  • "category": "weather",
  • "measurementType": "unknown",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

WEATHER

Get all active WEATHER connectors of a customer's location.

Get all active WEATHER connectors of a specific customer's location.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

strict
boolean

if set to true, only connectors directly associated with the given location will be returned; otherwise (defaul) also connectors which have "isAllowedOnAllLocation" will be returned, too

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

Responses

Response samples

Content type
application/json
{ }

Create WEATHER connector for customer.

Create WEATHER connector for customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

Request Body schema: application/json
required
uuid
required
string <uuid>

unique identifier for this connector

type
required
string <uuid>

the connector type's UUId the connector is an instance of.

name
required
string

the name for this Connector instance.

nameAlias1
string

the name alias 1 for this Connector instance.

nameAlias2
string

the name alias 2for this Connector instance.

location
required
string <uuid>

the location's UUId the connector is assigned to.

active
required
boolean
originalConnectorId
string

the optional original connector id for this connector

isAllowedOnAllLocations
boolean

if set to true, this connector may be used on devices which come from a different location of the customer than the one this connector is associated with. This is needed when the connector represents a system which aggregates data from different physical locations, e.g. via networks

Responses

Request samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "type": "4595bf66-18b2-445a-a884-1b08d0c2df0e",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "active": true,
  • "originalConnectorId": "string",
  • "isAllowedOnAllLocations": true
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "type": "4595bf66-18b2-445a-a884-1b08d0c2df0e",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "active": true,
  • "originalConnectorId": "string",
  • "isAllowedOnAllLocations": true,
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

Get all WEATHER connectors of a customer's location.

Get all WEATHER connectors of a specific customer's location.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

strict
boolean

if set to true, only connectors directly associated with the given location will be returned; otherwise (defaul) also connectors which have "isAllowedOnAllLocation" will be returned, too

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

Responses

Response samples

Content type
application/json
{ }

Get WEATHER connector of a customer's location.

Get WEATHER connector of a specific customer's location.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

connectorId
required
string

id of the connector to get the data for

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "type": "4595bf66-18b2-445a-a884-1b08d0c2df0e",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "active": true,
  • "originalConnectorId": "string",
  • "isAllowedOnAllLocations": true,
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

connectorId
required
string

id of the connector to get the data for

Responses

Response samples

Content type
application/json
{ }

Update connector for customer's location.

Update connector for customer's location.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

connectorId
required
string

id of the connector to get the data for

Request Body schema: application/json
required
uuid
required
string <uuid>

unique identifier for this connector

type
required
string <uuid>

the connector type's UUId the connector is an instance of.

name
required
string

the name for this Connector instance.

nameAlias1
string

the name alias 1 for this Connector instance.

nameAlias2
string

the name alias 2for this Connector instance.

location
required
string <uuid>

the location's UUId the connector is assigned to.

active
required
boolean
originalConnectorId
string

the optional original connector id for this connector

isAllowedOnAllLocations
boolean

if set to true, this connector may be used on devices which come from a different location of the customer than the one this connector is associated with. This is needed when the connector represents a system which aggregates data from different physical locations, e.g. via networks

Responses

Request samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "type": "4595bf66-18b2-445a-a884-1b08d0c2df0e",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "active": true,
  • "originalConnectorId": "string",
  • "isAllowedOnAllLocations": true
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "type": "4595bf66-18b2-445a-a884-1b08d0c2df0e",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "active": true,
  • "originalConnectorId": "string",
  • "isAllowedOnAllLocations": true,
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

Get all active WEATHER devices of a customer.

Get all active WEATHER devices that are assigned to a specific customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

Responses

Response samples

Content type
application/json
{ }

Create a new WEATHER device of a customer.

Create a new WEATHER device of a specific customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

Request Body schema: application/json
required
One of
uuid
required
string <uuid>

unique identifier for this device

customer
required
string <uuid>

the customer this device belongs to

name
required
string

the name of the device.

nameAlias1
string

the name alias 1 for this device instance.

nameAlias2
string

the name alias 2for this device instance.

active
required
boolean

if the device is active or not

originalDeviceId
required
string

the id for this device in the context of the device - e.g. the ID in the supplier's system

connector
required
string

the id of the connector this device belongs to

location
required
string <uuid>

the location's uuid the device can be related to.

site
string or null <uuid>

the site's uuid the device can be related to.

config
object or null

optional configuration object for the device

deviceType
required
string

the type of device

deviceSubType
string or null

the subtype of device

modifiedAt
required
string <date-time>
required
object (uiUserInfo)
createdAt
required
string <date-time>
required
object (uiUserInfo)

Responses

Request samples

Content type
application/json
Example
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "active": true,
  • "originalDeviceId": "string",
  • "connector": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "site": "862ae9eb-f0eb-41b6-b3e5-39fdd26ce81c",
  • "config": { },
  • "deviceType": "dt",
  • "deviceSubType": "temperature",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

Response samples

Content type
application/json
Example
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "active": true,
  • "originalDeviceId": "string",
  • "connector": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "site": "862ae9eb-f0eb-41b6-b3e5-39fdd26ce81c",
  • "config": { },
  • "deviceType": "dt",
  • "deviceSubType": "temperature",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

Get all WEATHER devices of a customer.

Get all WEATHER devices that are assigned to a specific customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

Responses

Response samples

Content type
application/json
{ }

Get a WEATHER device of a customer.

Get a WEATHER device that is assigned to a specific customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Responses

Response samples

Content type
application/json
Example
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "active": true,
  • "originalDeviceId": "string",
  • "connector": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "site": "862ae9eb-f0eb-41b6-b3e5-39fdd26ce81c",
  • "config": { },
  • "deviceType": "dt",
  • "deviceSubType": "temperature",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Responses

Response samples

Content type
application/json
{ }

Update a WEATHER device of a customer.

Update a WEATHER device of a specific customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Request Body schema: application/json
required
One of
uuid
required
string <uuid>

unique identifier for this device

customer
required
string <uuid>

the customer this device belongs to

name
required
string

the name of the device.

nameAlias1
string

the name alias 1 for this device instance.

nameAlias2
string

the name alias 2for this device instance.

active
required
boolean

if the device is active or not

originalDeviceId
required
string

the id for this device in the context of the device - e.g. the ID in the supplier's system

connector
required
string

the id of the connector this device belongs to

location
required
string <uuid>

the location's uuid the device can be related to.

site
string or null <uuid>

the site's uuid the device can be related to.

config
object or null

optional configuration object for the device

deviceType
required
string

the type of device

deviceSubType
string or null

the subtype of device

modifiedAt
required
string <date-time>
required
object (uiUserInfo)
createdAt
required
string <date-time>
required
object (uiUserInfo)

Responses

Request samples

Content type
application/json
Example
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "active": true,
  • "originalDeviceId": "string",
  • "connector": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "site": "862ae9eb-f0eb-41b6-b3e5-39fdd26ce81c",
  • "config": { },
  • "deviceType": "dt",
  • "deviceSubType": "temperature",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

Response samples

Content type
application/json
Example
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "active": true,
  • "originalDeviceId": "string",
  • "connector": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "site": "862ae9eb-f0eb-41b6-b3e5-39fdd26ce81c",
  • "config": { },
  • "deviceType": "dt",
  • "deviceSubType": "temperature",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

Get all active WEATHER datapoints of a WEATHER device.

Get all active WEATHER datapoints that are assigned to a specific WEATHER device.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Responses

Response samples

Content type
application/json
{ }

Create a new WEATHER datapoint for an WEATHER device of a customer.

Create a new WEATHER datapoint for an WEATHER device of a specific customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Request Body schema: application/json
required
uuid
required
string <uuid>

unique identifier for this datapoint.

name
required
string

the name of the datapoint.

nameAlias1
string

the name alias 1 for this datapoint instance.

nameAlias2
string

the name alias 2for this datapoint instance.

device
required
string <uuid>

the device's uuid the object is related to.

active
required
boolean

if the datapoint is active or not

originalDatapointId
required
string

the id for this datapoint in the context of the remote datapoint - e.g. the ID in the supplier's system

datapointType
required
string

the type of datapoint, usually matches the connector type key where this datapoint receives data from

customer
required
string <uuid>

the customer this datapoint belongs to

config
object or null
correctionFactor
number

Responses

Request samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "device": "8dca31e6-c85b-4a6b-bfb4-205d45d9b3bd",
  • "active": true,
  • "originalDatapointId": "string",
  • "datapointType": "string",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "config": { },
  • "correctionFactor": 0
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "device": "8dca31e6-c85b-4a6b-bfb4-205d45d9b3bd",
  • "active": true,
  • "originalDatapointId": "string",
  • "datapointSubType": "string",
  • "datapointType": "string",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "config": { },
  • "correctionFactor": 0,
  • "category": "weather",
  • "measurementType": "unknown",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

Get all WEATHER datapoints for a WEATHER device of a customer.

Get all WEATHER datapoints that are assigned to a specific WEATHER device of a customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Responses

Response samples

Content type
application/json
{ }

Get a WEATHER datapoint for a WEATHER device of a customer.

Get a WEATHER datapoint that is assigned to a specific WEATHER device and customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

datapointId
required
string

id of the datapoint to get the data for

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "device": "8dca31e6-c85b-4a6b-bfb4-205d45d9b3bd",
  • "active": true,
  • "originalDatapointId": "string",
  • "datapointSubType": "string",
  • "datapointType": "string",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "config": { },
  • "correctionFactor": 0,
  • "category": "weather",
  • "measurementType": "unknown",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

datapointId
required
string

id of the datapoint to get the data for

Responses

Response samples

Content type
application/json
{ }

Update a WEATHER datapoint for a WEATHER device of a customer.

Update a WEATHER datapoint of a specific WEATHER device and customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

datapointId
required
string

id of the datapoint to get the data for

Request Body schema: application/json
required
uuid
required
string <uuid>

unique identifier for this datapoint.

name
required
string

the name of the datapoint.

nameAlias1
string

the name alias 1 for this datapoint instance.

nameAlias2
string

the name alias 2for this datapoint instance.

device
required
string <uuid>

the device's uuid the object is related to.

active
required
boolean

if the datapoint is active or not

originalDatapointId
required
string

the id for this datapoint in the context of the remote datapoint - e.g. the ID in the supplier's system

datapointType
required
string

the type of datapoint, usually matches the connector type key where this datapoint receives data from

customer
required
string <uuid>

the customer this datapoint belongs to

config
object or null
correctionFactor
number

Responses

Request samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "device": "8dca31e6-c85b-4a6b-bfb4-205d45d9b3bd",
  • "active": true,
  • "originalDatapointId": "string",
  • "datapointType": "string",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "config": { },
  • "correctionFactor": 0
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "device": "8dca31e6-c85b-4a6b-bfb4-205d45d9b3bd",
  • "active": true,
  • "originalDatapointId": "string",
  • "datapointSubType": "string",
  • "datapointType": "string",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "config": { },
  • "correctionFactor": 0,
  • "category": "weather",
  • "measurementType": "unknown",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

WEATHERSITE

Get all active WEATHERSITE connectors of a customer's location.

Get all active WEATHERSITE connectors of a specific customer's location.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

strict
boolean

if set to true, only connectors directly associated with the given location will be returned; otherwise (defaul) also connectors which have "isAllowedOnAllLocation" will be returned, too

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

Responses

Response samples

Content type
application/json
{ }

Create WEATHERSITE connector for customer.

Create WEATHERSITE connector for customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

Request Body schema: application/json
required
uuid
required
string <uuid>

unique identifier for this connector

type
required
string <uuid>

the connector type's UUId the connector is an instance of.

name
required
string

the name for this Connector instance.

nameAlias1
string

the name alias 1 for this Connector instance.

nameAlias2
string

the name alias 2for this Connector instance.

location
required
string <uuid>

the location's UUId the connector is assigned to.

active
required
boolean
originalConnectorId
string

the optional original connector id for this connector

isAllowedOnAllLocations
boolean

if set to true, this connector may be used on devices which come from a different location of the customer than the one this connector is associated with. This is needed when the connector represents a system which aggregates data from different physical locations, e.g. via networks

required
object or null

Responses

Request samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "type": "4595bf66-18b2-445a-a884-1b08d0c2df0e",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "active": true,
  • "originalConnectorId": "string",
  • "isAllowedOnAllLocations": true,
  • "config": {
    }
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "type": "4595bf66-18b2-445a-a884-1b08d0c2df0e",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "active": true,
  • "originalConnectorId": "string",
  • "isAllowedOnAllLocations": true,
  • "config": {
    }
}

Get all WEATHERSITE connectors of a customer's location.

Get all WEATHERSITE connectors of a specific customer's location.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

strict
boolean

if set to true, only connectors directly associated with the given location will be returned; otherwise (defaul) also connectors which have "isAllowedOnAllLocation" will be returned, too

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

Responses

Response samples

Content type
application/json
{ }

Get WEATHERSITE connector of a customer's location.

Get WEATHERSITE connector of a specific customer's location.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

connectorId
required
string

id of the connector to get the data for

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "type": "4595bf66-18b2-445a-a884-1b08d0c2df0e",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "active": true,
  • "originalConnectorId": "string",
  • "isAllowedOnAllLocations": true,
  • "config": {
    }
}

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

connectorId
required
string

id of the connector to get the data for

Responses

Response samples

Content type
application/json
{ }

Update connector for customer's location.

Update connector for customer's location.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

connectorId
required
string

id of the connector to get the data for

Request Body schema: application/json
required
uuid
required
string <uuid>

unique identifier for this connector

type
required
string <uuid>

the connector type's UUId the connector is an instance of.

name
required
string

the name for this Connector instance.

nameAlias1
string

the name alias 1 for this Connector instance.

nameAlias2
string

the name alias 2for this Connector instance.

location
required
string <uuid>

the location's UUId the connector is assigned to.

active
required
boolean
originalConnectorId
string

the optional original connector id for this connector

isAllowedOnAllLocations
boolean

if set to true, this connector may be used on devices which come from a different location of the customer than the one this connector is associated with. This is needed when the connector represents a system which aggregates data from different physical locations, e.g. via networks

required
object or null

Responses

Request samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "type": "4595bf66-18b2-445a-a884-1b08d0c2df0e",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "active": true,
  • "originalConnectorId": "string",
  • "isAllowedOnAllLocations": true,
  • "config": {
    }
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "type": "4595bf66-18b2-445a-a884-1b08d0c2df0e",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "active": true,
  • "originalConnectorId": "string",
  • "isAllowedOnAllLocations": true,
  • "config": {
    }
}

Get all active WEATHERSITE devices of a customer.

Get all active WEATHERSITE devices that are assigned to a specific customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

Responses

Response samples

Content type
application/json
{ }

Create a new WEATHERSITE device of a customer.

Create a new WEATHERSITE device of a specific customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

Request Body schema: application/json
required
One of
uuid
required
string <uuid>

unique identifier for this device

customer
required
string <uuid>

the customer this device belongs to

name
required
string

the name of the device.

nameAlias1
string

the name alias 1 for this device instance.

nameAlias2
string

the name alias 2for this device instance.

active
required
boolean

if the device is active or not

originalDeviceId
required
string

the id for this device in the context of the device - e.g. the ID in the supplier's system

connector
required
string

the id of the connector this device belongs to

location
required
string <uuid>

the location's uuid the device can be related to.

site
string or null <uuid>

the site's uuid the device can be related to.

config
object or null

optional configuration object for the device

deviceType
required
string

the type of device

deviceSubType
string or null

the subtype of device

modifiedAt
required
string <date-time>
required
object (uiUserInfo)
createdAt
required
string <date-time>
required
object (uiUserInfo)

Responses

Request samples

Content type
application/json
Example
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "active": true,
  • "originalDeviceId": "string",
  • "connector": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "site": "862ae9eb-f0eb-41b6-b3e5-39fdd26ce81c",
  • "config": { },
  • "deviceType": "dt",
  • "deviceSubType": "temperature",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

Response samples

Content type
application/json
Example
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "active": true,
  • "originalDeviceId": "string",
  • "connector": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "site": "862ae9eb-f0eb-41b6-b3e5-39fdd26ce81c",
  • "config": { },
  • "deviceType": "dt",
  • "deviceSubType": "temperature",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

Get all WEATHERSITE devices of a customer.

Get all WEATHERSITE devices that are assigned to a specific customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

Responses

Response samples

Content type
application/json
{ }

Get a WEATHERSITE device of a customer.

Get a WEATHERSITE device that is assigned to a specific customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Responses

Response samples

Content type
application/json
Example
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "active": true,
  • "originalDeviceId": "string",
  • "connector": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "site": "862ae9eb-f0eb-41b6-b3e5-39fdd26ce81c",
  • "config": { },
  • "deviceType": "dt",
  • "deviceSubType": "temperature",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Responses

Response samples

Content type
application/json
{ }

Update a WEATHERSITE device of a customer.

Update a WEATHERSITE device of a specific customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Request Body schema: application/json
required
One of
uuid
required
string <uuid>

unique identifier for this device

customer
required
string <uuid>

the customer this device belongs to

name
required
string

the name of the device.

nameAlias1
string

the name alias 1 for this device instance.

nameAlias2
string

the name alias 2for this device instance.

active
required
boolean

if the device is active or not

originalDeviceId
required
string

the id for this device in the context of the device - e.g. the ID in the supplier's system

connector
required
string

the id of the connector this device belongs to

location
required
string <uuid>

the location's uuid the device can be related to.

site
string or null <uuid>

the site's uuid the device can be related to.

config
object or null

optional configuration object for the device

deviceType
required
string

the type of device

deviceSubType
string or null

the subtype of device

modifiedAt
required
string <date-time>
required
object (uiUserInfo)
createdAt
required
string <date-time>
required
object (uiUserInfo)

Responses

Request samples

Content type
application/json
Example
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "active": true,
  • "originalDeviceId": "string",
  • "connector": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "site": "862ae9eb-f0eb-41b6-b3e5-39fdd26ce81c",
  • "config": { },
  • "deviceType": "dt",
  • "deviceSubType": "temperature",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

Response samples

Content type
application/json
Example
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "active": true,
  • "originalDeviceId": "string",
  • "connector": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "site": "862ae9eb-f0eb-41b6-b3e5-39fdd26ce81c",
  • "config": { },
  • "deviceType": "dt",
  • "deviceSubType": "temperature",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

Get all active WEATHERSITE datapoints of a WEATHERSITE device.

Get all active WEATHERSITE datapoints that are assigned to a specific WEATHERSITE device.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Responses

Response samples

Content type
application/json
{ }

Create a new WEATHERSITE datapoint for an WEATHERSITE device of a customer.

Create a new WEATHERSITE datapoint for an WEATHERSITE device of a specific customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Request Body schema: application/json
required
uuid
required
string <uuid>

unique identifier for this datapoint.

name
required
string

the name of the datapoint.

nameAlias1
string

the name alias 1 for this datapoint instance.

nameAlias2
string

the name alias 2for this datapoint instance.

device
required
string <uuid>

the device's uuid the object is related to.

active
required
boolean

if the datapoint is active or not

originalDatapointId
required
string

the id for this datapoint in the context of the remote datapoint - e.g. the ID in the supplier's system

datapointType
required
string

the type of datapoint, usually matches the connector type key where this datapoint receives data from

customer
required
string <uuid>

the customer this datapoint belongs to

config
object or null
correctionFactor
number

Responses

Request samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "device": "8dca31e6-c85b-4a6b-bfb4-205d45d9b3bd",
  • "active": true,
  • "originalDatapointId": "string",
  • "datapointType": "string",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "config": { },
  • "correctionFactor": 0
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "device": "8dca31e6-c85b-4a6b-bfb4-205d45d9b3bd",
  • "active": true,
  • "originalDatapointId": "string",
  • "datapointSubType": "string",
  • "datapointType": "string",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "config": { },
  • "correctionFactor": 0,
  • "category": "weather",
  • "measurementType": "unknown",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

Get all WEATHERSITE datapoints for a WEATHERSITE device of a customer.

Get all WEATHERSITE datapoints that are assigned to a specific WEATHERSITE device of a customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Responses

Response samples

Content type
application/json
{ }

Get a WEATHERSITE datapoint for a WEATHERSITE device of a customer.

Get a WEATHERSITE datapoint that is assigned to a specific WEATHERSITE device and customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

datapointId
required
string

id of the datapoint to get the data for

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "device": "8dca31e6-c85b-4a6b-bfb4-205d45d9b3bd",
  • "active": true,
  • "originalDatapointId": "string",
  • "datapointSubType": "string",
  • "datapointType": "string",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "config": { },
  • "correctionFactor": 0,
  • "category": "weather",
  • "measurementType": "unknown",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

datapointId
required
string

id of the datapoint to get the data for

Responses

Response samples

Content type
application/json
{ }

Update a WEATHERSITE datapoint for a WEATHERSITE device of a customer.

Update a WEATHERSITE datapoint of a specific WEATHERSITE device and customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

datapointId
required
string

id of the datapoint to get the data for

Request Body schema: application/json
required
uuid
required
string <uuid>

unique identifier for this datapoint.

name
required
string

the name of the datapoint.

nameAlias1
string

the name alias 1 for this datapoint instance.

nameAlias2
string

the name alias 2for this datapoint instance.

device
required
string <uuid>

the device's uuid the object is related to.

active
required
boolean

if the datapoint is active or not

originalDatapointId
required
string

the id for this datapoint in the context of the remote datapoint - e.g. the ID in the supplier's system

datapointType
required
string

the type of datapoint, usually matches the connector type key where this datapoint receives data from

customer
required
string <uuid>

the customer this datapoint belongs to

config
object or null
correctionFactor
number

Responses

Request samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "device": "8dca31e6-c85b-4a6b-bfb4-205d45d9b3bd",
  • "active": true,
  • "originalDatapointId": "string",
  • "datapointType": "string",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "config": { },
  • "correctionFactor": 0
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "device": "8dca31e6-c85b-4a6b-bfb4-205d45d9b3bd",
  • "active": true,
  • "originalDatapointId": "string",
  • "datapointSubType": "string",
  • "datapointType": "string",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "config": { },
  • "correctionFactor": 0,
  • "category": "weather",
  • "measurementType": "unknown",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

SOLAREDGE

Get all active SOLAREDGE connectors of a customer's location.

Get all active SOLAREDGE connectors of a specific customer's location.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

strict
boolean

if set to true, only connectors directly associated with the given location will be returned; otherwise (defaul) also connectors which have "isAllowedOnAllLocation" will be returned, too

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

Responses

Response samples

Content type
application/json
{ }

Create SOLAREDGE connector for customer.

Create SOLAREDGE connector for customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

Request Body schema: application/json
required
uuid
required
string <uuid>

unique identifier for this connector

type
required
string <uuid>

the connector type's UUId the connector is an instance of.

name
required
string

the name for this Connector instance.

nameAlias1
string

the name alias 1 for this Connector instance.

nameAlias2
string

the name alias 2for this Connector instance.

location
required
string <uuid>

the location's UUId the connector is assigned to.

active
required
boolean
originalConnectorId
required
string

the optional original connector id for this connector

isAllowedOnAllLocations
boolean

if set to true, this connector may be used on devices which come from a different location of the customer than the one this connector is associated with. This is needed when the connector represents a system which aggregates data from different physical locations, e.g. via networks

required
object or null

Responses

Request samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "type": "4595bf66-18b2-445a-a884-1b08d0c2df0e",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "active": true,
  • "originalConnectorId": "string",
  • "isAllowedOnAllLocations": true,
  • "config": {
    }
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "type": "4595bf66-18b2-445a-a884-1b08d0c2df0e",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "active": true,
  • "originalConnectorId": "string",
  • "isAllowedOnAllLocations": true,
  • "config": {
    },
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

Get all SOLAREDGE connectors of a customer's location.

Get all SOLAREDGE connectors of a specific customer's location.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

strict
boolean

if set to true, only connectors directly associated with the given location will be returned; otherwise (defaul) also connectors which have "isAllowedOnAllLocation" will be returned, too

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

Responses

Response samples

Content type
application/json
{ }

Get SOLAREDGE connector of a customer's location.

Get SOLAREDGE connector of a specific customer's location.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

connectorId
required
string

id of the connector to get the data for

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "type": "4595bf66-18b2-445a-a884-1b08d0c2df0e",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "active": true,
  • "originalConnectorId": "string",
  • "isAllowedOnAllLocations": true,
  • "config": {
    },
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

connectorId
required
string

id of the connector to get the data for

Responses

Response samples

Content type
application/json
{ }

Update connector for customer's location.

Update connector for customer's location.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

connectorId
required
string

id of the connector to get the data for

Request Body schema: application/json
required
uuid
required
string <uuid>

unique identifier for this connector

type
required
string <uuid>

the connector type's UUId the connector is an instance of.

name
required
string

the name for this Connector instance.

nameAlias1
string

the name alias 1 for this Connector instance.

nameAlias2
string

the name alias 2for this Connector instance.

location
required
string <uuid>

the location's UUId the connector is assigned to.

active
required
boolean
originalConnectorId
required
string

the optional original connector id for this connector

isAllowedOnAllLocations
boolean

if set to true, this connector may be used on devices which come from a different location of the customer than the one this connector is associated with. This is needed when the connector represents a system which aggregates data from different physical locations, e.g. via networks

required
object or null

Responses

Request samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "type": "4595bf66-18b2-445a-a884-1b08d0c2df0e",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "active": true,
  • "originalConnectorId": "string",
  • "isAllowedOnAllLocations": true,
  • "config": {
    }
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "type": "4595bf66-18b2-445a-a884-1b08d0c2df0e",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "active": true,
  • "originalConnectorId": "string",
  • "isAllowedOnAllLocations": true,
  • "config": {
    },
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

Get all active SOLAREDGE devices of a customer.

Get all active SOLAREDGE devices that are assigned to a specific customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

Responses

Response samples

Content type
application/json
{ }

Create a new SOLAREDGE device of a customer.

Create a new SOLAREDGE device of a specific customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

Request Body schema: application/json
required
uuid
required
string <uuid>

unique identifier for this device

customer
required
string <uuid>

the customer this device belongs to

name
required
string

the name of the device.

nameAlias1
string

the name alias 1 for this device instance.

nameAlias2
string

the name alias 2for this device instance.

active
required
boolean

if the device is active or not

originalDeviceId
required
string

the id for this device in the context of the device - e.g. the ID in the supplier's system

connector
required
string

the id of the connector this device belongs to

location
required
string <uuid>

the location's uuid the device can be related to.

site
string or null <uuid>

the site's uuid the device can be related to.

required
object or null

optional configuration object for the device

deviceType
required
string

the type of device

deviceSubType
string or null

the subtype of device

Responses

Request samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "active": true,
  • "originalDeviceId": "string",
  • "connector": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "site": "862ae9eb-f0eb-41b6-b3e5-39fdd26ce81c",
  • "config": {
    },
  • "deviceType": "dt",
  • "deviceSubType": "temperature"
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "active": true,
  • "originalDeviceId": "string",
  • "connector": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "site": "862ae9eb-f0eb-41b6-b3e5-39fdd26ce81c",
  • "config": {
    },
  • "deviceType": "dt",
  • "deviceSubType": "temperature",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

Get all SOLAREDGE devices of a customer.

Get all SOLAREDGE devices that are assigned to a specific customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

Responses

Response samples

Content type
application/json
{ }

Get a SOLAREDGE device of a customer.

Get a SOLAREDGE device that is assigned to a specific customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "active": true,
  • "originalDeviceId": "string",
  • "connector": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "site": "862ae9eb-f0eb-41b6-b3e5-39fdd26ce81c",
  • "config": {
    },
  • "deviceType": "dt",
  • "deviceSubType": "temperature",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Responses

Response samples

Content type
application/json
{ }

Update a SOLAREDGE device of a customer.

Update a SOLAREDGE device of a specific customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Request Body schema: application/json
required
uuid
required
string <uuid>

unique identifier for this device

customer
required
string <uuid>

the customer this device belongs to

name
required
string

the name of the device.

nameAlias1
string

the name alias 1 for this device instance.

nameAlias2
string

the name alias 2for this device instance.

active
required
boolean

if the device is active or not

originalDeviceId
required
string

the id for this device in the context of the device - e.g. the ID in the supplier's system

connector
required
string

the id of the connector this device belongs to

location
required
string <uuid>

the location's uuid the device can be related to.

site
string or null <uuid>

the site's uuid the device can be related to.

required
object or null

optional configuration object for the device

deviceType
required
string

the type of device

deviceSubType
string or null

the subtype of device

Responses

Request samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "active": true,
  • "originalDeviceId": "string",
  • "connector": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "site": "862ae9eb-f0eb-41b6-b3e5-39fdd26ce81c",
  • "config": {
    },
  • "deviceType": "dt",
  • "deviceSubType": "temperature"
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "active": true,
  • "originalDeviceId": "string",
  • "connector": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "site": "862ae9eb-f0eb-41b6-b3e5-39fdd26ce81c",
  • "config": {
    },
  • "deviceType": "dt",
  • "deviceSubType": "temperature",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

Get all active SOLAREDGE datapoints of a SOLAREDGE device.

Get all active SOLAREDGE datapoints that are assigned to a specific SOLAREDGE device.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Responses

Response samples

Content type
application/json
{ }

Create a new SOLAREDGE datapoint for an SOLAREDGE device of a customer.

Create a new SOLAREDGE datapoint for an SOLAREDGE device of a specific customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Request Body schema: application/json
required
uuid
required
string <uuid>

unique identifier for this datapoint.

name
required
string

the name of the datapoint.

nameAlias1
string

the name alias 1 for this datapoint instance.

nameAlias2
string

the name alias 2for this datapoint instance.

device
required
string <uuid>

the device's uuid the object is related to.

active
required
boolean

if the datapoint is active or not

originalDatapointId
required
string
Enum: "powerConsumption" "powerProduction" "powerSelfConsumption" "powerExport" "powerImport" "energyConsumption" "energyProduction" "energySelfConsumption" "energyExport" "energyImport"

the id for this datapoint in the context of the remote datapoint - e.g. the ID in the supplier's system

datapointSubType
required
string
Enum: "powerConsumption" "powerProduction" "powerSelfConsumption" "powerExport" "powerImport" "energyConsumption" "energyProduction" "energySelfConsumption" "energyExport" "energyImport"

the subtype of datapoint, how the supplier of the connector would call it

datapointType
required
string

the type of datapoint, usually matches the connector type key where this datapoint receives data from

customer
required
string <uuid>

the customer this datapoint belongs to

config
object or null
correctionFactor
number
category
required
string
Enum: "weather" "energy" "environment" "status" "recognition" "unknown"
measurementType
required
string
Enum: "unknown" "temperature" "humidity" "pressure" "co2" "voltage" "voltagep1" "voltagep2" "voltagep3" "current" "currentp1" "currentp2" "currentp3" "totalcurrent" "totalactivepower" "totalreactivepower" "totalapparentpower" "totalpowerfactor" "totalactiveenergy" "totalreactiveenergy" "totalapparentenergy" "activepowerp1" "activepowerp2" "activepowerp3" "reactivepowerp1" "reactivepowerp2" "reactivepowerp3" "apparentpowerp1" "apparentpowerp2" "apparentpowerp3" "cosphip1" "cosphip2" "cosphip3" "powerfactorp1" "powerfactorp2" "powerfactorp3" "frequenzyp1" "frequenzyp2" "frequenzyp3" "energyproduction" "energyconsumption" "energyexport" "energyselfconsumption" "energyimport" "powerproduction" "powerexport" "powerconsumption" "powerimport" "powerselfconsumption" "contact" "touch" "touchcount" "presence" "presencecount" "waterdetector" "motion" "occupancy" "weatherprecipitation" "weatherprecipitationduration" "weatherhumidity" "weathercglo" "weatherwindspeed" "weatherwindgustspeed" "weatherwindgusttimestamp" "weatherwindheading" "weatherwindgustheading" "weatherhumidityrelative" "weathertemperatureair" "weatherpressure" "weatherpressurereduced" "weathersnowheight" "weathersunshineduration" "weatherdewpoint" "weathertemperaturesoil10" "weathertemperaturesoil100" "weathertemperaturewater" "personcountinside" "personcountin" "personcountout" "vehiclecountinside" "vehiclecountin" "vehiclecountout" "licenseplate" "county"

Responses

Request samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "device": "8dca31e6-c85b-4a6b-bfb4-205d45d9b3bd",
  • "active": true,
  • "originalDatapointId": "powerConsumption",
  • "datapointSubType": "powerConsumption",
  • "datapointType": "string",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "config": { },
  • "correctionFactor": 0,
  • "category": "weather",
  • "measurementType": "unknown"
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "device": "8dca31e6-c85b-4a6b-bfb4-205d45d9b3bd",
  • "active": true,
  • "originalDatapointId": "powerConsumption",
  • "datapointSubType": "powerConsumption",
  • "datapointType": "string",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "config": { },
  • "correctionFactor": 0,
  • "category": "weather",
  • "measurementType": "unknown",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

Get all SOLAREDGE datapoints for a SOLAREDGE device of a customer.

Get all SOLAREDGE datapoints that are assigned to a specific SOLAREDGE device of a customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Responses

Response samples

Content type
application/json
{ }

Get a SOLAREDGE datapoint for a SOLAREDGE device of a customer.

Get a SOLAREDGE datapoint that is assigned to a specific SOLAREDGE device and customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

datapointId
required
string

id of the datapoint to get the data for

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "device": "8dca31e6-c85b-4a6b-bfb4-205d45d9b3bd",
  • "active": true,
  • "originalDatapointId": "powerConsumption",
  • "datapointSubType": "powerConsumption",
  • "datapointType": "string",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "config": { },
  • "correctionFactor": 0,
  • "category": "weather",
  • "measurementType": "unknown",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

datapointId
required
string

id of the datapoint to get the data for

Responses

Response samples

Content type
application/json
{ }

Update a SOLAREDGE datapoint for a SOLAREDGE device of a customer.

Update a SOLAREDGE datapoint of a specific SOLAREDGE device and customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

datapointId
required
string

id of the datapoint to get the data for

Request Body schema: application/json
required
uuid
required
string <uuid>

unique identifier for this datapoint.

name
required
string

the name of the datapoint.

nameAlias1
string

the name alias 1 for this datapoint instance.

nameAlias2
string

the name alias 2for this datapoint instance.

device
required
string <uuid>

the device's uuid the object is related to.

active
required
boolean

if the datapoint is active or not

originalDatapointId
required
string
Enum: "powerConsumption" "powerProduction" "powerSelfConsumption" "powerExport" "powerImport" "energyConsumption" "energyProduction" "energySelfConsumption" "energyExport" "energyImport"

the id for this datapoint in the context of the remote datapoint - e.g. the ID in the supplier's system

datapointSubType
required
string
Enum: "powerConsumption" "powerProduction" "powerSelfConsumption" "powerExport" "powerImport" "energyConsumption" "energyProduction" "energySelfConsumption" "energyExport" "energyImport"

the subtype of datapoint, how the supplier of the connector would call it

datapointType
required
string

the type of datapoint, usually matches the connector type key where this datapoint receives data from

customer
required
string <uuid>

the customer this datapoint belongs to

config
object or null
correctionFactor
number
category
required
string
Enum: "weather" "energy" "environment" "status" "recognition" "unknown"
measurementType
required
string
Enum: "unknown" "temperature" "humidity" "pressure" "co2" "voltage" "voltagep1" "voltagep2" "voltagep3" "current" "currentp1" "currentp2" "currentp3" "totalcurrent" "totalactivepower" "totalreactivepower" "totalapparentpower" "totalpowerfactor" "totalactiveenergy" "totalreactiveenergy" "totalapparentenergy" "activepowerp1" "activepowerp2" "activepowerp3" "reactivepowerp1" "reactivepowerp2" "reactivepowerp3" "apparentpowerp1" "apparentpowerp2" "apparentpowerp3" "cosphip1" "cosphip2" "cosphip3" "powerfactorp1" "powerfactorp2" "powerfactorp3" "frequenzyp1" "frequenzyp2" "frequenzyp3" "energyproduction" "energyconsumption" "energyexport" "energyselfconsumption" "energyimport" "powerproduction" "powerexport" "powerconsumption" "powerimport" "powerselfconsumption" "contact" "touch" "touchcount" "presence" "presencecount" "waterdetector" "motion" "occupancy" "weatherprecipitation" "weatherprecipitationduration" "weatherhumidity" "weathercglo" "weatherwindspeed" "weatherwindgustspeed" "weatherwindgusttimestamp" "weatherwindheading" "weatherwindgustheading" "weatherhumidityrelative" "weathertemperatureair" "weatherpressure" "weatherpressurereduced" "weathersnowheight" "weathersunshineduration" "weatherdewpoint" "weathertemperaturesoil10" "weathertemperaturesoil100" "weathertemperaturewater" "personcountinside" "personcountin" "personcountout" "vehiclecountinside" "vehiclecountin" "vehiclecountout" "licenseplate" "county"

Responses

Request samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "device": "8dca31e6-c85b-4a6b-bfb4-205d45d9b3bd",
  • "active": true,
  • "originalDatapointId": "powerConsumption",
  • "datapointSubType": "powerConsumption",
  • "datapointType": "string",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "config": { },
  • "correctionFactor": 0,
  • "category": "weather",
  • "measurementType": "unknown"
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "device": "8dca31e6-c85b-4a6b-bfb4-205d45d9b3bd",
  • "active": true,
  • "originalDatapointId": "powerConsumption",
  • "datapointSubType": "powerConsumption",
  • "datapointType": "string",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "config": { },
  • "correctionFactor": 0,
  • "category": "weather",
  • "measurementType": "unknown",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

get Solaredge Datapoint Types

get Solaredge Datapoint Types

Authorizations:
custom-auth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth

Responses

Response samples

Content type
application/json
{ }

DT

Get all active DT connectors of a customer's location.

Get all active DT connectors of a specific customer's location.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

strict
boolean

if set to true, only connectors directly associated with the given location will be returned; otherwise (defaul) also connectors which have "isAllowedOnAllLocation" will be returned, too

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

Responses

Response samples

Content type
application/json
{ }

Create DT connector for customer.

Create DT connector for customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

Request Body schema: application/json
required
uuid
required
string <uuid>

unique identifier for this connector

type
required
string <uuid>

the connector type's UUId the connector is an instance of.

name
required
string

the name for this Connector instance.

nameAlias1
string

the name alias 1 for this Connector instance.

nameAlias2
string

the name alias 2for this Connector instance.

location
required
string <uuid>

the location's UUId the connector is assigned to.

active
required
boolean
originalConnectorId
string

the optional original connector id for this connector

isAllowedOnAllLocations
boolean

if set to true, this connector may be used on devices which come from a different location of the customer than the one this connector is associated with. This is needed when the connector represents a system which aggregates data from different physical locations, e.g. via networks

required
object or null

Responses

Request samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "type": "4595bf66-18b2-445a-a884-1b08d0c2df0e",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "active": true,
  • "originalConnectorId": "string",
  • "isAllowedOnAllLocations": true,
  • "config": {
    }
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "type": "4595bf66-18b2-445a-a884-1b08d0c2df0e",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "active": true,
  • "originalConnectorId": "string",
  • "isAllowedOnAllLocations": true,
  • "config": {
    },
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

Get all DT connectors of a customer's location.

Get all DT connectors of a specific customer's location.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

strict
boolean

if set to true, only connectors directly associated with the given location will be returned; otherwise (defaul) also connectors which have "isAllowedOnAllLocation" will be returned, too

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

Responses

Response samples

Content type
application/json
{ }

Get DT connector of a customer's location.

Get DT connector of a specific customer's location.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

connectorId
required
string

id of the connector to get the data for

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "type": "4595bf66-18b2-445a-a884-1b08d0c2df0e",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "active": true,
  • "originalConnectorId": "string",
  • "isAllowedOnAllLocations": true,
  • "config": {
    },
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

connectorId
required
string

id of the connector to get the data for

Responses

Response samples

Content type
application/json
{ }

Update connector for customer's location.

Update connector for customer's location.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

connectorId
required
string

id of the connector to get the data for

Request Body schema: application/json
required
uuid
required
string <uuid>

unique identifier for this connector

type
required
string <uuid>

the connector type's UUId the connector is an instance of.

name
required
string

the name for this Connector instance.

nameAlias1
string

the name alias 1 for this Connector instance.

nameAlias2
string

the name alias 2for this Connector instance.

location
required
string <uuid>

the location's UUId the connector is assigned to.

active
required
boolean
originalConnectorId
string

the optional original connector id for this connector

isAllowedOnAllLocations
boolean

if set to true, this connector may be used on devices which come from a different location of the customer than the one this connector is associated with. This is needed when the connector represents a system which aggregates data from different physical locations, e.g. via networks

required
object or null

Responses

Request samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "type": "4595bf66-18b2-445a-a884-1b08d0c2df0e",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "active": true,
  • "originalConnectorId": "string",
  • "isAllowedOnAllLocations": true,
  • "config": {
    }
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "type": "4595bf66-18b2-445a-a884-1b08d0c2df0e",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "active": true,
  • "originalConnectorId": "string",
  • "isAllowedOnAllLocations": true,
  • "config": {
    },
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

Get all active DT devices of a customer.

Get all active DT devices that are assigned to a specific customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

Responses

Response samples

Content type
application/json
{ }

Create a new DT device of a customer.

Create a new DT device of a specific customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

Request Body schema: application/json
required
uuid
required
string <uuid>

unique identifier for this device

customer
required
string <uuid>

the customer this device belongs to

name
required
string

the name of the device.

nameAlias1
string

the name alias 1 for this device instance.

nameAlias2
string

the name alias 2for this device instance.

active
required
boolean

if the device is active or not

originalDeviceId
required
string

the id for this device in the context of the device - e.g. the ID in the supplier's system

connector
required
string

the id of the connector this device belongs to

location
required
string <uuid>

the location's uuid the device can be related to.

site
string or null <uuid>

the site's uuid the device can be related to.

object or null

optional configuration object for the device

deviceType
required
string

the type of device

deviceSubType
string or null

the subtype of device

Responses

Request samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "active": true,
  • "originalDeviceId": "string",
  • "connector": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "site": "862ae9eb-f0eb-41b6-b3e5-39fdd26ce81c",
  • "config": {
    },
  • "deviceType": "dt",
  • "deviceSubType": "temperature"
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "active": true,
  • "originalDeviceId": "string",
  • "connector": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "site": "862ae9eb-f0eb-41b6-b3e5-39fdd26ce81c",
  • "config": {
    },
  • "deviceType": "dt",
  • "deviceSubType": "temperature",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

Get all DT devices of a customer.

Get all DT devices that are assigned to a specific customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

Responses

Response samples

Content type
application/json
{ }

Get a DT device of a customer.

Get a DT device that is assigned to a specific customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "active": true,
  • "originalDeviceId": "string",
  • "connector": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "site": "862ae9eb-f0eb-41b6-b3e5-39fdd26ce81c",
  • "config": {
    },
  • "deviceType": "dt",
  • "deviceSubType": "temperature",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Responses

Response samples

Content type
application/json
{ }

Update a DT device of a customer.

Update a DT device of a specific customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Request Body schema: application/json
required
uuid
required
string <uuid>

unique identifier for this device

customer
required
string <uuid>

the customer this device belongs to

name
required
string

the name of the device.

nameAlias1
string

the name alias 1 for this device instance.

nameAlias2
string

the name alias 2for this device instance.

active
required
boolean

if the device is active or not

originalDeviceId
required
string

the id for this device in the context of the device - e.g. the ID in the supplier's system

connector
required
string

the id of the connector this device belongs to

location
required
string <uuid>

the location's uuid the device can be related to.

site
string or null <uuid>

the site's uuid the device can be related to.

object or null

optional configuration object for the device

deviceType
required
string

the type of device

deviceSubType
string or null

the subtype of device

Responses

Request samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "active": true,
  • "originalDeviceId": "string",
  • "connector": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "site": "862ae9eb-f0eb-41b6-b3e5-39fdd26ce81c",
  • "config": {
    },
  • "deviceType": "dt",
  • "deviceSubType": "temperature"
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "active": true,
  • "originalDeviceId": "string",
  • "connector": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "site": "862ae9eb-f0eb-41b6-b3e5-39fdd26ce81c",
  • "config": {
    },
  • "deviceType": "dt",
  • "deviceSubType": "temperature",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

Get all active DT datapoints of a DT device.

Get all active DT datapoints that are assigned to a specific DT device.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Responses

Response samples

Content type
application/json
{ }

Create a new DT datapoint for a DT device of a customer.

Create a new DT datapoint for a DT device of a specific customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Request Body schema: application/json
required
uuid
required
string <uuid>

unique identifier for this datapoint.

name
required
string

the name of the datapoint.

nameAlias1
string

the name alias 1 for this datapoint instance.

nameAlias2
string

the name alias 2for this datapoint instance.

device
required
string <uuid>

the device's uuid the object is related to.

active
required
boolean

if the datapoint is active or not

originalDatapointId
required
string

the id for this datapoint in the context of the remote datapoint - e.g. the ID in the supplier's system

datapointSubType
required
string

the subtype of datapoint, how the supplier of the connector would call it

datapointType
required
string

the type of datapoint, usually matches the connector type key where this datapoint receives data from

customer
required
string <uuid>

the customer this datapoint belongs to

config
object or null
correctionFactor
number
category
required
string
Enum: "weather" "energy" "environment" "status" "recognition" "unknown"
measurementType
required
string
Enum: "unknown" "temperature" "humidity" "pressure" "co2" "voltage" "voltagep1" "voltagep2" "voltagep3" "current" "currentp1" "currentp2" "currentp3" "totalcurrent" "totalactivepower" "totalreactivepower" "totalapparentpower" "totalpowerfactor" "totalactiveenergy" "totalreactiveenergy" "totalapparentenergy" "activepowerp1" "activepowerp2" "activepowerp3" "reactivepowerp1" "reactivepowerp2" "reactivepowerp3" "apparentpowerp1" "apparentpowerp2" "apparentpowerp3" "cosphip1" "cosphip2" "cosphip3" "powerfactorp1" "powerfactorp2" "powerfactorp3" "frequenzyp1" "frequenzyp2" "frequenzyp3" "energyproduction" "energyconsumption" "energyexport" "energyselfconsumption" "energyimport" "powerproduction" "powerexport" "powerconsumption" "powerimport" "powerselfconsumption" "contact" "touch" "touchcount" "presence" "presencecount" "waterdetector" "motion" "occupancy" "weatherprecipitation" "weatherprecipitationduration" "weatherhumidity" "weathercglo" "weatherwindspeed" "weatherwindgustspeed" "weatherwindgusttimestamp" "weatherwindheading" "weatherwindgustheading" "weatherhumidityrelative" "weathertemperatureair" "weatherpressure" "weatherpressurereduced" "weathersnowheight" "weathersunshineduration" "weatherdewpoint" "weathertemperaturesoil10" "weathertemperaturesoil100" "weathertemperaturewater" "personcountinside" "personcountin" "personcountout" "vehiclecountinside" "vehiclecountin" "vehiclecountout" "licenseplate" "county"

Responses

Request samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "device": "8dca31e6-c85b-4a6b-bfb4-205d45d9b3bd",
  • "active": true,
  • "originalDatapointId": "string",
  • "datapointSubType": "string",
  • "datapointType": "string",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "config": { },
  • "correctionFactor": 0,
  • "category": "weather",
  • "measurementType": "unknown"
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "device": "8dca31e6-c85b-4a6b-bfb4-205d45d9b3bd",
  • "active": true,
  • "originalDatapointId": "string",
  • "datapointSubType": "string",
  • "datapointType": "string",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "config": { },
  • "correctionFactor": 0,
  • "category": "weather",
  • "measurementType": "unknown",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

Get all DT datapoints for a DT device of a customer.

Get all DT datapoints that are assigned to a specific DT device of a customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Responses

Response samples

Content type
application/json
{ }

Get a DT datapoint for a DT device of a customer.

Get a DT datapoint that is assigned to a specific DT device and customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

datapointId
required
string

id of the datapoint to get the data for

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "device": "8dca31e6-c85b-4a6b-bfb4-205d45d9b3bd",
  • "active": true,
  • "originalDatapointId": "string",
  • "datapointSubType": "string",
  • "datapointType": "string",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "config": { },
  • "correctionFactor": 0,
  • "category": "weather",
  • "measurementType": "unknown",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

datapointId
required
string

id of the datapoint to get the data for

Responses

Response samples

Content type
application/json
{ }

Update a DT datapoint for a DT device of a customer.

Update a DT datapointice of a specific DT device and customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

datapointId
required
string

id of the datapoint to get the data for

Request Body schema: application/json
required
uuid
required
string <uuid>

unique identifier for this datapoint.

name
required
string

the name of the datapoint.

nameAlias1
string

the name alias 1 for this datapoint instance.

nameAlias2
string

the name alias 2for this datapoint instance.

device
required
string <uuid>

the device's uuid the object is related to.

active
required
boolean

if the datapoint is active or not

originalDatapointId
required
string

the id for this datapoint in the context of the remote datapoint - e.g. the ID in the supplier's system

datapointSubType
required
string

the subtype of datapoint, how the supplier of the connector would call it

datapointType
required
string

the type of datapoint, usually matches the connector type key where this datapoint receives data from

customer
required
string <uuid>

the customer this datapoint belongs to

config
object or null
correctionFactor
number
category
required
string
Enum: "weather" "energy" "environment" "status" "recognition" "unknown"
measurementType
required
string
Enum: "unknown" "temperature" "humidity" "pressure" "co2" "voltage" "voltagep1" "voltagep2" "voltagep3" "current" "currentp1" "currentp2" "currentp3" "totalcurrent" "totalactivepower" "totalreactivepower" "totalapparentpower" "totalpowerfactor" "totalactiveenergy" "totalreactiveenergy" "totalapparentenergy" "activepowerp1" "activepowerp2" "activepowerp3" "reactivepowerp1" "reactivepowerp2" "reactivepowerp3" "apparentpowerp1" "apparentpowerp2" "apparentpowerp3" "cosphip1" "cosphip2" "cosphip3" "powerfactorp1" "powerfactorp2" "powerfactorp3" "frequenzyp1" "frequenzyp2" "frequenzyp3" "energyproduction" "energyconsumption" "energyexport" "energyselfconsumption" "energyimport" "powerproduction" "powerexport" "powerconsumption" "powerimport" "powerselfconsumption" "contact" "touch" "touchcount" "presence" "presencecount" "waterdetector" "motion" "occupancy" "weatherprecipitation" "weatherprecipitationduration" "weatherhumidity" "weathercglo" "weatherwindspeed" "weatherwindgustspeed" "weatherwindgusttimestamp" "weatherwindheading" "weatherwindgustheading" "weatherhumidityrelative" "weathertemperatureair" "weatherpressure" "weatherpressurereduced" "weathersnowheight" "weathersunshineduration" "weatherdewpoint" "weathertemperaturesoil10" "weathertemperaturesoil100" "weathertemperaturewater" "personcountinside" "personcountin" "personcountout" "vehiclecountinside" "vehiclecountin" "vehiclecountout" "licenseplate" "county"

Responses

Request samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "device": "8dca31e6-c85b-4a6b-bfb4-205d45d9b3bd",
  • "active": true,
  • "originalDatapointId": "string",
  • "datapointSubType": "string",
  • "datapointType": "string",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "config": { },
  • "correctionFactor": 0,
  • "category": "weather",
  • "measurementType": "unknown"
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "device": "8dca31e6-c85b-4a6b-bfb4-205d45d9b3bd",
  • "active": true,
  • "originalDatapointId": "string",
  • "datapointSubType": "string",
  • "datapointType": "string",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "config": { },
  • "correctionFactor": 0,
  • "category": "weather",
  • "measurementType": "unknown",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

Data

Gets measured data for a given customer

Gets measured data for a given customer, allowing several grouping and calculation options. The following types of measurement formats are supported:

  • Number values ("number"), like integers and floats
  • Categorical values ("categorical"), like MOTION_DETECTED, NO_MOTION_DETECTED
Depending on the format, several parameters are allowed or forbidden. The description of each parameter will contain "all", "number, or "categorical" to indicate if this parameter is allowed for the given format.

"Categorical" data only supports the following function-resolution-combinations:

  • "exact" and "max" - will return a "time stream" of all the events that have happened
  • "sum" and any resolution except "max" - will return a "summary" for each intervall where number of events and the sum of duration for each possible categorical value are returned

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

query Parameters
startdatetime
required
string <date-time>

[all] start date and time for the query

enddatetime
required
string <date-time>

[all] end date and time for the query

datapoints
Array of strings

[all] list of 1-n datapoints

object
Example:

"[all] labels to filter the data by"

category
required
string (measureDataCategory)
Enum: "weather" "energy" "environment" "status" "recognition" "unknown"

[all]

type
required
string (measureDataType)
Enum: "unknown" "temperature" "humidity" "pressure" "co2" "voltage" "voltagep1" "voltagep2" "voltagep3" "current" "currentp1" "currentp2" "currentp3" "totalcurrent" "totalactivepower" "totalreactivepower" "totalapparentpower" "totalpowerfactor" "totalactiveenergy" "totalreactiveenergy" "totalapparentenergy" "activepowerp1" "activepowerp2" "activepowerp3" "reactivepowerp1" "reactivepowerp2" "reactivepowerp3" "apparentpowerp1" "apparentpowerp2" "apparentpowerp3" "cosphip1" "cosphip2" "cosphip3" "powerfactorp1" "powerfactorp2" "powerfactorp3" "frequenzyp1" "frequenzyp2" "frequenzyp3" "energyproduction" "energyconsumption" "energyexport" "energyselfconsumption" "energyimport" "powerproduction" "powerexport" "powerconsumption" "powerimport" "powerselfconsumption" "contact" "touch" "touchcount" "presence" "presencecount" "waterdetector" "motion" "occupancy" "weatherprecipitation" "weatherprecipitationduration" "weatherhumidity" "weathercglo" "weatherwindspeed" "weatherwindgustspeed" "weatherwindgusttimestamp" "weatherwindheading" "weatherwindgustheading" "weatherhumidityrelative" "weathertemperatureair" "weatherpressure" "weatherpressurereduced" "weathersnowheight" "weathersunshineduration" "weatherdewpoint" "weathertemperaturesoil10" "weathertemperaturesoil100" "weathertemperaturewater" "personcountinside" "personcountin" "personcountout" "vehiclecountinside" "vehiclecountin" "vehiclecountout" "licenseplate" "county"

[all]

resolution
string
Enum: "max" "1m" "5m" "15m" "30m" "1h" "6h" "12h" "1d" "1w" "1mo"

[all] Either returns all values ('max') or groups them by the given time period

func
required
string
Enum: "minMaxAvg" "exact" "closestPreceding" "sum" "totalMin" "totalMax" "totalAvg" "totalMinMaxAvg" "totalSum"

[all] describes the function that should be performed on the data, grouped by the resolution; "exact" is only allowed if resolution is "max"; for [categorical], only "sum" and "exact" are allowed

diff
boolean

[number] ]hether the diff of values between found data should be calculated (e.g. for energy consumption based on absolute energy values)

combine
boolean

[all] only with functions 'minMaxAvg'[number] or 'sum'[all] and their 'totalX'[number] variants; if true the functions are performed on all datapoints included in the command, otherwise the function will be performed for each datapoint separately

includeprice
boolean

[number] only with functions 'exact', 'sum', 'totalSum', closestPreceeding'

queryId
string

[all] optional ID to identify the query and the repsonse (which will also contain the queryId in its body)

influx
boolean

[all] whether the data should be retrieved from Influx (true, default) or Timestream (false)

Responses

Response samples

Content type
application/json
{
  • "datapoints": [
    ],
  • "datapointResultDetails": {
    },
  • "unit": "string",
  • "format": "number",
  • "categoricalValues": [
    ],
  • "combined": true,
  • "queryId": "string",
  • "data": [
    ]
}

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

Responses

Response samples

Content type
application/json
{ }

Gets latest measured data for a given customer

Gets latest measured data for a given customer and a given list of datapoints

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

query Parameters
datapoints
Array of strings

list of 1-n datapoints

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

Responses

Response samples

Content type
application/json
{ }

Gets all or filtered datapoints (or their count) for customer

Gets datapoints or their count for customer optionally filtered by category, measurement type, location and site

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

query Parameters
count
boolean

optional flag to get only the number of datapoints instead of datapoints

category
string (measureDataCategory)
Enum: "weather" "energy" "environment" "status" "recognition" "unknown"

optional category to filter for

type
string (measureDataType)
Enum: "unknown" "temperature" "humidity" "pressure" "co2" "voltage" "voltagep1" "voltagep2" "voltagep3" "current" "currentp1" "currentp2" "currentp3" "totalcurrent" "totalactivepower" "totalreactivepower" "totalapparentpower" "totalpowerfactor" "totalactiveenergy" "totalreactiveenergy" "totalapparentenergy" "activepowerp1" "activepowerp2" "activepowerp3" "reactivepowerp1" "reactivepowerp2" "reactivepowerp3" "apparentpowerp1" "apparentpowerp2" "apparentpowerp3" "cosphip1" "cosphip2" "cosphip3" "powerfactorp1" "powerfactorp2" "powerfactorp3" "frequenzyp1" "frequenzyp2" "frequenzyp3" "energyproduction" "energyconsumption" "energyexport" "energyselfconsumption" "energyimport" "powerproduction" "powerexport" "powerconsumption" "powerimport" "powerselfconsumption" "contact" "touch" "touchcount" "presence" "presencecount" "waterdetector" "motion" "occupancy" "weatherprecipitation" "weatherprecipitationduration" "weatherhumidity" "weathercglo" "weatherwindspeed" "weatherwindgustspeed" "weatherwindgusttimestamp" "weatherwindheading" "weatherwindgustheading" "weatherhumidityrelative" "weathertemperatureair" "weatherpressure" "weatherpressurereduced" "weathersnowheight" "weathersunshineduration" "weatherdewpoint" "weathertemperaturesoil10" "weathertemperaturesoil100" "weathertemperaturewater" "personcountinside" "personcountin" "personcountout" "vehiclecountinside" "vehiclecountin" "vehiclecountout" "licenseplate" "county"

optional measurement type to filter for

location
string

optional location UUID

site
string

optional site UUID

inactive
boolean

if true, also inactive datapoints will be used in search result‚

Responses

Response samples

Content type
application/json
Example
[ ]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

Responses

Response samples

Content type
application/json
{ }

Gets filtered labels for customer

Gets labels for customer by category, measurement type

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

category
required
string (measureDataCategory)
Enum: "weather" "energy" "environment" "status" "recognition" "unknown"
Example: environment

the category to get the labels for

type
required
string (measureDataType)
Enum: "unknown" "temperature" "humidity" "pressure" "co2" "voltage" "voltagep1" "voltagep2" "voltagep3" "current" "currentp1" "currentp2" "currentp3" "totalcurrent" "totalactivepower" "totalreactivepower" "totalapparentpower" "totalpowerfactor" "totalactiveenergy" "totalreactiveenergy" "totalapparentenergy" "activepowerp1" "activepowerp2" "activepowerp3" "reactivepowerp1" "reactivepowerp2" "reactivepowerp3" "apparentpowerp1" "apparentpowerp2" "apparentpowerp3" "cosphip1" "cosphip2" "cosphip3" "powerfactorp1" "powerfactorp2" "powerfactorp3" "frequenzyp1" "frequenzyp2" "frequenzyp3" "energyproduction" "energyconsumption" "energyexport" "energyselfconsumption" "energyimport" "powerproduction" "powerexport" "powerconsumption" "powerimport" "powerselfconsumption" "contact" "touch" "touchcount" "presence" "presencecount" "waterdetector" "motion" "occupancy" "weatherprecipitation" "weatherprecipitationduration" "weatherhumidity" "weathercglo" "weatherwindspeed" "weatherwindgustspeed" "weatherwindgusttimestamp" "weatherwindheading" "weatherwindgustheading" "weatherhumidityrelative" "weathertemperatureair" "weatherpressure" "weatherpressurereduced" "weathersnowheight" "weathersunshineduration" "weatherdewpoint" "weathertemperaturesoil10" "weathertemperaturesoil100" "weathertemperaturewater" "personcountinside" "personcountin" "personcountout" "vehiclecountinside" "vehiclecountin" "vehiclecountout" "licenseplate" "county"
Example: temperature

the type of measurement to get the labels for

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

category
required
string (measureDataCategory)
Enum: "weather" "energy" "environment" "status" "recognition" "unknown"
Example: environment

the category to get the labels for

type
required
string (measureDataType)
Enum: "unknown" "temperature" "humidity" "pressure" "co2" "voltage" "voltagep1" "voltagep2" "voltagep3" "current" "currentp1" "currentp2" "currentp3" "totalcurrent" "totalactivepower" "totalreactivepower" "totalapparentpower" "totalpowerfactor" "totalactiveenergy" "totalreactiveenergy" "totalapparentenergy" "activepowerp1" "activepowerp2" "activepowerp3" "reactivepowerp1" "reactivepowerp2" "reactivepowerp3" "apparentpowerp1" "apparentpowerp2" "apparentpowerp3" "cosphip1" "cosphip2" "cosphip3" "powerfactorp1" "powerfactorp2" "powerfactorp3" "frequenzyp1" "frequenzyp2" "frequenzyp3" "energyproduction" "energyconsumption" "energyexport" "energyselfconsumption" "energyimport" "powerproduction" "powerexport" "powerconsumption" "powerimport" "powerselfconsumption" "contact" "touch" "touchcount" "presence" "presencecount" "waterdetector" "motion" "occupancy" "weatherprecipitation" "weatherprecipitationduration" "weatherhumidity" "weathercglo" "weatherwindspeed" "weatherwindgustspeed" "weatherwindgusttimestamp" "weatherwindheading" "weatherwindgustheading" "weatherhumidityrelative" "weathertemperatureair" "weatherpressure" "weatherpressurereduced" "weathersnowheight" "weathersunshineduration" "weatherdewpoint" "weathertemperaturesoil10" "weathertemperaturesoil100" "weathertemperaturewater" "personcountinside" "personcountin" "personcountout" "vehiclecountinside" "vehiclecountin" "vehiclecountout" "licenseplate" "county"
Example: temperature

the type of measurement to get the labels for

Responses

Response samples

Content type
application/json
{ }

Enums

Get all categories and types for measurement data

Get all categories and types for measurement data

Authorizations:
custom-auth

Responses

Response samples

Content type
application/json
{
  • "property1": [
    ],
  • "property2": [
    ]
}

for CORS

Authorizations:
custom-auth

Responses

Response samples

Content type
application/json
{ }

Get all resolutions for Generic "data" endpoint

Get all resolutions for Generic "data" endpoint

Authorizations:
custom-auth

Responses

Response samples

Content type
application/json
[
  • "string"
]

for CORS

Authorizations:
custom-auth

Responses

Response samples

Content type
application/json
{ }

Get all functions for Generic "data" endpoint

Get all functions for Generic "data" endpoint

Authorizations:
custom-auth

Responses

Response samples

Content type
application/json
[
  • "string"
]

for CORS

Authorizations:
custom-auth

Responses

Response samples

Content type
application/json
{ }

Get all formats for Generic "data" endpoint

Get all formats for Generic "data" endpoint

Authorizations:
custom-auth

Responses

Response samples

Content type
application/json
[
  • "string"
]

for CORS

Authorizations:
custom-auth

Responses

Response samples

Content type
application/json
{ }

Get all categorical measurement types and their allowed values

Get all categorical measurement types and their allowed values

Authorizations:
custom-auth

Responses

Response samples

Content type
application/json
{
  • "contact": [
    ],
  • "touch": [
    ],
  • "presence": [
    ],
  • "waterdetector": [
    ],
  • "motion": [
    ],
  • "occupancy": [
    ]
}

for CORS

Authorizations:
custom-auth

Responses

Response samples

Content type
application/json
{ }

Status

Gets status data for an item of a given customer

Gets status data for an item of a given customer

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

itemType
required
string
Enum: "datapoint" "device" "connector"
Example: connector

the item type to get the status for

uuid
required
string <uuid>
Example: 798ab324-b910-4175-a27b-c9450c35b7e4

the UUID of the item to get the status data for

Responses

Response samples

Content type
application/json
Example
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "message": "string"
}

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

itemType
required
string
Enum: "datapoint" "device" "connector"
Example: connector

the item type to get the status for

uuid
required
string <uuid>
Example: 798ab324-b910-4175-a27b-c9450c35b7e4

the UUID of the item to get the status data for

Responses

Response samples

Content type
application/json
{ }

GENERIC

Get all active GENERIC connectors of a customer's location.

Get all active GENERIC connectors of a specific customer's location.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

strict
boolean

if set to true, only connectors directly associated with the given location will be returned; otherwise (defaul) also connectors which have "isAllowedOnAllLocation" will be returned, too

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

Responses

Response samples

Content type
application/json
{ }

Create GENERIC connector for customer.

Create GENERIC connector for customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

Request Body schema: application/json
required
uuid
required
string <uuid>

unique identifier for this connector

type
required
string <uuid>

the connector type's UUId the connector is an instance of.

name
required
string

the name for this Connector instance.

nameAlias1
string

the name alias 1 for this Connector instance.

nameAlias2
string

the name alias 2for this Connector instance.

location
required
string <uuid>

the location's UUId the connector is assigned to.

active
required
boolean
originalConnectorId
string

the optional original connector id for this connector

isAllowedOnAllLocations
boolean

if set to true, this connector may be used on devices which come from a different location of the customer than the one this connector is associated with. This is needed when the connector represents a system which aggregates data from different physical locations, e.g. via networks

Responses

Request samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "type": "4595bf66-18b2-445a-a884-1b08d0c2df0e",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "active": true,
  • "originalConnectorId": "string",
  • "isAllowedOnAllLocations": true
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "type": "4595bf66-18b2-445a-a884-1b08d0c2df0e",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "active": true,
  • "originalConnectorId": "string",
  • "isAllowedOnAllLocations": true,
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

Get all GENERIC connectors of a customer's location.

Get all GENERIC connectors of a specific customer's location.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

strict
boolean

if set to true, only connectors directly associated with the given location will be returned; otherwise (defaul) also connectors which have "isAllowedOnAllLocation" will be returned, too

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

Responses

Response samples

Content type
application/json
{ }

Get GENERIC connector of a customer's location.

Get GENERIC connector of a specific customer's location.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

connectorId
required
string

id of the connector to get the data for

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "type": "4595bf66-18b2-445a-a884-1b08d0c2df0e",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "active": true,
  • "originalConnectorId": "string",
  • "isAllowedOnAllLocations": true,
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

connectorId
required
string

id of the connector to get the data for

Responses

Response samples

Content type
application/json
{ }

Update connector for customer's location.

Update connector for customer's location.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

connectorId
required
string

id of the connector to get the data for

Request Body schema: application/json
required
uuid
required
string <uuid>

unique identifier for this connector

type
required
string <uuid>

the connector type's UUId the connector is an instance of.

name
required
string

the name for this Connector instance.

nameAlias1
string

the name alias 1 for this Connector instance.

nameAlias2
string

the name alias 2for this Connector instance.

location
required
string <uuid>

the location's UUId the connector is assigned to.

active
required
boolean
originalConnectorId
string

the optional original connector id for this connector

isAllowedOnAllLocations
boolean

if set to true, this connector may be used on devices which come from a different location of the customer than the one this connector is associated with. This is needed when the connector represents a system which aggregates data from different physical locations, e.g. via networks

Responses

Request samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "type": "4595bf66-18b2-445a-a884-1b08d0c2df0e",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "active": true,
  • "originalConnectorId": "string",
  • "isAllowedOnAllLocations": true
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "type": "4595bf66-18b2-445a-a884-1b08d0c2df0e",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "active": true,
  • "originalConnectorId": "string",
  • "isAllowedOnAllLocations": true,
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

Get all active GENERIC devices of a customer.

Get all active GENERIC devices that are assigned to a specific customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

Responses

Response samples

Content type
application/json
{ }

Create a new GENERIC device of a customer.

Create a new GENERIC device of a specific customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

Request Body schema: application/json
required
uuid
required
string <uuid>

unique identifier for this device

customer
required
string <uuid>

the customer this device belongs to

name
required
string

the name of the device.

nameAlias1
string

the name alias 1 for this device instance.

nameAlias2
string

the name alias 2for this device instance.

active
required
boolean

if the device is active or not

originalDeviceId
required
string

the id for this device in the context of the device - e.g. the ID in the supplier's system

connector
required
string

the id of the connector this device belongs to

location
required
string <uuid>

the location's uuid the device can be related to.

site
string or null <uuid>

the site's uuid the device can be related to.

config
object or null

optional configuration object for the device

deviceType
required
string

the type of device

deviceSubType
string or null

the subtype of device

Responses

Request samples

Content type
application/json
"{\n \"uuid\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"customer\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"name\": \"0001-1KF1234567\",\n \"active\": true,\n \"originalDeviceId\": \"1KF1234567\",\n \"connector\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"location\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"site\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"config\": {},\n \"deviceType\": \"generic\",\n}\n"

Response samples

Content type
application/json
{
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

Get all GENERIC devices of a customer.

Get all GENERIC devices that are assigned to a specific customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

Responses

Response samples

Content type
application/json
{ }

Get an GENERIC device of a customer.

Get an GENERIC device that is assigned to a specific customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Responses

Response samples

Content type
application/json
{
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Responses

Response samples

Content type
application/json
{ }

Update an GENERIC device of a customer.

Update an GENERIC device of a specific customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Request Body schema: application/json
required
uuid
required
string <uuid>

unique identifier for this device

customer
required
string <uuid>

the customer this device belongs to

name
required
string

the name of the device.

nameAlias1
string

the name alias 1 for this device instance.

nameAlias2
string

the name alias 2for this device instance.

active
required
boolean

if the device is active or not

originalDeviceId
required
string

the id for this device in the context of the device - e.g. the ID in the supplier's system

connector
required
string

the id of the connector this device belongs to

location
required
string <uuid>

the location's uuid the device can be related to.

site
string or null <uuid>

the site's uuid the device can be related to.

config
object or null

optional configuration object for the device

deviceType
required
string

the type of device

deviceSubType
string or null

the subtype of device

Responses

Request samples

Content type
application/json
"{\n \"uuid\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"customer\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"name\": \"0001-1KF1234567\",\n \"active\": true,\n \"originalDeviceId\": \"1KF1234567\",\n \"connector\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"location\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"site\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"config\": {},\n \"deviceType\": \"generic\",\n}\n"

Response samples

Content type
application/json
{
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

Get all active GENERIC datapoints of an GENERIC device.

Get all active GENERIC datapoints that are assigned to a specific GENERIC device.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Responses

Response samples

Content type
application/json
{ }

Create a new GENERIC datapoint for an GENERIC device of a customer.

Create a new GENERIC datapoint for an GENERIC device of a specific customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Request Body schema: application/json
required
uuid
required
string <uuid>

unique identifier for this datapoint.

name
required
string

the name of the datapoint.

nameAlias1
string

the name alias 1 for this datapoint instance.

nameAlias2
string

the name alias 2for this datapoint instance.

device
required
string <uuid>

the device's uuid the object is related to.

active
required
boolean

if the datapoint is active or not

originalDatapointId
required
string

the id for this datapoint in the context of the remote datapoint - e.g. the ID in the supplier's system

datapointSubType
required
string

the subtype of datapoint, how the supplier of the connector would call it

datapointType
required
string

the type of datapoint, usually matches the connector type key where this datapoint receives data from

customer
required
string <uuid>

the customer this datapoint belongs to

config
object or null
correctionFactor
number
category
required
string
Enum: "weather" "energy" "environment" "status" "recognition" "unknown"
measurementType
required
string
Enum: "unknown" "temperature" "humidity" "pressure" "co2" "voltage" "voltagep1" "voltagep2" "voltagep3" "current" "currentp1" "currentp2" "currentp3" "totalcurrent" "totalactivepower" "totalreactivepower" "totalapparentpower" "totalpowerfactor" "totalactiveenergy" "totalreactiveenergy" "totalapparentenergy" "activepowerp1" "activepowerp2" "activepowerp3" "reactivepowerp1" "reactivepowerp2" "reactivepowerp3" "apparentpowerp1" "apparentpowerp2" "apparentpowerp3" "cosphip1" "cosphip2" "cosphip3" "powerfactorp1" "powerfactorp2" "powerfactorp3" "frequenzyp1" "frequenzyp2" "frequenzyp3" "energyproduction" "energyconsumption" "energyexport" "energyselfconsumption" "energyimport" "powerproduction" "powerexport" "powerconsumption" "powerimport" "powerselfconsumption" "contact" "touch" "touchcount" "presence" "presencecount" "waterdetector" "motion" "occupancy" "weatherprecipitation" "weatherprecipitationduration" "weatherhumidity" "weathercglo" "weatherwindspeed" "weatherwindgustspeed" "weatherwindgusttimestamp" "weatherwindheading" "weatherwindgustheading" "weatherhumidityrelative" "weathertemperatureair" "weatherpressure" "weatherpressurereduced" "weathersnowheight" "weathersunshineduration" "weatherdewpoint" "weathertemperaturesoil10" "weathertemperaturesoil100" "weathertemperaturewater" "personcountinside" "personcountin" "personcountout" "vehiclecountinside" "vehiclecountin" "vehiclecountout" "licenseplate" "county"

Responses

Request samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "device": "8dca31e6-c85b-4a6b-bfb4-205d45d9b3bd",
  • "active": true,
  • "originalDatapointId": "string",
  • "datapointSubType": "string",
  • "datapointType": "string",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "config": { },
  • "correctionFactor": 0,
  • "category": "weather",
  • "measurementType": "unknown"
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "device": "8dca31e6-c85b-4a6b-bfb4-205d45d9b3bd",
  • "active": true,
  • "originalDatapointId": "string",
  • "datapointSubType": "string",
  • "datapointType": "string",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "config": { },
  • "correctionFactor": 0,
  • "category": "weather",
  • "measurementType": "unknown",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

Get all GENERIC datapoints for an GENERIC device of a customer.

Get all GENERIC datapoints that are assigned to a specific GENERIC device of a customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Responses

Response samples

Content type
application/json
{ }

Get an GENERIC datapoint for an GENERIC device of a customer.

Get an GENERIC datapoint that is assigned to a specific GENERIC device and customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

datapointId
required
string

id of the datapoint to get the data for

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "device": "8dca31e6-c85b-4a6b-bfb4-205d45d9b3bd",
  • "active": true,
  • "originalDatapointId": "string",
  • "datapointSubType": "string",
  • "datapointType": "string",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "config": { },
  • "correctionFactor": 0,
  • "category": "weather",
  • "measurementType": "unknown",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

datapointId
required
string

id of the datapoint to get the data for

Responses

Response samples

Content type
application/json
{ }

Update an GENERIC datapoint for an GENERIC device of a customer.

Update an GENERIC datapoint of a specific GENERIC device and customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

datapointId
required
string

id of the datapoint to get the data for

Request Body schema: application/json
required
uuid
required
string <uuid>

unique identifier for this datapoint.

name
required
string

the name of the datapoint.

nameAlias1
string

the name alias 1 for this datapoint instance.

nameAlias2
string

the name alias 2for this datapoint instance.

device
required
string <uuid>

the device's uuid the object is related to.

active
required
boolean

if the datapoint is active or not

originalDatapointId
required
string

the id for this datapoint in the context of the remote datapoint - e.g. the ID in the supplier's system

datapointSubType
required
string

the subtype of datapoint, how the supplier of the connector would call it

datapointType
required
string

the type of datapoint, usually matches the connector type key where this datapoint receives data from

customer
required
string <uuid>

the customer this datapoint belongs to

config
object or null
correctionFactor
number
category
required
string
Enum: "weather" "energy" "environment" "status" "recognition" "unknown"
measurementType
required
string
Enum: "unknown" "temperature" "humidity" "pressure" "co2" "voltage" "voltagep1" "voltagep2" "voltagep3" "current" "currentp1" "currentp2" "currentp3" "totalcurrent" "totalactivepower" "totalreactivepower" "totalapparentpower" "totalpowerfactor" "totalactiveenergy" "totalreactiveenergy" "totalapparentenergy" "activepowerp1" "activepowerp2" "activepowerp3" "reactivepowerp1" "reactivepowerp2" "reactivepowerp3" "apparentpowerp1" "apparentpowerp2" "apparentpowerp3" "cosphip1" "cosphip2" "cosphip3" "powerfactorp1" "powerfactorp2" "powerfactorp3" "frequenzyp1" "frequenzyp2" "frequenzyp3" "energyproduction" "energyconsumption" "energyexport" "energyselfconsumption" "energyimport" "powerproduction" "powerexport" "powerconsumption" "powerimport" "powerselfconsumption" "contact" "touch" "touchcount" "presence" "presencecount" "waterdetector" "motion" "occupancy" "weatherprecipitation" "weatherprecipitationduration" "weatherhumidity" "weathercglo" "weatherwindspeed" "weatherwindgustspeed" "weatherwindgusttimestamp" "weatherwindheading" "weatherwindgustheading" "weatherhumidityrelative" "weathertemperatureair" "weatherpressure" "weatherpressurereduced" "weathersnowheight" "weathersunshineduration" "weatherdewpoint" "weathertemperaturesoil10" "weathertemperaturesoil100" "weathertemperaturewater" "personcountinside" "personcountin" "personcountout" "vehiclecountinside" "vehiclecountin" "vehiclecountout" "licenseplate" "county"

Responses

Request samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "device": "8dca31e6-c85b-4a6b-bfb4-205d45d9b3bd",
  • "active": true,
  • "originalDatapointId": "string",
  • "datapointSubType": "string",
  • "datapointType": "string",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "config": { },
  • "correctionFactor": 0,
  • "category": "weather",
  • "measurementType": "unknown"
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "device": "8dca31e6-c85b-4a6b-bfb4-205d45d9b3bd",
  • "active": true,
  • "originalDatapointId": "string",
  • "datapointSubType": "string",
  • "datapointType": "string",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "config": { },
  • "correctionFactor": 0,
  • "category": "weather",
  • "measurementType": "unknown",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

Send data to the generic-connector

Send data to the generic-connector

Authorizations:
custom-auth
Request Body schema: application/json
required
connectorUuid
required
string <uuid>
customerUuid
required
string <uuid>
deviceUuid
required
string <uuid>
datapointUuid
required
string <uuid>
timestamp
required
string <date-time>
value
required
string

Responses

Request samples

Content type
application/json
{
  • "connectorUuid": "d35b761f-01a3-438e-b959-b4349902444b",
  • "customerUuid": "12589d07-fa98-4994-8d16-bef116e8e30f",
  • "deviceUuid": "9e508920-d2ae-4d6c-8e73-5b5607accb47",
  • "datapointUuid": "d99c3de4-7271-45b1-8d86-111f93f6ce3e",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "value": "string"
}

Response samples

Content type
application/json
{ }

for CORS

Authorizations:
custom-auth

Responses

Response samples

Content type
application/json
{ }

Get a generic connector datapoint by its id

Get a generic connector datapoint by its id for updating the current measurement value

Authorizations:
custom-auth

Responses

Response samples

Content type
application/json
{
  • "datapoint": {
    },
  • "device": {
    },
  • "connector": {
    },
  • "customer": {
    }
}

for CORS

Authorizations:
custom-auth

Responses

Response samples

Content type
application/json
{ }

OPCUA

Get all active OPCUA connectors of a customer's location.

Get all active OPCUA connectors of a specific customer's location.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

strict
boolean

if set to true, only connectors directly associated with the given location will be returned; otherwise (defaul) also connectors which have "isAllowedOnAllLocation" will be returned, too

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

Responses

Response samples

Content type
application/json
{ }

Create OPCUA connector for customer.

Create OPCUA connector for customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

Request Body schema: application/json
required
modifiedAt
required
string <date-time>
required
object (uiUserInfo)
createdAt
required
string <date-time>
required
object (uiUserInfo)

Responses

Request samples

Content type
application/json
{
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "type": "4595bf66-18b2-445a-a884-1b08d0c2df0e",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "active": true,
  • "originalConnectorId": "string",
  • "isAllowedOnAllLocations": true
}

Get all OPCUA connectors of a customer's location.

Get all OPCUA connectors of a specific customer's location.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

strict
boolean

if set to true, only connectors directly associated with the given location will be returned; otherwise (defaul) also connectors which have "isAllowedOnAllLocation" will be returned, too

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

Responses

Response samples

Content type
application/json
{ }

Get OPCUA connector of a customer's location.

Get OPCUA connector of a specific customer's location.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

connectorId
required
string

id of the connector to get the data for

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "type": "4595bf66-18b2-445a-a884-1b08d0c2df0e",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "active": true,
  • "originalConnectorId": "string",
  • "isAllowedOnAllLocations": true
}

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

connectorId
required
string

id of the connector to get the data for

Responses

Response samples

Content type
application/json
{ }

Update connector for customer's location.

Update connector for customer's location.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

connectorId
required
string

id of the connector to get the data for

Request Body schema: application/json
required
modifiedAt
required
string <date-time>
required
object (uiUserInfo)
createdAt
required
string <date-time>
required
object (uiUserInfo)

Responses

Request samples

Content type
application/json
{
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "type": "4595bf66-18b2-445a-a884-1b08d0c2df0e",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "active": true,
  • "originalConnectorId": "string",
  • "isAllowedOnAllLocations": true
}

Get all active OPCUA devices of a customer.

Get all active OPCUA devices that are assigned to a specific customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

Responses

Response samples

Content type
application/json
{ }

Create a new OPCUA device of a customer.

Create a new OPCUA device of a specific customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

Request Body schema: application/json
required
uuid
required
string <uuid>

unique identifier for this device

customer
required
string <uuid>

the customer this device belongs to

name
required
string

the name of the device.

nameAlias1
string

the name alias 1 for this device instance.

nameAlias2
string

the name alias 2for this device instance.

active
required
boolean

if the device is active or not

originalDeviceId
required
string

the id for this device in the context of the device - e.g. the ID in the supplier's system

connector
required
string

the id of the connector this device belongs to

location
required
string <uuid>

the location's uuid the device can be related to.

site
string or null <uuid>

the site's uuid the device can be related to.

config
object or null

optional configuration object for the device

deviceType
required
string

the type of device

deviceSubType
string or null

the subtype of device

Responses

Request samples

Content type
application/json
"{\n \"uuid\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"customer\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"name\": \"0001-1KF1234567\",\n \"active\": true,\n \"originalDeviceId\": \"1KF1234567\",\n \"connector\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"location\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"site\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"config\": {},\n \"deviceType\": \"opcua\",\n}\n"

Response samples

Content type
application/json
{
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

Get all OPCUA devices of a customer.

Get all OPCUA devices that are assigned to a specific customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

Responses

Response samples

Content type
application/json
{ }

Get an OPCUA device of a customer.

Get an OPCUA device that is assigned to a specific customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Responses

Response samples

Content type
application/json
{
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Responses

Response samples

Content type
application/json
{ }

Update an OPCUA device of a customer.

Update an OPCUA device of a specific customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Request Body schema: application/json
required
uuid
required
string <uuid>

unique identifier for this device

customer
required
string <uuid>

the customer this device belongs to

name
required
string

the name of the device.

nameAlias1
string

the name alias 1 for this device instance.

nameAlias2
string

the name alias 2for this device instance.

active
required
boolean

if the device is active or not

originalDeviceId
required
string

the id for this device in the context of the device - e.g. the ID in the supplier's system

connector
required
string

the id of the connector this device belongs to

location
required
string <uuid>

the location's uuid the device can be related to.

site
string or null <uuid>

the site's uuid the device can be related to.

config
object or null

optional configuration object for the device

deviceType
required
string

the type of device

deviceSubType
string or null

the subtype of device

Responses

Request samples

Content type
application/json
"{\n \"uuid\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"customer\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"name\": \"0001-1KF1234567\",\n \"active\": true,\n \"originalDeviceId\": \"1KF1234567\",\n \"connector\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"location\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"site\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"config\": {},\n \"deviceType\": \"opcua\",\n}\n"

Response samples

Content type
application/json
{
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

Get all active OPCUA datapoints of an OPCUA device.

Get all active OPCUA datapoints that are assigned to a specific OPCUA device.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Responses

Response samples

Content type
application/json
{ }

Create a new OPCUA datapoint for an OPCUA device of a customer.

Create a new OPCUA datapoint for an OPCUA device of a specific customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Request Body schema: application/json
required
uuid
required
string <uuid>

unique identifier for this datapoint.

name
required
string

the name of the datapoint.

nameAlias1
string

the name alias 1 for this datapoint instance.

nameAlias2
string

the name alias 2for this datapoint instance.

device
required
string <uuid>

the device's uuid the object is related to.

active
required
boolean

if the datapoint is active or not

originalDatapointId
required
string

the id for this datapoint in the context of the remote datapoint - e.g. the ID in the supplier's system

datapointSubType
required
string

the subtype of datapoint, how the supplier of the connector would call it

datapointType
required
string

the type of datapoint, usually matches the connector type key where this datapoint receives data from

customer
required
string <uuid>

the customer this datapoint belongs to

config
object or null
correctionFactor
number
category
required
string
Enum: "weather" "energy" "environment" "status" "recognition" "unknown"
measurementType
required
string
Enum: "unknown" "temperature" "humidity" "pressure" "co2" "voltage" "voltagep1" "voltagep2" "voltagep3" "current" "currentp1" "currentp2" "currentp3" "totalcurrent" "totalactivepower" "totalreactivepower" "totalapparentpower" "totalpowerfactor" "totalactiveenergy" "totalreactiveenergy" "totalapparentenergy" "activepowerp1" "activepowerp2" "activepowerp3" "reactivepowerp1" "reactivepowerp2" "reactivepowerp3" "apparentpowerp1" "apparentpowerp2" "apparentpowerp3" "cosphip1" "cosphip2" "cosphip3" "powerfactorp1" "powerfactorp2" "powerfactorp3" "frequenzyp1" "frequenzyp2" "frequenzyp3" "energyproduction" "energyconsumption" "energyexport" "energyselfconsumption" "energyimport" "powerproduction" "powerexport" "powerconsumption" "powerimport" "powerselfconsumption" "contact" "touch" "touchcount" "presence" "presencecount" "waterdetector" "motion" "occupancy" "weatherprecipitation" "weatherprecipitationduration" "weatherhumidity" "weathercglo" "weatherwindspeed" "weatherwindgustspeed" "weatherwindgusttimestamp" "weatherwindheading" "weatherwindgustheading" "weatherhumidityrelative" "weathertemperatureair" "weatherpressure" "weatherpressurereduced" "weathersnowheight" "weathersunshineduration" "weatherdewpoint" "weathertemperaturesoil10" "weathertemperaturesoil100" "weathertemperaturewater" "personcountinside" "personcountin" "personcountout" "vehiclecountinside" "vehiclecountin" "vehiclecountout" "licenseplate" "county"

Responses

Request samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "device": "8dca31e6-c85b-4a6b-bfb4-205d45d9b3bd",
  • "active": true,
  • "originalDatapointId": "string",
  • "datapointSubType": "string",
  • "datapointType": "string",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "config": { },
  • "correctionFactor": 0,
  • "category": "weather",
  • "measurementType": "unknown"
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "device": "8dca31e6-c85b-4a6b-bfb4-205d45d9b3bd",
  • "active": true,
  • "originalDatapointId": "string",
  • "datapointSubType": "string",
  • "datapointType": "string",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "config": { },
  • "correctionFactor": 0,
  • "category": "weather",
  • "measurementType": "unknown",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

Get all OPCUA datapoints for an OPCUA device of a customer.

Get all OPCUA datapoints that are assigned to a specific OPCUA device of a customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Responses

Response samples

Content type
application/json
{ }

Get an OPCUA datapoint for an OPCUA device of a customer.

Get an OPCUA datapoint that is assigned to a specific OPCUA device and customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

datapointId
required
string

id of the datapoint to get the data for

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "device": "8dca31e6-c85b-4a6b-bfb4-205d45d9b3bd",
  • "active": true,
  • "originalDatapointId": "string",
  • "datapointSubType": "string",
  • "datapointType": "string",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "config": { },
  • "correctionFactor": 0,
  • "category": "weather",
  • "measurementType": "unknown",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

datapointId
required
string

id of the datapoint to get the data for

Responses

Response samples

Content type
application/json
{ }

Update an OPCUA datapoint for an OPCUA device of a customer.

Update an OPCUA datapoint of a specific OPCUA device and customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

datapointId
required
string

id of the datapoint to get the data for

Request Body schema: application/json
required
uuid
required
string <uuid>

unique identifier for this datapoint.

name
required
string

the name of the datapoint.

nameAlias1
string

the name alias 1 for this datapoint instance.

nameAlias2
string

the name alias 2for this datapoint instance.

device
required
string <uuid>

the device's uuid the object is related to.

active
required
boolean

if the datapoint is active or not

originalDatapointId
required
string

the id for this datapoint in the context of the remote datapoint - e.g. the ID in the supplier's system

datapointSubType
required
string

the subtype of datapoint, how the supplier of the connector would call it

datapointType
required
string

the type of datapoint, usually matches the connector type key where this datapoint receives data from

customer
required
string <uuid>

the customer this datapoint belongs to

config
object or null
correctionFactor
number
category
required
string
Enum: "weather" "energy" "environment" "status" "recognition" "unknown"
measurementType
required
string
Enum: "unknown" "temperature" "humidity" "pressure" "co2" "voltage" "voltagep1" "voltagep2" "voltagep3" "current" "currentp1" "currentp2" "currentp3" "totalcurrent" "totalactivepower" "totalreactivepower" "totalapparentpower" "totalpowerfactor" "totalactiveenergy" "totalreactiveenergy" "totalapparentenergy" "activepowerp1" "activepowerp2" "activepowerp3" "reactivepowerp1" "reactivepowerp2" "reactivepowerp3" "apparentpowerp1" "apparentpowerp2" "apparentpowerp3" "cosphip1" "cosphip2" "cosphip3" "powerfactorp1" "powerfactorp2" "powerfactorp3" "frequenzyp1" "frequenzyp2" "frequenzyp3" "energyproduction" "energyconsumption" "energyexport" "energyselfconsumption" "energyimport" "powerproduction" "powerexport" "powerconsumption" "powerimport" "powerselfconsumption" "contact" "touch" "touchcount" "presence" "presencecount" "waterdetector" "motion" "occupancy" "weatherprecipitation" "weatherprecipitationduration" "weatherhumidity" "weathercglo" "weatherwindspeed" "weatherwindgustspeed" "weatherwindgusttimestamp" "weatherwindheading" "weatherwindgustheading" "weatherhumidityrelative" "weathertemperatureair" "weatherpressure" "weatherpressurereduced" "weathersnowheight" "weathersunshineduration" "weatherdewpoint" "weathertemperaturesoil10" "weathertemperaturesoil100" "weathertemperaturewater" "personcountinside" "personcountin" "personcountout" "vehiclecountinside" "vehiclecountin" "vehiclecountout" "licenseplate" "county"

Responses

Request samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "device": "8dca31e6-c85b-4a6b-bfb4-205d45d9b3bd",
  • "active": true,
  • "originalDatapointId": "string",
  • "datapointSubType": "string",
  • "datapointType": "string",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "config": { },
  • "correctionFactor": 0,
  • "category": "weather",
  • "measurementType": "unknown"
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "device": "8dca31e6-c85b-4a6b-bfb4-205d45d9b3bd",
  • "active": true,
  • "originalDatapointId": "string",
  • "datapointSubType": "string",
  • "datapointType": "string",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "config": { },
  • "correctionFactor": 0,
  • "category": "weather",
  • "measurementType": "unknown",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

get OPCUA thing by thingId

get OPCUA thing by thingId

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

thingId
required
string

id of the thing to work with

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "thingName": "string",
  • "active": true,
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "thingArn": "string",
  • "thingId": "string",
  • "certificateArn": "string",
  • "certificateId": "string",
  • "certificatePresignedUrl": "string",
  • "publicKeyPresignedUrl": "string",
  • "privateKeyPresignedUrl": "string",
  • "zippedCertKeysPresignedUrl": "string",
  • "signedUrlExpiresAt": 0,
  • "connector": "ae3e6c6f-6542-43ae-8e3b-4654639f6b5f",
  • "macId": "string"
}

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

thingId
required
string

id of the thing to work with

Responses

Response samples

Content type
application/json
{ }

get OPCUA thing by connectorId

get OPCUA thing by connectorId

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

connectorId
required
string

id of the connector to get the data for

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "thingName": "string",
  • "active": true,
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "thingArn": "string",
  • "thingId": "string",
  • "certificateArn": "string",
  • "certificateId": "string",
  • "certificatePresignedUrl": "string",
  • "publicKeyPresignedUrl": "string",
  • "privateKeyPresignedUrl": "string",
  • "zippedCertKeysPresignedUrl": "string",
  • "signedUrlExpiresAt": 0,
  • "connector": "ae3e6c6f-6542-43ae-8e3b-4654639f6b5f",
  • "macId": "string"
}

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

connectorId
required
string

id of the connector to get the data for

Responses

Response samples

Content type
application/json
{ }

regen cert and keys for OPCUA thing by connectorId

regen cert and keys for OPCUA thing by connectorId

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

connectorId
required
string

id of the connector to get the data for

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "thingName": "string",
  • "active": true,
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "thingArn": "string",
  • "thingId": "string",
  • "certificateArn": "string",
  • "certificateId": "string",
  • "certificatePresignedUrl": "string",
  • "publicKeyPresignedUrl": "string",
  • "privateKeyPresignedUrl": "string",
  • "zippedCertKeysPresignedUrl": "string",
  • "signedUrlExpiresAt": 0,
  • "connector": "ae3e6c6f-6542-43ae-8e3b-4654639f6b5f",
  • "macId": "string"
}

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

connectorId
required
string

id of the connector to get the data for

Responses

Response samples

Content type
application/json
{ }

CALC

Get all active CALC connectors of a customer's location.

Get all active CALC connectors of a specific customer's location.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

strict
boolean

if set to true, only connectors directly associated with the given location will be returned; otherwise (defaul) also connectors which have "isAllowedOnAllLocation" will be returned, too

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

Responses

Response samples

Content type
application/json
{ }

Create CALC connector for customer.

Create CALC connector for customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

Request Body schema: application/json
required
uuid
required
string <uuid>

unique identifier for this connector

type
required
string <uuid>

the connector type's UUId the connector is an instance of.

name
required
string

the name for this Connector instance.

nameAlias1
string

the name alias 1 for this Connector instance.

nameAlias2
string

the name alias 2for this Connector instance.

location
required
string <uuid>

the location's UUId the connector is assigned to.

active
required
boolean
originalConnectorId
required
string or null

the optional original connector id for this connector

isAllowedOnAllLocations
boolean

if set to true, this connector may be used on devices which come from a different location of the customer than the one this connector is associated with. This is needed when the connector represents a system which aggregates data from different physical locations, e.g. via networks

required
object

Responses

Request samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "type": "4595bf66-18b2-445a-a884-1b08d0c2df0e",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "active": true,
  • "originalConnectorId": "string",
  • "isAllowedOnAllLocations": true,
  • "config": {
    }
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "type": "4595bf66-18b2-445a-a884-1b08d0c2df0e",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "active": true,
  • "originalConnectorId": "string",
  • "isAllowedOnAllLocations": true,
  • "config": {
    },
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

Get all CALC connectors of a customer's location.

Get all CALC connectors of a specific customer's location.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

strict
boolean

if set to true, only connectors directly associated with the given location will be returned; otherwise (defaul) also connectors which have "isAllowedOnAllLocation" will be returned, too

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

Responses

Response samples

Content type
application/json
{ }

Get CALC connector of a customer's location.

Get CALC connector of a specific customer's location.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

connectorId
required
string

id of the connector to get the data for

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "type": "4595bf66-18b2-445a-a884-1b08d0c2df0e",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "active": true,
  • "originalConnectorId": "string",
  • "isAllowedOnAllLocations": true,
  • "config": {
    },
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

connectorId
required
string

id of the connector to get the data for

Responses

Response samples

Content type
application/json
{ }

Update connector for customer's location.

Update connector for customer's location.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

connectorId
required
string

id of the connector to get the data for

Request Body schema: application/json
required
uuid
required
string <uuid>

unique identifier for this connector

type
required
string <uuid>

the connector type's UUId the connector is an instance of.

name
required
string

the name for this Connector instance.

nameAlias1
string

the name alias 1 for this Connector instance.

nameAlias2
string

the name alias 2for this Connector instance.

location
required
string <uuid>

the location's UUId the connector is assigned to.

active
required
boolean
originalConnectorId
required
string or null

the optional original connector id for this connector

isAllowedOnAllLocations
boolean

if set to true, this connector may be used on devices which come from a different location of the customer than the one this connector is associated with. This is needed when the connector represents a system which aggregates data from different physical locations, e.g. via networks

required
object

Responses

Request samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "type": "4595bf66-18b2-445a-a884-1b08d0c2df0e",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "active": true,
  • "originalConnectorId": "string",
  • "isAllowedOnAllLocations": true,
  • "config": {
    }
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "type": "4595bf66-18b2-445a-a884-1b08d0c2df0e",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "active": true,
  • "originalConnectorId": "string",
  • "isAllowedOnAllLocations": true,
  • "config": {
    },
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

Get all active CALC devices of a customer.

Get all active CALC devices that are assigned to a specific customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

Responses

Response samples

Content type
application/json
[
  • "{\n \"uuid\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"customer\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"name\": \"0001-1KF1234567\",\n \"active\": true,\n \"originalDeviceId\": \"1KF1234567\",\n \"connector\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"location\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"site\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"config\": {},\n \"deviceType\": \"generic\",\n}\n"
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

Responses

Response samples

Content type
application/json
{ }

Create a new CALC device of a customer.

Create a new CALC device of a specific customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

Request Body schema: application/json
required
uuid
required
string <uuid>

unique identifier for this device

customer
required
string <uuid>

the customer this device belongs to

name
required
string

the name of the device.

nameAlias1
string

the name alias 1 for this device instance.

nameAlias2
string

the name alias 2for this device instance.

active
required
boolean

if the device is active or not

originalDeviceId
required
string

the id for this device in the context of the device - e.g. the ID in the supplier's system

connector
required
string

the id of the connector this device belongs to

location
required
string <uuid>

the location's uuid the device can be related to.

site
string or null <uuid>

the site's uuid the device can be related to.

config
object or null

optional configuration object for the device

deviceType
required
string

the type of device

deviceSubType
string or null

the subtype of device

Responses

Request samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "active": true,
  • "originalDeviceId": "string",
  • "connector": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "site": "862ae9eb-f0eb-41b6-b3e5-39fdd26ce81c",
  • "config": { },
  • "deviceType": "dt",
  • "deviceSubType": "temperature"
}

Response samples

Content type
application/json
"{\n \"uuid\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"customer\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"name\": \"0001-1KF1234567\",\n \"active\": true,\n \"originalDeviceId\": \"1KF1234567\",\n \"connector\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"location\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"site\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"config\": {},\n \"deviceType\": \"generic\",\n}\n"

Get all CALC devices of a customer.

Get all CALC devices that are assigned to a specific customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

Responses

Response samples

Content type
application/json
[
  • "{\n \"uuid\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"customer\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"name\": \"0001-1KF1234567\",\n \"active\": true,\n \"originalDeviceId\": \"1KF1234567\",\n \"connector\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"location\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"site\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"config\": {},\n \"deviceType\": \"generic\",\n}\n"
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

Responses

Response samples

Content type
application/json
{ }

Get an CALC device of a customer.

Get an CALC device that is assigned to a specific customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Responses

Response samples

Content type
application/json
"{\n \"uuid\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"customer\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"name\": \"0001-1KF1234567\",\n \"active\": true,\n \"originalDeviceId\": \"1KF1234567\",\n \"connector\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"location\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"site\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"config\": {},\n \"deviceType\": \"generic\",\n}\n"

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Responses

Response samples

Content type
application/json
{ }

Update an CALC device of a customer.

Update an CALC device of a specific customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Request Body schema: application/json
required
uuid
required
string <uuid>

unique identifier for this device

customer
required
string <uuid>

the customer this device belongs to

name
required
string

the name of the device.

nameAlias1
string

the name alias 1 for this device instance.

nameAlias2
string

the name alias 2for this device instance.

active
required
boolean

if the device is active or not

originalDeviceId
required
string

the id for this device in the context of the device - e.g. the ID in the supplier's system

connector
required
string

the id of the connector this device belongs to

location
required
string <uuid>

the location's uuid the device can be related to.

site
string or null <uuid>

the site's uuid the device can be related to.

config
object or null

optional configuration object for the device

deviceType
required
string

the type of device

deviceSubType
string or null

the subtype of device

Responses

Request samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "active": true,
  • "originalDeviceId": "string",
  • "connector": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "site": "862ae9eb-f0eb-41b6-b3e5-39fdd26ce81c",
  • "config": { },
  • "deviceType": "dt",
  • "deviceSubType": "temperature"
}

Response samples

Content type
application/json
"{\n \"uuid\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"customer\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"name\": \"0001-1KF1234567\",\n \"active\": true,\n \"originalDeviceId\": \"1KF1234567\",\n \"connector\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"location\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"site\": \"3fa85f64-5717-4562-b3fc-2c963f66afa6\",\n \"config\": {},\n \"deviceType\": \"generic\",\n}\n"

Get all active CALC datapoints of an CALC device.

Get all active CALC datapoints that are assigned to a specific CALC device.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Responses

Response samples

Content type
application/json
{ }

Create a new CALC datapoint for an CALC device of a customer.

Create a new CALC datapoint for an CALC device of a specific customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Request Body schema: application/json
required
uuid
required
string <uuid>

unique identifier for this datapoint.

name
required
string

the name of the datapoint.

nameAlias1
string

the name alias 1 for this datapoint instance.

nameAlias2
string

the name alias 2for this datapoint instance.

device
required
string <uuid>

the device's uuid the object is related to.

active
required
boolean

if the datapoint is active or not

originalDatapointId
required
string

the id for this datapoint in the context of the remote datapoint - e.g. the ID in the supplier's system

datapointSubType
required
string

the subtype of datapoint, how the supplier of the connector would call it

datapointType
required
string

the type of datapoint, usually matches the connector type key where this datapoint receives data from

customer
required
string <uuid>

the customer this datapoint belongs to

object or null

Configuration of a calculated datapoint (the formula and its parameters)

correctionFactor
number
category
required
string
Enum: "weather" "energy" "environment" "status" "recognition" "unknown"
measurementType
required
string
Enum: "unknown" "temperature" "humidity" "pressure" "co2" "voltage" "voltagep1" "voltagep2" "voltagep3" "current" "currentp1" "currentp2" "currentp3" "totalcurrent" "totalactivepower" "totalreactivepower" "totalapparentpower" "totalpowerfactor" "totalactiveenergy" "totalreactiveenergy" "totalapparentenergy" "activepowerp1" "activepowerp2" "activepowerp3" "reactivepowerp1" "reactivepowerp2" "reactivepowerp3" "apparentpowerp1" "apparentpowerp2" "apparentpowerp3" "cosphip1" "cosphip2" "cosphip3" "powerfactorp1" "powerfactorp2" "powerfactorp3" "frequenzyp1" "frequenzyp2" "frequenzyp3" "energyproduction" "energyconsumption" "energyexport" "energyselfconsumption" "energyimport" "powerproduction" "powerexport" "powerconsumption" "powerimport" "powerselfconsumption" "contact" "touch" "touchcount" "presence" "presencecount" "waterdetector" "motion" "occupancy" "weatherprecipitation" "weatherprecipitationduration" "weatherhumidity" "weathercglo" "weatherwindspeed" "weatherwindgustspeed" "weatherwindgusttimestamp" "weatherwindheading" "weatherwindgustheading" "weatherhumidityrelative" "weathertemperatureair" "weatherpressure" "weatherpressurereduced" "weathersnowheight" "weathersunshineduration" "weatherdewpoint" "weathertemperaturesoil10" "weathertemperaturesoil100" "weathertemperaturewater" "personcountinside" "personcountin" "personcountout" "vehiclecountinside" "vehiclecountin" "vehiclecountout" "licenseplate" "county"

Responses

Request samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "device": "8dca31e6-c85b-4a6b-bfb4-205d45d9b3bd",
  • "active": true,
  • "originalDatapointId": "string",
  • "datapointSubType": "string",
  • "datapointType": "string",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "config": {
    },
  • "correctionFactor": 0,
  • "category": "weather",
  • "measurementType": "unknown"
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "device": "8dca31e6-c85b-4a6b-bfb4-205d45d9b3bd",
  • "active": true,
  • "originalDatapointId": "string",
  • "datapointSubType": "string",
  • "datapointType": "string",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "config": {
    },
  • "correctionFactor": 0,
  • "category": "weather",
  • "measurementType": "unknown",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

Get all CALC datapoints for an CALC device of a customer.

Get all CALC datapoints that are assigned to a specific CALC device of a customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Responses

Response samples

Content type
application/json
{ }

Get an CALC datapoint for an CALC device of a customer.

Get an CALC datapoint that is assigned to a specific CALC device and customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

datapointId
required
string

id of the datapoint to get the data for

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "device": "8dca31e6-c85b-4a6b-bfb4-205d45d9b3bd",
  • "active": true,
  • "originalDatapointId": "string",
  • "datapointSubType": "string",
  • "datapointType": "string",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "config": {
    },
  • "correctionFactor": 0,
  • "category": "weather",
  • "measurementType": "unknown",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

datapointId
required
string

id of the datapoint to get the data for

Responses

Response samples

Content type
application/json
{ }

Update an CALC datapoint for an CALC device of a customer.

Update an CALC datapoint of a specific CALC device and customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

datapointId
required
string

id of the datapoint to get the data for

Request Body schema: application/json
required
uuid
required
string <uuid>

unique identifier for this datapoint.

name
required
string

the name of the datapoint.

nameAlias1
string

the name alias 1 for this datapoint instance.

nameAlias2
string

the name alias 2for this datapoint instance.

device
required
string <uuid>

the device's uuid the object is related to.

active
required
boolean

if the datapoint is active or not

originalDatapointId
required
string

the id for this datapoint in the context of the remote datapoint - e.g. the ID in the supplier's system

datapointSubType
required
string

the subtype of datapoint, how the supplier of the connector would call it

datapointType
required
string

the type of datapoint, usually matches the connector type key where this datapoint receives data from

customer
required
string <uuid>

the customer this datapoint belongs to

object or null

Configuration of a calculated datapoint (the formula and its parameters)

correctionFactor
number
category
required
string
Enum: "weather" "energy" "environment" "status" "recognition" "unknown"
measurementType
required
string
Enum: "unknown" "temperature" "humidity" "pressure" "co2" "voltage" "voltagep1" "voltagep2" "voltagep3" "current" "currentp1" "currentp2" "currentp3" "totalcurrent" "totalactivepower" "totalreactivepower" "totalapparentpower" "totalpowerfactor" "totalactiveenergy" "totalreactiveenergy" "totalapparentenergy" "activepowerp1" "activepowerp2" "activepowerp3" "reactivepowerp1" "reactivepowerp2" "reactivepowerp3" "apparentpowerp1" "apparentpowerp2" "apparentpowerp3" "cosphip1" "cosphip2" "cosphip3" "powerfactorp1" "powerfactorp2" "powerfactorp3" "frequenzyp1" "frequenzyp2" "frequenzyp3" "energyproduction" "energyconsumption" "energyexport" "energyselfconsumption" "energyimport" "powerproduction" "powerexport" "powerconsumption" "powerimport" "powerselfconsumption" "contact" "touch" "touchcount" "presence" "presencecount" "waterdetector" "motion" "occupancy" "weatherprecipitation" "weatherprecipitationduration" "weatherhumidity" "weathercglo" "weatherwindspeed" "weatherwindgustspeed" "weatherwindgusttimestamp" "weatherwindheading" "weatherwindgustheading" "weatherhumidityrelative" "weathertemperatureair" "weatherpressure" "weatherpressurereduced" "weathersnowheight" "weathersunshineduration" "weatherdewpoint" "weathertemperaturesoil10" "weathertemperaturesoil100" "weathertemperaturewater" "personcountinside" "personcountin" "personcountout" "vehiclecountinside" "vehiclecountin" "vehiclecountout" "licenseplate" "county"

Responses

Request samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "device": "8dca31e6-c85b-4a6b-bfb4-205d45d9b3bd",
  • "active": true,
  • "originalDatapointId": "string",
  • "datapointSubType": "string",
  • "datapointType": "string",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "config": {
    },
  • "correctionFactor": 0,
  • "category": "weather",
  • "measurementType": "unknown"
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "device": "8dca31e6-c85b-4a6b-bfb4-205d45d9b3bd",
  • "active": true,
  • "originalDatapointId": "string",
  • "datapointSubType": "string",
  • "datapointType": "string",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "config": {
    },
  • "correctionFactor": 0,
  • "category": "weather",
  • "measurementType": "unknown",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

Validate the given config

Validate the fiven config in the context of the given CALC connector of a customer's location.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

connectorId
required
string

id of the connector to get the data for

Request Body schema: application/json
required
formula
required
string

the formula that should be calculated; any Javascript expression that results in a number can be used

required
object

the datapoints that should be used for the calculation

object

the global variables that should be used for the calculation

dp2dpTimeSeconds
integer or null

the time in seconds that should be used for waiting for the referenced datapoints to send new data

scheduleSeconds
integer or null

the schedule in seconds between two calculations; use either this or minutesOfHour

minutesOfHour
Array of integers <int32> [ items <int32 > ]

the minutes of the hour to run the calculation; use either this or scheduleSeconds

Responses

Request samples

Content type
application/json
{
  • "formula": "U * I * cos(phi) * sqrt(3) * constA",
  • "datapoints": {
    },
  • "globals": {
    },
  • "dp2dpTimeSeconds"": 60,
  • "minutesOfHour": [
    ]
}

Response samples

Content type
application/json
{
  • "status": "ok",
  • "errors": [
    ],
  • "calculatedResult": 0,
  • "latestData": {
    }
}

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

connectorId
required
string

id of the connector to get the data for

Responses

Response samples

Content type
application/json
{ }

ALARMING

Get all active alarm triggers of a customer

Get all active alarm triggers of a customer

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

query Parameters
locationId
string

Optional locationId to filter by

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

Responses

Response samples

Content type
application/json
{ }

Create a new alarming trigger for a customer

Create a new alarming trigger for a customer

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

Request Body schema: application/json
required
One of
One of
name
required
string
description
required
string
uuid
required
string <uuid>
active
required
boolean
customer
required
string <uuid>
timeoutMinutes
required
integer

the timeout in minutes

datapoint
required
string <uuid>

the datapoint UUID to create the alarm for

triggerType
required
string
Value: "DATAPOINT_TIMEOUT"

Responses

Request samples

Content type
application/json
Example
{
  • "name": "string",
  • "description": "string",
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "active": true,
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "timeoutMinutes": 0,
  • "datapoint": "52aa66de-e553-4383-9e16-52bfcd0efb0f",
  • "triggerType": "DATAPOINT_TIMEOUT"
}

Response samples

Content type
application/json
Example
{
  • "name": "string",
  • "description": "string",
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "active": true,
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "timeoutMinutes": 0,
  • "datapoint": "52aa66de-e553-4383-9e16-52bfcd0efb0f",
  • "triggerType": "DATAPOINT_TIMEOUT",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

Get all alarm triggers for a given customer

Get all alarm triggers for a given customer

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

query Parameters
locationId
string

Optional locationId to filter by

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

Responses

Response samples

Content type
application/json
{ }

Evaluate alarming trigger setup for a customer with the current/latest data

Evaluate alarming trigger setup for a customer with the current/latest data

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

Request Body schema: application/json
required
One of
One of
name
required
string
description
required
string
uuid
required
string <uuid>
active
required
boolean
customer
required
string <uuid>
timeoutMinutes
required
integer

the timeout in minutes

datapoint
required
string <uuid>

the datapoint UUID to create the alarm for

triggerType
required
string
Value: "DATAPOINT_TIMEOUT"

Responses

Request samples

Content type
application/json
Example
{
  • "name": "string",
  • "description": "string",
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "active": true,
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "timeoutMinutes": 0,
  • "datapoint": "52aa66de-e553-4383-9e16-52bfcd0efb0f",
  • "triggerType": "DATAPOINT_TIMEOUT"
}

Response samples

Content type
application/json
{
  • "evaluationResult": "string",
  • "isFormulaCorrect": true,
  • "message": "string"
}

Get alarm trigger for a given customer

Get alarm trigger for a given customer

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

alarmTriggerId
required
string

id of the alarm trigger

Responses

Response samples

Content type
application/json
Example
{
  • "name": "string",
  • "description": "string",
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "active": true,
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "timeoutMinutes": 0,
  • "datapoint": "52aa66de-e553-4383-9e16-52bfcd0efb0f",
  • "triggerType": "DATAPOINT_TIMEOUT",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

alarmTriggerId
required
string

id of the alarm trigger

Responses

Response samples

Content type
application/json
{ }

Update an alarm trigger of a customer

Update an alarm trigger of a customer

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

alarmTriggerId
required
string

id of the alarm trigger

Request Body schema: application/json
required
One of
One of
name
required
string
description
required
string
uuid
required
string <uuid>
active
required
boolean
customer
required
string <uuid>
timeoutMinutes
required
integer

the timeout in minutes

datapoint
required
string <uuid>

the datapoint UUID to create the alarm for

triggerType
required
string
Value: "DATAPOINT_TIMEOUT"

Responses

Request samples

Content type
application/json
Example
{
  • "name": "string",
  • "description": "string",
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "active": true,
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "timeoutMinutes": 0,
  • "datapoint": "52aa66de-e553-4383-9e16-52bfcd0efb0f",
  • "triggerType": "DATAPOINT_TIMEOUT"
}

Response samples

Content type
application/json
Example
{
  • "name": "string",
  • "description": "string",
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "active": true,
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "timeoutMinutes": 0,
  • "datapoint": "52aa66de-e553-4383-9e16-52bfcd0efb0f",
  • "triggerType": "DATAPOINT_TIMEOUT",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

Deletes an alarm trigger (and its associated actions) of a customer

Deletes (better: marks as deleted) an alarm trigger (and its associated actions) of a customer

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

alarmTriggerId
required
string

id of the alarm trigger

Responses

Response samples

Content type
application/json
{ }

Get active alarm triggers for a given datapoint of a customer

Get active alarm triggers for a given datapoint of a customer

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

datapointId
required
string

id of the datapoint to get the data for

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

datapointId
required
string

id of the datapoint to get the data for

Responses

Response samples

Content type
application/json
{ }

Get all alarm triggers for a given datapoint of a customer

Get all alarm triggers for a given datapoint of a customer

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

datapointId
required
string

id of the datapoint to get the data for

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

datapointId
required
string

id of the datapoint to get the data for

Responses

Response samples

Content type
application/json
{ }

Get active alarm triggers for a given device of a customer

Get active alarm triggers for a given device of a customer

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Responses

Response samples

Content type
application/json
{ }

Get all alarm triggers for a given device of a customer

Get all alarm triggers for a given device of a customer

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Responses

Response samples

Content type
application/json
{ }

Get active alarm triggers for a given connector of a customer

Get active alarm triggers for a given connector of a customer

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

connectorId
required
string

id of the connector to get the data for

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

connectorId
required
string

id of the connector to get the data for

Responses

Response samples

Content type
application/json
{ }

Get all alarm triggers for a given connector of a customer

Get all alarm triggers for a given connector of a customer

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

connectorId
required
string

id of the connector to get the data for

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

connectorId
required
string

id of the connector to get the data for

Responses

Response samples

Content type
application/json
{ }

Get active alarm trigger actions for a given alarm trigger and customer

Get active alarm trigger actions for a given alarm trigger and customer

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

alarmTriggerId
required
string

id of the alarm trigger for which to manage alarm actions

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

alarmTriggerId
required
string

id of the alarm trigger for which to manage alarm actions

Responses

Response samples

Content type
application/json
{ }

Create a new alarm trigger action for a given alarm trigger and customer

Create a new alarm trigger action for a given alarm trigger and customer

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

alarmTriggerId
required
string

id of the alarm trigger for which to manage alarm actions

Request Body schema: application/json
required
One of
uuid
required
string <uuid>

the UUID of the action

alarmTrigger
required
string <uuid>

the alarm trigger UUID to create the action for

actionType
required
string (alarmTriggerActionType)
Value: "EMAIL"
name
required
string

the name of the action

description
string

the description of the action

active
required
boolean

whether the action is active or not

emails
required
Array of strings <email> [ items <email > ]

the email address to send the alarm to

subjectExpression
required
string

the expression to evaluate to create the subject

bodyExpression
required
string

the expression to evaluate to create the body

Responses

Request samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "alarmTrigger": "e3228558-5084-4986-981d-8ecc16381df1",
  • "actionType": "EMAIL",
  • "name": "string",
  • "description": "string",
  • "active": true,
  • "emails": [
    ],
  • "subjectExpression": "Alarm {{triggerName}} triggered at {{triggerTime}}\n",
  • "bodyExpression": "Hello! Alarm {{triggerName}} for {{datapointName}}/{{deviceName}} at {{locationName}}/{{siteName}} triggered at {{triggerTime}} with the following details:\n- value from measurement: {{datapointValue}}\n- time of measurement: {{time}}\n- alarm formula: {{formula}}\n- result of formula evaluation: {{formulaResult}}\n"
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "alarmTrigger": "e3228558-5084-4986-981d-8ecc16381df1",
  • "actionType": "EMAIL",
  • "name": "string",
  • "description": "string",
  • "active": true,
  • "emails": [
    ],
  • "subjectExpression": "Alarm {{triggerName}} triggered at {{triggerTime}}\n",
  • "bodyExpression": "Hello! Alarm {{triggerName}} for {{datapointName}}/{{deviceName}} at {{locationName}}/{{siteName}} triggered at {{triggerTime}} with the following details:\n- value from measurement: {{datapointValue}}\n- time of measurement: {{time}}\n- alarm formula: {{formula}}\n- result of formula evaluation: {{formulaResult}}\n",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

Get all alarm trigger actions for a given alarm trigger of a customer

Get all alarm trigger actions for a given alarm trigger of a customer

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

alarmTriggerId
required
string

id of the alarm trigger for which to the the action for

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

alarmTriggerId
required
string

id of the alarm trigger for which to the the action for

Responses

Response samples

Content type
application/json
{ }

Get alarm trigger action for a given alarm trigger and customer

Get alarm trigger action for a given alarm trigger and customer

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

alarmTriggerId
required
string

id of the alarm trigger

alarmActionId
required
string

id of the action of a given alarm trigger and customer

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "alarmTrigger": "e3228558-5084-4986-981d-8ecc16381df1",
  • "actionType": "EMAIL",
  • "name": "string",
  • "description": "string",
  • "active": true,
  • "emails": [
    ],
  • "subjectExpression": "Alarm {{triggerName}} triggered at {{triggerTime}}\n",
  • "bodyExpression": "Hello! Alarm {{triggerName}} for {{datapointName}}/{{deviceName}} at {{locationName}}/{{siteName}} triggered at {{triggerTime}} with the following details:\n- value from measurement: {{datapointValue}}\n- time of measurement: {{time}}\n- alarm formula: {{formula}}\n- result of formula evaluation: {{formulaResult}}\n",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

alarmTriggerId
required
string

id of the alarm trigger

alarmActionId
required
string

id of the action of a given alarm trigger and customer

Responses

Response samples

Content type
application/json
{ }

Update an alarm trigger action of an alarm trigger of a customer

Update an alarm trigger action of an alarm trigger of a customer

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

alarmTriggerId
required
string

id of the alarm trigger

alarmActionId
required
string

id of the action of a given alarm trigger and customer

Request Body schema: application/json
required
One of
uuid
required
string <uuid>

the UUID of the action

alarmTrigger
required
string <uuid>

the alarm trigger UUID to create the action for

actionType
required
string (alarmTriggerActionType)
Value: "EMAIL"
name
required
string

the name of the action

description
string

the description of the action

active
required
boolean

whether the action is active or not

emails
required
Array of strings <email> [ items <email > ]

the email address to send the alarm to

subjectExpression
required
string

the expression to evaluate to create the subject

bodyExpression
required
string

the expression to evaluate to create the body

Responses

Request samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "alarmTrigger": "e3228558-5084-4986-981d-8ecc16381df1",
  • "actionType": "EMAIL",
  • "name": "string",
  • "description": "string",
  • "active": true,
  • "emails": [
    ],
  • "subjectExpression": "Alarm {{triggerName}} triggered at {{triggerTime}}\n",
  • "bodyExpression": "Hello! Alarm {{triggerName}} for {{datapointName}}/{{deviceName}} at {{locationName}}/{{siteName}} triggered at {{triggerTime}} with the following details:\n- value from measurement: {{datapointValue}}\n- time of measurement: {{time}}\n- alarm formula: {{formula}}\n- result of formula evaluation: {{formulaResult}}\n"
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "alarmTrigger": "e3228558-5084-4986-981d-8ecc16381df1",
  • "actionType": "EMAIL",
  • "name": "string",
  • "description": "string",
  • "active": true,
  • "emails": [
    ],
  • "subjectExpression": "Alarm {{triggerName}} triggered at {{triggerTime}}\n",
  • "bodyExpression": "Hello! Alarm {{triggerName}} for {{datapointName}}/{{deviceName}} at {{locationName}}/{{siteName}} triggered at {{triggerTime}} with the following details:\n- value from measurement: {{datapointValue}}\n- time of measurement: {{time}}\n- alarm formula: {{formula}}\n- result of formula evaluation: {{formulaResult}}\n",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

Deletes an alarm trigger action of an alarm trigger of a customer

Deletes (better: marks as deleted) an alarm trigger action of an alarm trigger of a customer

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

alarmTriggerId
required
string

id of the alarm trigger

alarmActionId
required
string

id of the action of a given alarm trigger and customer

Responses

Response samples

Content type
application/json
{ }

FLIC

Get all active FLIC connectors of a customer's location.

Get all active FLIC connectors of a specific customer's location.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

strict
boolean

if set to true, only connectors directly associated with the given location will be returned; otherwise (defaul) also connectors which have "isAllowedOnAllLocation" will be returned, too

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

Responses

Response samples

Content type
application/json
{ }

Create FLIC connector for customer.

Create FLIC connector for customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

Request Body schema: application/json
required
uuid
required
string <uuid>

unique identifier for this connector

type
required
string <uuid>

the connector type's UUId the connector is an instance of.

name
required
string

the name for this Connector instance.

nameAlias1
string

the name alias 1 for this Connector instance.

nameAlias2
string

the name alias 2for this Connector instance.

location
required
string <uuid>

the location's UUId the connector is assigned to.

active
required
boolean
originalConnectorId
required
string

the optional original connector id for this connector

isAllowedOnAllLocations
boolean

if set to true, this connector may be used on devices which come from a different location of the customer than the one this connector is associated with. This is needed when the connector represents a system which aggregates data from different physical locations, e.g. via networks

required
object or null

Responses

Request samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "type": "4595bf66-18b2-445a-a884-1b08d0c2df0e",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "active": true,
  • "originalConnectorId": "string",
  • "isAllowedOnAllLocations": true,
  • "config": {
    }
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "type": "4595bf66-18b2-445a-a884-1b08d0c2df0e",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "active": true,
  • "originalConnectorId": "string",
  • "isAllowedOnAllLocations": true,
  • "config": {
    },
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

Get all FLIC connectors of a customer's location.

Get all FLIC connectors of a specific customer's location.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

strict
boolean

if set to true, only connectors directly associated with the given location will be returned; otherwise (defaul) also connectors which have "isAllowedOnAllLocation" will be returned, too

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

Responses

Response samples

Content type
application/json
{ }

Get FLIC connector of a customer's location.

Get FLIC connector of a specific customer's location.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

connectorId
required
string

id of the connector to get the data for

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "type": "4595bf66-18b2-445a-a884-1b08d0c2df0e",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "active": true,
  • "originalConnectorId": "string",
  • "isAllowedOnAllLocations": true,
  • "config": {
    },
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

connectorId
required
string

id of the connector to get the data for

Responses

Response samples

Content type
application/json
{ }

Update connector for customer's location.

Update connector for customer's location.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

connectorId
required
string

id of the connector to get the data for

Request Body schema: application/json
required
uuid
required
string <uuid>

unique identifier for this connector

type
required
string <uuid>

the connector type's UUId the connector is an instance of.

name
required
string

the name for this Connector instance.

nameAlias1
string

the name alias 1 for this Connector instance.

nameAlias2
string

the name alias 2for this Connector instance.

location
required
string <uuid>

the location's UUId the connector is assigned to.

active
required
boolean
originalConnectorId
required
string

the optional original connector id for this connector

isAllowedOnAllLocations
boolean

if set to true, this connector may be used on devices which come from a different location of the customer than the one this connector is associated with. This is needed when the connector represents a system which aggregates data from different physical locations, e.g. via networks

required
object or null

Responses

Request samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "type": "4595bf66-18b2-445a-a884-1b08d0c2df0e",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "active": true,
  • "originalConnectorId": "string",
  • "isAllowedOnAllLocations": true,
  • "config": {
    }
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "type": "4595bf66-18b2-445a-a884-1b08d0c2df0e",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "active": true,
  • "originalConnectorId": "string",
  • "isAllowedOnAllLocations": true,
  • "config": {
    },
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

Get a FLIC AWS IoT thing for a FLIC connector of a customer.

Get a FLIC AWS IoT thing for a FLIC connector of a customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

connectorId
required
string

id of the connector to get the data for

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "thingName": "string",
  • "active": true,
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "thingArn": "string",
  • "thingId": "string",
  • "username": "string",
  • "connector": "ae3e6c6f-6542-43ae-8e3b-4654639f6b5f",
  • "flicId": "string",
  • "adapterConfig": {
    }
}

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

connectorId
required
string

id of the connector to get the data for

Responses

Response samples

Content type
application/json
{ }

Get all active FLIC devices of a customer.

Get all active FLIC devices that are assigned to a specific customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

Responses

Response samples

Content type
application/json
{ }

Create a new FLIC device of a customer.

Create a new FLIC device of a specific customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

Request Body schema: application/json
required
uuid
required
string <uuid>

unique identifier for this device

customer
required
string <uuid>

the customer this device belongs to

name
required
string

the name of the device.

nameAlias1
string

the name alias 1 for this device instance.

nameAlias2
string

the name alias 2for this device instance.

active
required
boolean

if the device is active or not

originalDeviceId
required
string

the id for this device in the context of the device - e.g. the ID in the supplier's system

connector
required
string

the id of the connector this device belongs to

location
required
string <uuid>

the location's uuid the device can be related to.

site
string or null <uuid>

the site's uuid the device can be related to.

config
object or null

optional configuration object for the device

deviceType
required
string

the type of device

deviceSubType
string or null

the subtype of device

Responses

Request samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "active": true,
  • "originalDeviceId": "string",
  • "connector": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "site": "862ae9eb-f0eb-41b6-b3e5-39fdd26ce81c",
  • "config": { },
  • "deviceType": "dt",
  • "deviceSubType": "temperature"
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "active": true,
  • "originalDeviceId": "string",
  • "connector": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "site": "862ae9eb-f0eb-41b6-b3e5-39fdd26ce81c",
  • "config": { },
  • "deviceType": "dt",
  • "deviceSubType": "temperature",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

Get all FLIC devices of a customer.

Get all FLIC devices that are assigned to a specific customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

Responses

Response samples

Content type
application/json
{ }

Get a FLIC device of a customer.

Get a FLIC device that is assigned to a specific customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "active": true,
  • "originalDeviceId": "string",
  • "connector": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "site": "862ae9eb-f0eb-41b6-b3e5-39fdd26ce81c",
  • "config": { },
  • "deviceType": "dt",
  • "deviceSubType": "temperature",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Responses

Response samples

Content type
application/json
{ }

Update a FLIC device of a customer.

Update a FLIC device of a specific customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Request Body schema: application/json
required
uuid
required
string <uuid>

unique identifier for this device

customer
required
string <uuid>

the customer this device belongs to

name
required
string

the name of the device.

nameAlias1
string

the name alias 1 for this device instance.

nameAlias2
string

the name alias 2for this device instance.

active
required
boolean

if the device is active or not

originalDeviceId
required
string

the id for this device in the context of the device - e.g. the ID in the supplier's system

connector
required
string

the id of the connector this device belongs to

location
required
string <uuid>

the location's uuid the device can be related to.

site
string or null <uuid>

the site's uuid the device can be related to.

config
object or null

optional configuration object for the device

deviceType
required
string

the type of device

deviceSubType
string or null

the subtype of device

Responses

Request samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "active": true,
  • "originalDeviceId": "string",
  • "connector": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "site": "862ae9eb-f0eb-41b6-b3e5-39fdd26ce81c",
  • "config": { },
  • "deviceType": "dt",
  • "deviceSubType": "temperature"
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "active": true,
  • "originalDeviceId": "string",
  • "connector": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "site": "862ae9eb-f0eb-41b6-b3e5-39fdd26ce81c",
  • "config": { },
  • "deviceType": "dt",
  • "deviceSubType": "temperature",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

Get all active FLIC datapoints of a FLIC device.

Get all active FLIC datapoints that are assigned to a specific FLIC device.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Responses

Response samples

Content type
application/json
{ }

Create a new FLIC datapoint for an FLIC device of a customer.

Create a new FLIC datapoint for an FLIC device of a specific customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Request Body schema: application/json
required
uuid
required
string <uuid>

unique identifier for this datapoint.

name
required
string

the name of the datapoint.

nameAlias1
string

the name alias 1 for this datapoint instance.

nameAlias2
string

the name alias 2for this datapoint instance.

device
required
string <uuid>

the device's uuid the object is related to.

active
required
boolean

if the datapoint is active or not

originalDatapointId
required
string

the id for this datapoint in the context of the remote datapoint - e.g. the ID in the supplier's system

datapointSubType
required
string

the subtype of datapoint, how the supplier of the connector would call it

datapointType
required
string

the type of datapoint, usually matches the connector type key where this datapoint receives data from

customer
required
string <uuid>

the customer this datapoint belongs to

config
object or null
correctionFactor
number
category
required
string
Enum: "weather" "energy" "environment" "status" "recognition" "unknown"
measurementType
required
string
Enum: "unknown" "temperature" "humidity" "pressure" "co2" "voltage" "voltagep1" "voltagep2" "voltagep3" "current" "currentp1" "currentp2" "currentp3" "totalcurrent" "totalactivepower" "totalreactivepower" "totalapparentpower" "totalpowerfactor" "totalactiveenergy" "totalreactiveenergy" "totalapparentenergy" "activepowerp1" "activepowerp2" "activepowerp3" "reactivepowerp1" "reactivepowerp2" "reactivepowerp3" "apparentpowerp1" "apparentpowerp2" "apparentpowerp3" "cosphip1" "cosphip2" "cosphip3" "powerfactorp1" "powerfactorp2" "powerfactorp3" "frequenzyp1" "frequenzyp2" "frequenzyp3" "energyproduction" "energyconsumption" "energyexport" "energyselfconsumption" "energyimport" "powerproduction" "powerexport" "powerconsumption" "powerimport" "powerselfconsumption" "contact" "touch" "touchcount" "presence" "presencecount" "waterdetector" "motion" "occupancy" "weatherprecipitation" "weatherprecipitationduration" "weatherhumidity" "weathercglo" "weatherwindspeed" "weatherwindgustspeed" "weatherwindgusttimestamp" "weatherwindheading" "weatherwindgustheading" "weatherhumidityrelative" "weathertemperatureair" "weatherpressure" "weatherpressurereduced" "weathersnowheight" "weathersunshineduration" "weatherdewpoint" "weathertemperaturesoil10" "weathertemperaturesoil100" "weathertemperaturewater" "personcountinside" "personcountin" "personcountout" "vehiclecountinside" "vehiclecountin" "vehiclecountout" "licenseplate" "county"

Responses

Request samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "device": "8dca31e6-c85b-4a6b-bfb4-205d45d9b3bd",
  • "active": true,
  • "originalDatapointId": "string",
  • "datapointSubType": "string",
  • "datapointType": "string",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "config": { },
  • "correctionFactor": 0,
  • "category": "weather",
  • "measurementType": "unknown"
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "device": "8dca31e6-c85b-4a6b-bfb4-205d45d9b3bd",
  • "active": true,
  • "originalDatapointId": "string",
  • "datapointSubType": "string",
  • "datapointType": "string",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "config": { },
  • "correctionFactor": 0,
  • "category": "weather",
  • "measurementType": "unknown",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

Get all FLIC datapoints for a FLIC device of a customer.

Get all FLIC datapoints that are assigned to a specific FLIC device of a customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Responses

Response samples

Content type
application/json
{ }

Get a FLIC datapoint for a FLIC device of a customer.

Get a FLIC datapoint that is assigned to a specific FLIC device and customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

datapointId
required
string

id of the datapoint to get the data for

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "device": "8dca31e6-c85b-4a6b-bfb4-205d45d9b3bd",
  • "active": true,
  • "originalDatapointId": "string",
  • "datapointSubType": "string",
  • "datapointType": "string",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "config": { },
  • "correctionFactor": 0,
  • "category": "weather",
  • "measurementType": "unknown",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

datapointId
required
string

id of the datapoint to get the data for

Responses

Response samples

Content type
application/json
{ }

Update a FLIC datapoint for a FLIC device of a customer.

Update a FLIC datapoint of a specific FLIC device and customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

datapointId
required
string

id of the datapoint to get the data for

Request Body schema: application/json
required
uuid
required
string <uuid>

unique identifier for this datapoint.

name
required
string

the name of the datapoint.

nameAlias1
string

the name alias 1 for this datapoint instance.

nameAlias2
string

the name alias 2for this datapoint instance.

device
required
string <uuid>

the device's uuid the object is related to.

active
required
boolean

if the datapoint is active or not

originalDatapointId
required
string

the id for this datapoint in the context of the remote datapoint - e.g. the ID in the supplier's system

datapointSubType
required
string

the subtype of datapoint, how the supplier of the connector would call it

datapointType
required
string

the type of datapoint, usually matches the connector type key where this datapoint receives data from

customer
required
string <uuid>

the customer this datapoint belongs to

config
object or null
correctionFactor
number
category
required
string
Enum: "weather" "energy" "environment" "status" "recognition" "unknown"
measurementType
required
string
Enum: "unknown" "temperature" "humidity" "pressure" "co2" "voltage" "voltagep1" "voltagep2" "voltagep3" "current" "currentp1" "currentp2" "currentp3" "totalcurrent" "totalactivepower" "totalreactivepower" "totalapparentpower" "totalpowerfactor" "totalactiveenergy" "totalreactiveenergy" "totalapparentenergy" "activepowerp1" "activepowerp2" "activepowerp3" "reactivepowerp1" "reactivepowerp2" "reactivepowerp3" "apparentpowerp1" "apparentpowerp2" "apparentpowerp3" "cosphip1" "cosphip2" "cosphip3" "powerfactorp1" "powerfactorp2" "powerfactorp3" "frequenzyp1" "frequenzyp2" "frequenzyp3" "energyproduction" "energyconsumption" "energyexport" "energyselfconsumption" "energyimport" "powerproduction" "powerexport" "powerconsumption" "powerimport" "powerselfconsumption" "contact" "touch" "touchcount" "presence" "presencecount" "waterdetector" "motion" "occupancy" "weatherprecipitation" "weatherprecipitationduration" "weatherhumidity" "weathercglo" "weatherwindspeed" "weatherwindgustspeed" "weatherwindgusttimestamp" "weatherwindheading" "weatherwindgustheading" "weatherhumidityrelative" "weathertemperatureair" "weatherpressure" "weatherpressurereduced" "weathersnowheight" "weathersunshineduration" "weatherdewpoint" "weathertemperaturesoil10" "weathertemperaturesoil100" "weathertemperaturewater" "personcountinside" "personcountin" "personcountout" "vehiclecountinside" "vehiclecountin" "vehiclecountout" "licenseplate" "county"

Responses

Request samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "device": "8dca31e6-c85b-4a6b-bfb4-205d45d9b3bd",
  • "active": true,
  • "originalDatapointId": "string",
  • "datapointSubType": "string",
  • "datapointType": "string",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "config": { },
  • "correctionFactor": 0,
  • "category": "weather",
  • "measurementType": "unknown"
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "device": "8dca31e6-c85b-4a6b-bfb4-205d45d9b3bd",
  • "active": true,
  • "originalDatapointId": "string",
  • "datapointSubType": "string",
  • "datapointType": "string",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "config": { },
  • "correctionFactor": 0,
  • "category": "weather",
  • "measurementType": "unknown",
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

AVA

get AVA Datapoint Types

get AVA Datapoint Types

Authorizations:
custom-auth

Responses

Response samples

Content type
application/json
{
  • "LPR": [
    ],
  • "COUNTS": [
    ]
}

for CORS

Authorizations:
custom-auth

Responses

Response samples

Content type
application/json
{ }

Get all active AVA connectors of a customer's location.

Get all active AVA connectors of a specific customer's location.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

strict
boolean

if set to true, only connectors directly associated with the given location will be returned; otherwise (defaul) also connectors which have "isAllowedOnAllLocation" will be returned, too

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

Responses

Response samples

Content type
application/json
{ }

Create AVA connector for customer.

Create AVA connector for customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

Request Body schema: application/json
required
uuid
required
string <uuid>

unique identifier for this connector

type
required
string <uuid>

the connector type's UUId the connector is an instance of.

name
required
string

the name for this Connector instance.

nameAlias1
string

the name alias 1 for this Connector instance.

nameAlias2
string

the name alias 2for this Connector instance.

location
required
string <uuid>

the location's UUId the connector is assigned to.

active
required
boolean
originalConnectorId
string

the optional original connector id for this connector

isAllowedOnAllLocations
boolean

if set to true, this connector may be used on devices which come from a different location of the customer than the one this connector is associated with. This is needed when the connector represents a system which aggregates data from different physical locations, e.g. via networks

required
object or null

Responses

Request samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "type": "4595bf66-18b2-445a-a884-1b08d0c2df0e",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "active": true,
  • "originalConnectorId": "string",
  • "isAllowedOnAllLocations": true,
  • "config": {
    }
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "type": "4595bf66-18b2-445a-a884-1b08d0c2df0e",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "active": true,
  • "originalConnectorId": "string",
  • "isAllowedOnAllLocations": true,
  • "config": {
    },
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

Get all AVA connectors of a customer's location.

Get all AVA connectors of a specific customer's location.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

strict
boolean

if set to true, only connectors directly associated with the given location will be returned; otherwise (defaul) also connectors which have "isAllowedOnAllLocation" will be returned, too

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

Responses

Response samples

Content type
application/json
{ }

Get AVA connector of a customer's location.

Get AVA connector of a specific customer's location.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

connectorId
required
string

id of the connector to get the data for

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "type": "4595bf66-18b2-445a-a884-1b08d0c2df0e",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "active": true,
  • "originalConnectorId": "string",
  • "isAllowedOnAllLocations": true,
  • "config": {
    },
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

connectorId
required
string

id of the connector to get the data for

Responses

Response samples

Content type
application/json
{ }

Update connector for customer's location.

Update connector for customer's location.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

locationId
required
string

id of the location to get the data for

connectorId
required
string

id of the connector to get the data for

Request Body schema: application/json
required
uuid
required
string <uuid>

unique identifier for this connector

type
required
string <uuid>

the connector type's UUId the connector is an instance of.

name
required
string

the name for this Connector instance.

nameAlias1
string

the name alias 1 for this Connector instance.

nameAlias2
string

the name alias 2for this Connector instance.

location
required
string <uuid>

the location's UUId the connector is assigned to.

active
required
boolean
originalConnectorId
string

the optional original connector id for this connector

isAllowedOnAllLocations
boolean

if set to true, this connector may be used on devices which come from a different location of the customer than the one this connector is associated with. This is needed when the connector represents a system which aggregates data from different physical locations, e.g. via networks

required
object or null

Responses

Request samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "type": "4595bf66-18b2-445a-a884-1b08d0c2df0e",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "active": true,
  • "originalConnectorId": "string",
  • "isAllowedOnAllLocations": true,
  • "config": {
    }
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "type": "4595bf66-18b2-445a-a884-1b08d0c2df0e",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "active": true,
  • "originalConnectorId": "string",
  • "isAllowedOnAllLocations": true,
  • "config": {
    },
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

Get all active AVA devices of a customer.

Get all active AVA devices that are assigned to a specific customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

Responses

Response samples

Content type
application/json
{ }

Create a new AVA device of a customer.

Create a new AVA device of a specific customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

Request Body schema: application/json
required
uuid
required
string <uuid>

unique identifier for this device

customer
required
string <uuid>

the customer this device belongs to

name
required
string

the name of the device.

nameAlias1
string

the name alias 1 for this device instance.

nameAlias2
string

the name alias 2for this device instance.

active
required
boolean

if the device is active or not

originalDeviceId
required
string

the id for this device in the context of the device - e.g. the ID in the supplier's system

connector
required
string

the id of the connector this device belongs to

location
required
string <uuid>

the location's uuid the device can be related to.

site
string or null <uuid>

the site's uuid the device can be related to.

config
object or null

optional configuration object for the device

deviceType
required
string

the type of device

deviceSubType
required
string or null
Enum: "LPR" "COUNTS"

the subtype of device

lastSeen
number

Last seen timestamp in milliseconds, will be used internally and is not intended to be set by user

Responses

Request samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "active": true,
  • "originalDeviceId": "string",
  • "connector": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "site": "862ae9eb-f0eb-41b6-b3e5-39fdd26ce81c",
  • "config": { },
  • "deviceType": "dt",
  • "deviceSubType": "LPR",
  • "lastSeen": 0
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "active": true,
  • "originalDeviceId": "string",
  • "connector": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "site": "862ae9eb-f0eb-41b6-b3e5-39fdd26ce81c",
  • "config": { },
  • "deviceType": "dt",
  • "deviceSubType": "LPR",
  • "lastSeen": 0,
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

Get all AVA devices of a customer.

Get all AVA devices that are assigned to a specific customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

Responses

Response samples

Content type
application/json
{ }

Get a AVA device of a customer.

Get a AVA device that is assigned to a specific customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "active": true,
  • "originalDeviceId": "string",
  • "connector": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "site": "862ae9eb-f0eb-41b6-b3e5-39fdd26ce81c",
  • "config": { },
  • "deviceType": "dt",
  • "deviceSubType": "LPR",
  • "lastSeen": 0,
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Responses

Response samples

Content type
application/json
{ }

Update a AVA device of a customer.

Update a AVA device of a specific customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Request Body schema: application/json
required
uuid
required
string <uuid>

unique identifier for this device

customer
required
string <uuid>

the customer this device belongs to

name
required
string

the name of the device.

nameAlias1
string

the name alias 1 for this device instance.

nameAlias2
string

the name alias 2for this device instance.

active
required
boolean

if the device is active or not

originalDeviceId
required
string

the id for this device in the context of the device - e.g. the ID in the supplier's system

connector
required
string

the id of the connector this device belongs to

location
required
string <uuid>

the location's uuid the device can be related to.

site
string or null <uuid>

the site's uuid the device can be related to.

config
object or null

optional configuration object for the device

deviceType
required
string

the type of device

deviceSubType
required
string or null
Enum: "LPR" "COUNTS"

the subtype of device

lastSeen
number

Last seen timestamp in milliseconds, will be used internally and is not intended to be set by user

Responses

Request samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "active": true,
  • "originalDeviceId": "string",
  • "connector": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "site": "862ae9eb-f0eb-41b6-b3e5-39fdd26ce81c",
  • "config": { },
  • "deviceType": "dt",
  • "deviceSubType": "LPR",
  • "lastSeen": 0
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "active": true,
  • "originalDeviceId": "string",
  • "connector": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "site": "862ae9eb-f0eb-41b6-b3e5-39fdd26ce81c",
  • "config": { },
  • "deviceType": "dt",
  • "deviceSubType": "LPR",
  • "lastSeen": 0,
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

Get all active AVA datapoints of a AVA device.

Get all active AVA datapoints that are assigned to a specific AVA device.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Responses

Response samples

Content type
application/json
{ }

Create a new AVA datapoint for an AVA device of a customer.

Create a new AVA datapoint for an AVA device of a specific customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Request Body schema: application/json
required
uuid
required
string <uuid>

unique identifier for this datapoint.

name
required
string

the name of the datapoint.

nameAlias1
string

the name alias 1 for this datapoint instance.

nameAlias2
string

the name alias 2for this datapoint instance.

device
required
string <uuid>

the device's uuid the object is related to.

active
required
boolean

if the datapoint is active or not

originalDatapointId
required
string

the id for this datapoint in the context of the remote datapoint - e.g. the ID in the supplier's system

datapointSubType
required
string

the subtype of datapoint, how the supplier of the connector would call it

datapointType
required
string

the type of datapoint, usually matches the connector type key where this datapoint receives data from

customer
required
string <uuid>

the customer this datapoint belongs to

config
object or null
correctionFactor
number
category
required
string
Enum: "weather" "energy" "environment" "status" "recognition" "unknown"
measurementType
required
string
Enum: "unknown" "temperature" "humidity" "pressure" "co2" "voltage" "voltagep1" "voltagep2" "voltagep3" "current" "currentp1" "currentp2" "currentp3" "totalcurrent" "totalactivepower" "totalreactivepower" "totalapparentpower" "totalpowerfactor" "totalactiveenergy" "totalreactiveenergy" "totalapparentenergy" "activepowerp1" "activepowerp2" "activepowerp3" "reactivepowerp1" "reactivepowerp2" "reactivepowerp3" "apparentpowerp1" "apparentpowerp2" "apparentpowerp3" "cosphip1" "cosphip2" "cosphip3" "powerfactorp1" "powerfactorp2" "powerfactorp3" "frequenzyp1" "frequenzyp2" "frequenzyp3" "energyproduction" "energyconsumption" "energyexport" "energyselfconsumption" "energyimport" "powerproduction" "powerexport" "powerconsumption" "powerimport" "powerselfconsumption" "contact" "touch" "touchcount" "presence" "presencecount" "waterdetector" "motion" "occupancy" "weatherprecipitation" "weatherprecipitationduration" "weatherhumidity" "weathercglo" "weatherwindspeed" "weatherwindgustspeed" "weatherwindgusttimestamp" "weatherwindheading" "weatherwindgustheading" "weatherhumidityrelative" "weathertemperatureair" "weatherpressure" "weatherpressurereduced" "weathersnowheight" "weathersunshineduration" "weatherdewpoint" "weathertemperaturesoil10" "weathertemperaturesoil100" "weathertemperaturewater" "personcountinside" "personcountin" "personcountout" "vehiclecountinside" "vehiclecountin" "vehiclecountout" "licenseplate" "county"

Responses

Request samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "device": "8dca31e6-c85b-4a6b-bfb4-205d45d9b3bd",
  • "active": true,
  • "originalDatapointId": "string",
  • "datapointSubType": "string",
  • "datapointType": "string",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "config": { },
  • "correctionFactor": 0,
  • "category": "weather",
  • "measurementType": "unknown"
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "active": true,
  • "originalDeviceId": "string",
  • "connector": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "site": "862ae9eb-f0eb-41b6-b3e5-39fdd26ce81c",
  • "config": { },
  • "deviceType": "dt",
  • "deviceSubType": "LPR",
  • "lastSeen": 0,
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

Get all AVA datapoints for a AVA device of a customer.

Get all AVA datapoints that are assigned to a specific AVA device of a customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Responses

Response samples

Content type
application/json
[
  • {
    }
]

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

Responses

Response samples

Content type
application/json
{ }

Get a AVA datapoint for a AVA device of a customer.

Get a AVA datapoint that is assigned to a specific AVA device and customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

datapointId
required
string

id of the datapoint to get the data for

Responses

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "active": true,
  • "originalDeviceId": "string",
  • "connector": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "site": "862ae9eb-f0eb-41b6-b3e5-39fdd26ce81c",
  • "config": { },
  • "deviceType": "dt",
  • "deviceSubType": "LPR",
  • "lastSeen": 0,
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

datapointId
required
string

id of the datapoint to get the data for

Responses

Response samples

Content type
application/json
{ }

Update a AVA datapoint for a AVA device of a customer.

Update a AVA datapoint of a specific AVA device and customer.

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

deviceId
required
string

id of the device to get the data for

datapointId
required
string

id of the datapoint to get the data for

Request Body schema: application/json
required
uuid
required
string <uuid>

unique identifier for this datapoint.

name
required
string

the name of the datapoint.

nameAlias1
string

the name alias 1 for this datapoint instance.

nameAlias2
string

the name alias 2for this datapoint instance.

device
required
string <uuid>

the device's uuid the object is related to.

active
required
boolean

if the datapoint is active or not

originalDatapointId
required
string

the id for this datapoint in the context of the remote datapoint - e.g. the ID in the supplier's system

datapointSubType
required
string

the subtype of datapoint, how the supplier of the connector would call it

datapointType
required
string

the type of datapoint, usually matches the connector type key where this datapoint receives data from

customer
required
string <uuid>

the customer this datapoint belongs to

config
object or null
correctionFactor
number
category
required
string
Enum: "weather" "energy" "environment" "status" "recognition" "unknown"
measurementType
required
string
Enum: "unknown" "temperature" "humidity" "pressure" "co2" "voltage" "voltagep1" "voltagep2" "voltagep3" "current" "currentp1" "currentp2" "currentp3" "totalcurrent" "totalactivepower" "totalreactivepower" "totalapparentpower" "totalpowerfactor" "totalactiveenergy" "totalreactiveenergy" "totalapparentenergy" "activepowerp1" "activepowerp2" "activepowerp3" "reactivepowerp1" "reactivepowerp2" "reactivepowerp3" "apparentpowerp1" "apparentpowerp2" "apparentpowerp3" "cosphip1" "cosphip2" "cosphip3" "powerfactorp1" "powerfactorp2" "powerfactorp3" "frequenzyp1" "frequenzyp2" "frequenzyp3" "energyproduction" "energyconsumption" "energyexport" "energyselfconsumption" "energyimport" "powerproduction" "powerexport" "powerconsumption" "powerimport" "powerselfconsumption" "contact" "touch" "touchcount" "presence" "presencecount" "waterdetector" "motion" "occupancy" "weatherprecipitation" "weatherprecipitationduration" "weatherhumidity" "weathercglo" "weatherwindspeed" "weatherwindgustspeed" "weatherwindgusttimestamp" "weatherwindheading" "weatherwindgustheading" "weatherhumidityrelative" "weathertemperatureair" "weatherpressure" "weatherpressurereduced" "weathersnowheight" "weathersunshineduration" "weatherdewpoint" "weathertemperaturesoil10" "weathertemperaturesoil100" "weathertemperaturewater" "personcountinside" "personcountin" "personcountout" "vehiclecountinside" "vehiclecountin" "vehiclecountout" "licenseplate" "county"

Responses

Request samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "device": "8dca31e6-c85b-4a6b-bfb4-205d45d9b3bd",
  • "active": true,
  • "originalDatapointId": "string",
  • "datapointSubType": "string",
  • "datapointType": "string",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "config": { },
  • "correctionFactor": 0,
  • "category": "weather",
  • "measurementType": "unknown"
}

Response samples

Content type
application/json
{
  • "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
  • "customer": "0ac6320b-fa4d-4235-8d23-413a2b863bad",
  • "name": "string",
  • "nameAlias1": "string",
  • "nameAlias2": "string",
  • "active": true,
  • "originalDeviceId": "string",
  • "connector": "string",
  • "location": "15f20760-76a7-41ee-b509-705d3ffd8eb5",
  • "site": "862ae9eb-f0eb-41b6-b3e5-39fdd26ce81c",
  • "config": { },
  • "deviceType": "dt",
  • "deviceSubType": "LPR",
  • "lastSeen": 0,
  • "modifiedAt": "2019-08-24T14:15:22Z",
  • "modifiedBy": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "createdBy": {
    }
}

Image

Store a new image

Requests to store a new image, returns details (including a presigned S3 PUT URL) to store the binary file

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

Request Body schema: application/json
required
fileName
string

the name of the file

fileSize
integer

the size of the file

mimeType
string

the mimeType of the file, excepts [image/gif, image/png, image/jpeg]

Responses

Request samples

Content type
application/json
{
  • "fileName": "string",
  • "fileSize": 0,
  • "mimeType": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "putUrl": "string",
  • "error": "string"
}

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

Responses

Response samples

Content type
application/json
{ }

Gets a stored image

Gets a stored image, by redirecting to a presigned S3 URL; IMPORTANT: if you then do a "GET getUrl", you need to make sure that you do NOT send any authentication information with the "GET getUrl" request, otherwise it will fail!

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

imageId
required
string

id of the image of the customer

Responses

Response samples

Content type
application/json
{
  • "error": "Only one SMA connector per location is allowed",
  • "complexError": {
    },
  • "ok": false
}

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

imageId
required
string

id of the image of the customer

Responses

Response samples

Content type
application/json
{ }

Updates an existng image

Updates an existing image, by first deleting the existing binary file, and redirecting to a presigned S3 PUT URL; IMPORTANT: if you then do a "PUT putUrl", you need to make sure that you do NOT send any authentication information with the request to the presigned PUT URL, otherwise it will fail!

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

imageId
required
string

id of the image of the customer

Request Body schema: application/json
required
fileName
string

the name of the file

fileSize
integer

the size of the file

mimeType
string

the mimeType of the file, excepts [image/gif, image/png, image/jpeg]

Responses

Request samples

Content type
application/json
{
  • "fileName": "string",
  • "fileSize": 0,
  • "mimeType": "string"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "putUrl": "string",
  • "error": "string"
}

Deletes a stored image

Deletes a stored image

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

imageId
required
string

id of the image of the customer

Responses

Response samples

Content type
application/json
{
  • "ok": true
}

Commits a temporary image

Commits a temporary image

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

imageId
required
string

id of the image of the customer

Responses

Response samples

Content type
application/json
{
  • "error": "Only one SMA connector per location is allowed",
  • "complexError": {
    },
  • "ok": false
}

for CORS

Authorizations:
custom-auth
path Parameters
customerId
required
string

id of the customer to get the data for

imageId
required
string

id of the image of the customer

Responses

Response samples

Content type
application/json
{ }

STATUS

get application status

get application status, no authorization needed

Responses

Response samples

Content type
application/json
{
  • "maintenance": {
    },
  • "measurementsDatabase": {
    },
  • "other": {
    }
}

for CORS

Responses

Response samples

Content type
application/json
{ }

update single application status

update single application status

Authorizations:
custom-auth
Request Body schema: application/json
required
type
required
string
Enum: "measurementsDatabases" "maintenance" "other"
status
required
boolean

Responses

Request samples

Content type
application/json
{
  • "type": "measurementsDatabases",
  • "status": true
}

Response samples

Content type
application/json
{
  • "maintenance": {
    },
  • "measurementsDatabase": {
    },
  • "other": {
    }
}

for CORS

Authorizations:
custom-auth

Responses

Response samples

Content type
application/json
{ }

update application status

update application status

Authorizations:
custom-auth
Request Body schema: application/json
required
measurementsDatabase
required
boolean
maintenance
required
boolean
other
required
boolean

Responses

Request samples

Content type
application/json
{
  • "measurementsDatabase": true,
  • "maintenance": true,
  • "other": true
}

Response samples

Content type
application/json
{
  • "maintenance": {
    },
  • "measurementsDatabase": {
    },
  • "other": {
    }
}

for CORS

Authorizations:
custom-auth

Responses

Response samples

Content type
application/json
{ }