Urbana GraphQL Documentation API Reference
GraphQL is at the heart of Urbana Platform. We believe in using the latest and greatest technology to find long lasting solutions for real world problems. In doing so we chose GraphQL over REST, because of many of its advantage.
To quickly give an overview of the authentication used for accessing the Urbana GraphQL APIs, following diagram can be referred:
The client send the credentials to the server through a secured channel, and the server verifies the request and related credentials to generate and give back the client an authenticated JWT token. The client, which can be both frontend and mobile then stores the token and uses it for all subsequent communication with the GraphQL APIs.
Terms of Service: https://urbanasmart.com/platform-conditions/
Contact: support@urbanasmart.com
Version: 1.0.0
What Is GraphQL?
GraphQL is a query language for APIs and a runtime for fulfilling those queries with your existing data. GraphQL provides a complete and understandable description of the data in your API, gives clients the power to ask for exactly what they need and nothing more, makes it easier to evolve APIs over time, and enables powerful developer tools.
Some Advantages:
-
No more Over and Underfetching
Overfetching Downloading superfluous data Overfetching means that a client downloads more information than is actually required in the app. Imagine for example a screen that needs to display a list of users only with their names. In a REST API, this app would usually hit the /users endpoint and receive a JSON array with user data. This response however might contain more info about the users that are returned, e.g. their birthdays or addresses, information that is useless for the client because it only needs to display the users’ names.
-
Underfetching and the n+1 problem
Another issue is underfetching and the n+1-requests problem. Underfetching generally means that a specific endpoint doesn’t provide enough of the required information. The client will have to make additional requests to fetch everything it needs. This can escalate to a situation where a client needs to first download a list of elements, but then needs to make one additional request per element to fetch the required data. As an example, consider the same app would also need to display the last three followers per user. The API provides the additional endpoint /users/user-id/followers. In order to be able to display the required information, the app will have to make one request to the /users endpoint and then hit the /users/user-id/followers endpoint for each user.
-
Rapid Product Iterations on the Frontend
A common pattern with REST APIs is to structure the endpoints according to the views that you have inside your app. This is handy since it allows for the client to get all required information for a particular view by simply accessing the corresponding endpoint. The major drawback of this approach is that it doesn’t allow for rapid iterations on the frontend. With every change that is made to the UI, there is a high risk that now there is more (or less) data required than before. Consequently, the backend needs to be adjusted as well to account for the new data needs. This kills productivity and notably slows down the ability to incorporate user feedback into a product. With GraphQL, this problem is solved. Thanks to the flexible nature of GraphQL, changes on the client-side can be made without any extra work on the server. Since clients can specify their exact data requirements, no backend engineer needs to make adjustments when the design and data needs on the frontend change.
-
Benefits of a Schema & Type System
GraphQL uses a strong type system to define the capabilities of an API. All the types that are exposed in an API are written down in a schema using the GraphQL Schema Definition Language (SDL). This schema serves as the contract between the client and the server to define how a client can access the data.
-
Field Specific
Send a GraphQL query to your API and get exactly what you need, nothing more and nothing less. GraphQL queries always return predictable results. Apps using GraphQL are fast and stable because they control the data they get, not the server. Many resources in a single request GraphQL queries access not just the properties of one resource but also smoothly follow references between them. While typical REST APIs require loading from multiple URLs, GraphQL APIs get all the data your app needs in a single request. Apps using GraphQL can be quick even on slow mobile network connections.
GraphQL Schema
A GraphQL schema is at the core of any GraphQL server implementation. It describes the functionality available to the client applications that connect to it. We can use any programming language to create a GraphQL schema and build an interface around it. The GraphQL runtime defines a generic graph-based schema to publish the capabilities of the data service it represents. Client applications can query the schema within its capabilities. This approach decouples clients from servers and allows both to evolve and scale independently.A sample GraphQL schema can be like below where the types are defined. The type can be related to the query operation as well as the "model" structure.
// Sample query and mutation types
type Query {
studentById(id:ID!):Student
}
type Student {
id:ID!
firstName:String
lastName:String
password:String
collegeId:String
}
type Mutation {
createStudent(collegeId:ID,firstName:String,lastName:String):String
}
In the example, we are dealing with an example of query type, a student model and a mutation to change student model.
Query
A GraphQL operation can either be a read or a write operation. A GraphQL query is used to read or fetch values while a mutation is used to write or post values. In either case, the operation is a simple string that a GraphQL server can parse and respond to with data in a specific format. The popular response format that is usually used for mobile and web applications is JSON.
type Query {
studentById(id:ID!):Student
}
The given query can be used to retrieve the student model by passing the id for a specific student. This can be done by following-
{
studentById(id:"ABC123") {
id
firstName
lastName
}
}
The response from the server can be as follows-
{
"data": {
"studentById": {
"id": "ABC123",
"firstName": "Michael",
"lastName":"Johnson"
}
}
}
Mutation
Mutation queries modify data in the data store and returns a value. It can be used to insert, update, or delete data. Mutations are defined as a part of the schema.
type Student {
id:ID!
firstName:String
lastName:String
password:String
collegeId:String
}
type Mutation {
createStudent(collegeId:ID,firstName:String,lastName:String):String
}
The given mutation can be used to create a new student. This can be done by passing the following arguments in the call-
mutation {
createStudent(collegeId:"101",firstName:"James",lastName:"Rodriguez") {
id
firstName
lastName
}
}
The above query adds a new student and retrieves the student object along with college object. This saves round trips to the server.
{
"data": {
"createStudent": {
"id": "101",
"firstName": "James",
"lastName": "Rodriguez"
}
}
}
Authentication
End Point /v1/authenticate
Before trying the APIs on GraphQL playground or using them, it is essential to authenticate and get a JWT access token. The token is available to all authenticated users which are created in the platform. The authorised user can access the APIs by calling a rest API <code/authenticate to obtain the token. The endpoints and parameters the user has to pass in the body (as a JSON) are as shown.
- Body:
{
email:"sampleemail@email.com",
password:"samplepassword"
}
- Response:
{
"status": "ok",
"item": {
"accessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZC",
"refreshToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZ",
"accessTokenExpiresInSeconds": 3600
}
}
Once the JWT token is received in the accessToken, the user has to pass it in all GraphQL API call with the header. The validity of the token is 1 hour and the client would need to fetch new token after expiry or refresh the current one.
Quick Start
Example for calling the Urabana get devices query
Step 1: Get JWT Token:
As described in the authentication step, the user token can be obtained by calling the /v1/authenticate endpoint.
Step 2: Calling APIs using playground:
The GraphQL queries and mutations can be in general used either through a compatible client like Insomnia or directly using playground.
The user on landing here would see a view like following:
Step 3: Setting up the header request and query variables:
The user can start calling the endpoint only by using the valid JWT token obtained in Step 1.
The valid JWT token has to be placed in the HTTP Headers field section 3 in the format below:
{"authorization": "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6Ijg1NzU0MzZlL}
In case the query or mutation requires the variable, they can be passed in the following way:
{
"page": 0,
"pageSize": 20,
"groupId": "5d43bb12-0f2b-4f73-ac3c-bc12a53b5aff"
}
Step 4: Calling the get devices query with parameters:
The user can create the query in the section 1. This is the standard scratch pad for putting the query or mutations. As the user starts typing, the scratch pad starts giving auto completitions making it easier to complete long complex query.
The query in our case is of the following, to get devices in a group:
query getDevices($page: Int, $pageSize: Int, $groupId: String) {
devices(
page: $page
pageSize: $pageSize
groupId: $groupId
deviceTypes: [lighting, virtual_asset, metering]
deviceModels: [RFTN, RFTZ, QRCODE]
) {
page {
items {
model {
name
type {
name
code
}
}
name
group {
name
id
}
}
}
}
}
and the query parameters are passed in section 3 as the following:
{
"page": 0,
"pageSize": 20,
"groupId": "5-4f73-ac3c-bc12a53b5aff"
}
Step 5: Getting the results:
The user can create the fetch the query by pressing the play button. The results are visualised in section 2. In our case the response is the following:
{
"data": {
"devices": {
"page": {
"items": [
{
"model": {
"name": "UID code",
"type": {
"name": "Virtual Asset",
"code": "virtual_asset"
}
},
"name": "VirtualAsset1",
"group": {
"name": "ENVIRONMENT",
"id": "15508c2e-466a-4c15-99d7-14eb54d3c75a"
}
},
{
"model": {
"name": "UID code",
"type": {
"name": "Virtual Asset",
"code": "virtual_asset"
}
},
"name": "VirtualAsset2",
"group": {
"name": "ENVIRONMENT",
"id": "15508c2e-466a-4c15-99d7-14eb54d3c75a"
}
}
]
}
}
},
"extensions": {
"operationName": "getDevices",
"variables": "{\"page\":0,\"pageSize\":20,\"groupId\":\"5d43bbc12a53b5aff\"}"
}
}
Docs and Schema
One of the biggest advantage of using playground is that the user can view and navigate all of the queries, types and mutations. This can be done using the docs and schemas tab present in the playground.
Docs tab enables user to view each query and mutation operations as well as the required and optional parameters needed and their types.
Schema tabs enables the user to view all the queries and mutations that are present in the platform thus giving a complete overview of the structure of GraphQL.
NOTE: To start using our services and try the GraphQL endpoints, you should be in possession of a valid user. The user is created by the admin of the platform post commercial agreements. The user would be provided credentials to access platform and subsequently try APIs. To get hands on with APIs, the first step would be using the authentication end point to get a valid JWT token. Based on the user permissions and access granted by the admin, there would be impacts on the actions that client can do using APIs. Actions like create group, edit, delete group etc require specific access and permissions. The validity of the token is 1 hour and the client would need to fetch new token after expiry.
Devices
This section deals with creation and management of the devices.
Get Multiple Devices
Fetch list of devices
loadCellStatus:
(no description)
deviceStatus:
(no description)
networkStatus:
(no description)
(no description)
search:
string
(no description)
page:
integer
(no description)
pageSize:
integer
(no description)
deviceModels:
(no description)
deviceTypes:
(no description)
groupId:
string
(no description)
Example
Request Content-Types:
application/json
Query
query devices($loadCellStatus: AutomationLoadCellThresholdStatus, $deviceStatus: DeviceStatusAllowedFilteringFields, $networkStatus: DeviceNetworkStatusAllowedFilteringFields, $sort: [DevicesSortingConditionInput!], $search: String, $page: Int, $pageSize: Int, $deviceModels: [DeviceModels!], $deviceTypes: [DeviceTypes!], $groupId: String){
devices(loadCellStatus: $loadCellStatus, deviceStatus: $deviceStatus, networkStatus: $networkStatus, sort: $sort, search: $search, page: $page, pageSize: $pageSize, deviceModels: $deviceModels, deviceTypes: $deviceTypes, groupId: $groupId){
status
total
page{
items{
id
organizationId
deviceHash
serial
name
supplier
tag
latitude
longitude
positionType
positionY
positionX
timeZone
networkType
loraParams{
id
deviceEUI
applicationEUI
joinEUI
version
loraClass
regionalParametersRevision
region
activationType
createdAt
updatedAt
}
maxLifetimeHours
maxLifetimeWarningPercentage
statusUpdateHoursOffset
referenceNumber
online
errors
statusUpdatedAt
createdAt
updatedAt
virtualAsset{
id
urlInfo
note
pictureUrl
createdAt
updatedAt
}
metering{
id
meterMID
connectedMeter
energyConsumptionEnabled
pulseOneConsumptionEnabled
pulseTwoConsumptionEnabled
status{
signal
enabled485
pulseOneEnabled
pulseTwoEnabled
totalActiveEnergyEnabled
activePowerEnabled
voltageEnabled
currentEnabled
powerFactorEnabled
frequencyEnabled
temperature
voltage
current
powerFactor
frequency
activePower
totalActiveEnergy
pulseOne
pulseTwo
errors
online
receivedAt
createdAt
updatedAt
}
createdAt
updatedAt
}
lighting{
status{
signal
dimmingLevel
temperature
activeEnergy
apparentEnergy
activePower
apparentPower
energyReactive
lampRunningHours
nodeRunningHours
onOffCycles
errors
lightingMode
online
deviceUnixEpoch
receivedAt
createdAt
updatedAt
}
}
parking{
class
}
automation{
description
ioConfig{
inputs{
key
label
connectedOutputs
}
outputs{
key
label
}
}
}
attachments{
id
path
filename
url
contentType
size
createdAt
updatedAt
}
images{
id
path
filename
url
contentType
size
createdAt
updatedAt
}
status
connectorId
}
size
index
}
}
}
Variables
{
"loadCellStatus": "string",
"deviceStatus": "string",
"networkStatus": "string",
"sort": [
{
"field": "string",
"order": "string"
}
],
"search": "string",
"page": "integer",
"pageSize": "integer",
"deviceModels": [
"string"
],
"deviceTypes": [
"string"
],
"groupId": "string"
}
query devices($loadCellStatus: AutomationLoadCellThresholdStatus, $deviceStatus: DeviceStatusAllowedFilteringFields, $networkStatus: DeviceNetworkStatusAllowedFilteringFields, $sort: [DevicesSortingConditionInput!], $search: String, $page: Int, $pageSize: Int, $deviceModels: [DeviceModels!], $deviceTypes: [DeviceTypes!], $groupId: String){
devices(loadCellStatus: $loadCellStatus, deviceStatus: $deviceStatus, networkStatus: $networkStatus, sort: $sort, search: $search, page: $page, pageSize: $pageSize, deviceModels: $deviceModels, deviceTypes: $deviceTypes, groupId: $groupId){
status
total
page{
items{
id
organizationId
deviceHash
serial
name
supplier
tag
latitude
longitude
positionType
positionY
positionX
timeZone
networkType
loraParams{
id
deviceEUI
applicationEUI
joinEUI
version
loraClass
regionalParametersRevision
region
activationType
createdAt
updatedAt
}
maxLifetimeHours
maxLifetimeWarningPercentage
statusUpdateHoursOffset
referenceNumber
online
errors
statusUpdatedAt
createdAt
updatedAt
virtualAsset{
id
urlInfo
note
pictureUrl
createdAt
updatedAt
}
metering{
id
meterMID
connectedMeter
energyConsumptionEnabled
pulseOneConsumptionEnabled
pulseTwoConsumptionEnabled
status{
signal
enabled485
pulseOneEnabled
pulseTwoEnabled
totalActiveEnergyEnabled
activePowerEnabled
voltageEnabled
currentEnabled
powerFactorEnabled
frequencyEnabled
temperature
voltage
current
powerFactor
frequency
activePower
totalActiveEnergy
pulseOne
pulseTwo
errors
online
receivedAt
createdAt
updatedAt
}
createdAt
updatedAt
}
lighting{
status{
signal
dimmingLevel
temperature
activeEnergy
apparentEnergy
activePower
apparentPower
energyReactive
lampRunningHours
nodeRunningHours
onOffCycles
errors
lightingMode
online
deviceUnixEpoch
receivedAt
createdAt
updatedAt
}
}
parking{
class
}
automation{
description
ioConfig{
inputs{
key
label
connectedOutputs
}
outputs{
key
label
}
}
}
attachments{
id
path
filename
url
contentType
size
createdAt
updatedAt
}
images{
id
path
filename
url
contentType
size
createdAt
updatedAt
}
status
connectorId
}
size
index
}
}
}
{
"loadCellStatus": "string",
"deviceStatus": "string",
"networkStatus": "string",
"sort": [
{
"field": "string",
"order": "string"
}
],
"search": "string",
"page": "integer",
"pageSize": "integer",
"deviceModels": [
"string"
],
"deviceTypes": [
"string"
],
"groupId": "string"
}
200 OK
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"devices": {
"total": "integer",
"page": {
"items": [
{
"id": "string",
"organizationId": "string",
"deviceHash": "string",
"serial": "string",
"name": "string",
"supplier": "string",
"tag": "string",
"latitude": "number",
"longitude": "number",
"positionY": "number",
"positionX": "number",
"timeZone": "string",
"loraParams": {
"id": "integer",
"deviceEUI": "string",
"applicationEUI": "string",
"joinEUI": "string",
"version": "string",
"loraClass": "string",
"regionalParametersRevision": "string",
"region": "string",
"activationType": "string"
},
"maxLifetimeHours": "integer",
"maxLifetimeWarningPercentage": "integer",
"statusUpdateHoursOffset": "integer",
"referenceNumber": "string",
"online": "boolean",
"errors": [
"string"
],
"virtualAsset": {
"id": "integer",
"urlInfo": "string",
"note": "string",
"pictureUrl": "string"
},
"metering": {
"id": "integer",
"meterMID": "boolean",
"connectedMeter": "string",
"energyConsumptionEnabled": "boolean",
"pulseOneConsumptionEnabled": "boolean",
"pulseTwoConsumptionEnabled": "boolean",
"status": {
"signal": "integer",
"enabled485": "boolean",
"pulseOneEnabled": "boolean",
"pulseTwoEnabled": "boolean",
"totalActiveEnergyEnabled": "boolean",
"activePowerEnabled": "boolean",
"voltageEnabled": "boolean",
"currentEnabled": "boolean",
"powerFactorEnabled": "boolean",
"frequencyEnabled": "boolean",
"temperature": "number",
"voltage": "number",
"current": "number",
"powerFactor": "number",
"frequency": "number",
"activePower": "number",
"totalActiveEnergy": "number",
"pulseOne": "integer",
"pulseTwo": "integer",
"errors": "string",
"online": "boolean"
}
},
"lighting": {
"status": {
"signal": "integer",
"dimmingLevel": "number",
"temperature": "number",
"activeEnergy": "number",
"apparentEnergy": "number",
"activePower": "number",
"apparentPower": "number",
"energyReactive": "number",
"lampRunningHours": "number",
"nodeRunningHours": "number",
"onOffCycles": "number",
"errors": "string"
}
}
}
]
}
}
}
}
Get Single Device
Fetch single device information
serial:
string
(no description)
id:
string
(no description)
Example
Request Content-Types:
application/json
Query
query device($serial: String, $id: String){
device(serial: $serial, id: $id){
status
item{
id
organizationId
deviceHash
serial
name
supplier
tag
latitude
longitude
positionType
positionY
positionX
timeZone
networkType
loraParams{
id
deviceEUI
applicationEUI
joinEUI
version
loraClass
regionalParametersRevision
region
activationType
createdAt
updatedAt
}
maxLifetimeHours
maxLifetimeWarningPercentage
statusUpdateHoursOffset
referenceNumber
online
errors
statusUpdatedAt
createdAt
updatedAt
virtualAsset{
id
urlInfo
note
pictureUrl
createdAt
updatedAt
}
metering{
id
meterMID
connectedMeter
energyConsumptionEnabled
pulseOneConsumptionEnabled
pulseTwoConsumptionEnabled
status{
signal
enabled485
pulseOneEnabled
pulseTwoEnabled
totalActiveEnergyEnabled
activePowerEnabled
voltageEnabled
currentEnabled
powerFactorEnabled
frequencyEnabled
temperature
voltage
current
powerFactor
frequency
activePower
totalActiveEnergy
pulseOne
pulseTwo
errors
online
receivedAt
createdAt
updatedAt
}
createdAt
updatedAt
}
lighting{
status{
signal
dimmingLevel
temperature
activeEnergy
apparentEnergy
activePower
apparentPower
energyReactive
lampRunningHours
nodeRunningHours
onOffCycles
errors
lightingMode
online
deviceUnixEpoch
receivedAt
createdAt
updatedAt
}
}
parking{
class
}
automation{
description
ioConfig{
inputs{
key
label
connectedOutputs
}
outputs{
key
label
}
}
}
attachments{
id
path
filename
url
contentType
size
createdAt
updatedAt
}
images{
id
path
filename
url
contentType
size
createdAt
updatedAt
}
status
connectorId
}
}
}
Variables
{
"serial": "string",
"id": "string"
}
query device($serial: String, $id: String){
device(serial: $serial, id: $id){
status
item{
id
organizationId
deviceHash
serial
name
supplier
tag
latitude
longitude
positionType
positionY
positionX
timeZone
networkType
loraParams{
id
deviceEUI
applicationEUI
joinEUI
version
loraClass
regionalParametersRevision
region
activationType
createdAt
updatedAt
}
maxLifetimeHours
maxLifetimeWarningPercentage
statusUpdateHoursOffset
referenceNumber
online
errors
statusUpdatedAt
createdAt
updatedAt
virtualAsset{
id
urlInfo
note
pictureUrl
createdAt
updatedAt
}
metering{
id
meterMID
connectedMeter
energyConsumptionEnabled
pulseOneConsumptionEnabled
pulseTwoConsumptionEnabled
status{
signal
enabled485
pulseOneEnabled
pulseTwoEnabled
totalActiveEnergyEnabled
activePowerEnabled
voltageEnabled
currentEnabled
powerFactorEnabled
frequencyEnabled
temperature
voltage
current
powerFactor
frequency
activePower
totalActiveEnergy
pulseOne
pulseTwo
errors
online
receivedAt
createdAt
updatedAt
}
createdAt
updatedAt
}
lighting{
status{
signal
dimmingLevel
temperature
activeEnergy
apparentEnergy
activePower
apparentPower
energyReactive
lampRunningHours
nodeRunningHours
onOffCycles
errors
lightingMode
online
deviceUnixEpoch
receivedAt
createdAt
updatedAt
}
}
parking{
class
}
automation{
description
ioConfig{
inputs{
key
label
connectedOutputs
}
outputs{
key
label
}
}
}
attachments{
id
path
filename
url
contentType
size
createdAt
updatedAt
}
images{
id
path
filename
url
contentType
size
createdAt
updatedAt
}
status
connectorId
}
}
}
{
"serial": "string",
"id": "string"
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"device": {
"item": {
"id": "string",
"organizationId": "string",
"deviceHash": "string",
"serial": "string",
"name": "string",
"supplier": "string",
"tag": "string",
"latitude": "number",
"longitude": "number",
"positionY": "number",
"positionX": "number",
"timeZone": "string",
"loraParams": {
"id": "integer",
"deviceEUI": "string",
"applicationEUI": "string",
"joinEUI": "string",
"version": "string",
"loraClass": "string",
"regionalParametersRevision": "string",
"region": "string",
"activationType": "string"
},
"maxLifetimeHours": "integer",
"maxLifetimeWarningPercentage": "integer",
"statusUpdateHoursOffset": "integer",
"referenceNumber": "string",
"online": "boolean",
"errors": [
"string"
],
"virtualAsset": {
"id": "integer",
"urlInfo": "string",
"note": "string",
"pictureUrl": "string"
},
"metering": {
"id": "integer",
"meterMID": "boolean",
"connectedMeter": "string",
"energyConsumptionEnabled": "boolean",
"pulseOneConsumptionEnabled": "boolean",
"pulseTwoConsumptionEnabled": "boolean",
"status": {
"signal": "integer",
"enabled485": "boolean",
"pulseOneEnabled": "boolean",
"pulseTwoEnabled": "boolean",
"totalActiveEnergyEnabled": "boolean",
"activePowerEnabled": "boolean",
"voltageEnabled": "boolean",
"currentEnabled": "boolean",
"powerFactorEnabled": "boolean",
"frequencyEnabled": "boolean",
"temperature": "number",
"voltage": "number",
"current": "number",
"powerFactor": "number",
"frequency": "number",
"activePower": "number",
"totalActiveEnergy": "number",
"pulseOne": "integer",
"pulseTwo": "integer",
"errors": "string",
"online": "boolean"
}
},
"lighting": {
"status": {
"signal": "integer",
"dimmingLevel": "number",
"temperature": "number",
"activeEnergy": "number",
"apparentEnergy": "number",
"activePower": "number",
"apparentPower": "number",
"energyReactive": "number",
"lampRunningHours": "number",
"nodeRunningHours": "number",
"onOffCycles": "number",
"errors": "string",
"online": "boolean",
"deviceUnixEpoch": "integer"
}
}
}
}
}
}
Groups
This section deals with management of the groups like creation of group, edit, etc.
Get Multiple Groups
Fetch list of multiple Group details
organizationId:
string
(no description)
search:
string
(no description)
deviceTypes:
(no description)
userId:
string
(no description)
flat:
boolean
(no description)
page:
integer
(no description)
pageSize:
integer
(no description)
Example
Request Content-Types:
application/json
Query
query groups($organizationId: String, $search: String, $deviceTypes: [DeviceTypes!], $userId: String, $flat: Boolean, $page: Int, $pageSize: Int){
groups(organizationId: $organizationId, search: $search, deviceTypes: $deviceTypes, userId: $userId, flat: $flat, page: $page, pageSize: $pageSize){
status
total
page{
items{
organizationId
id
name
path
latitude
longitude
positionType
positionY
positionX
timeZone
createdAt
updatedAt
countDevices
countDevicesDeep
countChildren
countChildrenDeep
currency
type
groupMap(userId: $userId){
id
height
width
url
createdAt
updatedAt
}
children{
organizationId
id
name
path
latitude
longitude
positionType
positionY
positionX
timeZone
createdAt
updatedAt
countDevices
countDevicesDeep
countChildren
countChildrenDeep
currency
type
}
devices{
id
organizationId
deviceHash
serial
name
supplier
tag
latitude
longitude
positionType
positionY
positionX
timeZone
networkType
maxLifetimeHours
maxLifetimeWarningPercentage
statusUpdateHoursOffset
referenceNumber
online
errors
statusUpdatedAt
createdAt
updatedAt
status
connectorId
}
}
size
index
}
}
}
Variables
{
"organizationId": "string",
"search": "string",
"deviceTypes": [
"string"
],
"userId": "string",
"flat": "boolean",
"page": "integer",
"pageSize": "integer"
}
query groups($organizationId: String, $search: String, $deviceTypes: [DeviceTypes!], $userId: String, $flat: Boolean, $page: Int, $pageSize: Int){
groups(organizationId: $organizationId, search: $search, deviceTypes: $deviceTypes, userId: $userId, flat: $flat, page: $page, pageSize: $pageSize){
status
total
page{
items{
organizationId
id
name
path
latitude
longitude
positionType
positionY
positionX
timeZone
createdAt
updatedAt
countDevices
countDevicesDeep
countChildren
countChildrenDeep
currency
type
groupMap(userId: $userId){
id
height
width
url
createdAt
updatedAt
}
children{
organizationId
id
name
path
latitude
longitude
positionType
positionY
positionX
timeZone
createdAt
updatedAt
countDevices
countDevicesDeep
countChildren
countChildrenDeep
currency
type
}
devices{
id
organizationId
deviceHash
serial
name
supplier
tag
latitude
longitude
positionType
positionY
positionX
timeZone
networkType
maxLifetimeHours
maxLifetimeWarningPercentage
statusUpdateHoursOffset
referenceNumber
online
errors
statusUpdatedAt
createdAt
updatedAt
status
connectorId
}
}
size
index
}
}
}
{
"organizationId": "string",
"search": "string",
"deviceTypes": [
"string"
],
"userId": "string",
"flat": "boolean",
"page": "integer",
"pageSize": "integer"
}
200 OK
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"groups": {
"total": "integer",
"page": {
"items": [
{
"organizationId": "string",
"id": "string",
"name": "string",
"path": "string",
"latitude": "number",
"longitude": "number",
"positionY": "number",
"positionX": "number",
"timeZone": "string",
"countDevices": "integer",
"countDevicesDeep": "integer",
"countChildren": "integer",
"countChildrenDeep": "integer",
"currency": "string",
"groupMap": {
"id": "number",
"height": "number",
"width": "number",
"url": "string"
},
"children": [
{
"organizationId": "string",
"id": "string",
"name": "string",
"path": "string",
"latitude": "number",
"longitude": "number",
"positionY": "number",
"positionX": "number",
"timeZone": "string",
"countDevices": "integer",
"countDevicesDeep": "integer",
"countChildren": "integer",
"countChildrenDeep": "integer",
"currency": "string"
}
],
"devices": [
{
"id": "string",
"organizationId": "string",
"deviceHash": "string",
"serial": "string",
"name": "string",
"supplier": "string",
"tag": "string",
"latitude": "number",
"longitude": "number",
"positionY": "number",
"positionX": "number",
"timeZone": "string",
"maxLifetimeHours": "integer",
"maxLifetimeWarningPercentage": "integer",
"statusUpdateHoursOffset": "integer",
"referenceNumber": "string",
"online": "boolean",
"errors": [
"string"
],
"connectorId": "string"
}
]
}
],
"size": "integer",
"index": "integer"
}
}
}
}
Get Single Group
Fetch single group details
organizationId:
string
(no description)
userId:
string
(no description)
id:
string
(no description)
Example
Request Content-Types:
application/json
Query
query group($organizationId: String, $userId: String, $id: String!){
group(organizationId: $organizationId, userId: $userId, id: $id){
status
item{
organizationId
id
name
path
latitude
longitude
positionType
positionY
positionX
timeZone
createdAt
updatedAt
countDevices
countDevicesDeep
countChildren
countChildrenDeep
currency
type
groupMap(userId: $userId){
id
height
width
url
createdAt
updatedAt
}
children{
organizationId
id
name
path
latitude
longitude
positionType
positionY
positionX
timeZone
createdAt
updatedAt
countDevices
countDevicesDeep
countChildren
countChildrenDeep
currency
type
}
devices{
id
organizationId
deviceHash
serial
name
supplier
tag
latitude
longitude
positionType
positionY
positionX
timeZone
networkType
maxLifetimeHours
maxLifetimeWarningPercentage
statusUpdateHoursOffset
referenceNumber
online
errors
statusUpdatedAt
createdAt
updatedAt
group{
organizationId
id
name
path
latitude
longitude
positionType
positionY
positionX
timeZone
createdAt
updatedAt
countDevices
countDevicesDeep
countChildren
countChildrenDeep
currency
type
groupMap(userId: $userId){
...RecursiveGroupMapFragment
}
children{
...RecursiveGroupBaseFragment
}
devices{
...RecursiveDeviceFragment
}
}
status
connectorId
}
}
}
}
Variables
{
"organizationId": "string",
"userId": "string",
"id": "string"
}
query group($organizationId: String, $userId: String, $id: String!){
group(organizationId: $organizationId, userId: $userId, id: $id){
status
item{
organizationId
id
name
path
latitude
longitude
positionType
positionY
positionX
timeZone
createdAt
updatedAt
countDevices
countDevicesDeep
countChildren
countChildrenDeep
currency
type
groupMap(userId: $userId){
id
height
width
url
createdAt
updatedAt
}
children{
organizationId
id
name
path
latitude
longitude
positionType
positionY
positionX
timeZone
createdAt
updatedAt
countDevices
countDevicesDeep
countChildren
countChildrenDeep
currency
type
}
devices{
id
organizationId
deviceHash
serial
name
supplier
tag
latitude
longitude
positionType
positionY
positionX
timeZone
networkType
maxLifetimeHours
maxLifetimeWarningPercentage
statusUpdateHoursOffset
referenceNumber
online
errors
statusUpdatedAt
createdAt
updatedAt
group{
organizationId
id
name
path
latitude
longitude
positionType
positionY
positionX
timeZone
createdAt
updatedAt
countDevices
countDevicesDeep
countChildren
countChildrenDeep
currency
type
groupMap(userId: $userId){
...RecursiveGroupMapFragment
}
children{
...RecursiveGroupBaseFragment
}
devices{
...RecursiveDeviceFragment
}
}
status
connectorId
}
}
}
}
{
"organizationId": "string",
"userId": "string",
"id": "string"
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"group": {
"item": {
"organizationId": "string",
"id": "string",
"name": "string",
"path": "string",
"latitude": "number",
"longitude": "number",
"positionY": "number",
"positionX": "number",
"timeZone": "string",
"countDevices": "integer",
"countDevicesDeep": "integer",
"countChildren": "integer",
"countChildrenDeep": "integer",
"currency": "string",
"groupMap": {
"id": "number",
"height": "number",
"width": "number",
"url": "string"
},
"children": [
{
"organizationId": "string",
"id": "string",
"name": "string",
"path": "string",
"latitude": "number",
"longitude": "number",
"positionY": "number",
"positionX": "number",
"timeZone": "string",
"countDevices": "integer",
"countDevicesDeep": "integer",
"countChildren": "integer",
"countChildrenDeep": "integer",
"currency": "string"
}
],
"devices": [
{
"id": "string",
"organizationId": "string",
"deviceHash": "string",
"serial": "string",
"name": "string",
"supplier": "string",
"tag": "string",
"latitude": "number",
"longitude": "number",
"positionY": "number",
"positionX": "number",
"timeZone": "string",
"maxLifetimeHours": "integer",
"maxLifetimeWarningPercentage": "integer",
"statusUpdateHoursOffset": "integer",
"referenceNumber": "string",
"online": "boolean",
"errors": [
"string"
],
"connectorId": "string"
}
]
}
}
}
}
Create Single Group
Query to create a single Group
name:
string
(no description)
type:
(no description)
latitude:
number
(no description)
longitude:
number
(no description)
timeZone:
string
(no description)
parentId:
string
(no description)
height:
number
(no description)
width:
number
(no description)
positionType:
(no description)
positionY:
number
(no description)
positionX:
number
(no description)
currency:
string
(no description)
file:
object
(no description)
Example
Request Content-Types:
application/json
Query
mutation createGroup($name: String!, $type: GroupTypes!, $latitude: Float, $longitude: Float, $timeZone: String, $parentId: String, $height: Float, $width: Float, $positionType: PositionTypes, $positionY: Float, $positionX: Float, $currency: String, $file: Upload){
createGroup(name: $name, type: $type, latitude: $latitude, longitude: $longitude, timeZone: $timeZone, parentId: $parentId, height: $height, width: $width, positionType: $positionType, positionY: $positionY, positionX: $positionX, currency: $currency, file: $file){
status
item{
organizationId
id
name
path
latitude
longitude
positionType
positionY
positionX
timeZone
createdAt
updatedAt
countDevices
countDevicesDeep
countChildren
countChildrenDeep
currency
type
groupMap(userId: $userId){
id
height
width
url
createdAt
updatedAt
}
children{
organizationId
id
name
path
latitude
longitude
positionType
positionY
positionX
timeZone
createdAt
updatedAt
countDevices
countDevicesDeep
countChildren
countChildrenDeep
currency
type
}
devices{
id
organizationId
deviceHash
serial
name
supplier
tag
latitude
longitude
positionType
positionY
positionX
timeZone
networkType
maxLifetimeHours
maxLifetimeWarningPercentage
statusUpdateHoursOffset
referenceNumber
online
errors
statusUpdatedAt
createdAt
updatedAt
status
connectorId
}
}
}
}
Variables
{
"name": "string",
"type": "string",
"latitude": "number",
"longitude": "number",
"timeZone": "string",
"parentId": "string",
"height": "number",
"width": "number",
"positionType": "string",
"positionY": "number",
"positionX": "number",
"currency": "string"
}
mutation createGroup($name: String!, $type: GroupTypes!, $latitude: Float, $longitude: Float, $timeZone: String, $parentId: String, $height: Float, $width: Float, $positionType: PositionTypes, $positionY: Float, $positionX: Float, $currency: String, $file: Upload){
createGroup(name: $name, type: $type, latitude: $latitude, longitude: $longitude, timeZone: $timeZone, parentId: $parentId, height: $height, width: $width, positionType: $positionType, positionY: $positionY, positionX: $positionX, currency: $currency, file: $file){
status
item{
organizationId
id
name
path
latitude
longitude
positionType
positionY
positionX
timeZone
createdAt
updatedAt
countDevices
countDevicesDeep
countChildren
countChildrenDeep
currency
type
groupMap(userId: $userId){
id
height
width
url
createdAt
updatedAt
}
children{
organizationId
id
name
path
latitude
longitude
positionType
positionY
positionX
timeZone
createdAt
updatedAt
countDevices
countDevicesDeep
countChildren
countChildrenDeep
currency
type
}
devices{
id
organizationId
deviceHash
serial
name
supplier
tag
latitude
longitude
positionType
positionY
positionX
timeZone
networkType
maxLifetimeHours
maxLifetimeWarningPercentage
statusUpdateHoursOffset
referenceNumber
online
errors
statusUpdatedAt
createdAt
updatedAt
status
connectorId
}
}
}
}
{
"name": "string",
"type": "string",
"latitude": "number",
"longitude": "number",
"timeZone": "string",
"parentId": "string",
"height": "number",
"width": "number",
"positionType": "string",
"positionY": "number",
"positionX": "number",
"currency": "string"
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"createGroup": {
"item": {
"organizationId": "string",
"id": "string",
"name": "string",
"path": "string",
"latitude": "number",
"longitude": "number",
"positionY": "number",
"positionX": "number",
"timeZone": "string",
"countDevices": "integer",
"countDevicesDeep": "integer",
"countChildren": "integer",
"countChildrenDeep": "integer",
"currency": "string",
"groupMap": {
"id": "number",
"height": "number",
"width": "number",
"url": "string"
},
"children": [
{
"organizationId": "string",
"id": "string",
"name": "string",
"path": "string",
"latitude": "number",
"longitude": "number",
"positionY": "number",
"positionX": "number",
"timeZone": "string",
"countDevices": "integer",
"countDevicesDeep": "integer",
"countChildren": "integer",
"countChildrenDeep": "integer",
"currency": "string"
}
],
"devices": [
{
"id": "string",
"organizationId": "string",
"deviceHash": "string",
"serial": "string",
"name": "string",
"supplier": "string",
"tag": "string",
"latitude": "number",
"longitude": "number",
"positionY": "number",
"positionX": "number",
"timeZone": "string",
"maxLifetimeHours": "integer",
"maxLifetimeWarningPercentage": "integer",
"statusUpdateHoursOffset": "integer",
"referenceNumber": "string",
"online": "boolean",
"errors": [
"string"
],
"connectorId": "string"
}
]
}
}
}
}
Edit Single Group
Query to edit a Group
id:
string
(no description)
name:
string
(no description)
type:
(no description)
timeZone:
string
(no description)
currency:
string
(no description)
latitude:
number
(no description)
longitude:
number
(no description)
height:
number
(no description)
width:
number
(no description)
positionType:
(no description)
positionY:
number
(no description)
positionX:
number
(no description)
file:
object
(no description)
Example
Request Content-Types:
application/json
Query
mutation editGroup($id: ID!, $name: String!, $type: GroupTypes!, $timeZone: String!, $currency: String!, $latitude: Float, $longitude: Float, $height: Float, $width: Float, $positionType: PositionTypes, $positionY: Float, $positionX: Float, $file: Upload){
editGroup(id: $id, name: $name, type: $type, timeZone: $timeZone, currency: $currency, latitude: $latitude, longitude: $longitude, height: $height, width: $width, positionType: $positionType, positionY: $positionY, positionX: $positionX, file: $file){
status
item{
organizationId
id
name
path
latitude
longitude
positionType
positionY
positionX
timeZone
createdAt
updatedAt
countDevices
countDevicesDeep
countChildren
countChildrenDeep
currency
type
groupMap(userId: $userId){
id
height
width
url
createdAt
updatedAt
}
children{
organizationId
id
name
path
latitude
longitude
positionType
positionY
positionX
timeZone
createdAt
updatedAt
countDevices
countDevicesDeep
countChildren
countChildrenDeep
currency
type
}
devices{
id
organizationId
deviceHash
serial
name
supplier
tag
latitude
longitude
positionType
positionY
positionX
timeZone
networkType
maxLifetimeHours
maxLifetimeWarningPercentage
statusUpdateHoursOffset
referenceNumber
online
errors
statusUpdatedAt
createdAt
updatedAt
status
connectorId
}
}
}
}
Variables
{
"id": "string",
"name": "string",
"type": "string",
"timeZone": "string",
"currency": "string",
"latitude": "number",
"longitude": "number",
"height": "number",
"width": "number",
"positionType": "string",
"positionY": "number",
"positionX": "number"
}
mutation editGroup($id: ID!, $name: String!, $type: GroupTypes!, $timeZone: String!, $currency: String!, $latitude: Float, $longitude: Float, $height: Float, $width: Float, $positionType: PositionTypes, $positionY: Float, $positionX: Float, $file: Upload){
editGroup(id: $id, name: $name, type: $type, timeZone: $timeZone, currency: $currency, latitude: $latitude, longitude: $longitude, height: $height, width: $width, positionType: $positionType, positionY: $positionY, positionX: $positionX, file: $file){
status
item{
organizationId
id
name
path
latitude
longitude
positionType
positionY
positionX
timeZone
createdAt
updatedAt
countDevices
countDevicesDeep
countChildren
countChildrenDeep
currency
type
groupMap(userId: $userId){
id
height
width
url
createdAt
updatedAt
}
children{
organizationId
id
name
path
latitude
longitude
positionType
positionY
positionX
timeZone
createdAt
updatedAt
countDevices
countDevicesDeep
countChildren
countChildrenDeep
currency
type
}
devices{
id
organizationId
deviceHash
serial
name
supplier
tag
latitude
longitude
positionType
positionY
positionX
timeZone
networkType
maxLifetimeHours
maxLifetimeWarningPercentage
statusUpdateHoursOffset
referenceNumber
online
errors
statusUpdatedAt
createdAt
updatedAt
status
connectorId
}
}
}
}
{
"id": "string",
"name": "string",
"type": "string",
"timeZone": "string",
"currency": "string",
"latitude": "number",
"longitude": "number",
"height": "number",
"width": "number",
"positionType": "string",
"positionY": "number",
"positionX": "number"
}
200 OK
Successful operation
type
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"editGroup": {
"item": {
"organizationId": "string",
"id": "string",
"name": "string",
"path": "string",
"latitude": "number",
"longitude": "number",
"positionY": "number",
"positionX": "number",
"timeZone": "string",
"countDevices": "integer",
"countDevicesDeep": "integer",
"countChildren": "integer",
"countChildrenDeep": "integer",
"currency": "string",
"groupMap": {
"id": "number",
"height": "number",
"width": "number",
"url": "string"
},
"children": [
{
"organizationId": "string",
"id": "string",
"name": "string",
"path": "string",
"latitude": "number",
"longitude": "number",
"positionY": "number",
"positionX": "number",
"timeZone": "string",
"countDevices": "integer",
"countDevicesDeep": "integer",
"countChildren": "integer",
"countChildrenDeep": "integer",
"currency": "string"
}
],
"devices": [
{
"id": "string",
"organizationId": "string",
"deviceHash": "string",
"serial": "string",
"name": "string",
"supplier": "string",
"tag": "string",
"latitude": "number",
"longitude": "number",
"positionY": "number",
"positionX": "number",
"timeZone": "string",
"maxLifetimeHours": "integer",
"maxLifetimeWarningPercentage": "integer",
"statusUpdateHoursOffset": "integer",
"referenceNumber": "string",
"online": "boolean",
"errors": [
"string"
],
"connectorId": "string"
}
]
}
}
}
}
Lighting
This section deals with lighting module and some of it's main components like program and schedules.
Get Multiple Lighting Programs
Fetch list of Lighting Programs
(no description)
search:
string
(no description)
page:
integer
(no description)
pageSize:
integer
(no description)
Example
Request Content-Types:
application/json
Query
query lightingPrograms($sort: [LightingProgramSortingConditionInput!], $search: String, $page: Int, $pageSize: Int){
lightingPrograms(sort: $sort, search: $search, page: $page, pageSize: $pageSize){
status
total
page{
items{
id
name
organizationId
description
createdBy{
id
name
lastName
email
gender
phoneNumber
avatar
confirmedAt
createdAt
updatedAt
lastAccess
createdBy{
...RecursiveUserFragment
}
}
editedBy{
id
name
lastName
email
gender
phoneNumber
avatar
confirmedAt
createdAt
updatedAt
lastAccess
createdBy{
...RecursiveUserFragment
}
}
createdAt
updatedAt
days{
id
dayOfWeek
createdAt
updatedAt
}
}
size
index
}
}
}
Variables
{
"sort": [
{
"field": "string",
"order": "string"
}
],
"search": "string",
"page": "integer",
"pageSize": "integer"
}
query lightingPrograms($sort: [LightingProgramSortingConditionInput!], $search: String, $page: Int, $pageSize: Int){
lightingPrograms(sort: $sort, search: $search, page: $page, pageSize: $pageSize){
status
total
page{
items{
id
name
organizationId
description
createdBy{
id
name
lastName
email
gender
phoneNumber
avatar
confirmedAt
createdAt
updatedAt
lastAccess
createdBy{
...RecursiveUserFragment
}
}
editedBy{
id
name
lastName
email
gender
phoneNumber
avatar
confirmedAt
createdAt
updatedAt
lastAccess
createdBy{
...RecursiveUserFragment
}
}
createdAt
updatedAt
days{
id
dayOfWeek
createdAt
updatedAt
}
}
size
index
}
}
}
{
"sort": [
{
"field": "string",
"order": "string"
}
],
"search": "string",
"page": "integer",
"pageSize": "integer"
}
200 OK
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"lightingPrograms": {
"total": "integer",
"page": {
"items": [
{
"id": "integer",
"name": "string",
"organizationId": "string",
"description": "string",
"createdBy": {
"id": "string",
"name": "string",
"lastName": "string",
"email": "string",
"phoneNumber": "string",
"avatar": "string"
},
"editedBy": {
"id": "string",
"name": "string",
"lastName": "string",
"email": "string",
"phoneNumber": "string",
"avatar": "string",
"createdBy": {
"id": "string",
"name": "string",
"lastName": "string",
"email": "string",
"phoneNumber": "string",
"avatar": "string"
}
},
"days": [
{
"id": "integer"
}
]
}
],
"size": "integer",
"index": "integer"
}
}
}
}
Get Single Lighting Program
Fetch single Lighting Program
programId:
integer
(no description)
Example
Request Content-Types:
application/json
Query
query lightingProgram($programId: Int!){
lightingProgram(programId: $programId){
status
item{
id
name
organizationId
description
createdBy{
id
name
lastName
email
gender
phoneNumber
avatar
confirmedAt
createdAt
updatedAt
lastAccess
createdBy{
...RecursiveUserFragment
}
}
editedBy{
id
name
lastName
email
gender
phoneNumber
avatar
confirmedAt
createdAt
updatedAt
lastAccess
createdBy{
...RecursiveUserFragment
}
}
createdAt
updatedAt
days{
id
dayOfWeek
createdAt
updatedAt
}
}
}
}
Variables
{
"programId": "integer"
}
query lightingProgram($programId: Int!){
lightingProgram(programId: $programId){
status
item{
id
name
organizationId
description
createdBy{
id
name
lastName
email
gender
phoneNumber
avatar
confirmedAt
createdAt
updatedAt
lastAccess
createdBy{
...RecursiveUserFragment
}
}
editedBy{
id
name
lastName
email
gender
phoneNumber
avatar
confirmedAt
createdAt
updatedAt
lastAccess
createdBy{
...RecursiveUserFragment
}
}
createdAt
updatedAt
days{
id
dayOfWeek
createdAt
updatedAt
}
}
}
}
{
"programId": "integer"
}
200 OK
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"lightingProgram": {
"item": {
"id": "integer",
"name": "string",
"organizationId": "string",
"description": "string",
"createdBy": {
"id": "string",
"name": "string",
"lastName": "string",
"email": "string",
"phoneNumber": "string",
"avatar": "string"
},
"editedBy": {
"id": "string",
"name": "string",
"lastName": "string",
"email": "string",
"phoneNumber": "string",
"avatar": "string",
"createdBy": {
"id": "string",
"name": "string",
"lastName": "string",
"email": "string",
"phoneNumber": "string",
"avatar": "string"
}
},
"days": [
{
"id": "integer"
}
]
}
}
}
}
Get Multiple Lighting Schedules
Fetch multiple Lighting Schedules
to:
object
(no description)
from:
object
(no description)
groupId:
string
(no description)
programId:
integer
(no description)
Example
Request Content-Types:
application/json
Query
query lightingSchedules($to: DateTimeScalar!, $from: DateTimeScalar!, $groupId: String, $programId: Int){
lightingSchedules(to: $to, from: $from, groupId: $groupId, programId: $programId){
status
items{
id
groupId
organizationId
programId
program{
id
name
organizationId
description
createdAt
updatedAt
}
programCommandId
programCommand{
id
label
groupId
status
devicesCount
confirmedDevicesCount
errorDevicesCount
commandsCount
confirmedCommandsCount
errorCommandsCount
createdAt
updatedAt
}
scheduledDate
lastRetryDate
createdAt
updatedAt
}
}
}
Variables
{
"groupId": "string",
"programId": "integer"
}
query lightingSchedules($to: DateTimeScalar!, $from: DateTimeScalar!, $groupId: String, $programId: Int){
lightingSchedules(to: $to, from: $from, groupId: $groupId, programId: $programId){
status
items{
id
groupId
organizationId
programId
program{
id
name
organizationId
description
createdAt
updatedAt
}
programCommandId
programCommand{
id
label
groupId
status
devicesCount
confirmedDevicesCount
errorDevicesCount
commandsCount
confirmedCommandsCount
errorCommandsCount
createdAt
updatedAt
}
scheduledDate
lastRetryDate
createdAt
updatedAt
}
}
}
{
"groupId": "string",
"programId": "integer"
}
200 OK
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"lightingSchedules": {
"items": [
{
"id": "integer",
"groupId": "string",
"organizationId": "string",
"programId": "integer",
"program": {
"id": "integer",
"name": "string",
"organizationId": "string",
"description": "string"
},
"programCommandId": "integer",
"programCommand": {
"id": "integer",
"label": "string",
"groupId": "string",
"devicesCount": "integer",
"confirmedDevicesCount": "integer",
"errorDevicesCount": "integer",
"commandsCount": "integer",
"confirmedCommandsCount": "integer",
"errorCommandsCount": "integer"
}
}
]
}
}
}
Get Single Lighting Schedule
Fetch single Lighting Schedule
scheduleId:
integer
(no description)
Example
Request Content-Types:
application/json
Query
query lightingSchedule($scheduleId: Int!){
lightingSchedule(scheduleId: $scheduleId){
status
item{
id
groupId
organizationId
programId
program{
id
name
organizationId
description
createdAt
updatedAt
}
programCommandId
programCommand{
id
label
groupId
status
devicesCount
confirmedDevicesCount
errorDevicesCount
commandsCount
confirmedCommandsCount
errorCommandsCount
createdAt
updatedAt
}
scheduledDate
lastRetryDate
createdAt
updatedAt
}
}
}
Variables
{
"scheduleId": "integer"
}
query lightingSchedule($scheduleId: Int!){
lightingSchedule(scheduleId: $scheduleId){
status
item{
id
groupId
organizationId
programId
program{
id
name
organizationId
description
createdAt
updatedAt
}
programCommandId
programCommand{
id
label
groupId
status
devicesCount
confirmedDevicesCount
errorDevicesCount
commandsCount
confirmedCommandsCount
errorCommandsCount
createdAt
updatedAt
}
scheduledDate
lastRetryDate
createdAt
updatedAt
}
}
}
{
"scheduleId": "integer"
}
200 OK
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"lightingSchedule": {
"item": {
"id": "integer",
"groupId": "string",
"organizationId": "string",
"programId": "integer",
"program": {
"id": "integer",
"name": "string",
"organizationId": "string",
"description": "string"
},
"programCommandId": "integer",
"programCommand": {
"id": "integer",
"label": "string",
"groupId": "string",
"devicesCount": "integer",
"confirmedDevicesCount": "integer",
"errorDevicesCount": "integer",
"commandsCount": "integer",
"confirmedCommandsCount": "integer",
"errorCommandsCount": "integer"
}
}
}
}
}
Parking
This section deals with parking module and some if it's main components like program and schedules.
Get Multiple Parking Programs
Fetch multiple Parking Programs
page:
integer
(no description)
pageSize:
integer
(no description)
(no description)
search:
string
(no description)
type:
(no description)
groupId:
string
(no description)
Example
Request Content-Types:
application/json
Query
query parkingPrograms($page: Int, $pageSize: Int, $sort: [ParkingProgramSortingConditionInput!], $search: String, $type: ParkingProgramType, $groupId: String){
parkingPrograms(page: $page, pageSize: $pageSize, sort: $sort, search: $search, type: $type, groupId: $groupId){
status
total
page{
items{
id
name
organizationId
description
groupId
group{
organizationId
id
name
path
latitude
longitude
positionType
positionY
positionX
timeZone
createdAt
updatedAt
countDevices
countDevicesDeep
countChildren
countChildrenDeep
currency
type
}
type
dailyCostSlots{
from
to
price
dayOfWeek
}
dailyTimeSlots{
from
to
maxMinutes
emails
dayOfWeek
}
schedules{
id
programId
organizationId
date
createdAt
updatedAt
}
createdBy{
id
name
lastName
email
gender
phoneNumber
avatar
confirmedAt
createdAt
updatedAt
lastAccess
createdBy{
...RecursiveUserFragment
}
}
createdAt
updatedAt
}
size
index
}
}
}
Variables
{
"page": "integer",
"pageSize": "integer",
"sort": [
{
"field": "string",
"order": "string"
}
],
"search": "string",
"type": "string",
"groupId": "string"
}
query parkingPrograms($page: Int, $pageSize: Int, $sort: [ParkingProgramSortingConditionInput!], $search: String, $type: ParkingProgramType, $groupId: String){
parkingPrograms(page: $page, pageSize: $pageSize, sort: $sort, search: $search, type: $type, groupId: $groupId){
status
total
page{
items{
id
name
organizationId
description
groupId
group{
organizationId
id
name
path
latitude
longitude
positionType
positionY
positionX
timeZone
createdAt
updatedAt
countDevices
countDevicesDeep
countChildren
countChildrenDeep
currency
type
}
type
dailyCostSlots{
from
to
price
dayOfWeek
}
dailyTimeSlots{
from
to
maxMinutes
emails
dayOfWeek
}
schedules{
id
programId
organizationId
date
createdAt
updatedAt
}
createdBy{
id
name
lastName
email
gender
phoneNumber
avatar
confirmedAt
createdAt
updatedAt
lastAccess
createdBy{
...RecursiveUserFragment
}
}
createdAt
updatedAt
}
size
index
}
}
}
{
"page": "integer",
"pageSize": "integer",
"sort": [
{
"field": "string",
"order": "string"
}
],
"search": "string",
"type": "string",
"groupId": "string"
}
200 OK
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"parkingPrograms": {
"total": "integer",
"page": {
"items": [
{
"id": "integer",
"name": "string",
"organizationId": "string",
"description": "string",
"groupId": "string",
"group": {
"organizationId": "string",
"id": "string",
"name": "string",
"path": "string",
"latitude": "number",
"longitude": "number",
"positionY": "number",
"positionX": "number",
"timeZone": "string",
"countDevices": "integer",
"countDevicesDeep": "integer",
"countChildren": "integer",
"countChildrenDeep": "integer",
"currency": "string"
},
"dailyCostSlots": [
{
"from": "string",
"to": "string",
"price": "number"
}
],
"dailyTimeSlots": [
{
"from": "string",
"to": "string",
"maxMinutes": "integer",
"emails": [
"string"
]
}
],
"schedules": [
{
"id": "integer",
"programId": "integer",
"organizationId": "string"
}
],
"createdBy": {
"id": "string",
"name": "string",
"lastName": "string",
"email": "string",
"phoneNumber": "string",
"avatar": "string"
}
}
],
"size": "integer",
"index": "integer"
}
}
}
}
Get Single Parking Program
Fetch single Parking Program
programId:
integer
(no description)
Example
Request Content-Types:
application/json
Query
query parkingProgram($programId: Int!){
parkingProgram(programId: $programId){
status
item{
id
name
organizationId
description
groupId
group{
organizationId
id
name
path
latitude
longitude
positionType
positionY
positionX
timeZone
createdAt
updatedAt
countDevices
countDevicesDeep
countChildren
countChildrenDeep
currency
type
}
type
dailyCostSlots{
from
to
price
dayOfWeek
}
dailyTimeSlots{
from
to
maxMinutes
emails
dayOfWeek
}
schedules{
id
programId
organizationId
date
createdAt
updatedAt
}
createdBy{
id
name
lastName
email
gender
phoneNumber
avatar
confirmedAt
createdAt
updatedAt
lastAccess
createdBy{
...RecursiveUserFragment
}
}
createdAt
updatedAt
}
}
}
Variables
{
"programId": "integer"
}
query parkingProgram($programId: Int!){
parkingProgram(programId: $programId){
status
item{
id
name
organizationId
description
groupId
group{
organizationId
id
name
path
latitude
longitude
positionType
positionY
positionX
timeZone
createdAt
updatedAt
countDevices
countDevicesDeep
countChildren
countChildrenDeep
currency
type
}
type
dailyCostSlots{
from
to
price
dayOfWeek
}
dailyTimeSlots{
from
to
maxMinutes
emails
dayOfWeek
}
schedules{
id
programId
organizationId
date
createdAt
updatedAt
}
createdBy{
id
name
lastName
email
gender
phoneNumber
avatar
confirmedAt
createdAt
updatedAt
lastAccess
createdBy{
...RecursiveUserFragment
}
}
createdAt
updatedAt
}
}
}
{
"programId": "integer"
}
200 OK
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"parkingProgram": {
"item": {
"id": "integer",
"name": "string",
"organizationId": "string",
"description": "string",
"groupId": "string",
"group": {
"organizationId": "string",
"id": "string",
"name": "string",
"path": "string",
"latitude": "number",
"longitude": "number",
"positionY": "number",
"positionX": "number",
"timeZone": "string",
"countDevices": "integer",
"countDevicesDeep": "integer",
"countChildren": "integer",
"countChildrenDeep": "integer",
"currency": "string"
},
"dailyCostSlots": [
{
"from": "string",
"to": "string",
"price": "number"
}
],
"dailyTimeSlots": [
{
"from": "string",
"to": "string",
"maxMinutes": "integer",
"emails": [
"string"
]
}
],
"schedules": [
{
"id": "integer",
"programId": "integer",
"organizationId": "string"
}
],
"createdBy": {
"id": "string",
"name": "string",
"lastName": "string",
"email": "string",
"phoneNumber": "string",
"avatar": "string"
}
}
}
}
}
Get Multiple Parking Schedules
Fetch multiple Parking Schedules
page:
integer
(no description)
pageSize:
integer
(no description)
from:
object
(no description)
to:
object
(no description)
groupIds:
string[]
(no description)
programId:
number
(no description)
Example
Request Content-Types:
application/json
Query
query parkingSchedules($page: Int, $pageSize: Int, $from: DateTimeScalar, $to: DateTimeScalar, $groupIds: [String!], $programId: Float){
parkingSchedules(page: $page, pageSize: $pageSize, from: $from, to: $to, groupIds: $groupIds, programId: $programId){
status
total
page{
items{
id
programId
organizationId
program{
id
name
organizationId
description
groupId
type
createdAt
updatedAt
}
date
createdAt
updatedAt
}
size
index
}
}
}
Variables
{
"page": "integer",
"pageSize": "integer",
"groupIds": [
"string"
],
"programId": "number"
}
query parkingSchedules($page: Int, $pageSize: Int, $from: DateTimeScalar, $to: DateTimeScalar, $groupIds: [String!], $programId: Float){
parkingSchedules(page: $page, pageSize: $pageSize, from: $from, to: $to, groupIds: $groupIds, programId: $programId){
status
total
page{
items{
id
programId
organizationId
program{
id
name
organizationId
description
groupId
type
createdAt
updatedAt
}
date
createdAt
updatedAt
}
size
index
}
}
}
{
"page": "integer",
"pageSize": "integer",
"groupIds": [
"string"
],
"programId": "number"
}
200 OK
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"parkingSchedules": {
"total": "integer",
"page": {
"items": [
{
"id": "integer",
"programId": "integer",
"organizationId": "string",
"program": {
"id": "integer",
"name": "string",
"organizationId": "string",
"description": "string",
"groupId": "string"
}
}
],
"size": "integer",
"index": "integer"
}
}
}
}
Get Single Parking Schedule
Fetch single Parking Schedule
scheduleId:
integer
(no description)
Example
Request Content-Types:
application/json
Query
query parkingSchedule($scheduleId: Int!){
parkingSchedule(scheduleId: $scheduleId){
status
item{
id
programId
organizationId
program{
id
name
organizationId
description
groupId
type
createdAt
updatedAt
}
date
createdAt
updatedAt
}
}
}
Variables
{
"scheduleId": "integer"
}
query parkingSchedule($scheduleId: Int!){
parkingSchedule(scheduleId: $scheduleId){
status
item{
id
programId
organizationId
program{
id
name
organizationId
description
groupId
type
createdAt
updatedAt
}
date
createdAt
updatedAt
}
}
}
{
"scheduleId": "integer"
}
200 OK
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"parkingSchedule": {
"item": {
"id": "integer",
"programId": "integer",
"organizationId": "string",
"program": {
"id": "integer",
"name": "string",
"organizationId": "string",
"description": "string",
"groupId": "string"
}
}
}
}
}
Metering
This section deals with metering module and some of it's main components like program and schedules.
Get Multiple Metering Programs
Fetch multiple Metering Programs
page:
integer
(no description)
pageSize:
integer
(no description)
(no description)
search:
string
(no description)
types:
(no description)
groupId:
string
(no description)
Example
Request Content-Types:
application/json
Query
query meteringPrograms($page: Int, $pageSize: Int, $sort: [MeteringProgramSortingConditionInput!], $search: String, $types: [MeteringProgramTypes!], $groupId: String){
meteringPrograms(page: $page, pageSize: $pageSize, sort: $sort, search: $search, types: $types, groupId: $groupId){
status
total
page{
items{
id
name
description
organizationId
groupId
group{
organizationId
id
name
path
latitude
longitude
positionType
positionY
positionX
timeZone
createdAt
updatedAt
countDevices
countDevicesDeep
countChildren
countChildrenDeep
currency
type
}
type
dailyCostSlots{
from
to
price
dayOfWeek
}
schedules{
id
programId
organizationId
date
createdAt
updatedAt
}
createdBy{
id
name
lastName
email
gender
phoneNumber
avatar
confirmedAt
createdAt
updatedAt
lastAccess
createdBy{
...RecursiveUserFragment
}
}
createdAt
updatedAt
}
size
index
}
}
}
Variables
{
"page": "integer",
"pageSize": "integer",
"sort": [
{
"field": "string",
"order": "string"
}
],
"search": "string",
"types": [
"string"
],
"groupId": "string"
}
query meteringPrograms($page: Int, $pageSize: Int, $sort: [MeteringProgramSortingConditionInput!], $search: String, $types: [MeteringProgramTypes!], $groupId: String){
meteringPrograms(page: $page, pageSize: $pageSize, sort: $sort, search: $search, types: $types, groupId: $groupId){
status
total
page{
items{
id
name
description
organizationId
groupId
group{
organizationId
id
name
path
latitude
longitude
positionType
positionY
positionX
timeZone
createdAt
updatedAt
countDevices
countDevicesDeep
countChildren
countChildrenDeep
currency
type
}
type
dailyCostSlots{
from
to
price
dayOfWeek
}
schedules{
id
programId
organizationId
date
createdAt
updatedAt
}
createdBy{
id
name
lastName
email
gender
phoneNumber
avatar
confirmedAt
createdAt
updatedAt
lastAccess
createdBy{
...RecursiveUserFragment
}
}
createdAt
updatedAt
}
size
index
}
}
}
{
"page": "integer",
"pageSize": "integer",
"sort": [
{
"field": "string",
"order": "string"
}
],
"search": "string",
"types": [
"string"
],
"groupId": "string"
}
200 OK
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"meteringPrograms": {
"total": "integer",
"page": {
"items": [
{
"id": "integer",
"name": "string",
"description": "string",
"organizationId": "string",
"groupId": "string",
"group": {
"organizationId": "string",
"id": "string",
"name": "string",
"path": "string",
"latitude": "number",
"longitude": "number",
"positionY": "number",
"positionX": "number",
"timeZone": "string",
"countDevices": "integer",
"countDevicesDeep": "integer",
"countChildren": "integer",
"countChildrenDeep": "integer",
"currency": "string"
},
"dailyCostSlots": [
{
"from": "string",
"to": "string",
"price": "number"
}
],
"schedules": [
{
"id": "integer",
"programId": "integer",
"organizationId": "string"
}
],
"createdBy": {
"id": "string",
"name": "string",
"lastName": "string",
"email": "string",
"phoneNumber": "string",
"avatar": "string"
}
}
],
"size": "integer",
"index": "integer"
}
}
}
}
Get Single Metering Program
Fetch single Metering Program
programId:
integer
(no description)
Example
Request Content-Types:
application/json
Query
query meteringProgram($programId: Int!){
meteringProgram(programId: $programId){
status
item{
id
name
description
organizationId
groupId
group{
organizationId
id
name
path
latitude
longitude
positionType
positionY
positionX
timeZone
createdAt
updatedAt
countDevices
countDevicesDeep
countChildren
countChildrenDeep
currency
type
}
type
dailyCostSlots{
from
to
price
dayOfWeek
}
schedules{
id
programId
organizationId
date
createdAt
updatedAt
}
createdBy{
id
name
lastName
email
gender
phoneNumber
avatar
confirmedAt
createdAt
updatedAt
lastAccess
createdBy{
...RecursiveUserFragment
}
}
createdAt
updatedAt
}
}
}
Variables
{
"programId": "integer"
}
query meteringProgram($programId: Int!){
meteringProgram(programId: $programId){
status
item{
id
name
description
organizationId
groupId
group{
organizationId
id
name
path
latitude
longitude
positionType
positionY
positionX
timeZone
createdAt
updatedAt
countDevices
countDevicesDeep
countChildren
countChildrenDeep
currency
type
}
type
dailyCostSlots{
from
to
price
dayOfWeek
}
schedules{
id
programId
organizationId
date
createdAt
updatedAt
}
createdBy{
id
name
lastName
email
gender
phoneNumber
avatar
confirmedAt
createdAt
updatedAt
lastAccess
createdBy{
...RecursiveUserFragment
}
}
createdAt
updatedAt
}
}
}
{
"programId": "integer"
}
200 OK
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"meteringProgram": {
"item": {
"id": "integer",
"name": "string",
"description": "string",
"organizationId": "string",
"groupId": "string",
"group": {
"organizationId": "string",
"id": "string",
"name": "string",
"path": "string",
"latitude": "number",
"longitude": "number",
"positionY": "number",
"positionX": "number",
"timeZone": "string",
"countDevices": "integer",
"countDevicesDeep": "integer",
"countChildren": "integer",
"countChildrenDeep": "integer",
"currency": "string"
},
"dailyCostSlots": [
{
"from": "string",
"to": "string",
"price": "number"
}
],
"schedules": [
{
"id": "integer",
"programId": "integer",
"organizationId": "string"
}
],
"createdBy": {
"id": "string",
"name": "string",
"lastName": "string",
"email": "string",
"phoneNumber": "string",
"avatar": "string"
}
}
}
}
}
Get Multiple Metering Schedules
Fetch multiple Metering Schedules
page:
integer
(no description)
pageSize:
integer
(no description)
from:
object
(no description)
to:
object
(no description)
groupIds:
string[]
(no description)
programId:
number
(no description)
Example
Request Content-Types:
application/json
Query
query meteringSchedules($page: Int, $pageSize: Int, $from: DateTimeScalar, $to: DateTimeScalar, $groupIds: [String!], $programId: Float){
meteringSchedules(page: $page, pageSize: $pageSize, from: $from, to: $to, groupIds: $groupIds, programId: $programId){
status
total
page{
items{
id
programId
organizationId
program{
id
name
description
organizationId
groupId
type
createdAt
updatedAt
}
date
createdAt
updatedAt
}
size
index
}
}
}
Variables
{
"page": "integer",
"pageSize": "integer",
"groupIds": [
"string"
],
"programId": "number"
}
query meteringSchedules($page: Int, $pageSize: Int, $from: DateTimeScalar, $to: DateTimeScalar, $groupIds: [String!], $programId: Float){
meteringSchedules(page: $page, pageSize: $pageSize, from: $from, to: $to, groupIds: $groupIds, programId: $programId){
status
total
page{
items{
id
programId
organizationId
program{
id
name
description
organizationId
groupId
type
createdAt
updatedAt
}
date
createdAt
updatedAt
}
size
index
}
}
}
{
"page": "integer",
"pageSize": "integer",
"groupIds": [
"string"
],
"programId": "number"
}
200 OK
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"meteringSchedules": {
"total": "integer",
"page": {
"items": [
{
"id": "integer",
"programId": "integer",
"organizationId": "string",
"program": {
"id": "integer",
"name": "string",
"description": "string",
"organizationId": "string",
"groupId": "string"
}
}
],
"size": "integer",
"index": "integer"
}
}
}
}
Get Single Metering Schedule
Fetch single Metering Schedule
scheduleId:
integer
(no description)
Example
Request Content-Types:
application/json
Query
query meteringSchedule($scheduleId: Int!){
meteringSchedule(scheduleId: $scheduleId){
status
item{
id
programId
organizationId
program{
id
name
description
organizationId
groupId
type
createdAt
updatedAt
}
date
createdAt
updatedAt
}
}
}
Variables
{
"scheduleId": "integer"
}
query meteringSchedule($scheduleId: Int!){
meteringSchedule(scheduleId: $scheduleId){
status
item{
id
programId
organizationId
program{
id
name
description
organizationId
groupId
type
createdAt
updatedAt
}
date
createdAt
updatedAt
}
}
}
{
"scheduleId": "integer"
}
200 OK
Successful operation
Response Content-Types: application/json
Response Example (200 OK)
{
"data": {
"meteringSchedule": {
"item": {
"id": "integer",
"programId": "integer",
"organizationId": "string",
"program": {
"id": "integer",
"name": "string",
"description": "string",
"organizationId": "string",
"groupId": "string"
}
}
}
}
}
Schema Definitions
AstroProgramCommandDeviceStatus: string
Lighting device astro clock program status",
-
objectCREATED
-
objectSENT
-
objectCONFIRMED
-
objectFAILED
-
objectTIMEOUT
Automation: object
- description:
- ioConfig:
- loadCellConfig:
- peopleCounterCameraConfig:
- io02Config:
Example
{
"description": "string",
"ioConfig": {
"inputs": [
{
"key": "number",
"label": "string",
"connectedOutputs": [
"number"
]
}
],
"outputs": [
{
"key": "number",
"label": "string"
}
]
},
"loadCellConfig": {
"nominalLoad": "number",
"thresholdOne": "number",
"thresholdTwo": "number"
},
"peopleCounterCameraConfig": {
"areaNumber": "number"
},
"io02Config": {
"input": [
{
"key": "number",
"label": "string"
}
],
"output": [
{
"key": "number",
"label": "string"
}
]
}
}
AutomationDigitalInputStatus: object
- signal:
- online:
- createdAt:
- updatedAt:
- receivedAt:
- digitalInputOne:
- digitalInputTwo:
Example
{
"signal": "number",
"online": "boolean",
"createdAt": "object",
"updatedAt": "object",
"receivedAt": "object",
"digitalInputOne": "boolean",
"digitalInputTwo": "boolean"
}
AutomationDigitalOutputStatus: object
- signal:
- online:
- createdAt:
- updatedAt:
- receivedAt:
- digitalOutputOne:
- digitalOutputTwo:
Example
{
"signal": "number",
"online": "boolean",
"createdAt": "object",
"updatedAt": "object",
"receivedAt": "object",
"digitalOutputOne": "boolean",
"digitalOutputTwo": "boolean"
}
AutomationIO01DigitalInputStatusPaginatedResponse: object
- status:
- total:
- page:
Example
{
"status": "string",
"total": "number",
"page": {
"items": [
{
"signal": "number",
"online": "boolean",
"createdAt": "object",
"updatedAt": "object",
"receivedAt": "object",
"digitalInputOne": "boolean",
"digitalInputTwo": "boolean"
}
],
"size": "number",
"index": "number"
}
}
AutomationIO01DigitalOutputStatusPaginatedResponse: object
- status:
- total:
- page:
Example
{
"status": "string",
"total": "number",
"page": {
"items": [
{
"signal": "number",
"online": "boolean",
"createdAt": "object",
"updatedAt": "object",
"receivedAt": "object",
"digitalOutputOne": "boolean",
"digitalOutputTwo": "boolean"
}
],
"size": "number",
"index": "number"
}
}
AutomationIO01Status: object
- online:
- digitalOutputStatus:
- digitalInputStatus:
Example
{
"online": "boolean",
"digitalOutputStatus": {
"signal": "number",
"online": "boolean",
"createdAt": "object",
"updatedAt": "object",
"receivedAt": "object",
"digitalOutputOne": "boolean",
"digitalOutputTwo": "boolean"
},
"digitalInputStatus": {
"signal": "number",
"online": "boolean",
"createdAt": "object",
"updatedAt": "object",
"receivedAt": "object",
"digitalInputOne": "boolean",
"digitalInputTwo": "boolean"
}
}
AutomationIO02ConfigurationRequestCommandInput: object
- configurationOption:
Example
{
"configurationOption": "string"
}
AutomationIO02ControlConfig: object
- input:
- output:
Example
{
"input": [
{
"key": "number",
"label": "string"
}
],
"output": [
{
"key": "number",
"label": "string"
}
]
}
AutomationIO02ControlConfigInput: object
Example
{
"input": [
{
"key": "number",
"label": "string"
}
],
"output": [
{
"key": "number",
"label": "string"
}
]
}
AutomationIO02ControlStatus: object
- key:
- label:
- value:
- receivedAt:
- online:
Example
{
"key": "number",
"label": "string",
"value": "boolean",
"receivedAt": "object",
"online": "boolean"
}
AutomationIO02DigitalData: object
- inputCountersType1:
- frequencyMeter:
- inputCountersType2:
- outputCounter:
- receivedAt:
Example
{
"inputCountersType1": {
"measure": "number",
"counter": "number"
},
"frequencyMeter": {
"measure": "number",
"date": "object",
"frequency": "number"
},
"inputCountersType2": {
"measures": [
{
"measure": "number",
"counter": "number",
"date": "object"
}
]
},
"outputCounter": "number",
"receivedAt": "object"
}
AutomationIO02DigitalDataHistory: object
- status:
- total:
- page:
Example
{
"status": "string",
"total": "number",
"page": {
"items": [
{
"inputCountersType1": {
"measure": "number",
"counter": "number"
},
"frequencyMeter": {
"measure": "number",
"date": "object",
"frequency": "number"
},
"inputCountersType2": {
"measures": [
{
"measure": "number",
"counter": "number",
"date": "object"
}
]
},
"outputCounter": "number",
"receivedAt": "object"
}
],
"size": "number",
"index": "number"
}
}
AutomationIO02DigitalDataResponse: object
- status:
- item:
Example
{
"status": "string",
"item": {
"inputCountersType1": {
"measure": "number",
"counter": "number"
},
"frequencyMeter": {
"measure": "number",
"date": "object",
"frequency": "number"
},
"inputCountersType2": {
"measures": [
{
"measure": "number",
"counter": "number",
"date": "object"
}
]
},
"outputCounter": "number",
"receivedAt": "object"
}
}
AutomationIO02FrequencyMeter: object
- measure:
- date:
- frequency:
Example
{
"measure": "number",
"date": "object",
"frequency": "number"
}
AutomationIO02GeneralSettingsCommandInput: object
- generalSettingsOption:
- enable:
Example
{
"generalSettingsOption": "string",
"enable": "boolean"
}
AutomationIO02IOCommandPayload: object
- controls:
Example
{
"controls": [
{
"key": "number",
"value": "boolean"
}
]
}
AutomationIO02InputCounterType2: object
- measures:
Example
{
"measures": [
{
"measure": "number",
"counter": "number",
"date": "object"
}
]
}
AutomationIO02InputCounterType2Measure: object
- measure:
- counter:
- date:
Example
{
"measure": "number",
"counter": "number",
"date": "object"
}
AutomationIO02PeriodCommandInput: object
- periodOption:
- minutes:
Example
{
"periodOption": "string",
"minutes": "number"
}
AutomationIO02Status: object
- signal:
- online:
- createdAt:
- updatedAt:
- receivedAt:
- input:
- output:
Example
{
"signal": "number",
"online": "boolean",
"createdAt": "object",
"updatedAt": "object",
"receivedAt": "object",
"input": [
{
"key": "number",
"label": "string",
"value": "boolean"
}
],
"output": [
{
"key": "number",
"label": "string",
"value": "boolean"
}
]
}
AutomationIO02StatusChart: object
- status:
- total:
- page:
Example
{
"status": "string",
"total": "number",
"page": {
"items": [
{
"key": "number",
"label": "string",
"value": "boolean",
"receivedAt": "object",
"online": "boolean"
}
],
"size": "number",
"index": "number"
}
}
AutomationIO02StatusHistory: object
- status:
- total:
- page:
Example
{
"status": "string",
"total": "number",
"page": {
"items": [
{
"signal": "number",
"online": "boolean",
"createdAt": "object",
"updatedAt": "object",
"receivedAt": "object",
"input": [
{
"key": "number",
"label": "string",
"value": "boolean"
}
],
"output": [
{
"key": "number",
"label": "string",
"value": "boolean"
}
]
}
],
"size": "number",
"index": "number"
}
}
AutomationIO02StatusResponse: object
- status:
- item:
Example
{
"status": "string",
"item": {
"signal": "number",
"online": "boolean",
"createdAt": "object",
"updatedAt": "object",
"receivedAt": "object",
"input": [
{
"key": "number",
"label": "string",
"value": "boolean"
}
],
"output": [
{
"key": "number",
"label": "string",
"value": "boolean"
}
]
}
}
AutomationLoadCellLoadStatusResponse: object
- status:
- item:
Example
{
"status": "string",
"item": {
"nominalLoad": "number",
"thresholdOne": "number",
"thresholdTwo": "number"
}
}
AutomationLoadCellStatusPaginatedResponse: object
- status:
- total:
- page:
Example
{
"status": "string",
"total": "number",
"page": {
"items": [
{
"signal": "number",
"weight": "number",
"batteryPercentage": "number",
"timeShift": "number",
"receivedAt": "object",
"online": "boolean"
}
],
"size": "number",
"index": "number"
}
}
AutomationLoadCellThresholdStatus: string
Automation Load Cell Threshold Status
-
objectNOMINAL_LOAD
-
objectTHRESHOLD_ONE
-
objectTHRESHOLD_TWO
AutomationLoadCellTotalLoadResponse: object
- status:
- item:
Example
{
"status": "string",
"item": {
"total": "number"
}
}
AutomationOPCUAPLCProtocol: object
- serialNo:
- connectionType:
- plcAddress:
- opcuaVars:
Example
{
"serialNo": {
"required": "boolean",
"path": "string"
},
"connectionType": {
"required": "boolean",
"path": "string"
},
"plcAddress": {
"required": "boolean",
"path": "string"
},
"opcuaVars": {
"required": "boolean",
"path": "string",
"isArray": "boolean",
"itemProtocol": {
"identifier": {
"required": "boolean",
"path": "string"
},
"identifierType": {
"required": "boolean",
"path": "string"
},
"namespaceIdentifier": {
"required": "boolean",
"path": "string"
},
"variableType": {
"required": "boolean",
"path": "string"
},
"variableDirection": {
"required": "boolean",
"path": "string"
},
"variableLabel": {
"required": "boolean",
"path": "string"
},
"variableUnit": {
"required": "boolean",
"path": "string"
},
"scaleFactor": {
"required": "boolean",
"path": "string"
},
"scaledVariableUnit": {
"required": "boolean",
"path": "string"
},
"variableCurrentValue": {
"required": "boolean",
"path": "string"
},
"error": {
"required": "boolean",
"path": "string"
}
}
}
}
AutomationOPCUAPLCProtocolField: object
- identifier:
- identifierType:
- namespaceIdentifier:
- variableType:
- variableDirection:
- variableLabel:
- variableUnit:
- scaleFactor:
- scaledVariableUnit:
- variableCurrentValue:
- error:
Example
{
"identifier": {
"required": "boolean",
"path": "string"
},
"identifierType": {
"required": "boolean",
"path": "string"
},
"namespaceIdentifier": {
"required": "boolean",
"path": "string"
},
"variableType": {
"required": "boolean",
"path": "string"
},
"variableDirection": {
"required": "boolean",
"path": "string"
},
"variableLabel": {
"required": "boolean",
"path": "string"
},
"variableUnit": {
"required": "boolean",
"path": "string"
},
"scaleFactor": {
"required": "boolean",
"path": "string"
},
"scaledVariableUnit": {
"required": "boolean",
"path": "string"
},
"variableCurrentValue": {
"required": "boolean",
"path": "string"
},
"error": {
"required": "boolean",
"path": "string"
}
}
AutomationOPCUAPLCProtocolInput: object
- serialNo:
- connectionType:
- plcAddress:
- opcuaVars:
Example
{
"serialNo": {
"required": "boolean",
"path": "string"
},
"connectionType": {
"required": "boolean",
"path": "string"
},
"plcAddress": {
"required": "boolean",
"path": "string"
},
"opcuaVars": {
"required": "boolean",
"path": "string",
"isArray": "boolean",
"itemProtocol": {
"identifier": {
"required": "boolean",
"path": "string"
},
"identifierType": {
"required": "boolean",
"path": "string"
},
"namespaceIdentifier": {
"required": "boolean",
"path": "string"
},
"variableType": {
"required": "boolean",
"path": "string"
},
"variableDirection": {
"required": "boolean",
"path": "string"
},
"variableLabel": {
"required": "boolean",
"path": "string"
},
"variableUnit": {
"required": "boolean",
"path": "string"
},
"scaleFactor": {
"required": "boolean",
"path": "string"
},
"scaledVariableUnit": {
"required": "boolean",
"path": "string"
},
"variableCurrentValue": {
"required": "boolean",
"path": "string"
},
"error": {
"required": "boolean",
"path": "string"
}
}
}
}
AutomationOPCUAPLCProtocolInputField: object
- identifier:
- identifierType:
- namespaceIdentifier:
- variableType:
- variableDirection:
- variableLabel:
- variableUnit:
- scaleFactor:
- scaledVariableUnit:
- variableCurrentValue:
- error:
Example
{
"identifier": {
"required": "boolean",
"path": "string"
},
"identifierType": {
"required": "boolean",
"path": "string"
},
"namespaceIdentifier": {
"required": "boolean",
"path": "string"
},
"variableType": {
"required": "boolean",
"path": "string"
},
"variableDirection": {
"required": "boolean",
"path": "string"
},
"variableLabel": {
"required": "boolean",
"path": "string"
},
"variableUnit": {
"required": "boolean",
"path": "string"
},
"scaleFactor": {
"required": "boolean",
"path": "string"
},
"scaledVariableUnit": {
"required": "boolean",
"path": "string"
},
"variableCurrentValue": {
"required": "boolean",
"path": "string"
},
"error": {
"required": "boolean",
"path": "string"
}
}
AutomationPC01Status: object
- signal:
- leftToRight:
- rightToLeft:
- createdAt:
- updatedAt:
- receivedAt:
- online:
Example
{
"signal": "number",
"leftToRight": "number",
"rightToLeft": "number",
"createdAt": "object",
"updatedAt": "object",
"receivedAt": "object",
"online": "boolean"
}
AutomationPC01StatusPaginatedResponse: object
- status:
- total:
- page:
Example
{
"status": "string",
"total": "number",
"page": {
"items": [
{
"signal": "number",
"leftToRight": "number",
"rightToLeft": "number",
"createdAt": "object",
"updatedAt": "object",
"receivedAt": "object",
"online": "boolean"
}
],
"size": "number",
"index": "number"
}
}
AutomationPC02Status: object
- signal:
- totalCounterIn:
- totalCounterOut:
- createdAt:
- updatedAt:
- receivedAt:
- online:
Example
{
"signal": "number",
"totalCounterIn": "number",
"totalCounterOut": "number",
"createdAt": "object",
"updatedAt": "object",
"receivedAt": "object",
"online": "boolean"
}
AutomationPC02StatusPaginatedResponse: object
- status:
- total:
- page:
Example
{
"status": "string",
"total": "number",
"page": {
"items": [
{
"signal": "number",
"totalCounterIn": "number",
"totalCounterOut": "number",
"createdAt": "object",
"updatedAt": "object",
"receivedAt": "object",
"online": "boolean"
}
],
"size": "number",
"index": "number"
}
}
AutomationPLCOPCUAStatus: object
- signal:
- serialNo:
- connectionType:
- plcAddress:
- opcuaVars:
- createdAt:
- updatedAt:
- receivedAt:
- online:
Example
{
"signal": "number",
"serialNo": "string",
"connectionType": "string",
"plcAddress": "string",
"opcuaVars": [
{
"identifier": "string",
"identifierType": "string",
"namespaceIdentifier": "number",
"variableType": "string",
"variableDirection": "string",
"variableLabel": "string",
"variableUnit": "string",
"scaleFactor": "number",
"scaledVariableUnit": "string",
"variableCurrentValue": "string",
"error": "string"
}
],
"createdAt": "object",
"updatedAt": "object",
"receivedAt": "object",
"online": "boolean"
}
AutomationPLCOPCUAStatusOPCUAVars: object
- identifier:
- identifierType:
- namespaceIdentifier:
- variableType:
- variableDirection:
- variableLabel:
- variableUnit:
- scaleFactor:
- scaledVariableUnit:
- variableCurrentValue:
- error:
Example
{
"identifier": "string",
"identifierType": "string",
"namespaceIdentifier": "number",
"variableType": "string",
"variableDirection": "string",
"variableLabel": "string",
"variableUnit": "string",
"scaleFactor": "number",
"scaledVariableUnit": "string",
"variableCurrentValue": "string",
"error": "string"
}
AutomationPLCOPCUAStatusPaginatedResponse: object
- status:
- total:
- page:
Example
{
"status": "string",
"total": "number",
"page": {
"items": [
{
"signal": "number",
"serialNo": "string",
"connectionType": "string",
"plcAddress": "string",
"opcuaVars": [
{
"identifier": "string",
"identifierType": "string",
"namespaceIdentifier": "number",
"variableType": "string",
"variableDirection": "string",
"variableLabel": "string",
"variableUnit": "string",
"scaleFactor": "number",
"scaledVariableUnit": "string",
"variableCurrentValue": "string",
"error": "string"
}
],
"createdAt": "object",
"updatedAt": "object",
"receivedAt": "object",
"online": "boolean"
}
],
"size": "number",
"index": "number"
}
}
AutomationPeopleCounterCameraStatus: object
- signal:
- in:
- out:
- totalPeople:
- totalRegion:
- maxPeople:
- regionPeopleCount:
- regionPeoples:
- createdAt:
- updatedAt:
- receivedAt:
- online:
Example
{
"signal": "number",
"in": "number",
"out": "number",
"totalPeople": "number",
"totalRegion": "number",
"maxPeople": "number",
"regionPeopleCount": [
{
"region": "number",
"people": "number"
}
],
"regionPeoples": "number",
"createdAt": "object",
"updatedAt": "object",
"receivedAt": "object",
"online": "boolean"
}
AutomationPeopleCounterCameraStatusPaginatedResponse: object
- status:
- total:
- page:
Example
{
"status": "string",
"total": "number",
"page": {
"items": [
{
"signal": "number",
"in": "number",
"out": "number",
"totalPeople": "number",
"totalRegion": "number",
"maxPeople": "number",
"regionPeopleCount": [
{
"region": "number",
"people": "number"
}
],
"regionPeoples": "number",
"createdAt": "object",
"updatedAt": "object",
"receivedAt": "object",
"online": "boolean"
}
],
"size": "number",
"index": "number"
}
}
AutomationRakAllButtonStatus: object
- buttonOneLastPressedAt:
- buttonTwoLastPressedAt:
- buttonThreeLastPressedAt:
- buttonFourLastPressedAt:
Example
{
"buttonOneLastPressedAt": "object",
"buttonTwoLastPressedAt": "object",
"buttonThreeLastPressedAt": "object",
"buttonFourLastPressedAt": "object"
}
AutomationRakAllButtonStatusResponse: object
- status:
- item:
Example
{
"status": "string",
"item": {
"buttonOneLastPressedAt": "object",
"buttonTwoLastPressedAt": "object",
"buttonThreeLastPressedAt": "object",
"buttonFourLastPressedAt": "object"
}
}
AutomationRakSmartButtonStatus: object
- signal:
- buttonOne:
- buttonTwo:
- buttonThree:
- buttonFour:
- lastPressedAt:
- createdAt:
- updatedAt:
- receivedAt:
- online:
Example
{
"signal": "number",
"buttonOne": "number",
"buttonTwo": "number",
"buttonThree": "number",
"buttonFour": "number",
"lastPressedAt": {
"buttonOneLastPressedAt": "object",
"buttonTwoLastPressedAt": "object",
"buttonThreeLastPressedAt": "object",
"buttonFourLastPressedAt": "object"
},
"createdAt": "object",
"updatedAt": "object",
"receivedAt": "object",
"online": "boolean"
}
AutomationRakSmartButtonStatusPaginatedResponse: object
- status:
- total:
- page:
Example
{
"status": "string",
"total": "number",
"page": {
"items": [
{
"signal": "number",
"buttonOne": "number",
"buttonTwo": "number",
"buttonThree": "number",
"buttonFour": "number",
"lastPressedAt": {
"buttonOneLastPressedAt": "object",
"buttonTwoLastPressedAt": "object",
"buttonThreeLastPressedAt": "object",
"buttonFourLastPressedAt": "object"
},
"createdAt": "object",
"updatedAt": "object",
"receivedAt": "object",
"online": "boolean"
}
],
"size": "number",
"index": "number"
}
}
AutomationST02Status: object
- signal:
- tamper:
- process:
- battery:
- fraud:
- hygrometry:
- temperature:
- di_0:
- di_1:
- power:
- valve:
- class:
- cable:
- leakage:
- receivedAt:
- online:
Example
{
"signal": "number",
"tamper": "boolean",
"process": "boolean",
"battery": "number",
"fraud": "boolean",
"hygrometry": "number",
"temperature": "number",
"di_0": "boolean",
"di_1": "boolean",
"power": "boolean",
"valve": "boolean",
"class": "string",
"cable": "boolean",
"leakage": "boolean",
"receivedAt": "object",
"online": "boolean"
}
AutomationST02StatusPaginatedResponse: object
- status:
- total:
- page:
Example
{
"status": "string",
"total": "number",
"page": {
"items": [
{
"signal": "number",
"tamper": "boolean",
"process": "boolean",
"battery": "number",
"fraud": "boolean",
"hygrometry": "number",
"temperature": "number",
"di_0": "boolean",
"di_1": "boolean",
"power": "boolean",
"valve": "boolean",
"class": "string",
"cable": "boolean",
"leakage": "boolean",
"receivedAt": "object",
"online": "boolean"
}
],
"size": "number",
"index": "number"
}
}
AutomationST03Status: object
- signal:
- tamper:
- process:
- battery:
- fraud:
- hygrometry:
- temperature:
- di_0:
- di_1:
- power:
- valve:
- class:
- cable:
- leakage:
- receivedAt:
- online:
Example
{
"signal": "number",
"tamper": "boolean",
"process": "boolean",
"battery": "number",
"fraud": "boolean",
"hygrometry": "number",
"temperature": "number",
"di_0": "boolean",
"di_1": "boolean",
"power": "boolean",
"valve": "boolean",
"class": "string",
"cable": "boolean",
"leakage": "boolean",
"receivedAt": "object",
"online": "boolean"
}
AutomationST03StatusPaginatedResponse: object
- status:
- total:
- page:
Example
{
"status": "string",
"total": "number",
"page": {
"items": [
{
"signal": "number",
"tamper": "boolean",
"process": "boolean",
"battery": "number",
"fraud": "boolean",
"hygrometry": "number",
"temperature": "number",
"di_0": "boolean",
"di_1": "boolean",
"power": "boolean",
"valve": "boolean",
"class": "string",
"cable": "boolean",
"leakage": "boolean",
"receivedAt": "object",
"online": "boolean"
}
],
"size": "number",
"index": "number"
}
}
AutomationTimedValveControlInput: object
- status:
- timeBase:
- interval:
Example
{
"status": "string",
"timeBase": "string",
"interval": "number"
}
AutomationTrafficCounterSensorRequestCommandInput: object
- operatingMode:
- deviceClass:
- uplinkType:
- uplinkInterval:
- linkCheckInterval:
- holdoffTime:
- radarAutotuning:
- radarSensitivity:
- LTRLaneDist:
- RTLLaneDist:
- SC0_START:
- SC0_END:
- SC1_START:
- SC1_END:
- SC2_START:
- SC2_END:
- SC3_START:
- SC3_END:
Example
{
"operatingMode": "string",
"deviceClass": "string",
"uplinkType": "string",
"uplinkInterval": "number",
"linkCheckInterval": "number",
"holdoffTime": "number",
"radarAutotuning": "boolean",
"radarSensitivity": "number",
"LTRLaneDist": "number",
"RTLLaneDist": "number",
"SC0_START": "number",
"SC0_END": "number",
"SC1_START": "number",
"SC1_END": "number",
"SC2_START": "number",
"SC2_END": "number",
"SC3_START": "number",
"SC3_END": "number"
}
AutomationTrafficCounterSensorStatus: object
- signal:
- batteryVoltage:
- solarPanelPower:
- temperature:
- leftSpeedClass0ObjectCount:
- leftSpeedClass0AvgSpeed:
- rightSpeedClass0ObjectCount:
- rightSpeedClass0AvgSpeed:
- leftSpeedClass1ObjectCount:
- leftSpeedClass1AvgSpeed:
- rightSpeedClass1ObjectCount:
- rightSpeedClass1AvgSpeed:
- leftSpeedClass2ObjectCount:
- leftSpeedClass2AvgSpeed:
- rightSpeedClass2ObjectCount:
- rightSpeedClass2AvgSpeed:
- leftSpeedClass3ObjectCount:
- leftSpeedClass3AvgSpeed:
- rightSpeedClass3ObjectCount:
- rightSpeedClass3AvgSpeed:
- createdAt:
- updatedAt:
- receivedAt:
- online:
Example
{
"signal": "number",
"batteryVoltage": "number",
"solarPanelPower": "number",
"temperature": "number",
"leftSpeedClass0ObjectCount": "number",
"leftSpeedClass0AvgSpeed": "number",
"rightSpeedClass0ObjectCount": "number",
"rightSpeedClass0AvgSpeed": "number",
"leftSpeedClass1ObjectCount": "number",
"leftSpeedClass1AvgSpeed": "number",
"rightSpeedClass1ObjectCount": "number",
"rightSpeedClass1AvgSpeed": "number",
"leftSpeedClass2ObjectCount": "number",
"leftSpeedClass2AvgSpeed": "number",
"rightSpeedClass2ObjectCount": "number",
"rightSpeedClass2AvgSpeed": "number",
"leftSpeedClass3ObjectCount": "number",
"leftSpeedClass3AvgSpeed": "number",
"rightSpeedClass3ObjectCount": "number",
"rightSpeedClass3AvgSpeed": "number",
"createdAt": "object",
"updatedAt": "object",
"receivedAt": "object",
"online": "boolean"
}
AutomationTrafficCounterSensorStatusPaginatedResponse: object
- status:
- total:
- page:
Example
{
"status": "string",
"total": "number",
"page": {
"items": [
{
"signal": "number",
"batteryVoltage": "number",
"solarPanelPower": "number",
"temperature": "number",
"leftSpeedClass0ObjectCount": "number",
"leftSpeedClass0AvgSpeed": "number",
"rightSpeedClass0ObjectCount": "number",
"rightSpeedClass0AvgSpeed": "number",
"leftSpeedClass1ObjectCount": "number",
"leftSpeedClass1AvgSpeed": "number",
"rightSpeedClass1ObjectCount": "number",
"rightSpeedClass1AvgSpeed": "number",
"leftSpeedClass2ObjectCount": "number",
"leftSpeedClass2AvgSpeed": "number",
"rightSpeedClass2ObjectCount": "number",
"rightSpeedClass2AvgSpeed": "number",
"leftSpeedClass3ObjectCount": "number",
"leftSpeedClass3AvgSpeed": "number",
"rightSpeedClass3ObjectCount": "number",
"rightSpeedClass3AvgSpeed": "number",
"createdAt": "object",
"updatedAt": "object",
"receivedAt": "object",
"online": "boolean"
}
],
"size": "number",
"index": "number"
}
}
AutomationValveStatusUpdateIntervalsInput: object
- closedIntervalUnit:
- closedInterval:
- openedIntervalUnit:
- openedInterval:
Example
{
"closedIntervalUnit": "string",
"closedInterval": "number",
"openedIntervalUnit": "string",
"openedInterval": "number"
}
CommandDeviceEffect: object
- id:
- commandScheduleId:
- commandId:
- params:
- lastExecutionDate:
- executionCount:
- device:
Example
{
"id": "number",
"commandScheduleId": "number",
"commandId": "number",
"params": "object",
"lastExecutionDate": "object",
"executionCount": "number",
"device": {
"id": "object",
"organizationId": "string",
"deviceHash": "string",
"serial": "string",
"name": "string",
"supplier": "string",
"tag": "string",
"latitude": "number",
"longitude": "number",
"positionType": "string",
"positionY": "number",
"positionX": "number",
"timeZone": "string",
"networkType": "string",
"loraParams": {
"id": "number",
"deviceEUI": "string",
"applicationEUI": "string",
"joinEUI": "string",
"version": "string",
"loraClass": "string",
"regionalParametersRevision": "string",
"region": "string",
"activationType": "string",
"createdAt": "object",
"updatedAt": "object"
},
"mqttParams": {
"id": "number",
"version": "string",
"createdAt": "object",
"updatedAt": "object"
},
"maxLifetimeHours": "number",
"maxLifetimeWarningPercentage": "number",
"statusUpdateHoursOffset": "number",
"referenceNumber": "string",
"online": "boolean",
"errors": [
"string"
],
"statusUpdatedAt": "object",
"createdAt": "object",
"updatedAt": "object",
"model": {}
}
}
CommandSchedule: object
- id:
- name:
- description:
- groupId:
- group:
- active:
- months:
- daysOfMonth:
- daysOfWeek:
- startDate:
- repeatPattern:
- createdBy:
- editedBy:
- createdAt:
- updatedAt:
- deviceEffects:
Example
{
"id": "number",
"name": "string",
"description": "string",
"groupId": "object",
"group": {
"organizationId": "string",
"id": "object",
"name": "string",
"path": "string",
"latitude": "number",
"longitude": "number",
"positionType": "string",
"positionY": "number",
"positionX": "number",
"timeZone": "string",
"createdAt": "object",
"updatedAt": "object",
"countDevices": "number",
"countDevicesDeep": "number",
"countChildren": "number",
"countChildrenDeep": "number",
"currency": "string",
"type": "string",
"groupMap": {
"id": "number",
"height": "number",
"width": "number",
"url": "string",
"createdAt": "object",
"updatedAt": "object"
},
"children": [
{
"organizationId": "string",
"id": "object",
"name": "string",
"path": "string",
"latitude": "number",
"longitude": "number",
"positionType": "string",
"positionY": "number",
"positionX": "number",
"timeZone": "string",
"createdAt": "object",
"updatedAt": "object",
"countDevices": "number",
"countDevicesDeep": "number",
"countChildren": "number",
"countChildrenDeep": "number",
"currency": "string",
"type": "string"
}
]
}
}
CommandScheduleAllowedSortingFields: string
Command schedule allowed sorting fields
-
objectname
-
objectid
-
objectcreatedAt
-
objectupdatedAt
CommandSchedulePaginatedResponse: object
- status:
- total:
- page:
Example
{
"status": "string",
"total": "number",
"page": {
"items": [
{
"id": "number",
"name": "string",
"description": "string",
"groupId": "object",
"group": {
"organizationId": "string",
"id": "object",
"name": "string",
"path": "string",
"latitude": "number",
"longitude": "number",
"positionType": "string",
"positionY": "number",
"positionX": "number",
"timeZone": "string",
"createdAt": "object",
"updatedAt": "object",
"countDevices": "number",
"countDevicesDeep": "number",
"countChildren": "number",
"countChildrenDeep": "number",
"currency": "string",
"type": "string",
"groupMap": {
"id": "number",
"height": "number",
"width": "number",
"url": "string",
"createdAt": "object",
"updatedAt": "object"
},
"children": [
{
"organizationId": "string",
"id": "object",
"name": "string",
"path": "string",
"latitude": "number",
"longitude": "number",
"positionType": "string",
"positionY": "number",
"positionX": "number",
"timeZone": "string",
"createdAt": "object",
"updatedAt": "object",
"countDevices": "number"
}
]
}
}
]
}
}
CommandScheduleRepetitionPattern: string
Command Schedule Repetition pattern
-
objectOnce
-
objectDaily
-
objectWeekly
-
objectMonthly
-
objectQuarterly
-
objectBiannually
CommandScheduleResponse: object
- status:
- item:
Example
{
"status": "string",
"item": {
"id": "number",
"name": "string",
"description": "string",
"groupId": "object",
"group": {
"organizationId": "string",
"id": "object",
"name": "string",
"path": "string",
"latitude": "number",
"longitude": "number",
"positionType": "string",
"positionY": "number",
"positionX": "number",
"timeZone": "string",
"createdAt": "object",
"updatedAt": "object",
"countDevices": "number",
"countDevicesDeep": "number",
"countChildren": "number",
"countChildrenDeep": "number",
"currency": "string",
"type": "string",
"groupMap": {
"id": "number",
"height": "number",
"width": "number",
"url": "string",
"createdAt": "object",
"updatedAt": "object"
},
"children": [
{
"organizationId": "string",
"id": "object",
"name": "string",
"path": "string",
"latitude": "number",
"longitude": "number",
"positionType": "string",
"positionY": "number",
"positionX": "number",
"timeZone": "string",
"createdAt": "object",
"updatedAt": "object",
"countDevices": "number",
"countDevicesDeep": "number",
"countChildren": "number",
"countChildrenDeep": "number"
}
]
}
}
}
CommandSchedulesSortingConditionInput: object
- field:
- order:
Example
{
"field": "string",
"order": "string"
}
Connector: object
- id:
- organizationId:
- name:
- type:
- vendor:
- topicBase:
Example
{
"id": "object",
"organizationId": "string",
"name": "string",
"type": {
"id": "string",
"name": "string"
},
"vendor": {
"id": "string",
"name": "string"
},
"topicBase": "string"
}
ConnectorCreation: object
- id:
- organizationId:
- name:
- type:
- vendor:
- username:
- password:
Example
{
"id": "object",
"organizationId": "string",
"name": "string",
"type": {
"id": "string",
"name": "string"
},
"vendor": {
"id": "string",
"name": "string"
},
"username": "string",
"password": "string"
}
ConnectorCreationResponse: object
- status:
- item:
Example
{
"status": "string",
"item": {
"id": "object",
"organizationId": "string",
"name": "string",
"type": {
"id": "string",
"name": "string"
},
"vendor": {
"id": "string",
"name": "string"
},
"username": "string",
"password": "string"
}
}
ConnectorPaginatedResponse: object
- status:
- total:
- page:
Example
{
"status": "string",
"total": "number",
"page": {
"items": [
{
"id": "object",
"organizationId": "string",
"name": "string",
"type": {
"id": "string",
"name": "string"
},
"vendor": {
"id": "string",
"name": "string"
},
"topicBase": "string"
}
],
"size": "number",
"index": "number"
}
}
ConnectorResponse: object
- status:
- item:
Example
{
"status": "string",
"item": {
"id": "object",
"organizationId": "string",
"name": "string",
"type": {
"id": "string",
"name": "string"
},
"vendor": {
"id": "string",
"name": "string"
},
"topicBase": "string"
}
}
ConnectorSchemaResponse: object
- status:
- item:
Example
{
"status": "string",
"item": {
"createConnector": "object",
"createConnectorUser": "object"
}
}
ConnectorTypesResponse: object
- status:
- items:
Example
{
"status": "string",
"items": [
{
"id": "string",
"name": "string"
}
]
}
ConnectorUser: object
- id:
- name:
- connectorClients:
- accessType:
- removable:
Example
{
"id": "string",
"name": "string",
"connectorClients": "number",
"accessType": "string",
"removable": "boolean"
}
ConnectorUserCreation: object
- id:
- username:
- password:
- accessType:
- removable:
Example
{
"id": "string",
"username": "string",
"password": "string",
"accessType": "string",
"removable": "boolean"
}
ConnectorUserCreationResponse: object
- status:
- item:
Example
{
"status": "string",
"item": {
"id": "string",
"username": "string",
"password": "string",
"accessType": "string",
"removable": "boolean"
}
}
ConnectorUsersPaginatedResponse: object
- status:
- total:
- page:
Example
{
"status": "string",
"total": "number",
"page": {
"items": [
{
"id": "string",
"name": "string",
"connectorClients": "number",
"accessType": "string",
"removable": "boolean"
}
],
"size": "number",
"index": "number"
}
}
ConnectorVendorsResponse: object
- status:
- items:
Example
{
"status": "string",
"items": [
{
"id": "string",
"name": "string"
}
]
}
ConnectorsSortingConditionInput: object
- field:
- order:
Example
{
"field": "string",
"order": "string"
}
Control: object
- id:
- title:
- columns:
- groupId:
- group:
- userIds:
- coverImage:
- logoImage:
- createdBy:
- updatedBy:
- createdAt:
- updatedAt:
- controlElements:
Example
{
"id": "object",
"title": "string",
"columns": "number",
"groupId": "string",
"group": {
"organizationId": "string",
"id": "object",
"name": "string",
"path": "string",
"latitude": "number",
"longitude": "number",
"positionType": "string",
"positionY": "number",
"positionX": "number",
"timeZone": "string",
"createdAt": "object",
"updatedAt": "object",
"countDevices": "number",
"countDevicesDeep": "number",
"countChildren": "number",
"countChildrenDeep": "number",
"currency": "string",
"type": "string",
"groupMap": {
"id": "number",
"height": "number",
"width": "number",
"url": "string",
"createdAt": "object",
"updatedAt": "object"
},
"children": [
{
"organizationId": "string",
"id": "object",
"name": "string",
"path": "string",
"latitude": "number",
"longitude": "number",
"positionType": "string",
"positionY": "number",
"positionX": "number",
"timeZone": "string",
"createdAt": "object",
"updatedAt": "object",
"countDevices": "number",
"countDevicesDeep": "number",
"countChildren": "number",
"countChildrenDeep": "number",
"currency": "string",
"type": "string"
}
]
}
}
ControlAllowedSortingFields: string
Control allowed sorting fields
-
objecttitle
-
objectcreatedAt
-
objectupdatedAt
ControlCommandButton: object
- controlElementId:
- deviceSerial:
- device:
- deviceCommandId:
- params:
- deviceCommandCode:
Example
{
"controlElementId": "number",
"deviceSerial": "string",
"device": {
"id": "object",
"organizationId": "string",
"deviceHash": "string",
"serial": "string",
"name": "string",
"supplier": "string",
"tag": "string",
"latitude": "number",
"longitude": "number",
"positionType": "string",
"positionY": "number",
"positionX": "number",
"timeZone": "string",
"networkType": "string",
"loraParams": {
"id": "number",
"deviceEUI": "string",
"applicationEUI": "string",
"joinEUI": "string",
"version": "string",
"loraClass": "string",
"regionalParametersRevision": "string",
"region": "string",
"activationType": "string",
"createdAt": "object",
"updatedAt": "object"
},
"mqttParams": {
"id": "number",
"version": "string",
"createdAt": "object",
"updatedAt": "object"
},
"maxLifetimeHours": "number",
"maxLifetimeWarningPercentage": "number",
"statusUpdateHoursOffset": "number",
"referenceNumber": "string",
"online": "boolean",
"errors": [
"string"
],
"statusUpdatedAt": "object",
"createdAt": "object",
"updatedAt": "object",
"model": {
"id": "number",
"name": "string",
"code": "string",
"createdAt": "object"
}
}
}
ControlCommandTempDimming: object
- controlElementId:
- deviceSerial:
- device:
- deviceCommandId:
- defaultTiming:
- defaultDimming:
- params:
Example
{
"controlElementId": "number",
"deviceSerial": "string",
"device": {
"id": "object",
"organizationId": "string",
"deviceHash": "string",
"serial": "string",
"name": "string",
"supplier": "string",
"tag": "string",
"latitude": "number",
"longitude": "number",
"positionType": "string",
"positionY": "number",
"positionX": "number",
"timeZone": "string",
"networkType": "string",
"loraParams": {
"id": "number",
"deviceEUI": "string",
"applicationEUI": "string",
"joinEUI": "string",
"version": "string",
"loraClass": "string",
"regionalParametersRevision": "string",
"region": "string",
"activationType": "string",
"createdAt": "object",
"updatedAt": "object"
},
"mqttParams": {
"id": "number",
"version": "string",
"createdAt": "object",
"updatedAt": "object"
},
"maxLifetimeHours": "number",
"maxLifetimeWarningPercentage": "number",
"statusUpdateHoursOffset": "number",
"referenceNumber": "string",
"online": "boolean",
"errors": [
"string"
],
"statusUpdatedAt": "object",
"createdAt": "object",
"updatedAt": "object",
"model": {
"id": "number",
"name": "string",
"code": "string",
"createdAt": "object"
}
}
}
ControlData: object
- id:
- controlElementId:
- deviceSerial:
- device:
- deviceCommandCode:
- dataResponse:
Example
{
"id": "object",
"controlElementId": "number",
"deviceSerial": "string",
"device": {
"id": "object",
"organizationId": "string",
"deviceHash": "string",
"serial": "string",
"name": "string",
"supplier": "string",
"tag": "string",
"latitude": "number",
"longitude": "number",
"positionType": "string",
"positionY": "number",
"positionX": "number",
"timeZone": "string",
"networkType": "string",
"loraParams": {
"id": "number",
"deviceEUI": "string",
"applicationEUI": "string",
"joinEUI": "string",
"version": "string",
"loraClass": "string",
"regionalParametersRevision": "string",
"region": "string",
"activationType": "string",
"createdAt": "object",
"updatedAt": "object"
},
"mqttParams": {
"id": "number",
"version": "string",
"createdAt": "object",
"updatedAt": "object"
},
"maxLifetimeHours": "number",
"maxLifetimeWarningPercentage": "number",
"statusUpdateHoursOffset": "number",
"referenceNumber": "string",
"online": "boolean",
"errors": [
"string"
],
"statusUpdatedAt": "object",
"createdAt": "object",
"updatedAt": "object",
"model": {
"id": "number",
"name": "string",
"code": "string"
}
}
}
ControlElement: object
- id:
- type:
- title:
- description:
- orderSequence:
- enabled:
- createdAt:
- updatedAt:
-
controlCommands:
object[]
- controlData:
Example
{
"id": "object",
"type": "string",
"title": "string",
"description": "string",
"orderSequence": "number",
"enabled": "boolean",
"createdAt": "object",
"updatedAt": "object",
"controlCommands": [
null
],
"controlData": [
{
"id": "object",
"controlElementId": "number",
"deviceSerial": "string",
"device": {
"id": "object",
"organizationId": "string",
"deviceHash": "string",
"serial": "string",
"name": "string",
"supplier": "string",
"tag": "string",
"latitude": "number",
"longitude": "number",
"positionType": "string",
"positionY": "number",
"positionX": "number",
"timeZone": "string",
"networkType": "string",
"loraParams": {
"id": "number",
"deviceEUI": "string",
"applicationEUI": "string",
"joinEUI": "string",
"version": "string",
"loraClass": "string",
"regionalParametersRevision": "string",
"region": "string",
"activationType": "string",
"createdAt": "object",
"updatedAt": "object"
},
"mqttParams": {
"id": "number",
"version": "string",
"createdAt": "object",
"updatedAt": "object"
},
"maxLifetimeHours": "number",
"maxLifetimeWarningPercentage": "number",
"statusUpdateHoursOffset": "number"
}
}
]
}
ControlElementTypes: string
Control Element Types
-
objectButton
-
objectInfo
-
objectData
-
objectTempDimming
ControlImage: object
- path:
- filename:
- url:
- contentType:
- size:
- createdAt:
- updatedAt:
Example
{
"path": "string",
"filename": "string",
"url": "string",
"contentType": "string",
"size": "number",
"createdAt": "object",
"updatedAt": "object"
}
ControlPaginatedResponse: object
- status:
- total:
- page:
Example
{
"status": "string",
"total": "number",
"page": {
"items": [
{
"id": "object",
"title": "string",
"columns": "number",
"groupId": "string",
"group": {
"organizationId": "string",
"id": "object",
"name": "string",
"path": "string",
"latitude": "number",
"longitude": "number",
"positionType": "string",
"positionY": "number",
"positionX": "number",
"timeZone": "string",
"createdAt": "object",
"updatedAt": "object",
"countDevices": "number",
"countDevicesDeep": "number",
"countChildren": "number",
"countChildrenDeep": "number",
"currency": "string",
"type": "string",
"groupMap": {
"id": "number",
"height": "number",
"width": "number",
"url": "string",
"createdAt": "object",
"updatedAt": "object"
},
"children": [
{
"organizationId": "string",
"id": "object",
"name": "string",
"path": "string",
"latitude": "number",
"longitude": "number",
"positionType": "string",
"positionY": "number",
"positionX": "number",
"timeZone": "string",
"createdAt": "object",
"updatedAt": "object",
"countDevices": "number"
}
]
}
}
]
}
}
ControlResponse: object
- status:
- item:
Example
{
"status": "string",
"item": {
"id": "object",
"title": "string",
"columns": "number",
"groupId": "string",
"group": {
"organizationId": "string",
"id": "object",
"name": "string",
"path": "string",
"latitude": "number",
"longitude": "number",
"positionType": "string",
"positionY": "number",
"positionX": "number",
"timeZone": "string",
"createdAt": "object",
"updatedAt": "object",
"countDevices": "number",
"countDevicesDeep": "number",
"countChildren": "number",
"countChildrenDeep": "number",
"currency": "string",
"type": "string",
"groupMap": {
"id": "number",
"height": "number",
"width": "number",
"url": "string",
"createdAt": "object",
"updatedAt": "object"
},
"children": [
{
"organizationId": "string",
"id": "object",
"name": "string",
"path": "string",
"latitude": "number",
"longitude": "number",
"positionType": "string",
"positionY": "number",
"positionX": "number",
"timeZone": "string",
"createdAt": "object",
"updatedAt": "object",
"countDevices": "number",
"countDevicesDeep": "number",
"countChildren": "number",
"countChildrenDeep": "number"
}
]
}
}
}
ControlsSortingConditionInput: object
- field:
- order:
Example
{
"field": "string",
"order": "string"
}
CreateAutomationInput: object
- description:
- ioConfig:
- loadCellConfig:
- peopleCounterCameraConfig:
- io02Config:
Example
{
"description": "string",
"ioConfig": {
"inputs": [
{
"key": "number",
"label": "string",
"connectedOutputs": [
"number"
]
}
],
"outputs": [
{
"key": "number",
"label": "string"
}
]
},
"loadCellConfig": {
"nominalLoad": "number",
"thresholdOne": "number",
"thresholdTwo": "number"
},
"peopleCounterCameraConfig": {
"areaNumber": "number"
},
"io02Config": {
"input": [
{
"key": "number",
"label": "string"
}
],
"output": [
{
"key": "number",
"label": "string"
}
]
}
}
CreateControlCommandInput: object
- deviceSerial:
- deviceCommandId:
- deviceCommandCode:
- defaultTiming:
- defaultDimming:
- params:
Example
{
"deviceSerial": "string",
"deviceCommandId": "number",
"deviceCommandCode": "string",
"defaultTiming": "boolean",
"defaultDimming": "boolean",
"params": "object"
}
CreateControlElementInput: object
- type:
- title:
- description:
- orderSequence:
- enabled:
- controlCommands:
- controlData:
Example
{
"type": "string",
"title": "string",
"description": "string",
"orderSequence": "number",
"enabled": "boolean",
"controlCommands": [
{
"deviceSerial": "string",
"deviceCommandId": "number",
"deviceCommandCode": "string",
"defaultTiming": "boolean",
"defaultDimming": "boolean",
"params": "object"
}
],
"controlData": [
{
"deviceSerial": "string",
"deviceCommandCode": "string"
}
]
}
CreateMeteringInput: object
- meterMID:
- connectedMeter:
- energyConsumptionEnabled:
- pulseOneConsumptionEnabled:
- pulseTwoConsumptionEnabled:
- pulseOneConfig:
- pulseTwoConfig:
Example
{
"meterMID": "boolean",
"connectedMeter": "string",
"energyConsumptionEnabled": "boolean",
"pulseOneConsumptionEnabled": "boolean",
"pulseTwoConsumptionEnabled": "boolean",
"pulseOneConfig": {
"type": "string",
"unitOfMeasure": "string",
"conversionRateMultiplier": "number"
},
"pulseTwoConfig": {
"type": "string",
"unitOfMeasure": "string",
"conversionRateMultiplier": "number"
}
}
CreateMqttDeviceInput: object
- version:
- meteringProtocol:
- automationOPCUAPLCProtocol:
Example
{
"version": "string",
"meteringProtocol": {
"productManufacturer": {
"required": "boolean",
"multiplier": "number",
"unitOfMeasure": "string",
"path": "string"
},
"productSupplier": {
"required": "boolean",
"multiplier": "number",
"unitOfMeasure": "string",
"path": "string"
},
"productModel": {
"required": "boolean",
"multiplier": "number",
"unitOfMeasure": "string",
"path": "string"
},
"error": {
"required": "boolean",
"multiplier": "number",
"unitOfMeasure": "string",
"path": "string"
},
"timestamp": {
"required": "boolean",
"multiplier": "number",
"unitOfMeasure": "string",
"path": "string"
},
"battery": {
"required": "boolean",
"multiplier": "number",
"unitOfMeasure": "string",
"path": "string"
},
"signalLevel": {
"required": "boolean",
"multiplier": "number",
"unitOfMeasure": "string",
"path": "string"
},
"electricVoltageL1": {
"required": "boolean",
"multiplier": "number",
"unitOfMeasure": "string",
"path": "string"
},
"electricVoltageL2": {
"required": "boolean",
"multiplier": "number",
"unitOfMeasure": "string",
"path": "string"
},
"electricVoltageL3": {
"required": "boolean"
}
}
}
CustomizedScheduleSettingFunctionType: string
Customized Schedule Setting Function Type
-
objectLIGHTON
-
objectLIGHTOFF
-
objectSETDIMMING
DailyProgramStatus: string
Lighting daily program status
-
objectCREATED
-
objectSENT
-
objectCONFIRMED
-
objectFAILED
-
objectTIMEOUT
DateTime: object
The javascript Date as string. Type represents date and time as the ISO Date string.
Example
object
DateTimeScalar: object
The javascript Date as string. Type represents date and time as the ISO Date string.
Example
object
DayOfWeek: string
Day of week
-
objectMONDAY
-
objectTUESDAY
-
objectWEDNESDAY
-
objectTHURSDAY
-
objectFRIDAY
-
objectSATURDAY
-
objectSUNDAY
Device: object
- id:
- organizationId:
- deviceHash:
- serial:
- name:
- supplier:
- tag:
- latitude:
- longitude:
- positionType:
- positionY:
- positionX:
- timeZone:
- networkType:
- loraParams:
- mqttParams:
- maxLifetimeHours:
- maxLifetimeWarningPercentage:
- statusUpdateHoursOffset:
- referenceNumber:
- online:
- errors:
- statusUpdatedAt:
- createdAt:
- updatedAt:
- model:
- group:
- virtualAsset:
- metering:
- lighting:
- parking:
- automation:
- attachments:
- images:
-
status:
object
- connectorId:
Example
{
"id": "object",
"organizationId": "string",
"deviceHash": "string",
"serial": "string",
"name": "string",
"supplier": "string",
"tag": "string",
"latitude": "number",
"longitude": "number",
"positionType": "string",
"positionY": "number",
"positionX": "number",
"timeZone": "string",
"networkType": "string",
"loraParams": {
"id": "number",
"deviceEUI": "string",
"applicationEUI": "string",
"joinEUI": "string",
"version": "string",
"loraClass": "string",
"regionalParametersRevision": "string",
"region": "string",
"activationType": "string",
"createdAt": "object",
"updatedAt": "object"
},
"mqttParams": {
"id": "number",
"version": "string",
"createdAt": "object",
"updatedAt": "object"
},
"maxLifetimeHours": "number",
"maxLifetimeWarningPercentage": "number",
"statusUpdateHoursOffset": "number",
"referenceNumber": "string",
"online": "boolean",
"errors": [
"string"
],
"statusUpdatedAt": "object",
"createdAt": "object",
"updatedAt": "object",
"model": {
"id": "number",
"name": "string",
"code": "string",
"createdAt": "object",
"updatedAt": "object",
"type": {
"id": "number"
}
}
}
DeviceAllowedSortingFields: string
Device allowed sorting fields
-
objectname
-
objectserial
-
objecttypeName
-
objectmodelName
-
objectgroupName
DeviceArrayResponse: object
- status:
- items:
Example
{
"status": "string",
"items": [
{
"id": "object",
"organizationId": "string",
"deviceHash": "string",
"serial": "string",
"name": "string",
"supplier": "string",
"tag": "string",
"latitude": "number",
"longitude": "number",
"positionType": "string",
"positionY": "number",
"positionX": "number",
"timeZone": "string",
"networkType": "string",
"loraParams": {
"id": "number",
"deviceEUI": "string",
"applicationEUI": "string",
"joinEUI": "string",
"version": "string",
"loraClass": "string",
"regionalParametersRevision": "string",
"region": "string",
"activationType": "string",
"createdAt": "object",
"updatedAt": "object"
},
"mqttParams": {
"id": "number",
"version": "string",
"createdAt": "object",
"updatedAt": "object"
},
"maxLifetimeHours": "number",
"maxLifetimeWarningPercentage": "number",
"statusUpdateHoursOffset": "number",
"referenceNumber": "string",
"online": "boolean",
"errors": [
"string"
],
"statusUpdatedAt": "object",
"createdAt": "object",
"updatedAt": "object",
"model": {
"id": "number",
"name": "string",
"code": "string",
"createdAt": "object",
"updatedAt": "object"
}
}
]
}
DeviceAttachment: object
- id:
- path:
- filename:
- url:
- contentType:
- size:
- createdAt:
- updatedAt:
Example
{
"id": "string",
"path": "string",
"filename": "string",
"url": "string",
"contentType": "string",
"size": "number",
"createdAt": "object",
"updatedAt": "object"
}
DeviceAttachmentArrayResponse: object
- status:
- items:
Example
{
"status": "string",
"items": [
{
"id": "string",
"path": "string",
"filename": "string",
"url": "string",
"contentType": "string",
"size": "number",
"createdAt": "object",
"updatedAt": "object"
}
]
}
DeviceCategory: object
- id:
- name:
- iconName:
- createdAt:
- updatedAt:
Example
{
"id": "number",
"name": "string",
"iconName": "string",
"createdAt": "object",
"updatedAt": "object"
}
DeviceCategoryArrayResponse: object
- status:
- items:
Example
{
"status": "string",
"items": [
{
"id": "number",
"name": "string",
"iconName": "string",
"createdAt": "object",
"updatedAt": "object"
}
]
}
DeviceCommandHistory: object
- deviceSerial:
- organizationId:
- deviceModelName:
- deviceTypeName:
- authorId:
- authorEmail:
- authorName:
- authorLastName:
- authorAvatar:
- authorPhone:
- commandTypeCode:
- commandTypeName:
- status:
- params:
- createdAt:
- updatedAt:
- group:
Example
{
"deviceSerial": "string",
"organizationId": "string",
"deviceModelName": "string",
"deviceTypeName": "string",
"authorId": "string",
"authorEmail": "string",
"authorName": "string",
"authorLastName": "string",
"authorAvatar": "string",
"authorPhone": "string",
"commandTypeCode": "string",
"commandTypeName": "string",
"status": "string",
"params": "object",
"createdAt": "object",
"updatedAt": "object",
"group": {
"organizationId": "string",
"id": "object",
"name": "string",
"path": "string",
"latitude": "number",
"longitude": "number",
"positionType": "string",
"positionY": "number",
"positionX": "number",
"timeZone": "string",
"createdAt": "object",
"updatedAt": "object",
"countDevices": "number",
"countDevicesDeep": "number",
"countChildren": "number",
"countChildrenDeep": "number",
"currency": "string",
"type": "string",
"groupMap": {
"id": "number",
"height": "number",
"width": "number",
"url": "string",
"createdAt": "object",
"updatedAt": "object"
},
"children": [
{
"organizationId": "string",
"id": "object",
"name": "string",
"path": "string",
"latitude": "number",
"longitude": "number"
}
]
}
}
DeviceCommandHistoryPaginatedResponse: object
- status:
- total:
- page:
Example
{
"status": "string",
"total": "number",
"page": {
"items": [
{
"deviceSerial": "string",
"organizationId": "string",
"deviceModelName": "string",
"deviceTypeName": "string",
"authorId": "string",
"authorEmail": "string",
"authorName": "string",
"authorLastName": "string",
"authorAvatar": "string",
"authorPhone": "string",
"commandTypeCode": "string",
"commandTypeName": "string",
"status": "string",
"params": "object",
"createdAt": "object",
"updatedAt": "object",
"group": {
"organizationId": "string",
"id": "object",
"name": "string",
"path": "string",
"latitude": "number",
"longitude": "number",
"positionType": "string",
"positionY": "number",
"positionX": "number",
"timeZone": "string",
"createdAt": "object",
"updatedAt": "object",
"countDevices": "number",
"countDevicesDeep": "number",
"countChildren": "number",
"countChildrenDeep": "number",
"currency": "string",
"type": "string",
"groupMap": {
"id": "number",
"height": "number",
"width": "number",
"url": "string",
"createdAt": "object",
"updatedAt": "object"
},
"children": [
{
"organizationId": "string"
}
]
}
}
]
}
}
DeviceCommandResponse: object
- status:
- item:
Example
{
"status": "string",
"item": {
"id": "string",
"comment": "string",
"deviceSerial": "string",
"authorId": "string",
"authorEmail": "string",
"authorName": "string",
"authorPhone": "string",
"authorAvatar": "string",
"attachments": [
{
"id": "string",
"path": "string",
"filename": "string",
"url": "string",
"contentType": "string",
"size": "number",
"createdAt": "object",
"updatedAt": "object"
}
],
"createdAt": "object"
}
}
DeviceComment: object
- id:
- comment:
- deviceSerial:
- authorId:
- authorEmail:
- authorName:
- authorPhone:
- authorAvatar:
- attachments:
- createdAt:
Example
{
"id": "string",
"comment": "string",
"deviceSerial": "string",
"authorId": "string",
"authorEmail": "string",
"authorName": "string",
"authorPhone": "string",
"authorAvatar": "string",
"attachments": [
{
"id": "string",
"path": "string",
"filename": "string",
"url": "string",
"contentType": "string",
"size": "number",
"createdAt": "object",
"updatedAt": "object"
}
],
"createdAt": "object"
}
DeviceCommentPaginatedResponse: object
- status:
- total:
- page:
Example
{
"status": "string",
"total": "number",
"page": {
"items": [
{
"id": "string",
"comment": "string",
"deviceSerial": "string",
"authorId": "string",
"authorEmail": "string",
"authorName": "string",
"authorPhone": "string",
"authorAvatar": "string",
"attachments": [
{
"id": "string",
"path": "string",
"filename": "string",
"url": "string",
"contentType": "string",
"size": "number",
"createdAt": "object",
"updatedAt": "object"
}
],
"createdAt": "object"
}
],
"size": "number",
"index": "number"
}
}
DeviceImage: object
- id:
- path:
- filename:
- url:
- contentType:
- size:
- createdAt:
- updatedAt:
Example
{
"id": "string",
"path": "string",
"filename": "string",
"url": "string",
"contentType": "string",
"size": "number",
"createdAt": "object",
"updatedAt": "object"
}
DeviceImageArrayResponse: object
- status:
- items:
Example
{
"status": "string",
"items": [
{
"id": "string",
"path": "string",
"filename": "string",
"url": "string",
"contentType": "string",
"size": "number",
"createdAt": "object",
"updatedAt": "object"
}
]
}
DeviceInsallationInfoAttachmentArrayResponse: object
- status:
- items:
Example
{
"status": "string",
"items": [
{
"id": "string",
"path": "string",
"filename": "string",
"url": "string",
"contentType": "string",
"size": "number",
"createdAt": "object",
"updatedAt": "object"
}
]
}
DeviceInstallationInfo: object
- id:
- name:
- description:
- url:
- deviceSerial:
- attachments:
- createdAt:
- updatedAt:
Example
{
"id": "string",
"name": "string",
"description": "string",
"url": "string",
"deviceSerial": "string",
"attachments": [
{
"id": "string",
"path": "string",
"filename": "string",
"url": "string",
"contentType": "string",
"size": "number",
"createdAt": "object",
"updatedAt": "object"
}
],
"createdAt": "object",
"updatedAt": "object"
}
DeviceInstallationInfoPaginatedResponse: object
- status:
- total:
- page:
Example
{
"status": "string",
"total": "number",
"page": {
"items": [
{
"id": "string",
"name": "string",
"description": "string",
"url": "string",
"deviceSerial": "string",
"attachments": [
{
"id": "string",
"path": "string",
"filename": "string",
"url": "string",
"contentType": "string",
"size": "number",
"createdAt": "object",
"updatedAt": "object"
}
],
"createdAt": "object",
"updatedAt": "object"
}
],
"size": "number",
"index": "number"
}
}
DeviceInstallationInfoResponse: object
- status:
- item:
Example
{
"status": "string",
"item": {
"id": "string",
"name": "string",
"description": "string",
"url": "string",
"deviceSerial": "string",
"attachments": [
{
"id": "string",
"path": "string",
"filename": "string",
"url": "string",
"contentType": "string",
"size": "number",
"createdAt": "object",
"updatedAt": "object"
}
],
"createdAt": "object",
"updatedAt": "object"
}
}
DeviceModel: object
- id:
- name:
- code:
- createdAt:
- updatedAt:
- type:
- commands:
Example
{
"id": "number",
"name": "string",
"code": "string",
"createdAt": "object",
"updatedAt": "object",
"type": {
"id": "number",
"name": "string",
"code": "string",
"payloadSchema": "object",
"createdAt": "object",
"updatedAt": "object",
"models": [
{
"id": "number",
"name": "string",
"code": "string",
"createdAt": "object",
"updatedAt": "object",
"type": {
"id": "number",
"name": "string",
"code": "string",
"payloadSchema": "object",
"createdAt": "object",
"updatedAt": "object",
"models": [
{
"id": "number",
"name": "string",
"code": "string",
"createdAt": "object",
"updatedAt": "object",
"type": {
"id": "number",
"name": "string",
"code": "string",
"payloadSchema": "object",
"createdAt": "object",
"updatedAt": "object",
"models": [
{
"id": "number",
"name": "string",
"code": "string",
"createdAt": "object",
"updatedAt": "object",
"type": {
"id": "number",
"name": "string",
"code": "string"
}
}
]
}
}
]
}
}
]
}
}
DeviceModelArrayResponse: object
- status:
- items:
Example
{
"status": "string",
"items": [
{
"id": "number",
"name": "string",
"code": "string",
"createdAt": "object",
"updatedAt": "object",
"type": {
"id": "number",
"name": "string",
"code": "string",
"payloadSchema": "object",
"createdAt": "object",
"updatedAt": "object",
"models": [
{
"id": "number",
"name": "string",
"code": "string",
"createdAt": "object",
"updatedAt": "object",
"type": {
"id": "number",
"name": "string",
"code": "string",
"payloadSchema": "object",
"createdAt": "object",
"updatedAt": "object",
"models": [
{
"id": "number",
"name": "string",
"code": "string",
"createdAt": "object",
"updatedAt": "object",
"type": {
"id": "number",
"name": "string",
"code": "string",
"payloadSchema": "object",
"createdAt": "object",
"updatedAt": "object",
"models": [
{
"id": "number",
"name": "string",
"code": "string",
"createdAt": "object",
"updatedAt": "object",
"type": {}
}
]
}
}
]
}
}
]
}
}
]
}
DeviceModelCommand: object
- id:
- name:
- code:
- mutation:
- params:
- createdAt:
- updatedAt:
Example
{
"id": "number",
"name": "string",
"code": "string",
"mutation": "string",
"params": "object",
"createdAt": "object",
"updatedAt": "object"
}
DeviceModelCommandsArrayResponse: object
- status:
- items:
Example
{
"status": "string",
"items": [
{
"id": "number",
"name": "string",
"code": "string",
"mutation": "string",
"params": "object",
"createdAt": "object",
"updatedAt": "object"
}
]
}
DeviceModels: string
Device Models
-
objectUK1
-
objectRFTN
-
objectRFTZ
-
objectRFT0
-
objectRFT1
-
objectRF01
-
objectRN01
-
objectRZ01
-
objectMTMD
-
objectMTMT
-
objectPKI1
-
objectAM01
-
objectAM02
-
objectAM03
-
objectIO01
-
objectSB01
-
objectSM01
-
objectSO01
-
objectPL03
-
objectTH01
-
objectST02
-
objectST03
-
objectSO03
-
objectWH01
-
objectRN02
-
objectSB02
-
objectMDY050
-
objectMSH325
-
objectMSH475
-
objectQRCODE
-
objectRFT0_V1
-
objectRFTN_V2
-
objectRFTZ_V2
-
objectCAMERA_AI
-
objectLINEA_LIGHT
-
objectVIRTUAL_SLOT
-
objectMQTT_RAW
-
objectMQTT_METERING
-
objectPLCOPCUA
-
objectCC01EU00T
-
objectIO02
-
objectPM01EU0BT
-
objectTR01EU00T
-
objectTR03EU00T
-
objectRZ02EU00T
-
objectRF02EU00T
-
objectSO02EU0BT
-
objectAM04EU0BT
-
objectAM05EU0BT
-
objectPM02EU0BT
-
objectPC02EU0BT
-
objectPC01EU0BT
DeviceNetworkStatusAllowedFilteringFields: string
Device Network Status Allowed Filtering Fields
-
objectONLINE
-
objectOFFLINE
-
objectUNKNOWN
DevicePaginatedResponse: object
- status:
- total:
- page:
Example
{
"status": "string",
"total": "number",
"page": {
"items": [
{
"id": "object",
"organizationId": "string",
"deviceHash": "string",
"serial": "string",
"name": "string",
"supplier": "string",
"tag": "string",
"latitude": "number",
"longitude": "number",
"positionType": "string",
"positionY": "number",
"positionX": "number",
"timeZone": "string",
"networkType": "string",
"loraParams": {
"id": "number",
"deviceEUI": "string",
"applicationEUI": "string",
"joinEUI": "string",
"version": "string",
"loraClass": "string",
"regionalParametersRevision": "string",
"region": "string",
"activationType": "string",
"createdAt": "object",
"updatedAt": "object"
},
"mqttParams": {
"id": "number",
"version": "string",
"createdAt": "object",
"updatedAt": "object"
},
"maxLifetimeHours": "number",
"maxLifetimeWarningPercentage": "number",
"statusUpdateHoursOffset": "number",
"referenceNumber": "string",
"online": "boolean",
"errors": [
"string"
],
"statusUpdatedAt": "object",
"createdAt": "object",
"updatedAt": "object",
"model": {
"id": "number",
"name": "string",
"code": "string"
}
}
]
}
}
DeviceResponse: object
- status:
- item:
Example
{
"status": "string",
"item": {
"id": "object",
"organizationId": "string",
"deviceHash": "string",
"serial": "string",
"name": "string",
"supplier": "string",
"tag": "string",
"latitude": "number",
"longitude": "number",
"positionType": "string",
"positionY": "number",
"positionX": "number",
"timeZone": "string",
"networkType": "string",
"loraParams": {
"id": "number",
"deviceEUI": "string",
"applicationEUI": "string",
"joinEUI": "string",
"version": "string",
"loraClass": "string",
"regionalParametersRevision": "string",
"region": "string",
"activationType": "string",
"createdAt": "object",
"updatedAt": "object"
},
"mqttParams": {
"id": "number",
"version": "string",
"createdAt": "object",
"updatedAt": "object"
},
"maxLifetimeHours": "number",
"maxLifetimeWarningPercentage": "number",
"statusUpdateHoursOffset": "number",
"referenceNumber": "string",
"online": "boolean",
"errors": [
"string"
],
"statusUpdatedAt": "object",
"createdAt": "object",
"updatedAt": "object",
"model": {
"id": "number",
"name": "string",
"code": "string",
"createdAt": "object",
"updatedAt": "object"
}
}
}
DeviceStatusAllowedFilteringFields: string
Device Status Allowed Filtering Fields
-
objectOK
-
objectERROR
-
objectUNKNOWN
DeviceType: object
- id:
- name:
- code:
- payloadSchema:
- createdAt:
- updatedAt:
- models:
Example
{
"id": "number",
"name": "string",
"code": "string",
"payloadSchema": "object",
"createdAt": "object",
"updatedAt": "object",
"models": [
{
"id": "number",
"name": "string",
"code": "string",
"createdAt": "object",
"updatedAt": "object",
"type": {
"id": "number",
"name": "string",
"code": "string",
"payloadSchema": "object",
"createdAt": "object",
"updatedAt": "object",
"models": [
{
"id": "number",
"name": "string",
"code": "string",
"createdAt": "object",
"updatedAt": "object",
"type": {
"id": "number",
"name": "string",
"code": "string",
"payloadSchema": "object",
"createdAt": "object",
"updatedAt": "object",
"models": [
{
"id": "number",
"name": "string",
"code": "string",
"createdAt": "object",
"updatedAt": "object",
"type": {
"id": "number",
"name": "string",
"code": "string",
"payloadSchema": "object",
"createdAt": "object",
"updatedAt": "object",
"models": [
{
"id": "number"
}
]
}
}
]
}
}
]
}
}
]
}
DeviceTypeArrayResponse: object
- status:
- items:
Example
{
"status": "string",
"items": [
{
"id": "number",
"name": "string",
"code": "string",
"payloadSchema": "object",
"createdAt": "object",
"updatedAt": "object",
"models": [
{
"id": "number",
"name": "string",
"code": "string",
"createdAt": "object",
"updatedAt": "object",
"type": {
"id": "number",
"name": "string",
"code": "string",
"payloadSchema": "object",
"createdAt": "object",
"updatedAt": "object",
"models": [
{
"id": "number",
"name": "string",
"code": "string",
"createdAt": "object",
"updatedAt": "object",
"type": {
"id": "number",
"name": "string",
"code": "string",
"payloadSchema": "object",
"createdAt": "object",
"updatedAt": "object",
"models": [
{
"id": "number",
"name": "string",
"code": "string",
"createdAt": "object",
"updatedAt": "object",
"type": {
"id": "number",
"name": "string",
"code": "string",
"payloadSchema": "object",
"createdAt": "object",
"updatedAt": "object",
"models": [
null
]
}
}
]
}
}
]
}
}
]
}
]
}
DeviceTypeResponse: object
- status:
- item:
Example
{
"status": "string",
"item": {
"id": "number",
"name": "string",
"code": "string",
"payloadSchema": "object",
"createdAt": "object",
"updatedAt": "object",
"models": [
{
"id": "number",
"name": "string",
"code": "string",
"createdAt": "object",
"updatedAt": "object",
"type": {
"id": "number",
"name": "string",
"code": "string",
"payloadSchema": "object",
"createdAt": "object",
"updatedAt": "object",
"models": [
{
"id": "number",
"name": "string",
"code": "string",
"createdAt": "object",
"updatedAt": "object",
"type": {
"id": "number",
"name": "string",
"code": "string",
"payloadSchema": "object",
"createdAt": "object",
"updatedAt": "object",
"models": [
{
"id": "number",
"name": "string",
"code": "string",
"createdAt": "object",
"updatedAt": "object",
"type": {
"id": "number",
"name": "string",
"code": "string",
"payloadSchema": "object",
"createdAt": "object",
"updatedAt": "object",
"models": [
null
]
}
}
]
}
}
]
}
}
]
}
}
DeviceTypes: string
Device Types
-
objectlighting
-
objectmetering
-
objectparking
-
objectvirtual_asset
-
objectenvironment
-
objectautomation
-
objectwearable
-
objectraw
DeviceURL: object
- id:
- deviceSerial:
- name:
- url:
- createdAt:
- updatedAt:
Example
{
"id": "string",
"deviceSerial": "string",
"name": "string",
"url": "string",
"createdAt": "object",
"updatedAt": "object"
}
DeviceURLPaginatedResponse: object
- status:
- total:
- page:
Example
{
"status": "string",
"total": "number",
"page": {
"items": [
{
"id": "string",
"deviceSerial": "string",
"name": "string",
"url": "string",
"createdAt": "object",
"updatedAt": "object"
}
],
"size": "number",
"index": "number"
}
}
DeviceURLResponse: object
- status:
- item:
Example
{
"status": "string",
"item": {
"id": "string",
"deviceSerial": "string",
"name": "string",
"url": "string",
"createdAt": "object",
"updatedAt": "object"
}
}
DownloadDeviceDataTypes: object
- code:
- label:
- deviceTypes:
Example
{
"code": "string",
"label": "string",
"deviceTypes": [
"string"
]
}
DownloadDeviceDataTypesArrayResponse: object
- status:
- items:
Example
{
"status": "string",
"items": [
{
"code": "string",
"label": "string",
"deviceTypes": [
"string"
]
}
]
}
DownloadTemplate: object
- id:
- organizationId:
- name:
- readingFrequency:
- groups:
- deviceTypes:
- deviceModels:
- deviceInfos:
- deviceDataTypes:
- lastSentTo:
- lastSentDate:
- lastDownloadRequestedBy:
- lastDownloadRequestDate:
- url:
- createdBy:
- editedBy:
- createdAt:
- updatedAt:
- schedule:
Example
{
"id": "number",
"organizationId": "string",
"name": "string",
"readingFrequency": "string",
"groups": [
"string"
],
"deviceTypes": [
"string"
],
"deviceModels": [
"string"
],
"deviceInfos": [
"string"
],
"deviceDataTypes": [
{
"code": "string",
"customLabel": "string"
}
],
"lastSentTo": [
"string"
],
"lastSentDate": "object",
"lastDownloadRequestedBy": {
"id": "object",
"name": "string",
"lastName": "string",
"email": "string",
"gender": "string",
"phoneNumber": "string",
"avatar": "string",
"confirmedAt": "object",
"createdAt": "object",
"updatedAt": "object",
"lastAccess": "object",
"createdBy": {
"id": "object",
"name": "string",
"lastName": "string",
"email": "string",
"gender": "string",
"phoneNumber": "string",
"avatar": "string",
"confirmedAt": "object",
"createdAt": "object",
"updatedAt": "object",
"lastAccess": "object",
"createdBy": {
"id": "object",
"name": "string",
"lastName": "string",
"email": "string",
"gender": "string",
"phoneNumber": "string",
"avatar": "string",
"confirmedAt": "object"
}
}
}
}
DownloadTemplateAllowedSortingFields: string
Download template allowed sorting fields
-
objectname
-
objectid
-
objectcreatedAt
-
objectupdatedAt
DownloadTemplatePaginatedResponse: object
- status:
- total:
- page:
Example
{
"status": "string",
"total": "number",
"page": {
"items": [
{
"id": "number",
"organizationId": "string",
"name": "string",
"readingFrequency": "string",
"groups": [
"string"
],
"deviceTypes": [
"string"
],
"deviceModels": [
"string"
],
"deviceInfos": [
"string"
],
"deviceDataTypes": [
{
"code": "string",
"customLabel": "string"
}
],
"lastSentTo": [
"string"
],
"lastSentDate": "object",
"lastDownloadRequestedBy": {
"id": "object",
"name": "string",
"lastName": "string",
"email": "string",
"gender": "string",
"phoneNumber": "string",
"avatar": "string",
"confirmedAt": "object",
"createdAt": "object",
"updatedAt": "object",
"lastAccess": "object",
"createdBy": {
"id": "object",
"name": "string",
"lastName": "string",
"email": "string",
"gender": "string",
"phoneNumber": "string",
"avatar": "string",
"confirmedAt": "object",
"createdAt": "object",
"updatedAt": "object",
"lastAccess": "object",
"createdBy": {
"id": "object",
"name": "string",
"lastName": "string",
"email": "string"
}
}
}
}
]
}
}
DownloadTemplateResponse: object
- status:
- item:
Example
{
"status": "string",
"item": {
"id": "number",
"organizationId": "string",
"name": "string",
"readingFrequency": "string",
"groups": [
"string"
],
"deviceTypes": [
"string"
],
"deviceModels": [
"string"
],
"deviceInfos": [
"string"
],
"deviceDataTypes": [
{
"code": "string",
"customLabel": "string"
}
],
"lastSentTo": [
"string"
],
"lastSentDate": "object",
"lastDownloadRequestedBy": {
"id": "object",
"name": "string",
"lastName": "string",
"email": "string",
"gender": "string",
"phoneNumber": "string",
"avatar": "string",
"confirmedAt": "object",
"createdAt": "object",
"updatedAt": "object",
"lastAccess": "object",
"createdBy": {
"id": "object",
"name": "string",
"lastName": "string",
"email": "string",
"gender": "string",
"phoneNumber": "string",
"avatar": "string",
"confirmedAt": "object",
"createdAt": "object",
"updatedAt": "object",
"lastAccess": "object",
"createdBy": {
"id": "object",
"name": "string",
"lastName": "string",
"email": "string",
"gender": "string",
"phoneNumber": "string"
}
}
}
}
}
DownloadTemplateSchedule: object
- id:
- active:
- repeatPattern:
- startDate:
- destinations:
- template:
- createdAt:
- updatedAt:
Example
{
"id": "number",
"active": "boolean",
"repeatPattern": "string",
"startDate": "object",
"destinations": [
{
"id": "number",
"enabled": "boolean",
"type": "string"
}
],
"template": {
"id": "number",
"organizationId": "string",
"name": "string",
"readingFrequency": "string",
"groups": [
"string"
],
"deviceTypes": [
"string"
],
"deviceModels": [
"string"
],
"deviceInfos": [
"string"
],
"deviceDataTypes": [
{
"code": "string",
"customLabel": "string"
}
],
"lastSentTo": [
"string"
],
"lastSentDate": "object",
"lastDownloadRequestedBy": {
"id": "object",
"name": "string",
"lastName": "string",
"email": "string",
"gender": "string",
"phoneNumber": "string",
"avatar": "string",
"confirmedAt": "object",
"createdAt": "object",
"updatedAt": "object",
"lastAccess": "object",
"createdBy": {
"id": "object",
"name": "string",
"lastName": "string",
"email": "string",
"gender": "string",
"phoneNumber": "string",
"avatar": "string",
"confirmedAt": "object",
"createdAt": "object",
"updatedAt": "object"
}
}
}
}
DownloadTemplateScheduleDestination: object
- id:
- enabled:
- type:
-
params:
object
Example
{
"id": "number",
"enabled": "boolean",
"type": "string"
}
DownloadTemplateScheduleDestinationArray: object
- status:
- items:
Example
{
"status": "string",
"items": [
{
"id": "number",
"enabled": "boolean",
"type": "string"
}
]
}
DownloadTemplateScheduleDestinationInput: object
- enabled:
- type:
- sftpParams:
- emailParams:
Example
{
"enabled": "boolean",
"type": "string",
"sftpParams": {
"server": "string",
"port": "number",
"url": "string",
"path": "string",
"user": "string",
"password": "string",
"passphrase": "string",
"privateKey": "object"
},
"emailParams": {
"emails": [
"string"
]
}
}
DownloadTemplateScheduleDestinationTypes: string
Download Template Schedule Destination Types
-
objectSFTP
-
objectEMAIL
DownloadTemplateScheduleResponse: object
- status:
- item:
Example
{
"status": "string",
"item": {
"id": "number",
"active": "boolean",
"repeatPattern": "string",
"startDate": "object",
"destinations": [
{
"id": "number",
"enabled": "boolean",
"type": "string"
}
],
"template": {
"id": "number",
"organizationId": "string",
"name": "string",
"readingFrequency": "string",
"groups": [
"string"
],
"deviceTypes": [
"string"
],
"deviceModels": [
"string"
],
"deviceInfos": [
"string"
],
"deviceDataTypes": [
{
"code": "string",
"customLabel": "string"
}
],
"lastSentTo": [
"string"
],
"lastSentDate": "object",
"lastDownloadRequestedBy": {
"id": "object",
"name": "string",
"lastName": "string",
"email": "string",
"gender": "string",
"phoneNumber": "string",
"avatar": "string",
"confirmedAt": "object",
"createdAt": "object",
"updatedAt": "object",
"lastAccess": "object",
"createdBy": {
"id": "object",
"name": "string",
"lastName": "string",
"email": "string",
"gender": "string",
"phoneNumber": "string",
"avatar": "string",
"confirmedAt": "object"
}
}
}
}
}
DownloadTemplateSortingConditionInput: object
- field:
- order:
Example
{
"field": "string",
"order": "string"
}
EditAutomationInput: object
- description:
- ioConfig:
- loadCellConfig:
- peopleCounterCameraConfig:
- io02Config:
Example
{
"description": "string",
"ioConfig": {
"inputs": [
{
"key": "number",
"label": "string",
"connectedOutputs": [
"number"
]
}
],
"outputs": [
{
"key": "number",
"label": "string"
}
]
},
"loadCellConfig": {
"nominalLoad": "number",
"thresholdOne": "number",
"thresholdTwo": "number"
},
"peopleCounterCameraConfig": {
"areaNumber": "number"
},
"io02Config": {
"input": [
{
"key": "number",
"label": "string"
}
],
"output": [
{
"key": "number",
"label": "string"
}
]
}
}
EditMeteringInput: object
- meterMID:
- connectedMeter:
- energyConsumptionEnabled:
- pulseOneConsumptionEnabled:
- pulseTwoConsumptionEnabled:
- pulseOneConfig:
- pulseTwoConfig:
Example
{
"meterMID": "boolean",
"connectedMeter": "string",
"energyConsumptionEnabled": "boolean",
"pulseOneConsumptionEnabled": "boolean",
"pulseTwoConsumptionEnabled": "boolean",
"pulseOneConfig": {
"type": "string",
"unitOfMeasure": "string",
"conversionRateMultiplier": "number"
},
"pulseTwoConfig": {
"type": "string",
"unitOfMeasure": "string",
"conversionRateMultiplier": "number"
}
}
EditMqttDeviceInput: object
- version:
- meteringProtocol:
- automationOPCUAPLCProtocol:
Example
{
"version": "string",
"meteringProtocol": {
"productManufacturer": {
"required": "boolean",
"multiplier": "number",
"unitOfMeasure": "string",
"path": "string"
},
"productSupplier": {
"required": "boolean",
"multiplier": "number",
"unitOfMeasure": "string",
"path": "string"
},
"productModel": {
"required": "boolean",
"multiplier": "number",
"unitOfMeasure": "string",
"path": "string"
},
"error": {
"required": "boolean",
"multiplier": "number",
"unitOfMeasure": "string",
"path": "string"
},
"timestamp": {
"required": "boolean",
"multiplier": "number",
"unitOfMeasure": "string",
"path": "string"
},
"battery": {
"required": "boolean",
"multiplier": "number",
"unitOfMeasure": "string",
"path": "string"
},
"signalLevel": {
"required": "boolean",
"multiplier": "number",
"unitOfMeasure": "string",
"path": "string"
},
"electricVoltageL1": {
"required": "boolean",
"multiplier": "number",
"unitOfMeasure": "string",
"path": "string"
},
"electricVoltageL2": {
"required": "boolean",
"multiplier": "number",
"unitOfMeasure": "string",
"path": "string"
},
"electricVoltageL3": {
"required": "boolean"
}
}
}
EnvironmentAM03Status: object
- methaneAlarm:
- online:
- signal:
- receivedAt:
- createdAt:
- updatedAt:
Example
{
"methaneAlarm": "boolean",
"online": "boolean",
"signal": "number",
"receivedAt": "object",
"createdAt": "object",
"updatedAt": "object"
}
EnvironmentAM03StatusPaginatedResponse: object
- status:
- total:
- page:
Example
{
"status": "string",
"total": "number",
"page": {
"items": [
{
"methaneAlarm": "boolean",
"online": "boolean",
"signal": "number",
"receivedAt": "object",
"createdAt": "object",
"updatedAt": "object"
}
],
"size": "number",
"index": "number"
}
}
EnvironmentAM04BatteryPercentageStatus: object
- value:
- receivedAt:
Example
{
"value": "number",
"receivedAt": "object"
}
EnvironmentAM04BatteryStatus: object
- batteryPercentage:
- waterLeakageStatus:
- magnetStatus:
- online:
- signal:
- receivedAt:
- createdAt:
- updatedAt:
Example
{
"batteryPercentage": "number",
"waterLeakageStatus": "boolean",
"magnetStatus": "boolean",
"online": "boolean",
"signal": "number",
"receivedAt": "object",
"createdAt": "object",
"updatedAt": "object"
}
EnvironmentAM04BatteryStatusPaginatedResponse: object
- status:
- total:
- page:
Example
{
"status": "string",
"total": "number",
"page": {
"items": [
{
"batteryPercentage": "number",
"waterLeakageStatus": "boolean",
"magnetStatus": "boolean",
"online": "boolean",
"signal": "number",
"receivedAt": "object",
"createdAt": "object",
"updatedAt": "object"
}
],
"size": "number",
"index": "number"
}
}
EnvironmentAM04Status: object
- batteryPercentage:
- temperature:
- humidity:
- waterLeakageStatus:
- magnetStatus:
- online:
- signal:
- receivedAt:
- createdAt:
- updatedAt:
Example
{
"batteryPercentage": {
"value": "number",
"receivedAt": "object"
},
"temperature": "number",
"humidity": "number",
"waterLeakageStatus": "boolean",
"magnetStatus": "boolean",
"online": "boolean",
"signal": "number",
"receivedAt": "object",
"createdAt": "object",
"updatedAt": "object"
}
EnvironmentAM04StatusPaginatedResponse: object
- status:
- total:
- page:
Example
{
"status": "string",
"total": "number",
"page": {
"items": [
{
"batteryPercentage": {
"value": "number",
"receivedAt": "object"
},
"temperature": "number",
"humidity": "number",
"waterLeakageStatus": "boolean",
"magnetStatus": "boolean",
"online": "boolean",
"signal": "number",
"receivedAt": "object",
"createdAt": "object",
"updatedAt": "object"
}
],
"size": "number",
"index": "number"
}
}
EnvironmentAM05BatteryPercentageStatus: object
- value:
- receivedAt:
Example
{
"value": "number",
"receivedAt": "object"
}
EnvironmentAM05BatteryStatus: object
- batteryPercentage:
- online:
- signal:
- receivedAt:
- createdAt:
- updatedAt:
Example
{
"batteryPercentage": "number",
"online": "boolean",
"signal": "number",
"receivedAt": "object",
"createdAt": "object",
"updatedAt": "object"
}
EnvironmentAM05BatteryStatusPaginatedResponse: object
- status:
- total:
- page:
Example
{
"status": "string",
"total": "number",
"page": {
"items": [
{
"batteryPercentage": "number",
"online": "boolean",
"signal": "number",
"receivedAt": "object",
"createdAt": "object",
"updatedAt": "object"
}
],
"size": "number",
"index": "number"
}
}
EnvironmentAM05Status: object
- batteryPercentage:
- temperature:
- humidity:
- online:
- signal:
- receivedAt:
- createdAt:
- updatedAt:
Example
{
"batteryPercentage": {
"value": "number",
"receivedAt": "object"
},
"temperature": "number",
"humidity": "number",
"online": "boolean",
"signal": "number",
"receivedAt": "object",
"createdAt": "object",
"updatedAt": "object"
}
EnvironmentAM05StatusPaginatedResponse: object
- status:
- total:
- page:
Example
{
"status": "string",
"total": "number",
"page": {
"items": [
{
"batteryPercentage": {
"value": "number",
"receivedAt": "object"
},
"temperature": "number",
"humidity": "number",
"online": "boolean",
"signal": "number",
"receivedAt": "object",
"createdAt": "object",
"updatedAt": "object"
}
],
"size": "number",
"index": "number"
}
}
EnvironmentBatteryStatus: object
- batteryPercentage:
- receivedAt:
Example
{
"batteryPercentage": "number",
"receivedAt": "object"
}
EnvironmentBatteryStatusResponse: object
- status:
- total:
- page:
Example
{
"status": "string",
"total": "number",
"page": {
"items": [
{
"batteryPercentage": "number",
"receivedAt": "object"
}
],
"size": "number",
"index": "number"
}
}
EnvironmentPL03Status: object
- occupied:
- illuminance:
- temperature:
- batteryPercentage:
- battery:
- online:
- signal:
- receivedAt:
Example
{
"occupied": "boolean",
"illuminance": "number",
"temperature": "number",
"batteryPercentage": "number",
"battery": "number",
"online": "boolean",
"signal": "number",
"receivedAt": "object"
}
EnvironmentPL03StatusPaginatedResponse: object
- status:
- total:
- page:
Example
{
"status": "string",
"total": "number",
"page": {
"items": [
{
"occupied": "boolean",
"illuminance": "number",
"temperature": "number",
"batteryPercentage": "number",
"battery": "number",
"online": "boolean",
"signal": "number",
"receivedAt": "object"
}
],
"size": "number",
"index": "number"
}
}
EnvironmentPM02Status: object
- batteryPercentage:
- pmMass010:
- pmMass025:
- pmMass040:
- pmMass100:
- pmNumber005:
- pmNumber010:
- pmNumber025:
- pmNumber040:
- pmNumber100:
- online:
- signal:
- receivedAt:
- createdAt:
- updatedAt:
Example
{
"batteryPercentage": "number",
"pmMass010": "number",
"pmMass025": "number",
"pmMass040": "number",
"pmMass100": "number",
"pmNumber005": "number",
"pmNumber010": "number",
"pmNumber025": "number",
"pmNumber040": "number",
"pmNumber100": "number",
"online": "boolean",
"signal": "number",
"receivedAt": "object",
"createdAt": "object",
"updatedAt": "object"
}
EnvironmentPM02StatusPaginatedResponse: object
- status:
- total:
- page:
Example
{
"status": "string",
"total": "number",
"page": {
"items": [
{
"batteryPercentage": "number",
"pmMass010": "number",
"pmMass025": "number",
"pmMass040": "number",
"pmMass100": "number",
"pmNumber005": "number",
"pmNumber010": "number",
"pmNumber025": "number",
"pmNumber040": "number",
"pmNumber100": "number",
"online": "boolean",
"signal": "number",
"receivedAt": "object",
"createdAt": "object",
"updatedAt": "object"
}
],
"size": "number",
"index": "number"
}
}
EnvironmentPMSensorStatus: object
- temperature:
- humidity:
- pressure:
- pm_010:
- pm_025:
- pm_100:
- batteryPercentage:
- online:
- signal:
- receivedAt:
- createdAt:
- updatedAt:
Example
{
"temperature": "number",
"humidity": "number",
"pressure": "number",
"pm_010": "number",
"pm_025": "number",
"pm_100": "number",
"batteryPercentage": "number",
"online": "boolean",
"signal": "number",
"receivedAt": "object",
"createdAt": "object",
"updatedAt": "object"
}
EnvironmentPMSensorStatusPaginatedResponse: object
- status:
- total:
- page:
Example
{
"status": "string",
"total": "number",
"page": {
"items": [
{
"temperature": "number",
"humidity": "number",
"pressure": "number",
"pm_010": "number",
"pm_025": "number",
"pm_100": "number",
"batteryPercentage": "number",
"online": "boolean",
"signal": "number",
"receivedAt": "object",
"createdAt": "object",
"updatedAt": "object"
}
],
"size": "number",
"index": "number"
}
}
EnvironmentSM01Status: object
- highTemperatureAlarm:
- fireAlarm:
- batteryPercentage:
- battery:
- online:
- signal:
- receivedAt:
- createdAt:
- updatedAt:
Example
{
"highTemperatureAlarm": "boolean",
"fireAlarm": "boolean",
"batteryPercentage": "number",
"battery": "number",
"online": "boolean",
"signal": "number",
"receivedAt": "object",
"createdAt": "object",
"updatedAt": "object"
}
EnvironmentSM01StatusPaginatedResponse: object
- status:
- total:
- page:
Example
{
"status": "string",
"total": "number",
"page": {
"items": [
{
"highTemperatureAlarm": "boolean",
"fireAlarm": "boolean",
"batteryPercentage": "number",
"battery": "number",
"online": "boolean",
"signal": "number",
"receivedAt": "object",
"createdAt": "object",
"updatedAt": "object"
}
],
"size": "number",
"index": "number"
}
}
EnvironmentSO01Status: object
- temperature:
- moisture:
- conductivity:
- online:
- signal:
- receivedAt:
- createdAt:
- updatedAt:
Example
{
"temperature": "number",
"moisture": "number",
"conductivity": "number",
"online": "boolean",
"signal": "number",
"receivedAt": "object",
"createdAt": "object",
"updatedAt": "object"
}
EnvironmentSO01StatusPaginatedResponse: object
- status:
- total:
- page:
Example
{
"status": "string",
"total": "number",
"page": {
"items": [
{
"temperature": "number",
"moisture": "number",
"conductivity": "number",
"online": "boolean",
"signal": "number",
"receivedAt": "object",
"createdAt": "object",
"updatedAt": "object"
}
],
"size": "number",
"index": "number"
}
}
EnvironmentSO03Status: object
- signal:
- dielectricPermittivity:
- volumetricWaterContent:
- soilTemperature:
- electricalConductivity:
- batteryVoltage:
- batteryPercentage:
- error:
- receivedAt:
- online:
Example
{
"signal": "number",
"dielectricPermittivity": "number",
"volumetricWaterContent": "number",
"soilTemperature": "number",
"electricalConductivity": "number",
"batteryVoltage": "number",
"batteryPercentage": "number",
"error": "string",
"receivedAt": "object",
"online": "boolean"
}
EnvironmentSO03StatusPaginatedResponse: object
- status:
- total:
- page:
Example
{
"status": "string",
"total": "number",
"page": {
"items": [
{
"signal": "number",
"dielectricPermittivity": "number",
"volumetricWaterContent": "number",
"soilTemperature": "number",
"electricalConductivity": "number",
"batteryVoltage": "number",
"batteryPercentage": "number",
"error": "string",
"receivedAt": "object",
"online": "boolean"
}
],
"size": "number",
"index": "number"
}
}
EnvironmentSo02Status: object
- soilMoistureAtDepthLevel0:
- soilTemperatureAtDepthLevel0:
- soilMoistureAtDepthLevel1:
- soilTemperatureAtDepthLevel1:
- soilMoistureAtDepthLevel2:
- soilTemperatureAtDepthLevel2:
- soilMoistureAtDepthLevel3:
- soilTemperatureAtDepthLevel3:
- soilMoistureAtDepthLevel4:
- soilTemperatureAtDepthLevel4:
- soilMoistureAtDepthLevel5:
- soilTemperatureAtDepthLevel5:
- soilMoistureAtDepthLevel6:
- soilTemperatureAtDepthLevel6:
- soilMoistureAtDepthLevel7:
- soilTemperatureAtDepthLevel7:
- batteryVoltage:
- batteryPercentage:
- online:
- signal:
- receivedAt:
- createdAt:
- updatedAt:
Example
{
"soilMoistureAtDepthLevel0": "number",
"soilTemperatureAtDepthLevel0": "number",
"soilMoistureAtDepthLevel1": "number",
"soilTemperatureAtDepthLevel1": "number",
"soilMoistureAtDepthLevel2": "number",
"soilTemperatureAtDepthLevel2": "number",
"soilMoistureAtDepthLevel3": "number",
"soilTemperatureAtDepthLevel3": "number",
"soilMoistureAtDepthLevel4": "number",
"soilTemperatureAtDepthLevel4": "number",
"soilMoistureAtDepthLevel5": "number",
"soilTemperatureAtDepthLevel5": "number",
"soilMoistureAtDepthLevel6": "number",
"soilTemperatureAtDepthLevel6": "number",
"soilMoistureAtDepthLevel7": "number",
"soilTemperatureAtDepthLevel7": "number",
"batteryVoltage": "number",
"batteryPercentage": "number",
"online": "boolean",
"signal": "number",
"receivedAt": "object",
"createdAt": "object",
"updatedAt": "object"
}
EnvironmentSo02StatusPaginatedResponse: object
- status:
- total:
- page:
Example
{
"status": "string",
"total": "number",
"page": {
"items": [
{
"soilMoistureAtDepthLevel0": "number",
"soilTemperatureAtDepthLevel0": "number",
"soilMoistureAtDepthLevel1": "number",
"soilTemperatureAtDepthLevel1": "number",
"soilMoistureAtDepthLevel2": "number",
"soilTemperatureAtDepthLevel2": "number",
"soilMoistureAtDepthLevel3": "number",
"soilTemperatureAtDepthLevel3": "number",
"soilMoistureAtDepthLevel4": "number",
"soilTemperatureAtDepthLevel4": "number",
"soilMoistureAtDepthLevel5": "number",
"soilTemperatureAtDepthLevel5": "number",
"soilMoistureAtDepthLevel6": "number",
"soilTemperatureAtDepthLevel6": "number",
"soilMoistureAtDepthLevel7": "number",
"soilTemperatureAtDepthLevel7": "number",
"batteryVoltage": "number",
"batteryPercentage": "number",
"online": "boolean",
"signal": "number",
"receivedAt": "object",
"createdAt": "object",
"updatedAt": "object"
}
],
"size": "number",
"index": "number"
}
}
EnvironmentStatus: object
- tvoc:
- illumination:
- activity:
- co2:
- temperature:
- humidity:
- infrared:
- infrared_and_visible:
- pressure:
- online:
- signal:
- receivedAt:
- createdAt:
- updatedAt:
Example
{
"tvoc": "number",
"illumination": "number",
"activity": "number",
"co2": "number",
"temperature": "number",
"humidity": "number",
"infrared": "number",
"infrared_and_visible": "number",
"pressure": "number",
"online": "boolean",
"signal": "number",
"receivedAt": "object",
"createdAt": "object",
"updatedAt": "object"
}
EnvironmentStatusPaginatedResponse: object
- status:
- total:
- page:
Example
{
"status": "string",
"total": "number",
"page": {
"items": [
{
"tvoc": "number",
"illumination": "number",
"activity": "number",
"co2": "number",
"temperature": "number",
"humidity": "number",
"infrared": "number",
"infrared_and_visible": "number",
"pressure": "number",
"online": "boolean",
"signal": "number",
"receivedAt": "object",
"createdAt": "object",
"updatedAt": "object"
}
],
"size": "number",
"index": "number"
}
}
EnvironmentTH01Status: object
- temperature:
- humidity:
- batteryStatus:
- online:
- signal:
- receivedAt:
Example
{
"temperature": "number",
"humidity": "number",
"batteryStatus": {
"batteryPercentage": "number",
"receivedAt": "object"
},
"online": "boolean",
"signal": "number",
"receivedAt": "object"
}
EnvironmentTH01StatusPaginatedResponse: object
- status:
- total:
- page:
Example
{
"status": "string",
"total": "number",
"page": {
"items": [
{
"temperature": "number",
"humidity": "number",
"batteryStatus": {
"batteryPercentage": "number",
"receivedAt": "object"
},
"online": "boolean",
"signal": "number",
"receivedAt": "object"
}
],
"size": "number",
"index": "number"
}
}
EnvironmentTemperatureAlarmInput: object
- mode:
- minTemperature:
- maxTemperature:
- lockTime:
- continueTime:
Example
{
"mode": "string",
"minTemperature": "number",
"maxTemperature": "number",
"lockTime": "number",
"continueTime": "number"
}
EnvironmentTemperatureModes: string
Environment Temperature Modes
-
objectDISABLE
-
objectBELOW
-
objectABOVE
-
objectWITHIN
EnvironmentWH01Status: object
- signal:
- barometerData:
- temperature:
- windSpeed:
- avgWindSpeed:
- windDirection:
- humidityPercentage:
- rainRate:
- UV:
- solarRadiation:
- dayRain:
- dayEt:
- soilMoisture1:
- soilMoisture2:
- soilMoisture3:
- soilMoisture4:
- leafWetness1:
- leafWetness2:
- leafWetness3:
- leafWetness4:
- forecastIcon:
- barTrend:
- error:
- receivedAt:
- online:
Example
{
"signal": "number",
"barometerData": "number",
"temperature": "number",
"windSpeed": "number",
"avgWindSpeed": "number",
"windDirection": "number",
"humidityPercentage": "number",
"rainRate": "number",
"UV": "number",
"solarRadiation": "number",
"dayRain": "number",
"dayEt": "number",
"soilMoisture1": "number",
"soilMoisture2": "number",
"soilMoisture3": "number",
"soilMoisture4": "number",
"leafWetness1": "number",
"leafWetness2": "number",
"leafWetness3": "number",
"leafWetness4": "number",
"forecastIcon": "string",
"barTrend": "number",
"error": "string",
"receivedAt": "object",
"online": "boolean"
}
EnvironmentWH01StatusPaginatedResponse: object
- status:
- total:
- page:
Example
{
"status": "string",
"total": "number",
"page": {
"items": [
{
"signal": "number",
"barometerData": "number",
"temperature": "number",
"windSpeed": "number",
"avgWindSpeed": "number",
"windDirection": "number",
"humidityPercentage": "number",
"rainRate": "number",
"UV": "number",
"solarRadiation": "number",
"dayRain": "number",
"dayEt": "number",
"soilMoisture1": "number",
"soilMoisture2": "number",
"soilMoisture3": "number",
"soilMoisture4": "number",
"leafWetness1": "number",
"leafWetness2": "number",
"leafWetness3": "number",
"leafWetness4": "number",
"forecastIcon": "string",
"barTrend": "number",
"error": "string",
"receivedAt": "object",
"online": "boolean"
}
],
"size": "number",
"index": "number"
}
}
Float: number
The Float scalar type represents signed double-precision fractional values as specified by
IEEE 754.
Example
number
ForecastIcons: string
Forecast Icons
-
objectrain
-
objectcloud
-
objectsun
-
objectsnow
-
objectsun_cloud
-
objectcloud_rain
-
objectcloud_rain_snow
-
objectcloud_snow
-
objectsun_cloud_rain
-
objectsun_cloud_rain_snow
-
objectsun_cloud_snow
FormResponse: object
- status:
- item:
Example
{
"status": "string",
"item": {
"id": "number",
"organizationId": "string",
"name": "string",
"group": {
"organizationId": "string",
"id": "object",
"name": "string",
"path": "string",
"latitude": "number",
"longitude": "number",
"positionType": "string",
"positionY": "number",
"positionX": "number",
"timeZone": "string",
"createdAt": "object",
"updatedAt": "object",
"countDevices": "number",
"countDevicesDeep": "number",
"countChildren": "number",
"countChildrenDeep": "number",
"currency": "string",
"type": "string",
"groupMap": {
"id": "number",
"height": "number",
"width": "number",
"url": "string",
"createdAt": "object",
"updatedAt": "object"
},
"children": [
{
"organizationId": "string",
"id": "object",
"name": "string",
"path": "string",
"latitude": "number",
"longitude": "number",
"positionType": "string",
"positionY": "number",
"positionX": "number",
"timeZone": "string",
"createdAt": "object",
"updatedAt": "object",
"countDevices": "number",
"countDevicesDeep": "number",
"countChildren": "number",
"countChildrenDeep": "number",
"currency": "string"
}
]
}
}
}
FormsPageResponse: object
- status:
- total:
- page:
Example
{
"status": "string",
"total": "number",
"page": {
"items": [
{
"id": "number",
"organizationId": "string",
"name": "string",
"group": {
"organizationId": "string",
"id": "object",
"name": "string",
"path": "string",
"latitude": "number",
"longitude": "number",
"positionType": "string",
"positionY": "number",
"positionX": "number",
"timeZone": "string",
"createdAt": "object",
"updatedAt": "object",
"countDevices": "number",
"countDevicesDeep": "number",
"countChildren": "number",
"countChildrenDeep": "number",
"currency": "string",
"type": "string",
"groupMap": {
"id": "number",
"height": "number",
"width": "number",
"url": "string",
"createdAt": "object",
"updatedAt": "object"
},
"children": [
{
"organizationId": "string",
"id": "object",
"name": "string",
"path": "string",
"latitude": "number",
"longitude": "number",
"positionType": "string",
"positionY": "number",
"positionX": "number",
"timeZone": "string",
"createdAt": "object",
"updatedAt": "object",
"countDevices": "number",
"countDevicesDeep": "number"
}
]
}
}
]
}
}
GeneralPermission: object
- code:
- permissionsType:
- orderSequence:
Example
{
"code": "string",
"permissionsType": "string",
"orderSequence": "number"
}
GeneralPermissionPaginatedResponse: object
- status:
- total:
- page:
Example
{
"status": "string",
"total": "number",
"page": {
"items": [
{
"code": "string",
"permissionsType": "string",
"orderSequence": "number"
}
],
"size": "number",
"index": "number"
}
}
Group: object
- organizationId:
- id:
- name:
- path:
- latitude:
- longitude:
- positionType:
- positionY:
- positionX:
- timeZone:
- createdAt:
- updatedAt:
- countDevices:
- countDevicesDeep:
- countChildren:
- countChildrenDeep:
- currency:
- type:
- groupMap:
- children:
- devices:
- parent:
- parents:
Example
{
"organizationId": "string",
"id": "object",
"name": "string",
"path": "string",
"latitude": "number",
"longitude": "number",
"positionType": "string",
"positionY": "number",
"positionX": "number",
"timeZone": "string",
"createdAt": "object",
"updatedAt": "object",
"countDevices": "number",
"countDevicesDeep": "number",
"countChildren": "number",
"countChildrenDeep": "number",
"currency": "string",
"type": "string",
"groupMap": {
"id": "number",
"height": "number",
"width": "number",
"url": "string",
"createdAt": "object",
"updatedAt": "object"
},
"children": [
{
"organizationId": "string",
"id": "object",
"name": "string",
"path": "string",
"latitude": "number",
"longitude": "number",
"positionType": "string",
"positionY": "number",
"positionX": "number",
"timeZone": "string",
"createdAt": "object",
"updatedAt": "object",
"countDevices": "number",
"countDevicesDeep": "number",
"countChildren": "number",
"countChildrenDeep": "number",
"currency": "string",
"type": "string"
}
],
"devices": [
{
"id": "object",
"organizationId": "string",
"deviceHash": "string"
}
]
}
GroupAccessPolicyInput: object
- groupId:
- groupPermission:
Example
{
"groupId": "string",
"groupPermission": [
"string"
]
}
GroupBase: object
- organizationId:
- id:
- name:
- path:
- latitude:
- longitude:
- positionType:
- positionY:
- positionX:
- timeZone:
- createdAt:
- updatedAt:
- countDevices:
- countDevicesDeep:
- countChildren:
- countChildrenDeep:
- currency:
- type:
Example
{
"organizationId": "string",
"id": "object",
"name": "string",
"path": "string",
"latitude": "number",
"longitude": "number",
"positionType": "string",
"positionY": "number",
"positionX": "number",
"timeZone": "string",
"createdAt": "object",
"updatedAt": "object",
"countDevices": "number",
"countDevicesDeep": "number",
"countChildren": "number",
"countChildrenDeep": "number",
"currency": "string",
"type": "string"
}
GroupMap: object
- id:
- height:
- width:
- url:
- createdAt:
- updatedAt:
Example
{
"id": "number",
"height": "number",
"width": "number",
"url": "string",
"createdAt": "object",
"updatedAt": "object"
}
GroupPaginatedResponse: object
- status:
- total:
- page:
Example
{
"status": "string",
"total": "number",
"page": {
"items": [
{
"organizationId": "string",
"id": "object",
"name": "string",
"path": "string",
"latitude": "number",
"longitude": "number",
"positionType": "string",
"positionY": "number",
"positionX": "number",
"timeZone": "string",
"createdAt": "object",
"updatedAt": "object",
"countDevices": "number",
"countDevicesDeep": "number",
"countChildren": "number",
"countChildrenDeep": "number",
"currency": "string",
"type": "string",
"groupMap": {
"id": "number",
"height": "number",
"width": "number",
"url": "string",
"createdAt": "object",
"updatedAt": "object"
},
"children": [
{
"organizationId": "string",
"id": "object",
"name": "string",
"path": "string",
"latitude": "number",
"longitude": "number",
"positionType": "string",
"positionY": "number",
"positionX": "number",
"timeZone": "string",
"createdAt": "object",
"updatedAt": "object",
"countDevices": "number",
"countDevicesDeep": "number",
"countChildren": "number",
"countChildrenDeep": "number",
"currency": "string",
"type": "string"
}
],
"devices": [
null
]
}
]
}
}
GroupPermissions: string
Group permissions
-
objectEditGroupDetails
-
objectDeleteGroup
-
objectCreateSubGroup
-
objectAssignDevices
-
objectRemoveDevices
-
objectEditDeviceDetails
-
objectAssignUsers
-
objectRemoveUsers
GroupResponse: object
- status:
- item:
Example
{
"status": "string",
"item": {
"organizationId": "string",
"id": "object",
"name": "string",
"path": "string",
"latitude": "number",
"longitude": "number",
"positionType": "string",
"positionY": "number",
"positionX": "number",
"timeZone": "string",
"createdAt": "object",
"updatedAt": "object",
"countDevices": "number",
"countDevicesDeep": "number",
"countChildren": "number",
"countChildrenDeep": "number",
"currency": "string",
"type": "string",
"groupMap": {
"id": "number",
"height": "number",
"width": "number",
"url": "string",
"createdAt": "object",
"updatedAt": "object"
},
"children": [
{
"organizationId": "string",
"id": "object",
"name": "string",
"path": "string",
"latitude": "number",
"longitude": "number",
"positionType": "string",
"positionY": "number",
"positionX": "number",
"timeZone": "string",
"createdAt": "object",
"updatedAt": "object",
"countDevices": "number",
"countDevicesDeep": "number",
"countChildren": "number",
"countChildrenDeep": "number",
"currency": "string",
"type": "string"
}
],
"devices": [
{
"id": "object"
}
]
}
}
GroupTypeStatsResponse: object
- status:
- item:
Example
{
"status": "string",
"item": {
"countCEP": "number",
"countBEP": "number"
}
}
GroupTypes: string
- CEP
@description Stands for Outdoor groups
- BEP
@description Stands for Indoor groups
-
objectCEP
-
objectBEP
ID: object
The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.
Example
object
IO02ConfigurationOptions: string
IO02 configuration options
-
objectGENERAL
-
objectTHRESHOLD
-
objectLEVEL_SENSOR_PARAMETER
IO02GeneralSettingsOptions: string
IO02 general settings options
-
objectWAKE_UP_ON_ACCELEROMETER
-
objectNO_TIME_SYNC_REQUEST
-
objectUNCONFIRMED_UPLINK_MESSAGE
-
objectLEDS_OFF
-
objectSINGLE_JOIN_OR_DAY
-
objectUPLINK_TIME_SYNCHRONIZED
IOConfig: object
- inputs:
- outputs:
Example
{
"inputs": [
{
"key": "number",
"label": "string",
"connectedOutputs": [
"number"
]
}
],
"outputs": [
{
"key": "number",
"label": "string"
}
]
}
IOConfigInput: object
- inputs:
- outputs:
Example
{
"inputs": [
{
"key": "number",
"label": "string",
"connectedOutputs": [
"number"
]
}
],
"outputs": [
{
"key": "number",
"label": "string"
}
]
}
Int: number
The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.
Example
number
JSON: object
The JSON scalar type represents JSON values as specified by
ECMA-404.
Example
object
LicenceAccess: string
Licence Access
-
objectUrbanaWeb
-
objectToolkitApp
-
objectFamilyApp
-
objectMyControlApp
LicenceModules: string
Licence modules
-
objectMaintenance
-
objectLighting
-
objectParking
-
objectMetering
-
objectLoad
-
objectMyControls
-
objectMachineTracking
Lighting: object
- status:
Example
{
"status": {
"signal": "number",
"dimmingLevel": "number",
"temperature": "number",
"activeEnergy": "number",
"apparentEnergy": "number",
"activePower": "number",
"apparentPower": "number",
"energyReactive": "number",
"lampRunningHours": "number",
"nodeRunningHours": "number",
"onOffCycles": "number",
"errors": "string",
"lightingMode": "string",
"online": "boolean",
"deviceUnixEpoch": "number",
"receivedAt": "object",
"createdAt": "object",
"updatedAt": "object"
}
}
LightingAnalyticsAggregationType: string
Lighting Analytics Aggregation Type
-
objectsum_of_differences
-
objectnet_sum
LightingAnalyticsConsumptionResponse: object
- status:
- item:
Example
{
"status": "string",
"item": {
"yesterday": "number",
"month": "number",
"currently": "number"
}
}
LightingAnalyticsEnergyStats: object
- activeEnergy:
- receivedAt:
Example
{
"activeEnergy": "number",
"receivedAt": "object"
}
LightingAnalyticsEnergyStatsArrayResponse: object
- status:
- items:
Example
{
"status": "string",
"items": [
{
"activeEnergy": "number",
"receivedAt": "object"
}
]
}
LightingAnalyticsEnergyTransformationInput: object
- startFromZero:
Example
{
"startFromZero": "boolean"
}
LightingAstroProgram: object
- id:
- name:
- description:
- organizationId:
- sunriseOffsetMinutes:
- sunsetOffsetMinutes:
- dimmingLevel:
- createdBy:
- editedBy:
- createdAt:
- updatedAt:
- days:
Example
{
"id": "number",
"name": "string",
"description": "string",
"organizationId": "string",
"sunriseOffsetMinutes": "number",
"sunsetOffsetMinutes": "number",
"dimmingLevel": "number",
"createdBy": {
"id": "object",
"name": "string",
"lastName": "string",
"email": "string",
"gender": "string",
"phoneNumber": "string",
"avatar": "string",
"confirmedAt": "object",
"createdAt": "object",
"updatedAt": "object",
"lastAccess": "object",
"createdBy": {
"id": "object",
"name": "string",
"lastName": "string",
"email": "string",
"gender": "string",
"phoneNumber": "string",
"avatar": "string",
"confirmedAt": "object",
"createdAt": "object",
"updatedAt": "object",
"lastAccess": "object",
"createdBy": {
"id": "object",
"name": "string",
"lastName": "string",
"email": "string",
"gender": "string",
"phoneNumber": "string",
"avatar": "string",
"confirmedAt": "object",
"createdAt": "object",
"updatedAt": "object",
"lastAccess": "object",
"createdBy": {
"id": "object",
"name": "string",
"lastName": "string",
"email": "string",
"gender": "string"
}
}
}
}
}
LightingAstroProgramCommand: object
- id:
- label:
- groupId:
- sunriseOffsetMinutes:
- sunsetOffsetMinutes:
- dimmingLevel:
- group:
- status:
- devicesCount:
- confirmedDevicesCount:
- errorDevicesCount:
- createdAt:
- updatedAt:
- devices:
Example
{
"id": "number",
"label": "string",
"groupId": "string",
"sunriseOffsetMinutes": "number",
"sunsetOffsetMinutes": "number",
"dimmingLevel": "number",
"group": {
"organizationId": "string",
"id": "object",
"name": "string",
"path": "string",
"latitude": "number",
"longitude": "number",
"positionType": "string",
"positionY": "number",
"positionX": "number",
"timeZone": "string",
"createdAt": "object",
"updatedAt": "object",
"countDevices": "number",
"countDevicesDeep": "number",
"countChildren": "number",
"countChildrenDeep": "number",
"currency": "string",
"type": "string",
"groupMap": {
"id": "number",
"height": "number",
"width": "number",
"url": "string",
"createdAt": "object",
"updatedAt": "object"
},
"children": [
{
"organizationId": "string",
"id": "object",
"name": "string",
"path": "string",
"latitude": "number",
"longitude": "number",
"positionType": "string",
"positionY": "number",
"positionX": "number",
"timeZone": "string",
"createdAt": "object",
"updatedAt": "object",
"countDevices": "number",
"countDevicesDeep": "number",
"countChildren": "number",
"countChildrenDeep": "number"
}
]
}
}
LightingAstroProgramCommandDevice: object
- id:
- deviceSerial:
- programCommandId:
- status:
- sendAttempts:
- lastSendAttemptDate:
- createdAt:
- updatedAt:
- programCommand:
- device:
Example
{
"id": "number",
"deviceSerial": "string",
"programCommandId": "number",
"status": "string",
"sendAttempts": "number",
"lastSendAttemptDate": "object",
"createdAt": "object",
"updatedAt": "object",
"programCommand": {
"id": "number",
"label": "string",
"groupId": "string",
"sunriseOffsetMinutes": "number",
"sunsetOffsetMinutes": "number",
"dimmingLevel": "number",
"group": {
"organizationId": "string",
"id": "object",
"name": "string",
"path": "string",
"latitude": "number",
"longitude": "number",
"positionType": "string",
"positionY": "number",
"positionX": "number",
"timeZone": "string",
"createdAt": "object",
"updatedAt": "object",
"countDevices": "number",
"countDevicesDeep": "number",
"countChildren": "number",
"countChildrenDeep": "number",
"currency": "string",
"type": "string",
"groupMap": {
"id": "number",
"height": "number",
"width": "number",
"url": "string",
"createdAt": "object",
"updatedAt": "object"
},
"children": [
{
"organizationId": "string",
"id": "object",
"name": "string",
"path": "string",
"latitude": "number",
"longitude": "number",
"positionType": "string"
}
]
}
}
}
LightingAstroProgramCommandDevicePaginatedResponse: object
- status:
- total:
- page:
Example
{
"status": "string",
"total": "number",
"page": {
"items": [
{
"id": "number",
"deviceSerial": "string",
"programCommandId": "number",
"status": "string",
"sendAttempts": "number",
"lastSendAttemptDate": "object",
"createdAt": "object",
"updatedAt": "object",
"programCommand": {
"id": "number",
"label": "string",
"groupId": "string",
"sunriseOffsetMinutes": "number",
"sunsetOffsetMinutes": "number",
"dimmingLevel": "number",
"group": {
"organizationId": "string",
"id": "object",
"name": "string",
"path": "string",
"latitude": "number",
"longitude": "number",
"positionType": "string",
"positionY": "number",
"positionX": "number",
"timeZone": "string",
"createdAt": "object",
"updatedAt": "object",
"countDevices": "number",
"countDevicesDeep": "number",
"countChildren": "number",
"countChildrenDeep": "number",
"currency": "string",
"type": "string",
"groupMap": {
"id": "number",
"height": "number",
"width": "number",
"url": "string",
"createdAt": "object",
"updatedAt": "object"
},
"children": [
{
"organizationId": "string",
"id": "object"
}
]
}
}
}
]
}
}
LightingAstroProgramCommandsPaginatedResponse: object
- status:
- total:
- page:
Example
{
"status": "string",
"total": "number",
"page": {
"items": [
{
"id": "number",
"label": "string",
"groupId": "string",
"sunriseOffsetMinutes": "number",
"sunsetOffsetMinutes": "number",
"dimmingLevel": "number",
"group": {
"organizationId": "string",
"id": "object",
"name": "string",
"path": "string",
"latitude": "number",
"longitude": "number",
"positionType": "string",
"positionY": "number",
"positionX": "number",
"timeZone": "string",
"createdAt": "object",
"updatedAt": "object",
"countDevices": "number",
"countDevicesDeep": "number",
"countChildren": "number",
"countChildrenDeep": "number",
"currency": "string",
"type": "string",
"groupMap": {
"id": "number",
"height": "number",
"width": "number",
"url": "string",
"createdAt": "object",
"updatedAt": "object"
},
"children": [
{
"organizationId": "string",
"id": "object",
"name": "string",
"path": "string",
"latitude": "number",
"longitude": "number",
"positionType": "string",
"positionY": "number",
"positionX": "number",
"timeZone": "string",
"createdAt": "object"
}
]
}
}
]
}
}
LightingAstroProgramPaginatedResponse: object
- status:
- total:
- page:
Example
{
"status": "string",
"total": "number",
"page": {
"items": [
{
"id": "number",
"name": "string",
"description": "string",
"organizationId": "string",
"sunriseOffsetMinutes": "number",
"sunsetOffsetMinutes": "number",
"dimmingLevel": "number",
"createdBy": {
"id": "object",
"name": "string",
"lastName": "string",
"email": "string",
"gender": "string",
"phoneNumber": "string",
"avatar": "string",
"confirmedAt": "object",
"createdAt": "object",
"updatedAt": "object",
"lastAccess": "object",
"createdBy": {
"id": "object",
"name": "string",
"lastName": "string",
"email": "string",
"gender": "string",
"phoneNumber": "string",
"avatar": "string",
"confirmedAt": "object",
"createdAt": "object",
"updatedAt": "object",
"lastAccess": "object",
"createdBy": {
"id": "object",
"name": "string",
"lastName": "string",
"email": "string",
"gender": "string",
"phoneNumber": "string",
"avatar": "string",
"confirmedAt": "object",
"createdAt": "object",
"updatedAt": "object",
"lastAccess": "object",
"createdBy": {
"id": "object"
}
}
}
}
}
]
}
}
LightingAstroProgramResponse: object
- status:
- item:
Example
{
"status": "string",
"item": {
"id": "number",
"name": "string",
"description": "string",
"organizationId": "string",
"sunriseOffsetMinutes": "number",
"sunsetOffsetMinutes": "number",
"dimmingLevel": "number",
"createdBy": {
"id": "object",
"name": "string",
"lastName": "string",
"email": "string",
"gender": "string",
"phoneNumber": "string",
"avatar": "string",
"confirmedAt": "object",
"createdAt": "object",
"updatedAt": "object",
"lastAccess": "object",
"createdBy": {
"id": "object",
"name": "string",
"lastName": "string",
"email": "string",
"gender": "string",
"phoneNumber": "string",
"avatar": "string",
"confirmedAt": "object",
"createdAt": "object",
"updatedAt": "object",
"lastAccess": "object",
"createdBy": {
"id": "object",
"name": "string",
"lastName": "string",
"email": "string",
"gender": "string",
"phoneNumber": "string",
"avatar": "string",
"confirmedAt": "object",
"createdAt": "object",
"updatedAt": "object",
"lastAccess": "object",
"createdBy": {
"id": "object",
"name": "string",
"lastName": "string"
}
}
}
}
}
}
LightingAstroSchedule: object
- id:
- groupId:
- group:
- organizationId:
- programId:
- program:
- programCommandId:
- programCommand:
- scheduledDate:
- lastRetryDate:
- createdAt:
- updatedAt:
Example
{
"id": "number",
"groupId": "string",
"group": {
"organizationId": "string",
"id": "object",
"name": "string",
"path": "string",
"latitude": "number",
"longitude": "number",
"positionType": "string",
"positionY": "number",
"positionX": "number",
"timeZone": "string",
"createdAt": "object",
"updatedAt": "object",
"countDevices": "number",
"countDevicesDeep": "number",
"countChildren": "number",
"countChildrenDeep": "number",
"currency": "string",
"type": "string",
"groupMap": {
"id": "number",
"height": "number",
"width": "number",
"url": "string",
"createdAt": "object",
"updatedAt": "object"
},
"children": [
{
"organizationId": "string",
"id": "object",
"name": "string",
"path": "string",
"latitude": "number",
"longitude": "number",
"positionType": "string",
"positionY": "number",
"positionX": "number",
"timeZone": "string",
"createdAt": "object",
"updatedAt": "object",
"countDevices": "number",
"countDevicesDeep": "number",
"countChildren": "number",
"countChildrenDeep": "number",
"currency": "string",
"type": "string"
}
],
"devices": [
{}
]
}
}
LightingAstroScheduleArrayResponse: object
- status:
- items:
Example
{
"status": "string",
"items": [
{
"id": "number",
"groupId": "string",
"group": {
"organizationId": "string",
"id": "object",
"name": "string",
"path": "string",
"latitude": "number",
"longitude": "number",
"positionType": "string",
"positionY": "number",
"positionX": "number",
"timeZone": "string",
"createdAt": "object",
"updatedAt": "object",
"countDevices": "number",
"countDevicesDeep": "number",
"countChildren": "number",
"countChildrenDeep": "number",
"currency": "string",
"type": "string",
"groupMap": {
"id": "number",
"height": "number",
"width": "number",
"url": "string",
"createdAt": "object",
"updatedAt": "object"
},
"children": [
{
"organizationId": "string",
"id": "object",
"name": "string",
"path": "string",
"latitude": "number",
"longitude": "number",
"positionType": "string",
"positionY": "number",
"positionX": "number",
"timeZone": "string",
"createdAt": "object",
"updatedAt": "object",
"countDevices": "number",
"countDevicesDeep": "number",
"countChildren": "number",
"countChildrenDeep": "number",
"currency": "string"
}
]
}
}
]
}
LightingAstroScheduleResponse: object
- status:
- item:
Example
{
"status": "string",
"item": {
"id": "number",
"groupId": "string",
"group": {
"organizationId": "string",
"id": "object",
"name": "string",
"path": "string",
"latitude": "number",
"longitude": "number",
"positionType": "string",
"positionY": "number",
"positionX": "number",
"timeZone": "string",
"createdAt": "object",
"updatedAt": "object",
"countDevices": "number",
"countDevicesDeep": "number",
"countChildren": "number",
"countChildrenDeep": "number",
"currency": "string",
"type": "string",
"groupMap": {
"id": "number",
"height": "number",
"width": "number",
"url": "string",
"createdAt": "object",
"updatedAt": "object"
},
"children": [
{
"organizationId": "string",
"id": "object",
"name": "string",
"path": "string",
"latitude": "number",
"longitude": "number",
"positionType": "string",
"positionY": "number",
"positionX": "number",
"timeZone": "string",
"createdAt": "object",
"updatedAt": "object",
"countDevices": "number",
"countDevicesDeep": "number",
"countChildren": "number",
"countChildrenDeep": "number",
"currency": "string",
"type": "string"
}
]
}
}
}
LightingCustomizedScheduleSettingInput: object
- scheduleNumber:
- enable:
- executionTime1:
- functionTypeForExecutionTime1:
- dimmingForExecutionTime1:
- executionTime2:
- functionTypeForExecutionTime2:
- dimmingForExecutionTime2:
- executionTime3:
- functionTypeForExecutionTime3:
- dimmingForExecutionTime3:
- executionTime4:
- functionTypeForExecutionTime4:
- dimmingForExecutionTime4:
Example
{
"scheduleNumber": "number",
"enable": "boolean",
"executionTime1": "string",
"functionTypeForExecutionTime1": "string",
"dimmingForExecutionTime1": "number",
"executionTime2": "string",
"functionTypeForExecutionTime2": "string",
"dimmingForExecutionTime2": "number",
"executionTime3": "string",
"functionTypeForExecutionTime3": "string",
"dimmingForExecutionTime3": "number",
"executionTime4": "string",
"functionTypeForExecutionTime4": "string",
"dimmingForExecutionTime4": "number"
}
LightingDailyProgramCommand: object
- id:
- dimmingPoints:
- createdAt:
- updatedAt:
Example
{
"id": "number",
"dimmingPoints": [
{
"timeIndex": "number",
"dimmingLevel": "number"
}
],
"createdAt": "object",
"updatedAt": "object"
}
LightingDailyProgramCommandResponse: object
- status:
- item:
Example
{
"status": "string",
"item": {
"id": "number",
"dimmingPoints": [
{
"timeIndex": "number",
"dimmingLevel": "number"
}
],
"createdAt": "object",
"updatedAt": "object"
}
}
LightingDeviceProgramStatus: object
- dayOfWeek:
- programValidityFirstDate:
- programValidityLastDate:
- dimmingPoints:
- receivedAt:
Example
{
"dayOfWeek": "string",
"programValidityFirstDate": "object",
"programValidityLastDate": "object",
"dimmingPoints": [
{
"timeIndex": "number",
"dimmingLevel": "number"
}
],
"receivedAt": "object"
}
LightingDeviceProgramStatusResponse: object
- status:
- item:
Example
{
"status": "string",
"item": {
"dayOfWeek": "string",
"programValidityFirstDate": "object",
"programValidityLastDate": "object",
"dimmingPoints": [
{
"timeIndex": "number",
"dimmingLevel": "number"
}
],
"receivedAt": "object"
}
}
LightingModes: string
Lighting modes
-
objectLIGHTING_PROGRAM
-
objectPERMANENT_DIMMING
-
objectASTROCLOCK
-
objectTEMPORARY_DIMMING
-
objectON
-
objectOFF
LightingProgram: object
- id:
- name:
- organizationId:
- description:
- createdBy:
- editedBy:
- createdAt:
- updatedAt:
- days:
Example
{
"id": "number",
"name": "string",
"organizationId": "string",
"description": "string",
"createdBy": {
"id": "object",
"name": "string",
"lastName": "string",
"email": "string",
"gender": "string",
"phoneNumber": "string",
"avatar": "string",
"confirmedAt": "object",
"createdAt": "object",
"updatedAt": "object",
"lastAccess": "object",
"createdBy": {
"id": "object",
"name": "string",
"lastName": "string",
"email": "string",
"gender": "string",
"phoneNumber": "string",
"avatar": "string",
"confirmedAt": "object",
"createdAt": "object",
"updatedAt": "object",
"lastAccess": "object",
"createdBy": {
"id": "object",
"name": "string",
"lastName": "string",
"email": "string",
"gender": "string",
"phoneNumber": "string",
"avatar": "string",
"confirmedAt": "object",
"createdAt": "object",
"updatedAt": "object",
"lastAccess": "object",
"createdBy": {
"id": "object",
"name": "string",
"lastName": "string",
"email": "string",
"gender": "string",
"phoneNumber": "string",
"avatar": "string",
"confirmedAt": "object"
}
}
}
}
}
LightingProgramAllowedSortingFields: string
Lighting program allowed sorting fields
-
objectname
-
objectid
-
objectcreatedAt
-
objectupdatedAt
LightingProgramCommand: object
- id:
- label:
- groupId:
- group:
- status:
- devicesCount:
- confirmedDevicesCount:
- errorDevicesCount:
- commandsCount:
- confirmedCommandsCount:
- errorCommandsCount:
- createdAt:
- updatedAt:
- devices:
- days:
Example
{
"id": "number",
"label": "string",
"groupId": "string",
"group": {
"organizationId": "string",
"id": "object",
"name": "string",
"path": "string",
"latitude": "number",
"longitude": "number",
"positionType": "string",
"positionY": "number",
"positionX": "number",
"timeZone": "string",
"createdAt": "object",
"updatedAt": "object",
"countDevices": "number",
"countDevicesDeep": "number",
"countChildren": "number",
"countChildrenDeep": "number",
"currency": "string",
"type": "string",
"groupMap": {
"id": "number",
"height": "number",
"width": "number",
"url": "string",
"createdAt": "object",
"updatedAt": "object"
},
"children": [
{
"organizationId": "string",
"id": "object",
"name": "string",
"path": "string",
"latitude": "number",
"longitude": "number",
"positionType": "string",
"positionY": "number",
"positionX": "number",
"timeZone": "string",
"createdAt": "object",
"updatedAt": "object",
"countDevices": "number",
"countDevicesDeep": "number",
"countChildren": "number",
"countChildrenDeep": "number",
"currency": "string",
"type": "string"
}
],
"devices": [
null
]
}
}
LightingProgramCommandDay: object
- id:
- programCommandId:
- dayOfWeek:
- dailyProgramId:
- dailyProgram:
- createdAt:
- updatedAt:
Example
{
"id": "number",
"programCommandId": "number",
"dayOfWeek": "string",
"dailyProgramId": "number",
"dailyProgram": {
"id": "number",
"dimmingPoints": [
{
"timeIndex": "number",
"dimmingLevel": "number"
}
],
"createdAt": "object",
"updatedAt": "object"
},
"createdAt": "object",
"updatedAt": "object"
}
LightingProgramCommandDevice: object
- id:
- deviceSerial:
- programCommandId:
- statuses:
- createdAt:
- updatedAt:
- programCommand:
- device:
Example
{
"id": "number",
"deviceSerial": "string",
"programCommandId": "number",
"statuses": [
{
"id": "number",
"programCommandDeviceId": "number",
"dayOfWeek": "string",
"status": "string",
"sendAttempts": "number",
"lastSendAttemptDate": "object",
"createdAt": "object",
"updatedAt": "object",
"programCommandDevice": {
"id": "number",
"deviceSerial": "string",
"programCommandId": "number",
"statuses": [
{
"id": "number",
"programCommandDeviceId": "number",
"dayOfWeek": "string",
"status": "string",
"sendAttempts": "number",
"lastSendAttemptDate": "object",
"createdAt": "object",
"updatedAt": "object",
"programCommandDevice": {
"id": "number",
"deviceSerial": "string",
"programCommandId": "number",
"statuses": [
{
"id": "number",
"programCommandDeviceId": "number",
"dayOfWeek": "string",
"status": "string",
"sendAttempts": "number",
"lastSendAttemptDate": "object",
"createdAt": "object",
"updatedAt": "object",
"programCommandDevice": {
"id": "number",
"deviceSerial": "string",
"programCommandId": "number",
"statuses": [
{
"id": "number",
"programCommandDeviceId": "number",
"dayOfWeek": "string",
"status": "string"
}
]
}
}
]
}
}
]
}
}
]
}
LightingProgramCommandDeviceDayStatus: object
- id:
- programCommandDeviceId:
- dayOfWeek:
- status:
- sendAttempts:
- lastSendAttemptDate:
- createdAt:
- updatedAt:
- programCommandDevice:
Example
{
"id": "number",
"programCommandDeviceId": "number",
"dayOfWeek": "string",
"status": "string",
"sendAttempts": "number",
"lastSendAttemptDate": "object",
"createdAt": "object",
"updatedAt": "object",
"programCommandDevice": {
"id": "number",
"deviceSerial": "string",
"programCommandId": "number",
"statuses": [
{
"id": "number",
"programCommandDeviceId": "number",
"dayOfWeek": "string",
"status": "string",
"sendAttempts": "number",
"lastSendAttemptDate": "object",
"createdAt": "object",
"updatedAt": "object",
"programCommandDevice": {
"id": "number",
"deviceSerial": "string",
"programCommandId": "number",
"statuses": [
{
"id": "number",
"programCommandDeviceId": "number",
"dayOfWeek": "string",
"status": "string",
"sendAttempts": "number",
"lastSendAttemptDate": "object",
"createdAt": "object",
"updatedAt": "object",
"programCommandDevice": {
"id": "number",
"deviceSerial": "string",
"programCommandId": "number",
"statuses": [
{
"id": "number",
"programCommandDeviceId": "number",
"dayOfWeek": "string",
"status": "string",
"sendAttempts": "number",
"lastSendAttemptDate": "object",
"createdAt": "object",
"updatedAt": "object",
"programCommandDevice": {}
}
]
}
}
]
}
}
]
}
}
LightingProgramCommandDeviceDayStatusPaginatedResponse: object
- status:
- total:
- page:
Example
{
"status": "string",
"total": "number",
"page": {
"items": [
{
"id": "number",
"programCommandDeviceId": "number",
"dayOfWeek": "string",
"status": "string",
"sendAttempts": "number",
"lastSendAttemptDate": "object",
"createdAt": "object",
"updatedAt": "object",
"programCommandDevice": {
"id": "number",
"deviceSerial": "string",
"programCommandId": "number",
"statuses": [
{
"id": "number",
"programCommandDeviceId": "number",
"dayOfWeek": "string",
"status": "string",
"sendAttempts": "number",
"lastSendAttemptDate": "object",
"createdAt": "object",
"updatedAt": "object",
"programCommandDevice": {
"id": "number",
"deviceSerial": "string",
"programCommandId": "number",
"statuses": [
{
"id": "number",
"programCommandDeviceId": "number",
"dayOfWeek": "string",
"status": "string",
"sendAttempts": "number",
"lastSendAttemptDate": "object",
"createdAt": "object",
"updatedAt": "object",
"programCommandDevice": {
"id": "number",
"deviceSerial": "string",
"programCommandId": "number",
"statuses": [
{
"id": "number",
"programCommandDeviceId": "number",
"dayOfWeek": "string",
"status": "string"
}
]
}
}
]
}
}
]
}
}
]
}
}
LightingProgramCommandDevicePaginatedResponse: object
- status:
- total:
- page:
Example
{
"status": "string",
"total": "number",
"page": {
"items": [
{
"id": "number",
"deviceSerial": "string",
"programCommandId": "number",
"statuses": [
{
"id": "number",
"programCommandDeviceId": "number",
"dayOfWeek": "string",
"status": "string",
"sendAttempts": "number",
"lastSendAttemptDate": "object",
"createdAt": "object",
"updatedAt": "object",
"programCommandDevice": {
"id": "number",
"deviceSerial": "string",
"programCommandId": "number",
"statuses": [
{
"id": "number",
"programCommandDeviceId": "number",
"dayOfWeek": "string",
"status": "string",
"sendAttempts": "number",
"lastSendAttemptDate": "object",
"createdAt": "object",
"updatedAt": "object",
"programCommandDevice": {
"id": "number",
"deviceSerial": "string",
"programCommandId": "number",
"statuses": [
{
"id": "number",
"programCommandDeviceId": "number",
"dayOfWeek": "string",
"status": "string",
"sendAttempts": "number",
"lastSendAttemptDate": "object",
"createdAt": "object",
"updatedAt": "object",
"programCommandDevice": {
"id": "number",
"deviceSerial": "string",
"programCommandId": "number",
"statuses": [
{}
]
}
}
]
}
}
]
}
}
]
}
]
}
}
LightingProgramCommandsPaginatedResponse: object
- status:
- total:
- page:
Example
{
"status": "string",
"total": "number",
"page": {
"items": [
{
"id": "number",
"label": "string",
"groupId": "string",
"group": {
"organizationId": "string",
"id": "object",
"name": "string",
"path": "string",
"latitude": "number",
"longitude": "number",
"positionType": "string",
"positionY": "number",
"positionX": "number",
"timeZone": "string",
"createdAt": "object",
"updatedAt": "object",
"countDevices": "number",
"countDevicesDeep": "number",
"countChildren": "number",
"countChildrenDeep": "number",
"currency": "string",
"type": "string",
"groupMap": {
"id": "number",
"height": "number",
"width": "number",
"url": "string",
"createdAt": "object",
"updatedAt": "object"
},
"children": [
{
"organizationId": "string",
"id": "object",
"name": "string",
"path": "string",
"latitude": "number",
"longitude": "number",
"positionType": "string",
"positionY": "number",
"positionX": "number",
"timeZone": "string",
"createdAt": "object",
"updatedAt": "object",
"countDevices": "number",
"countDevicesDeep": "number"
}
]
}
}
]
}
}
LightingProgramDailyInput: object
- dayOfWeek:
- dimmingPoints:
Example
{
"dayOfWeek": "string",
"dimmingPoints": [
{
"timeIndex": "number",
"dimmingLevel": "number"
}
]
}
LightingProgramDay: object
- id:
- dayOfWeek:
- dimmingPoints:
- createdAt:
- updatedAt:
Example
{
"id": "number",
"dayOfWeek": "string",
"dimmingPoints": [
{
"timeIndex": "number",
"dimmingLevel": "number"
}
],
"createdAt": "object",
"updatedAt": "object"
}
LightingProgramDayResponse: object
- status:
- item:
Example
{
"status": "string",
"item": {
"id": "number",
"dayOfWeek": "string",
"dimmingPoints": [
{
"timeIndex": "number",
"dimmingLevel": "number"
}
],
"createdAt": "object",
"updatedAt": "object"
}
}
LightingProgramInput: object
- dailyPrograms:
Example
{
"dailyPrograms": [
{
"dayOfWeek": "string",
"dimmingPoints": [
{
"timeIndex": "number",
"dimmingLevel": "number"
}
]
}
]
}
LightingProgramPaginatedResponse: object
- status:
- total:
- page:
Example
{
"status": "string",
"total": "number",
"page": {
"items": [
{
"id": "number",
"name": "string",
"organizationId": "string",
"description": "string",
"createdBy": {
"id": "object",
"name": "string",
"lastName": "string",
"email": "string",
"gender": "string",
"phoneNumber": "string",
"avatar": "string",
"confirmedAt": "object",
"createdAt": "object",
"updatedAt": "object",
"lastAccess": "object",
"createdBy": {
"id": "object",
"name": "string",
"lastName": "string",
"email": "string",
"gender": "string",
"phoneNumber": "string",
"avatar": "string",
"confirmedAt": "object",
"createdAt": "object",
"updatedAt": "object",
"lastAccess": "object",
"createdBy": {
"id": "object",
"name": "string",
"lastName": "string",
"email": "string",
"gender": "string",
"phoneNumber": "string",
"avatar": "string",
"confirmedAt": "object",
"createdAt": "object",
"updatedAt": "object",
"lastAccess": "object",
"createdBy": {
"id": "object",
"name": "string",
"lastName": "string",
"email": "string"
}
}
}
}
}
]
}
}
LightingProgramResponse: object
- status:
- item:
Example
{
"status": "string",
"item": {
"id": "number",
"name": "string",
"organizationId": "string",
"description": "string",
"createdBy": {
"id": "object",
"name": "string",
"lastName": "string",
"email": "string",
"gender": "string",
"phoneNumber": "string",
"avatar": "string",
"confirmedAt": "object",
"createdAt": "object",
"updatedAt": "object",
"lastAccess": "object",
"createdBy": {
"id": "object",
"name": "string",
"lastName": "string",
"email": "string",
"gender": "string",
"phoneNumber": "string",
"avatar": "string",
"confirmedAt": "object",
"createdAt": "object",
"updatedAt": "object",
"lastAccess": "object",
"createdBy": {
"id": "object",
"name": "string",
"lastName": "string",
"email": "string",
"gender": "string",
"phoneNumber": "string",
"avatar": "string",
"confirmedAt": "object",
"createdAt": "object",
"updatedAt": "object",
"lastAccess": "object",
"createdBy": {
"id": "object",
"name": "string",
"lastName": "string",
"email": "string",
"gender": "string",
"phoneNumber": "string"
}
}
}
}
}
}
LightingProgramSortingConditionInput: object
- field:
- order:
Example
{
"field": "string",
"order": "string"
}
LightingProgramTemplate: object
- id:
- groupId:
- dimmingPoints:
- templateName:
- editedBy:
- createdBy:
- createdAt:
- updatedAt:
- group:
Example
{
"id": "number",
"groupId": "string",
"dimmingPoints": [
{
"timeIndex": "number",
"dimmingLevel": "number"
}
],
"templateName": "string",
"editedBy": {
"id": "object",
"name": "string",
"lastName": "string",
"email": "string",
"gender": "string",
"phoneNumber": "string",
"avatar": "string",
"confirmedAt": "object",
"createdAt": "object",
"updatedAt": "object",
"lastAccess": "object",
"createdBy": {
"id": "object",
"name": "string",
"lastName": "string",
"email": "string",
"gender": "string",
"phoneNumber": "string",
"avatar": "string",
"confirmedAt": "object",
"createdAt": "object",
"updatedAt": "object",
"lastAccess": "object",
"createdBy": {
"id": "object",
"name": "string",
"lastName": "string",
"email": "string",
"gender": "string",
"phoneNumber": "string",
"avatar": "string",
"confirmedAt": "object",
"createdAt": "object",
"updatedAt": "object",
"lastAccess": "object",
"createdBy": {
"id": "object",
"name": "string",
"lastName": "string",
"email": "string",
"gender": "string",
"phoneNumber": "string"
}
}
}
}
}
LightingProgramTemplatePaginatedResponse: object
- status:
- total:
- page:
Example
{
"status": "string",
"total": "number",
"page": {
"items": [
{
"id": "number",
"groupId": "string",
"dimmingPoints": [
{
"timeIndex": "number",
"dimmingLevel": "number"
}
],
"templateName": "string",
"editedBy": {
"id": "object",
"name": "string",
"lastName": "string",
"email": "string",
"gender": "string",
"phoneNumber": "string",
"avatar": "string",
"confirmedAt": "object",
"createdAt": "object",
"updatedAt": "object",
"lastAccess": "object",
"createdBy": {
"id": "object",
"name": "string",
"lastName": "string",
"email": "string",
"gender": "string",
"phoneNumber": "string",
"avatar": "string",
"confirmedAt": "object",
"createdAt": "object",
"updatedAt": "object",
"lastAccess": "object",
"createdBy": {
"id": "object",
"name": "string",
"lastName": "string",
"email": "string",
"gender": "string",
"phoneNumber": "string",
"avatar": "string",
"confirmedAt": "object",
"createdAt": "object",
"updatedAt": "object",
"lastAccess": "object",
"createdBy": {
"id": "object"
}
}
}
}
}
]
}
}
LightingProgramTemplateResponse: object
- status:
- item:
Example
{
"status": "string",
"item": {
"id": "number",
"groupId": "string",
"dimmingPoints": [
{
"timeIndex": "number",
"dimmingLevel": "number"
}
],
"templateName": "string",
"editedBy": {
"id": "object",
"name": "string",
"lastName": "string",
"email": "string",
"gender": "string",
"phoneNumber": "string",
"avatar": "string",
"confirmedAt": "object",
"createdAt": "object",
"updatedAt": "object",
"lastAccess": "object",
"createdBy": {
"id": "object",
"name": "string",
"lastName": "string",
"email": "string",
"gender": "string",
"phoneNumber": "string",
"avatar": "string",
"confirmedAt": "object",
"createdAt": "object",
"updatedAt": "object",
"lastAccess": "object",
"createdBy": {
"id": "object",
"name": "string",
"lastName": "string",
"email": "string",
"gender": "string",
"phoneNumber": "string",
"avatar": "string",
"confirmedAt": "object",
"createdAt": "object",
"updatedAt": "object",
"lastAccess": "object",
"createdBy": {
"id": "object",
"name": "string",
"lastName": "string",
"email": "string"
}
}
}
}
}
}
LightingSchedule: object
- id:
- groupId:
- group:
- organizationId:
- programId:
- program:
- programCommandId:
- programCommand:
- scheduledDate:
- lastRetryDate:
- createdAt:
- updatedAt:
Example
{
"id": "number",
"groupId": "string",
"group": {
"organizationId": "string",
"id": "object",
"name": "string",
"path": "string",
"latitude": "number",
"longitude": "number",
"positionType": "string",
"positionY": "number",
"positionX": "number",
"timeZone": "string",
"createdAt": "object",
"updatedAt": "object",
"countDevices": "number",
"countDevicesDeep": "number",
"countChildren": "number",
"countChildrenDeep": "number",
"currency": "string",
"type": "string",
"groupMap": {
"id": "number",
"height": "number",
"width": "number",
"url": "string",
"createdAt": "object",
"updatedAt": "object"
},
"children": [
{
"organizationId": "string",
"id": "object",
"name": "string",
"path": "string",
"latitude": "number",
"longitude": "number",
"positionType": "string",
"positionY": "number",
"positionX": "number",
"timeZone": "string",
"createdAt": "object",
"updatedAt": "object",
"countDevices": "number",
"countDevicesDeep": "number",
"countChildren": "number",
"countChildrenDeep": "number",
"currency": "string",
"type": "string"
}
],
"devices": [
{}
]
}
}
LightingScheduleArrayResponse: object
- status:
- items:
Example
{
"status": "string",
"items": [
{
"id": "number",
"groupId": "string",
"group": {
"organizationId": "string",
"id": "object",
"name": "string",
"path": "string",
"latitude": "number",
"longitude": "number",
"positionType": "string",
"positionY": "number",
"positionX": "number",
"timeZone": "string",
"createdAt": "object",
"updatedAt": "object",
"countDevices": "number",
"countDevicesDeep": "number",
"countChildren": "number",
"countChildrenDeep": "number",
"currency": "string",
"type": "string",
"groupMap": {
"id": "number",
"height": "number",
"width": "number",
"url": "string",
"createdAt": "object",
"updatedAt": "object"
},
"children": [
{
"organizationId": "string",
"id": "object",
"name": "string",
"path": "string",
"latitude": "number",
"longitude": "number",
"positionType": "string",
"positionY": "number",
"positionX": "number",
"timeZone": "string",
"createdAt": "object",
"updatedAt": "object",
"countDevices": "number",
"countDevicesDeep": "number",
"countChildren": "number",
"countChildrenDeep": "number",
"currency": "string"
}
]
}
}
]
}
LightingScheduleResponse: object
- status:
- item:
Example
{
"status": "string",
"item": {
"id": "number",
"groupId": "string",
"group": {
"organizationId": "string",
"id": "object",
"name": "string",
"path": "string",
"latitude": "number",
"longitude": "number",
"positionType": "string",
"positionY": "number",
"positionX": "number",
"timeZone": "string",
"createdAt": "object",
"updatedAt": "object",
"countDevices": "number",
"countDevicesDeep": "number",
"countChildren": "number",
"countChildrenDeep": "number",
"currency": "string",
"type": "string",
"groupMap": {
"id": "number",
"height": "number",
"width": "number",
"url": "string",
"createdAt": "object",
"updatedAt": "object"
},
"children": [
{
"organizationId": "string",
"id": "object",
"name": "string",
"path": "string",
"latitude": "number",
"longitude": "number",
"positionType": "string",
"positionY": "number",
"positionX": "number",
"timeZone": "string",
"createdAt": "object",
"updatedAt": "object",
"countDevices": "number",
"countDevicesDeep": "number",
"countChildren": "number",
"countChildrenDeep": "number",
"currency": "string",
"type": "string"
}
]
}
}
}
LightingStatus: object
- signal:
- dimmingLevel:
- temperature:
- activeEnergy:
- apparentEnergy:
- activePower:
- apparentPower:
- energyReactive:
- lampRunningHours:
- nodeRunningHours:
- onOffCycles:
- errors:
- lightingMode:
- online:
- deviceUnixEpoch:
- receivedAt:
- createdAt:
- updatedAt:
Example
{
"signal": "number",
"dimmingLevel": "number",
"temperature": "number",
"activeEnergy": "number",
"apparentEnergy": "number",
"activePower": "number",
"apparentPower": "number",
"energyReactive": "number",
"lampRunningHours": "number",
"nodeRunningHours": "number",
"onOffCycles": "number",
"errors": "string",
"lightingMode": "string",
"online": "boolean",
"deviceUnixEpoch": "number",
"receivedAt": "object",
"createdAt": "object",
"updatedAt": "object"
}
LightingStatusPaginatedResponse: object
- status:
- total:
- page:
Example
{
"status": "string",
"total": "number",
"page": {
"items": [
{
"signal": "number",
"dimmingLevel": "number",
"temperature": "number",
"activeEnergy": "number",
"apparentEnergy": "number",
"activePower": "number",
"apparentPower": "number",
"energyReactive": "number",
"lampRunningHours": "number",
"nodeRunningHours": "number",
"onOffCycles": "number",
"errors": "string",
"lightingMode": "string",
"online": "boolean",
"deviceUnixEpoch": "number",
"receivedAt": "object",
"createdAt": "object",
"updatedAt": "object"
}
],
"size": "number",
"index": "number"
}
}
LoraParams: object
- id:
- deviceEUI:
- applicationEUI:
- joinEUI:
- version:
- loraClass:
- regionalParametersRevision:
- region:
- activationType:
- createdAt:
- updatedAt:
Example
{
"id": "number",
"deviceEUI": "string",
"applicationEUI": "string",
"joinEUI": "string",
"version": "string",
"loraClass": "string",
"regionalParametersRevision": "string",
"region": "string",
"activationType": "string",
"createdAt": "object",
"updatedAt": "object"
}
MaintenanceForm: object
- id:
- organizationId:
- name:
- group:
- configurationJson:
- editedBy:
- createdBy:
- createdAt:
- updatedAt:
Example
{
"id": "number",
"organizationId": "string",
"name": "string",
"group": {
"organizationId": "string",
"id": "object",
"name": "string",
"path": "string",
"latitude": "number",
"longitude": "number",
"positionType": "string",
"positionY": "number",
"positionX": "number",
"timeZone": "string",
"createdAt": "object",
"updatedAt": "object",
"countDevices": "number",
"countDevicesDeep": "number",
"countChildren": "number",
"countChildrenDeep": "number",
"currency": "string",
"type": "string",
"groupMap": {
"id": "number",
"height": "number",
"width": "number",
"url": "string",
"createdAt": "object",
"updatedAt": "object"
},
"children": [
{
"organizationId": "string",
"id": "object",
"name": "string",
"path": "string",
"latitude": "number",
"longitude": "number",
"positionType": "string",
"positionY": "number",
"positionX": "number",
"timeZone": "string",
"createdAt": "object",
"updatedAt": "object",
"countDevices": "number",
"countDevicesDeep": "number",
"countChildren": "number",
"countChildrenDeep": "number",
"currency": "string",
"type": "string"
}
],
"devices": [
null
]
}
}
MaintenanceFormAllowedSortingFields: string
Maintenance form allowed sorting fields
-
objectname
-
objectcreatedAt
-
objectupdatedAt
MaintenanceFormsSortingConditionInput: object
- field:
- order:
Example
{
"field": "string",
"order": "string"
}
MaintenanceNotification: object
- id:
- operationId:
- notificationType:
- detectionDate:
- deviceSerial:
- organizationId:
- deviceName:
- deviceTypeName:
- deviceGroupId:
- deviceGroupName:
- latestDeviceStatus:
- latestDeviceStatusMessage:
- lastStatusUpdateDate:
- deviceMaxLifetimeHours:
- deviceRemainingLifetimeHours:
Example
{
"id": "number",
"operationId": "number",
"notificationType": "string",
"detectionDate": "object",
"deviceSerial": "string",
"organizationId": "string",
"deviceName": "string",
"deviceTypeName": "string",
"deviceGroupId": "string",
"deviceGroupName": "string",
"latestDeviceStatus": "string",
"latestDeviceStatusMessage": "string",
"lastStatusUpdateDate": "object",
"deviceMaxLifetimeHours": "number",
"deviceRemainingLifetimeHours": "number"
}
MaintenanceNotificationAllowedSortingFields: string
Maintenance notification allowed sorting fields
-
objectdeviceSerial
-
objectnotificationType
-
objectdetectionDate
-
objectcreatedAt
-
objectupdatedAt
MaintenanceNotificationsSortingConditionInput: object
- field:
- order:
Example
{
"field": "string",
"order": "string"
}
MaintenanceOperation: object
- id:
- name:
- organizationId:
- groupId:
- groupName:
- categoryId:
- status:
- lastStatusUpdateDate:
- managerEmails:
- managerEmailSent:
- maintainerEmails:
- maintainerEmailSent:
- scheduledDate:
- description:
- createdAt:
- updatedAt:
- category:
- expectedCost:
- repetitionPattern:
- repetitionOffset:
- numberOfRepetition:
- repetitionEndDate:
- externalData:
- form:
Example
{
"id": "number",
"name": "string",
"organizationId": "object",
"groupId": "object",
"groupName": "string",
"categoryId": "number",
"status": "string",
"lastStatusUpdateDate": "object",
"managerEmails": [
"string"
],
"managerEmailSent": "boolean",
"maintainerEmails": [
"string"
],
"maintainerEmailSent": "boolean",
"scheduledDate": "object",
"description": "string",
"createdAt": "object",
"updatedAt": "object",
"category": {
"id": "number",
"color": "string",
"name": "string"
},
"expectedCost": {
"id": "number",
"operationId": "number",
"value": "number",
"currency": "string"
},
"repetitionPattern": "string",
"repetitionOffset": "number",
"numberOfRepetition": "number",
"repetitionEndDate": "object",
"externalData": "object",
"form": {
"id": "number",
"operationId": "number",
"name": "string",
"configurationJson": "object",
"responsesJson": "object",
"editedBy": {
"id": "object",
"name": "string",
"lastName": "string",
"email": "string",
"gender": "string",
"phoneNumber": "string",
"avatar": "string",
"confirmedAt": "object",
"createdAt": "object",
"updatedAt": "object",
"lastAccess": "object"
}
}
}
MaintenanceOperationAllowedSortingFields: string
Maintenance operation allowed sorting fields
-
objectname
-
objectstatus
-
objectcost
-
objectscheduledDate
-
objectcreatedAt
-
objectupdatedAt
MaintenanceOperationForm: object
- id:
- operationId:
- name:
- configurationJson:
- responsesJson:
- editedBy:
- createdBy:
- createdAt:
- updatedAt:
Example
{
"id": "number",
"operationId": "number",
"name": "string",
"configurationJson": "object",
"responsesJson": "object",
"editedBy": {
"id": "object",
"name": "string",
"lastName": "string",
"email": "string",
"gender": "string",
"phoneNumber": "string",
"avatar": "string",
"confirmedAt": "object",
"createdAt": "object",
"updatedAt": "object",
"lastAccess": "object",
"createdBy": {
"id": "object",
"name": "string",
"lastName": "string",
"email": "string",
"gender": "string",
"phoneNumber": "string",
"avatar": "string",
"confirmedAt": "object",
"createdAt": "object",
"updatedAt": "object",
"lastAccess": "object",
"createdBy": {
"id": "object",
"name": "string",
"lastName": "string",
"email": "string",
"gender": "string",
"phoneNumber": "string",
"avatar": "string",
"confirmedAt": "object",
"createdAt": "object",
"updatedAt": "object",
"lastAccess": "object",
"createdBy": {
"id": "object",
"name": "string",
"lastName": "string",
"email": "string",
"gender": "string",
"phoneNumber": "string",
"avatar": "string"
}
}
}
}
}
MaintenanceOperationFormHistory: object
- id:
- userId:
- userFirstName:
- userLastName:
- operationId:
- action:
- formId:
- formName:
- timestamp:
- configurationJson:
- responsesJson:
Example
{
"id": "string",
"userId": "string",
"userFirstName": "string",
"userLastName": "string",
"operationId": "number",
"action": "string",
"formId": "number",
"formName": "string",
"timestamp": "object",
"configurationJson": "object",
"responsesJson": "object"
}
MaintenanceOperationFormHistoryActions: string
Maintenance operation form history actions
-
objectDELETE
-
objectASSIGN
-
objectFILL
MaintenanceOperationLinkedItems: object
- operationId:
- notifications:
- devices:
Example
{
"operationId": "number",
"notifications": [
{
"id": "number",
"operationId": "number",
"notificationType": "string",
"detectionDate": "object",
"deviceSerial": "string",
"organizationId": "string",
"deviceName": "string",
"deviceTypeName": "string",
"deviceGroupId": "string",
"deviceGroupName": "string",
"latestDeviceStatus": "string",
"latestDeviceStatusMessage": "string",
"lastStatusUpdateDate": "object",
"deviceMaxLifetimeHours": "number",
"deviceRemainingLifetimeHours": "number"
}
],
"devices": [
{
"id": "object",
"organizationId": "string",
"deviceHash": "string",
"serial": "string",
"name": "string",
"supplier": "string",
"tag": "string",
"latitude": "number",
"longitude": "number",
"positionType": "string",
"positionY": "number",
"positionX": "number",
"timeZone": "string",
"networkType": "string",
"loraParams": {
"id": "number",
"deviceEUI": "string",
"applicationEUI": "string",
"joinEUI": "string",
"version": "string",
"loraClass": "string",
"regionalParametersRevision": "string",
"region": "string",
"activationType": "string",
"createdAt": "object",
"updatedAt": "object"
},
"mqttParams": {
"id": "number",
"version": "string",
"createdAt": "object"
}
}
]
}
MaintenanceOperationRepetitionPattern: string
Maintenance operation repetition pattern
-
objectDay
-
objectWeek
-
objectMonth
-
objectYear
MaintenanceOperationStatus: string
Maintenance Operation Status
-
objectPENDING
-
objectRESOLVED
-
objectAPPROVED
MaintenanceOperationsSortingConditionInput: object
- field:
- order:
Example
{
"field": "string",
"order": "string"
}
Metering: object
- id:
- meterMID:
- connectedMeter:
- energyConsumptionEnabled:
- pulseOneConsumptionEnabled:
- pulseTwoConsumptionEnabled:
- pulseOneConfig:
- pulseTwoConfig:
- status:
- createdAt:
- updatedAt:
Example
{
"id": "number",
"meterMID": "boolean",
"connectedMeter": "string",
"energyConsumptionEnabled": "boolean",
"pulseOneConsumptionEnabled": "boolean",
"pulseTwoConsumptionEnabled": "boolean",
"pulseOneConfig": {
"type": "string",
"unitOfMeasure": "string",
"conversionRateMultiplier": "number"
},
"pulseTwoConfig": {
"type": "string",
"unitOfMeasure": "string",
"conversionRateMultiplier": "number"
},
"status": {
"signal": "number",
"enabled485": "boolean",
"pulseOneEnabled": "boolean",
"pulseTwoEnabled": "boolean",
"totalActiveEnergyEnabled": "boolean",
"activePowerEnabled": "boolean",
"voltageEnabled": "boolean",
"currentEnabled": "boolean",
"powerFactorEnabled": "boolean",
"frequencyEnabled": "boolean",
"temperature": "number",
"voltage": "number",
"current": "number",
"powerFactor": "number",
"frequency": "number",
"activePower": "number",
"totalActiveEnergy": "number",
"pulseOne": "number",
"pulseTwo": "number",
"errors": "string",
"online": "boolean",
"receivedAt": "object",
"createdAt": "object",
"updatedAt": "object"
},
"createdAt": "object",
"updatedAt": "object"
}
MeteringAnalyticsAnomaliesPaginatedResponse: object
- status:
- total:
- page:
Example
{
"status": "string",
"total": "number",
"page": {
"items": [
{
"date": "object",
"groupId": "string",
"group": {
"organizationId": "string",
"id": "object",
"name": "string",
"path": "string",
"latitude": "number",
"longitude": "number",
"positionType": "string",
"positionY": "number",
"positionX": "number",
"timeZone": "string",
"createdAt": "object",
"updatedAt": "object",
"countDevices": "number",
"countDevicesDeep": "number",
"countChildren": "number",
"countChildrenDeep": "number",
"currency": "string",
"type": "string",
"groupMap": {
"id": "number",
"height": "number",
"width": "number",
"url": "string",
"createdAt": "object",
"updatedAt": "object"
},
"children": [
{
"organizationId": "string",
"id": "object",
"name": "string",
"path": "string",
"latitude": "number",
"longitude": "number",
"positionType": "string",
"positionY": "number",
"positionX": "number",
"timeZone": "string",
"createdAt": "object",
"updatedAt": "object",
"countDevices": "number",
"countDevicesDeep": "number",
"countChildren": "number"
}
]
}
}
]
}
}
MeteringAnalyticsAnomaly: object
- date:
- groupId:
- group:
- deviceId:
- device:
- anomalyType:
Example
{
"date": "object",
"groupId": "string",
"group": {
"organizationId": "string",
"id": "object",
"name": "string",
"path": "string",
"latitude": "number",
"longitude": "number",
"positionType": "string",
"positionY": "number",
"positionX": "number",
"timeZone": "string",
"createdAt": "object",
"updatedAt": "object",
"countDevices": "number",
"countDevicesDeep": "number",
"countChildren": "number",
"countChildrenDeep": "number",
"currency": "string",
"type": "string",
"groupMap": {
"id": "number",
"height": "number",
"width": "number",
"url": "string",
"createdAt": "object",
"updatedAt": "object"
},
"children": [
{
"organizationId": "string",
"id": "object",
"name": "string",
"path": "string",
"latitude": "number",
"longitude": "number",
"positionType": "string",
"positionY": "number",
"positionX": "number",
"timeZone": "string",
"createdAt": "object",
"updatedAt": "object",
"countDevices": "number",
"countDevicesDeep": "number",
"countChildren": "number",
"countChildrenDeep": "number",
"currency": "string",
"type": "string"
}
],
"devices": [
{}
]
}
}
MeteringAnalyticsConsumptionResponse: object
- status:
- item:
Example
{
"status": "string",
"item": {
"today": "number",
"month": "number",
"currently": "number"
}
}
MeteringAnalyticsEconomicArrayResponse: object
- status:
- items:
Example
{
"status": "string",
"items": [
{
"date": "object",
"total": "number"
}
]
}
MeteringEnergyStatus: object
- enabled485:
- pulseOneEnabled:
- pulseTwoEnabled:
- activeEnergyImpEnabled:
- totalActiveEnergyImpEnabled:
- activeEnergyExpEnabled:
- totalActiveEnergyExpEnabled:
- reactiveEnergyImpEnabled:
- totalReactiveEnergyImpEnabled:
- reactiveEnergyExpEnabled:
- totalReactiveEnergyExpEnabled:
- temperature:
- activeEnergyImpL1:
- activeEnergyImpL2:
- activeEnergyImpL3:
- activeEnergyImpTotal:
- activeEnergyExpL1:
- activeEnergyExpL2:
- activeEnergyExpL3:
- activeEnergyExpTotal:
- reactiveEnergyImpL1:
- reactiveEnergyImpL2:
- reactiveEnergyImpL3:
- reactiveEnergyImpTotal:
- reactiveEnergyExpL1:
- reactiveEnergyExpL2:
- reactiveEnergyExpL3:
- reactiveEnergyExpTotal:
- pulseOne:
- pulseTwo:
- signal:
- online:
- errors:
- receivedAt:
- createdAt:
- updatedAt:
Example
{
"enabled485": "boolean",
"pulseOneEnabled": "boolean",
"pulseTwoEnabled": "boolean",
"activeEnergyImpEnabled": "boolean",
"totalActiveEnergyImpEnabled": "boolean",
"activeEnergyExpEnabled": "boolean",
"totalActiveEnergyExpEnabled": "boolean",
"reactiveEnergyImpEnabled": "boolean",
"totalReactiveEnergyImpEnabled": "boolean",
"reactiveEnergyExpEnabled": "boolean",
"totalReactiveEnergyExpEnabled": "boolean",
"temperature": "number",
"activeEnergyImpL1": "number",
"activeEnergyImpL2": "number",
"activeEnergyImpL3": "number",
"activeEnergyImpTotal": "number",
"activeEnergyExpL1": "number",
"activeEnergyExpL2": "number",
"activeEnergyExpL3": "number",
"activeEnergyExpTotal": "number",
"reactiveEnergyImpL1": "number",
"reactiveEnergyImpL2": "number",
"reactiveEnergyImpL3": "number",
"reactiveEnergyImpTotal": "number",
"reactiveEnergyExpL1": "number",
"reactiveEnergyExpL2": "number",
"reactiveEnergyExpL3": "number",
"reactiveEnergyExpTotal": "number",
"pulseOne": "number",
"pulseTwo": "number",
"signal": "number",
"online": "boolean",
"errors": "string",
"receivedAt": "object",
"createdAt": "object",
"updatedAt": "object"
}
MeteringEnergyStatusPaginatedResponse: object
- status:
- total:
- page:
Example
{
"status": "string",
"total": "number",
"page": {
"items": [
{
"enabled485": "boolean",
"pulseOneEnabled": "boolean",
"pulseTwoEnabled": "boolean",
"activeEnergyImpEnabled": "boolean",
"totalActiveEnergyImpEnabled": "boolean",
"activeEnergyExpEnabled": "boolean",
"totalActiveEnergyExpEnabled": "boolean",
"reactiveEnergyImpEnabled": "boolean",
"totalReactiveEnergyImpEnabled": "boolean",
"reactiveEnergyExpEnabled": "boolean",
"totalReactiveEnergyExpEnabled": "boolean",
"temperature": "number",
"activeEnergyImpL1": "number",
"activeEnergyImpL2": "number",
"activeEnergyImpL3": "number",
"activeEnergyImpTotal": "number",
"activeEnergyExpL1": "number",
"activeEnergyExpL2": "number",
"activeEnergyExpL3": "number",
"activeEnergyExpTotal": "number",
"reactiveEnergyImpL1": "number",
"reactiveEnergyImpL2": "number",
"reactiveEnergyImpL3": "number",
"reactiveEnergyImpTotal": "number",
"reactiveEnergyExpL1": "number",
"reactiveEnergyExpL2": "number",
"reactiveEnergyExpL3": "number",
"reactiveEnergyExpTotal": "number",
"pulseOne": "number",
"pulseTwo": "number",
"signal": "number",
"online": "boolean",
"errors": "string",
"receivedAt": "object",
"createdAt": "object",
"updatedAt": "object"
}
],
"size": "number",
"index": "number"
}
}
MeteringGenericStatus: object
- productManufacturer:
- productSupplier:
- productModel:
- error:
- timestamp:
- battery:
- signalLevel:
- electricVoltageL1:
- electricVoltageL2:
- electricVoltageL3:
- electricVoltageL12:
- electricVoltageL23:
- electricVoltageL31:
- electricCurrentL1:
- electricCurrentL2:
- electricCurrentL3:
- electricFrequency:
- electricPowerFactorL1:
- electricPowerFactorL2:
- electricPowerFactorL3:
- electricTotalPowerFactor:
- electricActivePowerL1:
- electricActivePowerL2:
- electricActivePowerL3:
- electricTotalActivePower:
- electricReactivePowerL1:
- electricReactivePowerL2:
- electricReactivePowerL3:
- electricTotalReactivePower:
- electricApparentPowerL1:
- electricApparentPowerL2:
- electricApparentPowerL3:
- electricTotalApparentPower:
- electricActiveEnergyImpL1:
- electricActiveEnergyImpL2:
- electricActiveEnergyImpL3:
- electricTotalActiveEnergyImp:
- electricActiveEnergyExpL1:
- electricActiveEnergyExpL2:
- electricActiveEnergyExpL3:
- electricTotalActiveEnergyExp:
- electricReactiveEnergyImpL1:
- electricReactiveEnergyImpL2:
- electricReactiveEnergyImpL3:
- electricTotalReactiveEnergyImp:
- electricReactiveEnergyExpL1:
- electricReactiveEnergyExpL2:
- electricReactiveEnergyExpL3:
- electricTotalReactiveEnergyExp:
- totalGasVolume:
- totalWaterVolume:
- totalThermalEnergy:
- thermalPower:
- thermalVolume:
- thermalFlow:
- thermalFwTemp:
- thermalRtTemp:
- online:
- receivedAt:
- createdAt:
- updatedAt:
Example
{
"productManufacturer": "string",
"productSupplier": "string",
"productModel": "string",
"error": "string",
"timestamp": "number",
"battery": "number",
"signalLevel": "number",
"electricVoltageL1": "number",
"electricVoltageL2": "number",
"electricVoltageL3": "number",
"electricVoltageL12": "number",
"electricVoltageL23": "number",
"electricVoltageL31": "number",
"electricCurrentL1": "number",
"electricCurrentL2": "number",
"electricCurrentL3": "number",
"electricFrequency": "number",
"electricPowerFactorL1": "number",
"electricPowerFactorL2": "number",
"electricPowerFactorL3": "number",
"electricTotalPowerFactor": "number",
"electricActivePowerL1": "number",
"electricActivePowerL2": "number",
"electricActivePowerL3": "number",
"electricTotalActivePower": "number",
"electricReactivePowerL1": "number",
"electricReactivePowerL2": "number",
"electricReactivePowerL3": "number",
"electricTotalReactivePower": "number",
"electricApparentPowerL1": "number",
"electricApparentPowerL2": "number",
"electricApparentPowerL3": "number",
"electricTotalApparentPower": "number",
"electricActiveEnergyImpL1": "number",
"electricActiveEnergyImpL2": "number",
"electricActiveEnergyImpL3": "number",
"electricTotalActiveEnergyImp": "number",
"electricActiveEnergyExpL1": "number",
"electricActiveEnergyExpL2": "number",
"electricActiveEnergyExpL3": "number",
"electricTotalActiveEnergyExp": "number",
"electricReactiveEnergyImpL1": "number",
"electricReactiveEnergyImpL2": "number",
"electricReactiveEnergyImpL3": "number",
"electricTotalReactiveEnergyImp": "number",
"electricReactiveEnergyExpL1": "number",
"electricReactiveEnergyExpL2": "number",
"electricReactiveEnergyExpL3": "number",
"electricTotalReactiveEnergyExp": "number"
}
MeteringGenericStatusPaginatedResponse: object
- status:
- total:
- page:
Example
{
"status": "string",
"total": "number",
"page": {
"items": [
{
"productManufacturer": "string",
"productSupplier": "string",
"productModel": "string",
"error": "string",
"timestamp": "number",
"battery": "number",
"signalLevel": "number",
"electricVoltageL1": "number",
"electricVoltageL2": "number",
"electricVoltageL3": "number",
"electricVoltageL12": "number",
"electricVoltageL23": "number",
"electricVoltageL31": "number",
"electricCurrentL1": "number",
"electricCurrentL2": "number",
"electricCurrentL3": "number",
"electricFrequency": "number",
"electricPowerFactorL1": "number",
"electricPowerFactorL2": "number",
"electricPowerFactorL3": "number",
"electricTotalPowerFactor": "number",
"electricActivePowerL1": "number",
"electricActivePowerL2": "number",
"electricActivePowerL3": "number",
"electricTotalActivePower": "number",
"electricReactivePowerL1": "number",
"electricReactivePowerL2": "number",
"electricReactivePowerL3": "number",
"electricTotalReactivePower": "number",
"electricApparentPowerL1": "number",
"electricApparentPowerL2": "number",
"electricApparentPowerL3": "number",
"electricTotalApparentPower": "number",
"electricActiveEnergyImpL1": "number",
"electricActiveEnergyImpL2": "number",
"electricActiveEnergyImpL3": "number",
"electricTotalActiveEnergyImp": "number",
"electricActiveEnergyExpL1": "number",
"electricActiveEnergyExpL2": "number",
"electricActiveEnergyExpL3": "number",
"electricTotalActiveEnergyExp": "number",
"electricReactiveEnergyImpL1": "number",
"electricReactiveEnergyImpL2": "number",
"electricReactiveEnergyImpL3": "number",
"electricTotalReactiveEnergyImp": "number"
}
]
}
}
MeteringInstantStatus: object
- activePowerEnabled:
- totalActivePowerEnabled:
- reactivePowerEnabled:
- totalReactivePowerEnabled:
- voltageEnabled:
- ptpVoltageEnabled:
- currentEnabled:
- powerFactorEnabled:
- powerFactorTotalEnabled:
- apparentPowerEnabled:
- totalApparentPowerEnabled:
- frequencyEnabled:
- temperature:
- voltageL1:
- voltageL2:
- voltageL3:
- voltageL12:
- voltageL23:
- voltageL31:
- currentL1:
- currentL2:
- currentL3:
- frequency:
- powerFactorL1:
- powerFactorL2:
- powerFactorL3:
- totalPowerFactor:
- activePowerL1:
- activePowerL2:
- activePowerL3:
- totalActivePower:
- reactivePowerL1:
- reactivePowerL2:
- reactivePowerL3:
- totalReactivePower:
- apparentPowerL1:
- apparentPowerL2:
- apparentPowerL3:
- totalApparentPower:
- signal:
- online:
- errors:
- receivedAt:
- createdAt:
- updatedAt:
Example
{
"activePowerEnabled": "boolean",
"totalActivePowerEnabled": "boolean",
"reactivePowerEnabled": "boolean",
"totalReactivePowerEnabled": "boolean",
"voltageEnabled": "boolean",
"ptpVoltageEnabled": "boolean",
"currentEnabled": "boolean",
"powerFactorEnabled": "boolean",
"powerFactorTotalEnabled": "boolean",
"apparentPowerEnabled": "boolean",
"totalApparentPowerEnabled": "boolean",
"frequencyEnabled": "boolean",
"temperature": "number",
"voltageL1": "number",
"voltageL2": "number",
"voltageL3": "number",
"voltageL12": "number",
"voltageL23": "number",
"voltageL31": "number",
"currentL1": "number",
"currentL2": "number",
"currentL3": "number",
"frequency": "number",
"powerFactorL1": "number",
"powerFactorL2": "number",
"powerFactorL3": "number",
"totalPowerFactor": "number",
"activePowerL1": "number",
"activePowerL2": "number",
"activePowerL3": "number",
"totalActivePower": "number",
"reactivePowerL1": "number",
"reactivePowerL2": "number",
"reactivePowerL3": "number",
"totalReactivePower": "number",
"apparentPowerL1": "number",
"apparentPowerL2": "number",
"apparentPowerL3": "number",
"totalApparentPower": "number",
"signal": "number",
"online": "boolean",
"errors": "string",
"receivedAt": "object",
"createdAt": "object",
"updatedAt": "object"
}
MeteringInstantStatusPaginatedResponse: object
- status:
- total:
- page:
Example
{
"status": "string",
"total": "number",
"page": {
"items": [
{
"activePowerEnabled": "boolean",
"totalActivePowerEnabled": "boolean",
"reactivePowerEnabled": "boolean",
"totalReactivePowerEnabled": "boolean",
"voltageEnabled": "boolean",
"ptpVoltageEnabled": "boolean",
"currentEnabled": "boolean",
"powerFactorEnabled": "boolean",
"powerFactorTotalEnabled": "boolean",
"apparentPowerEnabled": "boolean",
"totalApparentPowerEnabled": "boolean",
"frequencyEnabled": "boolean",
"temperature": "number",
"voltageL1": "number",
"voltageL2": "number",
"voltageL3": "number",
"voltageL12": "number",
"voltageL23": "number",
"voltageL31": "number",
"currentL1": "number",
"currentL2": "number",
"currentL3": "number",
"frequency": "number",
"powerFactorL1": "number",
"powerFactorL2": "number",
"powerFactorL3": "number",
"totalPowerFactor": "number",
"activePowerL1": "number",
"activePowerL2": "number",
"activePowerL3": "number",
"totalActivePower": "number",
"reactivePowerL1": "number",
"reactivePowerL2": "number",
"reactivePowerL3": "number",
"totalReactivePower": "number",
"apparentPowerL1": "number",
"apparentPowerL2": "number",
"apparentPowerL3": "number",
"totalApparentPower": "number",
"signal": "number",
"online": "boolean",
"errors": "string",
"receivedAt": "object",
"createdAt": "object",
"updatedAt": "object"
}
]
}
}
MeteringMessageFormat: string
Metering Message Format
-
objectSTANDARD
-
objectCOMPACT
-
objectJSON
-
objectSCHEDULED_DAILY
-
objectSCHEDULED_EXTENDED
-
objectCOMBINED
-
objectHEAT_INTELLIGENCE
MeteringProgram: object
- id:
- name:
- description:
- organizationId:
- groupId:
- group:
- type:
- dailyCostSlots:
- schedules:
- editedBy:
- createdBy:
- createdAt:
- updatedAt:
Example
{
"id": "number",
"name": "string",
"description": "string",
"organizationId": "string",
"groupId": "string",
"group": {
"organizationId": "string",
"id": "object",
"name": "string",
"path": "string",
"latitude": "number",
"longitude": "number",
"positionType": "string",
"positionY": "number",
"positionX": "number",
"timeZone": "string",
"createdAt": "object",
"updatedAt": "object",
"countDevices": "number",
"countDevicesDeep": "number",
"countChildren": "number",
"countChildrenDeep": "number",
"currency": "string",
"type": "string",
"groupMap": {
"id": "number",
"height": "number",
"width": "number",
"url": "string",
"createdAt": "object",
"updatedAt": "object"
},
"children": [
{
"organizationId": "string",
"id": "object",
"name": "string",
"path": "string",
"latitude": "number",
"longitude": "number",
"positionType": "string",
"positionY": "number",
"positionX": "number",
"timeZone": "string",
"createdAt": "object",
"updatedAt": "object",
"countDevices": "number",
"countDevicesDeep": "number",
"countChildren": "number",
"countChildrenDeep": "number",
"currency": "string"
}
]
}
}
MeteringProgramAllowedSortingFields: string
Metering program allowed sorting fields
-
objectname
-
objectid
-
objecttype
-
objectcreatedAt
-
objectupdatedAt
MeteringProgramPaginatedResponse: object
- status:
- total:
- page:
Example
{
"status": "string",
"total": "number",
"page": {
"items": [
{
"id": "number",
"name": "string",
"description": "string",
"organizationId": "string",
"groupId": "string",
"group": {
"organizationId": "string",
"id": "object",
"name": "string",
"path": "string",
"latitude": "number",
"longitude": "number",
"positionType": "string",
"positionY": "number",
"positionX": "number",
"timeZone": "string",
"createdAt": "object",
"updatedAt": "object",
"countDevices": "number",
"countDevicesDeep": "number",
"countChildren": "number",
"countChildrenDeep": "number",
"currency": "string",
"type": "string",
"groupMap": {
"id": "number",
"height": "number",
"width": "number",
"url": "string",
"createdAt": "object",
"updatedAt": "object"
},
"children": [
{
"organizationId": "string",
"id": "object",
"name": "string",
"path": "string",
"latitude": "number",
"longitude": "number",
"positionType": "string",
"positionY": "number",
"positionX": "number",
"timeZone": "string",
"createdAt": "object",
"updatedAt": "object"
}
]
}
}
]
}
}
MeteringProgramResponse: object
- status:
- item:
Example
{
"status": "string",
"item": {
"id": "number",
"name": "string",
"description": "string",
"organizationId": "string",
"groupId": "string",
"group": {
"organizationId": "string",
"id": "object",
"name": "string",
"path": "string",
"latitude": "number",
"longitude": "number",
"positionType": "string",
"positionY": "number",
"positionX": "number",
"timeZone": "string",
"createdAt": "object",
"updatedAt": "object",
"countDevices": "number",
"countDevicesDeep": "number",
"countChildren": "number",
"countChildrenDeep": "number",
"currency": "string",
"type": "string",
"groupMap": {
"id": "number",
"height": "number",
"width": "number",
"url": "string",
"createdAt": "object",
"updatedAt": "object"
},
"children": [
{
"organizationId": "string",
"id": "object",
"name": "string",
"path": "string",
"latitude": "number",
"longitude": "number",
"positionType": "string",
"positionY": "number",
"positionX": "number",
"timeZone": "string",
"createdAt": "object",
"updatedAt": "object",
"countDevices": "number",
"countDevicesDeep": "number",
"countChildren": "number"
}
]
}
}
}
MeteringProgramSortingConditionInput: object
- field:
- order:
Example
{
"field": "string",
"order": "string"
}
MeteringPulseConfig: object
- type:
- unitOfMeasure:
- conversionRateMultiplier:
Example
{
"type": "string",
"unitOfMeasure": "string",
"conversionRateMultiplier": "number"
}
MeteringPulseConfigInput: object
- type:
- unitOfMeasure:
- conversionRateMultiplier:
Example
{
"type": "string",
"unitOfMeasure": "string",
"conversionRateMultiplier": "number"
}
MeteringSchedule: object
- id:
- programId:
- organizationId:
- program:
- date:
- createdAt:
- updatedAt:
Example
{
"id": "number",
"programId": "number",
"organizationId": "string",
"program": {
"id": "number",
"name": "string",
"description": "string",
"organizationId": "string",
"groupId": "string",
"group": {
"organizationId": "string",
"id": "object",
"name": "string",
"path": "string",
"latitude": "number",
"longitude": "number",
"positionType": "string",
"positionY": "number",
"positionX": "number",
"timeZone": "string",
"createdAt": "object",
"updatedAt": "object",
"countDevices": "number",
"countDevicesDeep": "number",
"countChildren": "number",
"countChildrenDeep": "number",
"currency": "string",
"type": "string",
"groupMap": {
"id": "number",
"height": "number",
"width": "number",
"url": "string",
"createdAt": "object",
"updatedAt": "object"
},
"children": [
{
"organizationId": "string",
"id": "object",
"name": "string",
"path": "string",
"latitude": "number",
"longitude": "number",
"positionType": "string",
"positionY": "number",
"positionX": "number",
"timeZone": "string",
"createdAt": "object",
"updatedAt": "object",
"countDevices": "number"
}
]
}
}
}
MeteringScheduleArrayResponse: object
- status:
- items:
Example
{
"status": "string",
"items": [
{
"id": "number",
"programId": "number",
"organizationId": "string",
"program": {
"id": "number",
"name": "string",
"description": "string",
"organizationId": "string",
"groupId": "string",
"group": {
"organizationId": "string",
"id": "object",
"name": "string",
"path": "string",
"latitude": "number",
"longitude": "number",
"positionType": "string",
"positionY": "number",
"positionX": "number",
"timeZone": "string",
"createdAt": "object",
"updatedAt": "object",
"countDevices": "number",
"countDevicesDeep": "number",
"countChildren": "number",
"countChildrenDeep": "number",
"currency": "string",
"type": "string",
"groupMap": {
"id": "number",
"height": "number",
"width": "number",
"url": "string",
"createdAt": "object",
"updatedAt": "object"
},
"children": [
{
"organizationId": "string",
"id": "object",
"name": "string",
"path": "string",
"latitude": "number",
"longitude": "number",
"positionType": "string",
"positionY": "number",
"positionX": "number",
"timeZone": "string"
}
]
}
}
}
]
}
MeteringSchedulePaginatedResponse: object
- status:
- total:
- page:
Example
{
"status": "string",
"total": "number",
"page": {
"items": [
{
"id": "number",
"programId": "number",
"organizationId": "string",
"program": {
"id": "number",
"name": "string",
"description": "string",
"organizationId": "string",
"groupId": "string",
"group": {
"organizationId": "string",
"id": "object",
"name": "string",
"path": "string",
"latitude": "number",
"longitude": "number",
"positionType": "string",
"positionY": "number",
"positionX": "number",
"timeZone": "string",
"createdAt": "object",
"updatedAt": "object",
"countDevices": "number",
"countDevicesDeep": "number",
"countChildren": "number",
"countChildrenDeep": "number",
"currency": "string",
"type": "string",
"groupMap": {
"id": "number",
"height": "number",
"width": "number",
"url": "string",
"createdAt": "object",
"updatedAt": "object"
},
"children": [
{
"organizationId": "string",
"id": "object",
"name": "string",
"path": "string",
"latitude": "number",
"longitude": "number",
"positionType": "string",
"positionY": "number"
}
]
}
}
}
]
}
}
MeteringScheduleResponse: object
- status:
- item:
Example
{
"status": "string",
"item": {
"id": "number",
"programId": "number",
"organizationId": "string",
"program": {
"id": "number",
"name": "string",
"description": "string",
"organizationId": "string",
"groupId": "string",
"group": {
"organizationId": "string",
"id": "object",
"name": "string",
"path": "string",
"latitude": "number",
"longitude": "number",
"positionType": "string",
"positionY": "number",
"positionX": "number",
"timeZone": "string",
"createdAt": "object",
"updatedAt": "object",
"countDevices": "number",
"countDevicesDeep": "number",
"countChildren": "number",
"countChildrenDeep": "number",
"currency": "string",
"type": "string",
"groupMap": {
"id": "number",
"height": "number",
"width": "number",
"url": "string",
"createdAt": "object",
"updatedAt": "object"
},
"children": [
{
"organizationId": "string",
"id": "object",
"name": "string",
"path": "string",
"latitude": "number",
"longitude": "number",
"positionType": "string",
"positionY": "number",
"positionX": "number",
"timeZone": "string",
"createdAt": "object"
}
]
}
}
}
}
MeteringStats: object
-
minCurrent:
number[][]
-
maxCurrent:
number[][]
-
averageCurrent:
number[][]
-
minTemperature:
number[][]
-
maxTemperature:
number[][]
-
averageTemperature:
number[][]
-
minVoltage:
number[][]
-
maxVoltage:
number[][]
-
averageVoltage:
number[][]
-
minFrequency:
number[][]
-
maxFrequency:
number[][]
-
averageFrequency:
number[][]
-
minTotalActiveEnergy:
number[][]
-
maxTotalActiveEnergy:
number[][]
-
averageTotalActiveEnergy:
number[][]
-
totalActiveEnergy:
number[][]
-
minPowerFactor:
number[][]
-
maxPowerFactor:
number[][]
-
averagePowerFactor:
number[][]
-
minActivePower:
number[][]
-
maxActivePower:
number[][]
-
averageActivePower:
number[][]
-
totalActivePower:
number[][]
-
minReactivePower:
number[][]
-
maxReactivePower:
number[][]
-
averageReactivePower:
number[][]
-
totalReactivePower:
number[][]
Example
{
"minCurrent": [
[
"number"
]
],
"maxCurrent": [
[
"number"
]
],
"averageCurrent": [
[
"number"
]
],
"minTemperature": [
[
"number"
]
],
"maxTemperature": [
[
"number"
]
],
"averageTemperature": [
[
"number"
]
],
"minVoltage": [
[
"number"
]
],
"maxVoltage": [
[
"number"
]
],
"averageVoltage": [
[
"number"
]
],
"minFrequency": [
[
"number"
]
],
"maxFrequency": [
[
"number"
]
],
"averageFrequency": [
[
"number"
]
],
"minTotalActiveEnergy": [
[
"number"
]
],
"maxTotalActiveEnergy": [
[
"number"
]
],
"averageTotalActiveEnergy": [
[
"number"
]
],
"totalActiveEnergy": [
[
"number"
]
],
"minPowerFactor": [
[
"number"
]
],
"maxPowerFactor": [
[
"number"
]
],
"averagePowerFactor": [
[
"number"
]
],
"minActivePower": [
[
"number"
]
],
"maxActivePower": [
[
"number"
]
],
"averageActivePower": [
[
"number"
]
],
"totalActivePower": [
[
"number"
]
],
"minReactivePower": [
[
"number"
]
],
"maxReactivePower": [
[
null
]
]
}
MeteringStatsKeys: string
Metering Stats Keys
-
objectminCurrent
-
objectmaxCurrent
-
objectaverageCurrent
-
objectminTemperature
-
objectmaxTemperature
-
objectaverageTemperature
-
objectminVoltage
-
objectmaxVoltage
-
objectaverageVoltage
-
objectminFrequency
-
objectmaxFrequency
-
objectaverageFrequency
-
objectminTotalActiveEnergy
-
objectmaxTotalActiveEnergy
-
objectaverageTotalActiveEnergy
-
objecttotalActiveEnergy
-
objectminPowerFactor
-
objectmaxPowerFactor
-
objectaveragePowerFactor
-
objectminActivePower
-
objectmaxActivePower
-
objectaverageActivePower
-
objecttotalActivePower
-
objectminReactivePower
-
objectmaxReactivePower
-
objectaverageReactivePower
-
objecttotalReactivePower
MeteringStatsResponse: object
- status:
- item:
Example
{
"status": "string",
"item": {
"minCurrent": [
[
"number"
]
],
"maxCurrent": [
[
"number"
]
],
"averageCurrent": [
[
"number"
]
],
"minTemperature": [
[
"number"
]
],
"maxTemperature": [
[
"number"
]
],
"averageTemperature": [
[
"number"
]
],
"minVoltage": [
[
"number"
]
],
"maxVoltage": [
[
"number"
]
],
"averageVoltage": [
[
"number"
]
],
"minFrequency": [
[
"number"
]
],
"maxFrequency": [
[
"number"
]
],
"averageFrequency": [
[
"number"
]
],
"minTotalActiveEnergy": [
[
"number"
]
],
"maxTotalActiveEnergy": [
[
"number"
]
],
"averageTotalActiveEnergy": [
[
"number"
]
],
"totalActiveEnergy": [
[
"number"
]
],
"minPowerFactor": [
[
"number"
]
],
"maxPowerFactor": [
[
"number"
]
],
"averagePowerFactor": [
[
"number"
]
],
"minActivePower": [
[
"number"
]
],
"maxActivePower": [
[
"number"
]
],
"averageActivePower": [
[
"number"
]
],
"totalActivePower": [
[
"number"
]
],
"minReactivePower": [
[
null
]
]
}
}
MeteringStatus: object
- signal:
- enabled485:
- pulseOneEnabled:
- pulseTwoEnabled:
- totalActiveEnergyEnabled:
- activePowerEnabled:
- voltageEnabled:
- currentEnabled:
- powerFactorEnabled:
- frequencyEnabled:
- temperature:
- voltage:
- current:
- powerFactor:
- frequency:
- activePower:
- totalActiveEnergy:
- pulseOne:
- pulseTwo:
- errors:
- online:
- receivedAt:
- createdAt:
- updatedAt:
Example
{
"signal": "number",
"enabled485": "boolean",
"pulseOneEnabled": "boolean",
"pulseTwoEnabled": "boolean",
"totalActiveEnergyEnabled": "boolean",
"activePowerEnabled": "boolean",
"voltageEnabled": "boolean",
"currentEnabled": "boolean",
"powerFactorEnabled": "boolean",
"frequencyEnabled": "boolean",
"temperature": "number",
"voltage": "number",
"current": "number",
"powerFactor": "number",
"frequency": "number",
"activePower": "number",
"totalActiveEnergy": "number",
"pulseOne": "number",
"pulseTwo": "number",
"errors": "string",
"online": "boolean",
"receivedAt": "object",
"createdAt": "object",
"updatedAt": "object"
}
MeteringStatusPaginatedResponse: object
- status:
- total:
- page:
Example
{
"status": "string",
"total": "number",
"page": {
"items": [
{
"signal": "number",
"enabled485": "boolean",
"pulseOneEnabled": "boolean",
"pulseTwoEnabled": "boolean",
"totalActiveEnergyEnabled": "boolean",
"activePowerEnabled": "boolean",
"voltageEnabled": "boolean",
"currentEnabled": "boolean",
"powerFactorEnabled": "boolean",
"frequencyEnabled": "boolean",
"temperature": "number",
"voltage": "number",
"current": "number",
"powerFactor": "number",
"frequency": "number",
"activePower": "number",
"totalActiveEnergy": "number",
"pulseOne": "number",
"pulseTwo": "number",
"errors": "string",
"online": "boolean",
"receivedAt": "object",
"createdAt": "object",
"updatedAt": "object"
}
],
"size": "number",
"index": "number"
}
}
MeteringThreePhaseStatus: object
- online:
- energyStatus:
- instantStatus:
Example
{
"online": "boolean",
"energyStatus": {
"enabled485": "boolean",
"pulseOneEnabled": "boolean",
"pulseTwoEnabled": "boolean",
"activeEnergyImpEnabled": "boolean",
"totalActiveEnergyImpEnabled": "boolean",
"activeEnergyExpEnabled": "boolean",
"totalActiveEnergyExpEnabled": "boolean",
"reactiveEnergyImpEnabled": "boolean",
"totalReactiveEnergyImpEnabled": "boolean",
"reactiveEnergyExpEnabled": "boolean",
"totalReactiveEnergyExpEnabled": "boolean",
"temperature": "number",
"activeEnergyImpL1": "number",
"activeEnergyImpL2": "number",
"activeEnergyImpL3": "number",
"activeEnergyImpTotal": "number",
"activeEnergyExpL1": "number",
"activeEnergyExpL2": "number",
"activeEnergyExpL3": "number",
"activeEnergyExpTotal": "number",
"reactiveEnergyImpL1": "number",
"reactiveEnergyImpL2": "number",
"reactiveEnergyImpL3": "number",
"reactiveEnergyImpTotal": "number",
"reactiveEnergyExpL1": "number",
"reactiveEnergyExpL2": "number",
"reactiveEnergyExpL3": "number",
"reactiveEnergyExpTotal": "number",
"pulseOne": "number",
"pulseTwo": "number",
"signal": "number",
"online": "boolean",
"errors": "string",
"receivedAt": "object",
"createdAt": "object",
"updatedAt": "object"
},
"instantStatus": {
"activePowerEnabled": "boolean",
"totalActivePowerEnabled": "boolean",
"reactivePowerEnabled": "boolean",
"totalReactivePowerEnabled": "boolean",
"voltageEnabled": "boolean",
"ptpVoltageEnabled": "boolean",
"currentEnabled": "boolean",
"powerFactorEnabled": "boolean",
"powerFactorTotalEnabled": "boolean",
"apparentPowerEnabled": "boolean"
}
}
MeteringUK1Status: object
- signal:
- energyConsumption:
- heatEnergy:
- coolingEnergy:
- volume:
- power:
- flow:
- forwardTemperature:
- returnTemperature:
- meterId:
- errors:
- online:
- receivedAt:
- createdAt:
- updatedAt:
Example
{
"signal": "number",
"energyConsumption": "number",
"heatEnergy": "number",
"coolingEnergy": "number",
"volume": "number",
"power": "number",
"flow": "number",
"forwardTemperature": "number",
"returnTemperature": "number",
"meterId": "number",
"errors": "string",
"online": "boolean",
"receivedAt": "object",
"createdAt": "object",
"updatedAt": "object"
}
MeteringUK1StatusPaginatedResponse: object
- status:
- total:
- page:
Example
{
"status": "string",
"total": "number",
"page": {
"items": [
{
"signal": "number",
"energyConsumption": "number",
"heatEnergy": "number",
"coolingEnergy": "number",
"volume": "number",
"power": "number",
"flow": "number",
"forwardTemperature": "number",
"returnTemperature": "number",
"meterId": "number",
"errors": "string",
"online": "boolean",
"receivedAt": "object",
"createdAt": "object",
"updatedAt": "object"
}
],
"size": "number",
"index": "number"
}
}
MqttMeteringProtocol: object
- productManufacturer:
- productSupplier:
- productModel:
- error:
- timestamp:
- battery:
- signalLevel:
- electricVoltageL1:
- electricVoltageL2:
- electricVoltageL3:
- electricVoltageL12:
- electricVoltageL23:
- electricVoltageL31:
- electricCurrentL1:
- electricCurrentL2:
- electricCurrentL3:
- electricFrequency:
- electricPowerFactorL1:
- electricPowerFactorL2:
- electricPowerFactorL3:
- electricTotalPowerFactor:
- electricActivePowerL1:
- electricActivePowerL2:
- electricActivePowerL3:
- electricTotalActivePower:
- electricReactivePowerL1:
- electricReactivePowerL2:
- electricReactivePowerL3:
- electricTotalReactivePower:
- electricApparentPowerL1:
- electricApparentPowerL2:
- electricApparentPowerL3:
- electricTotalApparentPower:
- electricActiveEnergyImpL1:
- electricActiveEnergyImpL2:
- electricActiveEnergyImpL3:
- electricTotalActiveEnergyImp:
- electricActiveEnergyExpL1:
- electricActiveEnergyExpL2:
- electricActiveEnergyExpL3:
- electricTotalActiveEnergyExp:
- electricReactiveEnergyImpL1:
- electricReactiveEnergyImpL2:
- electricReactiveEnergyImpL3:
- electricTotalReactiveEnergyImp:
- electricReactiveEnergyExpL1:
- electricReactiveEnergyExpL2:
- electricReactiveEnergyExpL3:
- electricTotalReactiveEnergyExp:
- totalGasVolume:
- totalWaterVolume:
- totalThermalEnergy:
- thermalPower:
- thermalVolume:
- thermalFlow:
- thermalFwTemp:
- thermalRtTemp:
Example
{
"productManufacturer": {
"required": "boolean",
"multiplier": "number",
"unitOfMeasure": "string",
"path": "string"
},
"productSupplier": {
"required": "boolean",
"multiplier": "number",
"unitOfMeasure": "string",
"path": "string"
},
"productModel": {
"required": "boolean",
"multiplier": "number",
"unitOfMeasure": "string",
"path": "string"
},
"error": {
"required": "boolean",
"multiplier": "number",
"unitOfMeasure": "string",
"path": "string"
},
"timestamp": {
"required": "boolean",
"multiplier": "number",
"unitOfMeasure": "string",
"path": "string"
},
"battery": {
"required": "boolean",
"multiplier": "number",
"unitOfMeasure": "string",
"path": "string"
},
"signalLevel": {
"required": "boolean",
"multiplier": "number",
"unitOfMeasure": "string",
"path": "string"
},
"electricVoltageL1": {
"required": "boolean",
"multiplier": "number",
"unitOfMeasure": "string",
"path": "string"
},
"electricVoltageL2": {
"required": "boolean",
"multiplier": "number",
"unitOfMeasure": "string",
"path": "string"
},
"electricVoltageL3": {
"required": "boolean",
"multiplier": "number",
"unitOfMeasure": "string"
}
}
MqttMeteringProtocolInput: object
- productManufacturer:
- productSupplier:
- productModel:
- error:
- timestamp:
- battery:
- signalLevel:
- electricVoltageL1:
- electricVoltageL2:
- electricVoltageL3:
- electricVoltageL12:
- electricVoltageL23:
- electricVoltageL31:
- electricCurrentL1:
- electricCurrentL2:
- electricCurrentL3:
- electricFrequency:
- electricPowerFactorL1:
- electricPowerFactorL2:
- electricPowerFactorL3:
- electricTotalPowerFactor:
- electricActivePowerL1:
- electricActivePowerL2:
- electricActivePowerL3:
- electricTotalActivePower:
- electricReactivePowerL1:
- electricReactivePowerL2:
- electricReactivePowerL3:
- electricTotalReactivePower:
- electricApparentPowerL1:
- electricApparentPowerL2:
- electricApparentPowerL3:
- electricTotalApparentPower:
- electricActiveEnergyImpL1:
- electricActiveEnergyImpL2:
- electricActiveEnergyImpL3:
- electricTotalActiveEnergyImp:
- electricActiveEnergyExpL1:
- electricActiveEnergyExpL2:
- electricActiveEnergyExpL3:
- electricTotalActiveEnergyExp:
- electricReactiveEnergyImpL1:
- electricReactiveEnergyImpL2:
- electricReactiveEnergyImpL3:
- electricTotalReactiveEnergyImp:
- electricReactiveEnergyExpL1:
- electricReactiveEnergyExpL2:
- electricReactiveEnergyExpL3:
- electricTotalReactiveEnergyExp:
- totalGasVolume:
- totalWaterVolume:
- totalThermalEnergy:
- thermalPower:
- thermalVolume:
- thermalFlow:
- thermalFwTemp:
- thermalRtTemp:
Example
{
"productManufacturer": {
"required": "boolean",
"multiplier": "number",
"unitOfMeasure": "string",
"path": "string"
},
"productSupplier": {
"required": "boolean",
"multiplier": "number",
"unitOfMeasure": "string",
"path": "string"
},
"productModel": {
"required": "boolean",
"multiplier": "number",
"unitOfMeasure": "string",
"path": "string"
},
"error": {
"required": "boolean",
"multiplier": "number",
"unitOfMeasure": "string",
"path": "string"
},
"timestamp": {
"required": "boolean",
"multiplier": "number",
"unitOfMeasure": "string",
"path": "string"
},
"battery": {
"required": "boolean",
"multiplier": "number",
"unitOfMeasure": "string",
"path": "string"
},
"signalLevel": {
"required": "boolean",
"multiplier": "number",
"unitOfMeasure": "string",
"path": "string"
},
"electricVoltageL1": {
"required": "boolean",
"multiplier": "number",
"unitOfMeasure": "string",
"path": "string"
},
"electricVoltageL2": {
"required": "boolean",
"multiplier": "number",
"unitOfMeasure": "string",
"path": "string"
},
"electricVoltageL3": {
"required": "boolean",
"multiplier": "number",
"unitOfMeasure": "string"
}
}
MqttPLCOPCAUOpcuVarField: object
- required:
- path:
- isArray:
- itemProtocol:
Example
{
"required": "boolean",
"path": "string",
"isArray": "boolean",
"itemProtocol": {
"identifier": {
"required": "boolean",
"path": "string"
},
"identifierType": {
"required": "boolean",
"path": "string"
},
"namespaceIdentifier": {
"required": "boolean",
"path": "string"
},
"variableType": {
"required": "boolean",
"path": "string"
},
"variableDirection": {
"required": "boolean",
"path": "string"
},
"variableLabel": {
"required": "boolean",
"path": "string"
},
"variableUnit": {
"required": "boolean",
"path": "string"
},
"scaleFactor": {
"required": "boolean",
"path": "string"
},
"scaledVariableUnit": {
"required": "boolean",
"path": "string"
},
"variableCurrentValue": {
"required": "boolean",
"path": "string"
},
"error": {
"required": "boolean",
"path": "string"
}
}
}
MqttPLCOPCUAVarsFieldInput: object
- required:
- path:
- isArray:
- itemProtocol:
Example
{
"required": "boolean",
"path": "string",
"isArray": "boolean",
"itemProtocol": {
"identifier": {
"required": "boolean",
"path": "string"
},
"identifierType": {
"required": "boolean",
"path": "string"
},
"namespaceIdentifier": {
"required": "boolean",
"path": "string"
},
"variableType": {
"required": "boolean",
"path": "string"
},
"variableDirection": {
"required": "boolean",
"path": "string"
},
"variableLabel": {
"required": "boolean",
"path": "string"
},
"variableUnit": {
"required": "boolean",
"path": "string"
},
"scaleFactor": {
"required": "boolean",
"path": "string"
},
"scaledVariableUnit": {
"required": "boolean",
"path": "string"
},
"variableCurrentValue": {
"required": "boolean",
"path": "string"
},
"error": {
"required": "boolean",
"path": "string"
}
}
}
MqttParams: object
- id:
- version:
-
protocol:
object
- createdAt:
- updatedAt:
Example
{
"id": "number",
"version": "string",
"createdAt": "object",
"updatedAt": "object"
}
NotificationPageResponse: object
- status:
- total:
- page:
Example
{
"status": "string",
"total": "number",
"page": {
"items": [
{
"id": "number",
"operationId": "number",
"notificationType": "string",
"detectionDate": "object",
"deviceSerial": "string",
"organizationId": "string",
"deviceName": "string",
"deviceTypeName": "string",
"deviceGroupId": "string",
"deviceGroupName": "string",
"latestDeviceStatus": "string",
"latestDeviceStatusMessage": "string",
"lastStatusUpdateDate": "object",
"deviceMaxLifetimeHours": "number",
"deviceRemainingLifetimeHours": "number"
}
],
"size": "number",
"index": "number"
}
}
OperationFormHistoryPageResponse: object
- status:
- total:
- page:
Example
{
"status": "string",
"total": "number",
"page": {
"items": [
{
"id": "string",
"userId": "string",
"userFirstName": "string",
"userLastName": "string",
"operationId": "number",
"action": "string",
"formId": "number",
"formName": "string",
"timestamp": "object",
"configurationJson": "object",
"responsesJson": "object"
}
],
"size": "number",
"index": "number"
}
}
OperationFormHistoryResponse: object
- status:
- item:
Example
{
"status": "string",
"item": {
"id": "string",
"userId": "string",
"userFirstName": "string",
"userLastName": "string",
"operationId": "number",
"action": "string",
"formId": "number",
"formName": "string",
"timestamp": "object",
"configurationJson": "object",
"responsesJson": "object"
}
}
OperationLinkedItemsResponse: object
- status:
- item:
Example
{
"status": "string",
"item": {
"operationId": "number",
"notifications": [
{
"id": "number",
"operationId": "number",
"notificationType": "string",
"detectionDate": "object",
"deviceSerial": "string",
"organizationId": "string",
"deviceName": "string",
"deviceTypeName": "string",
"deviceGroupId": "string",
"deviceGroupName": "string",
"latestDeviceStatus": "string",
"latestDeviceStatusMessage": "string",
"lastStatusUpdateDate": "object",
"deviceMaxLifetimeHours": "number",
"deviceRemainingLifetimeHours": "number"
}
],
"devices": [
{
"id": "object",
"organizationId": "string",
"deviceHash": "string",
"serial": "string",
"name": "string",
"supplier": "string",
"tag": "string",
"latitude": "number",
"longitude": "number",
"positionType": "string",
"positionY": "number",
"positionX": "number",
"timeZone": "string",
"networkType": "string",
"loraParams": {
"id": "number",
"deviceEUI": "string",
"applicationEUI": "string",
"joinEUI": "string",
"version": "string",
"loraClass": "string",
"regionalParametersRevision": "string",
"region": "string",
"activationType": "string",
"createdAt": "object",
"updatedAt": "object"
},
"mqttParams": {
"id": "number"
}
}
]
}
}
OperationResponse: object
- status:
- item:
Example
{
"status": "string",
"item": {
"id": "number",
"name": "string",
"organizationId": "object",
"groupId": "object",
"groupName": "string",
"categoryId": "number",
"status": "string",
"lastStatusUpdateDate": "object",
"managerEmails": [
"string"
],
"managerEmailSent": "boolean",
"maintainerEmails": [
"string"
],
"maintainerEmailSent": "boolean",
"scheduledDate": "object",
"description": "string",
"createdAt": "object",
"updatedAt": "object",
"category": {
"id": "number",
"color": "string",
"name": "string"
},
"expectedCost": {
"id": "number",
"operationId": "number",
"value": "number",
"currency": "string"
},
"repetitionPattern": "string",
"repetitionOffset": "number",
"numberOfRepetition": "number",
"repetitionEndDate": "object",
"externalData": "object",
"form": {
"id": "number",
"operationId": "number",
"name": "string",
"configurationJson": "object",
"responsesJson": "object",
"editedBy": {
"id": "object",
"name": "string",
"lastName": "string",
"email": "string",
"gender": "string",
"phoneNumber": "string",
"avatar": "string",
"confirmedAt": "object",
"createdAt": "object"
}
}
}
}
OperationsCategoryArrayResponse: object
- status:
- items:
Example
{
"status": "string",
"items": [
{
"id": "number",
"color": "string",
"name": "string"
}
]
}
OperationsPageResponse: object
- status:
- total:
- page:
Example
{
"status": "string",
"total": "number",
"page": {
"items": [
{
"id": "number",
"name": "string",
"organizationId": "object",
"groupId": "object",
"groupName": "string",
"categoryId": "number",
"status": "string",
"lastStatusUpdateDate": "object",
"managerEmails": [
"string"
],
"managerEmailSent": "boolean",
"maintainerEmails": [
"string"
],
"maintainerEmailSent": "boolean",
"scheduledDate": "object",
"description": "string",
"createdAt": "object",
"updatedAt": "object",
"category": {
"id": "number",
"color": "string",
"name": "string"
},
"expectedCost": {
"id": "number",
"operationId": "number",
"value": "number",
"currency": "string"
},
"repetitionPattern": "string",
"repetitionOffset": "number",
"numberOfRepetition": "number",
"repetitionEndDate": "object",
"externalData": "object",
"form": {
"id": "number",
"operationId": "number",
"name": "string",
"configurationJson": "object",
"responsesJson": "object",
"editedBy": {
"id": "object",
"name": "string",
"lastName": "string",
"email": "string",
"gender": "string",
"phoneNumber": "string",
"avatar": "string"
}
}
}
]
}
}
Organization: object
- id:
- name:
- address:
- contactNumber:
- contactEmail:
- vatNumber:
- website:
- licenceType:
- expirationDate:
- maximumDevices:
- image:
- policy:
- createdBy:
- updatedBy:
- createdAt:
- updatedAt:
- global:
Example
{
"id": "object",
"name": "string",
"address": "string",
"contactNumber": "string",
"contactEmail": "string",
"vatNumber": "string",
"website": "string",
"licenceType": "string",
"expirationDate": "object",
"maximumDevices": "number",
"image": {
"path": "string",
"filename": "string",
"url": "string",
"contentType": "string",
"size": "number"
},
"policy": {
"licenceModules": [
"string"
],
"licenceAccess": [
"string"
]
},
"createdBy": {
"id": "object",
"name": "string",
"lastName": "string",
"email": "string",
"gender": "string",
"phoneNumber": "string",
"avatar": "string",
"confirmedAt": "object",
"createdAt": "object",
"updatedAt": "object",
"lastAccess": "object",
"createdBy": {
"id": "object",
"name": "string",
"lastName": "string",
"email": "string",
"gender": "string",
"phoneNumber": "string",
"avatar": "string",
"confirmedAt": "object",
"createdAt": "object",
"updatedAt": "object",
"lastAccess": "object",
"createdBy": {
"id": "object",
"name": "string",
"lastName": "string",
"email": "string"
}
}
}
}
OrganizationAllowedSortingFields: string
Organization allowed sorting fields
-
objectname
-
objectid
-
objectcreatedAt
-
objectupdatedAt
OrganizationGeneralPermissions: string
Organization General Permissions Types
-
objectEditOrganization
-
objectAssignRemoveLicense
-
objectAssignRemoveModule
-
objectAssignRemoveAccess
-
objectCreateOrganizationRole
-
objectUpdateOrganizationRole
-
objectRemoveOrganizationRole
-
objectAssignRemoveUser
-
objectUpdateUserStatus
-
objectAssignRemoveUserModule
-
objectAssignRemoveUserAccess
-
objectAssignRemoveUserLicenceType
-
objectManageOrganizationGroup
-
objectManageUserPermission
-
objectSuperDeviceCommandPermission
-
objectManageNetworkConnectors
OrganizationPaginatedResponse: object
- status:
- total:
- page:
Example
{
"status": "string",
"total": "number",
"page": {
"items": [
{
"id": "object",
"name": "string",
"address": "string",
"contactNumber": "string",
"contactEmail": "string",
"vatNumber": "string",
"website": "string",
"licenceType": "string",
"expirationDate": "object",
"maximumDevices": "number",
"image": {
"path": "string",
"filename": "string",
"url": "string",
"contentType": "string",
"size": "number"
},
"policy": {
"licenceModules": [
"string"
],
"licenceAccess": [
"string"
]
},
"createdBy": {
"id": "object",
"name": "string",
"lastName": "string",
"email": "string",
"gender": "string",
"phoneNumber": "string",
"avatar": "string",
"confirmedAt": "object",
"createdAt": "object",
"updatedAt": "object",
"lastAccess": "object",
"createdBy": {
"id": "object",
"name": "string",
"lastName": "string",
"email": "string",
"gender": "string",
"phoneNumber": "string",
"avatar": "string",
"confirmedAt": "object",
"createdAt": "object",
"updatedAt": "object",
"lastAccess": "object",
"createdBy": {}
}
}
}
]
}
}
OrganizationPolicy: object
- licenceModules:
- licenceAccess:
Example
{
"licenceModules": [
"string"
],
"licenceAccess": [
"string"
]
}
OrganizationPolicyInput: object
- licenceModules:
- licenceAccess:
Example
{
"licenceModules": [
"string"
],
"licenceAccess": [
"string"
]
}
OrganizationPolicyResponse: object
- status:
- item:
Example
{
"status": "string",
"item": {
"licenceModules": [
"string"
],
"licenceAccess": [
"string"
]
}
}
OrganizationResponse: object
- status:
- item:
Example
{
"status": "string",
"item": {
"id": "object",
"name": "string",
"address": "string",
"contactNumber": "string",
"contactEmail": "string",
"vatNumber": "string",
"website": "string",
"licenceType": "string",
"expirationDate": "object",
"maximumDevices": "number",
"image": {
"path": "string",
"filename": "string",
"url": "string",
"contentType": "string",
"size": "number"
},
"policy": {
"licenceModules": [
"string"
],
"licenceAccess": [
"string"
]
},
"createdBy": {
"id": "object",
"name": "string",
"lastName": "string",
"email": "string",
"gender": "string",
"phoneNumber": "string",
"avatar": "string",
"confirmedAt": "object",
"createdAt": "object",
"updatedAt": "object",
"lastAccess": "object",
"createdBy": {
"id": "object",
"name": "string",
"lastName": "string",
"email": "string",
"gender": "string",
"phoneNumber": "string",
"avatar": "string",
"confirmedAt": "object",
"createdAt": "object",
"updatedAt": "object",
"lastAccess": "object",
"createdBy": {
"id": "object",
"name": "string"
}
}
}
}
}
OrganizationRole: object
- id:
- name:
- userCount:
- createdBy:
- updatedBy:
- createdAt:
- updatedAt:
- permissions:
Example
{
"id": "object",
"name": "string",
"userCount": "number",
"createdBy": {
"id": "object",
"name": "string",
"lastName": "string",
"email": "string",
"gender": "string",
"phoneNumber": "string",
"avatar": "string",
"confirmedAt": "object",
"createdAt": "object",
"updatedAt": "object",
"lastAccess": "object",
"createdBy": {
"id": "object",
"name": "string",
"lastName": "string",
"email": "string",
"gender": "string",
"phoneNumber": "string",
"avatar": "string",
"confirmedAt": "object",
"createdAt": "object",
"updatedAt": "object",
"lastAccess": "object",
"createdBy": {
"id": "object",
"name": "string",
"lastName": "string",
"email": "string",
"gender": "string",
"phoneNumber": "string",
"avatar": "string",
"confirmedAt": "object",
"createdAt": "object",
"updatedAt": "object",
"lastAccess": "object",
"createdBy": {
"id": "object",
"name": "string",
"lastName": "string",
"email": "string",
"gender": "string",
"phoneNumber": "string",
"avatar": "string",
"confirmedAt": "object",
"createdAt": "object"
}
}
}
}
}
OrganizationRoleAllowedSortingFields: string
Organization role allowed sorting fields
-
objectname
-
objectcreatedAt
-
objectupdatedAt
OrganizationRolePaginatedResponse: object
- status:
- total:
- page:
Example
{
"status": "string",
"total": "number",
"page": {
"items": [
{
"id": "object",
"name": "string",
"userCount": "number",
"createdBy": {
"id": "object",
"name": "string",
"lastName": "string",
"email": "string",
"gender": "string",
"phoneNumber": "string",
"avatar": "string",
"confirmedAt": "object",
"createdAt": "object",
"updatedAt": "object",
"lastAccess": "object",
"createdBy": {
"id": "object",
"name": "string",
"lastName": "string",
"email": "string",
"gender": "string",
"phoneNumber": "string",
"avatar": "string",
"confirmedAt": "object",
"createdAt": "object",
"updatedAt": "object",
"lastAccess": "object",
"createdBy": {
"id": "object",
"name": "string",
"lastName": "string",
"email": "string",
"gender": "string",
"phoneNumber": "string",
"avatar": "string",
"confirmedAt": "object",
"createdAt": "object",
"updatedAt": "object",
"lastAccess": "object",
"createdBy": {
"id": "object",
"name": "string",
"lastName": "string",
"email": "string",
"gender": "string"
}
}
}
}
}
]
}
}
OrganizationRolePermission: object
- generalPermissionId:
- generalPermissionCode:
Example
{
"generalPermissionId": "number",
"generalPermissionCode": "string"
}
OrganizationRoleResponse: object
- status:
- item:
Example
{
"status": "string",
"item": {
"id": "object",
"name": "string",
"userCount": "number",
"createdBy": {
"id": "object",
"name": "string",
"lastName": "string",
"email": "string",
"gender": "string",
"phoneNumber": "string",
"avatar": "string",
"confirmedAt": "object",
"createdAt": "object",
"updatedAt": "object",
"lastAccess": "object",
"createdBy": {
"id": "object",
"name": "string",
"lastName": "string",
"email": "string",
"gender": "string",
"phoneNumber": "string",
"avatar": "string",
"confirmedAt": "object",
"createdAt": "object",
"updatedAt": "object",
"lastAccess": "object",
"createdBy": {
"id": "object",
"name": "string",
"lastName": "string",
"email": "string",
"gender": "string",
"phoneNumber": "string",
"avatar": "string",
"confirmedAt": "object",
"createdAt": "object",
"updatedAt": "object",
"lastAccess": "object",
"createdBy": {
"id": "object",
"name": "string",
"lastName": "string",
"email": "string",
"gender": "string",
"phoneNumber": "string",
"avatar": "string"
}
}
}
}
}
}
OrganizationUser: object
- id:
- organizationRoleId:
- organizationId:
- status:
- licenceType:
- activeModules:
- activeAccess:
- lastAccess:
- user:
- organizationRole:
- createdBy:
- updatedBy:
- createdAt:
- updatedAt:
- accessPolicy:
- organization:
Example
{
"id": "object",
"organizationRoleId": "string",
"organizationId": "string",
"status": "string",
"licenceType": "string",
"activeModules": [
"string"
],
"activeAccess": [
"string"
],
"lastAccess": "object",
"user": {
"id": "object",
"name": "string",
"lastName": "string",
"email": "string",
"gender": "string",
"phoneNumber": "string",
"avatar": "string",
"confirmedAt": "object",
"createdAt": "object",
"updatedAt": "object",
"lastAccess": "object",
"createdBy": {
"id": "object",
"name": "string",
"lastName": "string",
"email": "string",
"gender": "string",
"phoneNumber": "string",
"avatar": "string",
"confirmedAt": "object",
"createdAt": "object",
"updatedAt": "object",
"lastAccess": "object",
"createdBy": {
"id": "object",
"name": "string",
"lastName": "string",
"email": "string",
"gender": "string",
"phoneNumber": "string",
"avatar": "string",
"confirmedAt": "object",
"createdAt": "object",
"updatedAt": "object",
"lastAccess": "object",
"createdBy": {
"id": "object",
"name": "string",
"lastName": "string"
}
}
}
}
}
OrganizationUserAccessPolicy: object
- id:
- userId:
- licence:
- organizationPermission:
- platformPermission:
- groupAccessPolicies:
- globalOrganizationUser:
Example
{
"id": "string",
"userId": "string",
"licence": {
"type": "string",
"activeModules": [
"string"
],
"access": [
"string"
]
},
"organizationPermission": [
"string"
],
"platformPermission": [
"string"
],
"groupAccessPolicies": [
{
"groupId": "string",
"groupPermission": [
"string"
]
}
],
"globalOrganizationUser": "boolean"
}
OrganizationUserAllowedSortingFields: string
Organization user allowed sorting fields
-
objectlastName
-
objectname
-
objectemail
-
objectrole
-
objectlastAccess
OrganizationUserListItem: object
- id:
- name:
- lastName:
- email:
- avatar:
- status:
- roleName:
- organizationName:
- lastAccess:
- organizationLastAccess:
Example
{
"id": "object",
"name": "string",
"lastName": "string",
"email": "string",
"avatar": "string",
"status": "string",
"roleName": "string",
"organizationName": "string",
"lastAccess": "object",
"organizationLastAccess": "object"
}
OrganizationUserPaginatedResponse: object
- status:
- total:
- page:
Example
{
"status": "string",
"total": "number",
"page": {
"items": [
{
"id": "object",
"name": "string",
"lastName": "string",
"email": "string",
"avatar": "string",
"status": "string",
"roleName": "string",
"organizationName": "string",
"lastAccess": "object",
"organizationLastAccess": "object"
}
],
"size": "number",
"index": "number"
}
}
OrganizationUserResponse: object
- status:
- item:
Example
{
"status": "string",
"item": {
"id": "object",
"organizationRoleId": "string",
"organizationId": "string",
"status": "string",
"licenceType": "string",
"activeModules": [
"string"
],
"activeAccess": [
"string"
],
"lastAccess": "object",
"user": {
"id": "object",
"name": "string",
"lastName": "string",
"email": "string",
"gender": "string",
"phoneNumber": "string",
"avatar": "string",
"confirmedAt": "object",
"createdAt": "object",
"updatedAt": "object",
"lastAccess": "object",
"createdBy": {
"id": "object",
"name": "string",
"lastName": "string",
"email": "string",
"gender": "string",
"phoneNumber": "string",
"avatar": "string",
"confirmedAt": "object",
"createdAt": "object",
"updatedAt": "object",
"lastAccess": "object",
"createdBy": {
"id": "object",
"name": "string",
"lastName": "string",
"email": "string",
"gender": "string",
"phoneNumber": "string",
"avatar": "string",
"confirmedAt": "object",
"createdAt": "object",
"updatedAt": "object",
"lastAccess": "object",
"createdBy": {
"id": "object"
}
}
}
}
}
}
OrganizationsRoleSortingConditionInput: object
- field:
- order:
Example
{
"field": "string",
"order": "string"
}
OrganizationsSortingConditionInput: object
- field:
- order:
Example
{
"field": "string",
"order": "string"
}
OrganizationsUserSortingConditionInput: object
- field:
- order:
Example
{
"field": "string",
"order": "string"
}
PageAutomationDigitalInputStatusResponse: object
- items:
- size:
- index:
Example
{
"items": [
{
"signal": "number",
"online": "boolean",
"createdAt": "object",
"updatedAt": "object",
"receivedAt": "object",
"digitalInputOne": "boolean",
"digitalInputTwo": "boolean"
}
],
"size": "number",
"index": "number"
}
PageAutomationDigitalOutputStatusResponse: object
- items:
- size:
- index:
Example
{
"items": [
{
"signal": "number",
"online": "boolean",
"createdAt": "object",
"updatedAt": "object",
"receivedAt": "object",
"digitalOutputOne": "boolean",
"digitalOutputTwo": "boolean"
}
],
"size": "number",
"index": "number"
}
PageAutomationIO02ControlStatusResponse: object
- items:
- size:
- index:
Example
{
"items": [
{
"key": "number",
"label": "string",
"value": "boolean",
"receivedAt": "object",
"online": "boolean"
}
],
"size": "number",
"index": "number"
}
PageAutomationIO02DigitalDataResponse: object
- items:
- size:
- index:
Example
{
"items": [
{
"inputCountersType1": {
"measure": "number",
"counter": "number"
},
"frequencyMeter": {
"measure": "number",
"date": "object",
"frequency": "number"
},
"inputCountersType2": {
"measures": [
{
"measure": "number",
"counter": "number",
"date": "object"
}
]
},
"outputCounter": "number",
"receivedAt": "object"
}
],
"size": "number",
"index": "number"
}
PageAutomationIO02StatusResponse: object
- items:
- size:
- index:
Example
{
"items": [
{
"signal": "number",
"online": "boolean",
"createdAt": "object",
"updatedAt": "object",
"receivedAt": "object",
"input": [
{
"key": "number",
"label": "string",
"value": "boolean"
}
],
"output": [
{
"key": "number",
"label": "string",
"value": "boolean"
}
]
}
],
"size": "number",
"index": "number"
}
PageAutomationLoadCellStatusResponse: object
- items:
- size:
- index:
Example
{
"items": [
{
"signal": "number",
"weight": "number",
"batteryPercentage": "number",
"timeShift": "number",
"receivedAt": "object",
"online": "boolean"
}
],
"size": "number",
"index": "number"
}
PageAutomationPC01StatusResponse: object
- items:
- size:
- index:
Example
{
"items": [
{
"signal": "number",
"leftToRight": "number",
"rightToLeft": "number",
"createdAt": "object",
"updatedAt": "object",
"receivedAt": "object",
"online": "boolean"
}
],
"size": "number",
"index": "number"
}
PageAutomationPC02StatusResponse: object
- items:
- size:
- index:
Example
{
"items": [
{
"signal": "number",
"totalCounterIn": "number",
"totalCounterOut": "number",
"createdAt": "object",
"updatedAt": "object",
"receivedAt": "object",
"online": "boolean"
}
],
"size": "number",
"index": "number"
}
PageAutomationPLCOPCUAStatusResponse: object
- items:
- size:
- index:
Example
{
"items": [
{
"signal": "number",
"serialNo": "string",
"connectionType": "string",
"plcAddress": "string",
"opcuaVars": [
{
"identifier": "string",
"identifierType": "string",
"namespaceIdentifier": "number",
"variableType": "string",
"variableDirection": "string",
"variableLabel": "string",
"variableUnit": "string",
"scaleFactor": "number",
"scaledVariableUnit": "string",
"variableCurrentValue": "string",
"error": "string"
}
],
"createdAt": "object",
"updatedAt": "object",
"receivedAt": "object",
"online": "boolean"
}
],
"size": "number",
"index": "number"
}
PageAutomationPeopleCounterCameraStatusResponse: object
- items:
- size:
- index:
Example
{
"items": [
{
"signal": "number",
"in": "number",
"out": "number",
"totalPeople": "number",
"totalRegion": "number",
"maxPeople": "number",
"regionPeopleCount": [
{
"region": "number",
"people": "number"
}
],
"regionPeoples": "number",
"createdAt": "object",
"updatedAt": "object",
"receivedAt": "object",
"online": "boolean"
}
],
"size": "number",
"index": "number"
}
PageAutomationRakSmartButtonStatusResponse: object
- items:
- size:
- index:
Example
{
"items": [
{
"signal": "number",
"buttonOne": "number",
"buttonTwo": "number",
"buttonThree": "number",
"buttonFour": "number",
"lastPressedAt": {
"buttonOneLastPressedAt": "object",
"buttonTwoLastPressedAt": "object",
"buttonThreeLastPressedAt": "object",
"buttonFourLastPressedAt": "object"
},
"createdAt": "object",
"updatedAt": "object",
"receivedAt": "object",
"online": "boolean"
}
],
"size": "number",
"index": "number"
}
PageAutomationST02StatusResponse: object
- items:
- size:
- index:
Example
{
"items": [
{
"signal": "number",
"tamper": "boolean",
"process": "boolean",
"battery": "number",
"fraud": "boolean",
"hygrometry": "number",
"temperature": "number",
"di_0": "boolean",
"di_1": "boolean",
"power": "boolean",
"valve": "boolean",
"class": "string",
"cable": "boolean",
"leakage": "boolean",
"receivedAt": "object",
"online": "boolean"
}
],
"size": "number",
"index": "number"
}
PageAutomationST03StatusResponse: object
- items:
- size:
- index:
Example
{
"items": [
{
"signal": "number",
"tamper": "boolean",
"process": "boolean",
"battery": "number",
"fraud": "boolean",
"hygrometry": "number",
"temperature": "number",
"di_0": "boolean",
"di_1": "boolean",
"power": "boolean",
"valve": "boolean",
"class": "string",
"cable": "boolean",
"leakage": "boolean",
"receivedAt": "object",
"online": "boolean"
}
],
"size": "number",
"index": "number"
}
PageAutomationTrafficCounterSensorStatusResponse: object
- items:
- size:
- index:
Example
{
"items": [
{
"signal": "number",
"batteryVoltage": "number",
"solarPanelPower": "number",
"temperature": "number",
"leftSpeedClass0ObjectCount": "number",
"leftSpeedClass0AvgSpeed": "number",
"rightSpeedClass0ObjectCount": "number",
"rightSpeedClass0AvgSpeed": "number",
"leftSpeedClass1ObjectCount": "number",
"leftSpeedClass1AvgSpeed": "number",
"rightSpeedClass1ObjectCount": "number",
"rightSpeedClass1AvgSpeed": "number",
"leftSpeedClass2ObjectCount": "number",
"leftSpeedClass2AvgSpeed": "number",
"rightSpeedClass2ObjectCount": "number",
"rightSpeedClass2AvgSpeed": "number",
"leftSpeedClass3ObjectCount": "number",
"leftSpeedClass3AvgSpeed": "number",
"rightSpeedClass3ObjectCount": "number",
"rightSpeedClass3AvgSpeed": "number",
"createdAt": "object",
"updatedAt": "object",
"receivedAt": "object",
"online": "boolean"
}
],
"size": "number",
"index": "number"
}
PageCommandScheduleResponse: object
- items:
- size:
- index:
Example
{
"items": [
{
"id": "number",
"name": "string",
"description": "string",
"groupId": "object",
"group": {
"organizationId": "string",
"id": "object",
"name": "string",
"path": "string",
"latitude": "number",
"longitude": "number",
"positionType": "string",
"positionY": "number",
"positionX": "number",
"timeZone": "string",
"createdAt": "object",
"updatedAt": "object",
"countDevices": "number",
"countDevicesDeep": "number",
"countChildren": "number",
"countChildrenDeep": "number",
"currency": "string",
"type": "string",
"groupMap": {
"id": "number",
"height": "number",
"width": "number",
"url": "string",
"createdAt": "object",
"updatedAt": "object"
},
"children": [
{
"organizationId": "string",
"id": "object",
"name": "string",
"path": "string",
"latitude": "number",
"longitude": "number",
"positionType": "string",
"positionY": "number",
"positionX": "number",
"timeZone": "string",
"createdAt": "object",
"updatedAt": "object",
"countDevices": "number",
"countDevicesDeep": "number",
"countChildren": "number",
"countChildrenDeep": "number"
}
]
}
}
]
}
PageConnectorUserResponse: object
- items:
- size:
- index:
Example
{
"items": [
{
"id": "string",
"name": "string",
"connectorClients": "number",
"accessType": "string",
"removable": "boolean"
}
],
"size": "number",
"index": "number"
}
PageControlResponse: object
Example
{
"items": [
{
"id": "object",
"title": "string",
"columns": "number",
"groupId": "string",
"group": {
"organizationId": "string",
"id": "object",
"name": "string",
"path": "string",
"latitude": "number",
"longitude": "number",
"positionType": "string",
"positionY": "number",
"positionX": "number",
"timeZone": "string",
"createdAt": "object",
"updatedAt": "object",
"countDevices": "number",
"countDevicesDeep": "number",
"countChildren": "number",
"countChildrenDeep": "number",
"currency": "string",
"type": "string",
"groupMap": {
"id": "number",
"height": "number",
"width": "number",
"url": "string",
"createdAt": "object",
"updatedAt": "object"
},
"children": [
{
"organizationId": "string",
"id": "object",
"name": "string",
"path": "string",
"latitude": "number",
"longitude": "number",
"positionType": "string",
"positionY": "number",
"positionX": "number",
"timeZone": "string",
"createdAt": "object",
"updatedAt": "object",
"countDevices": "number",
"countDevicesDeep": "number",
"countChildren": "number",
"countChildrenDeep": "number"
}
]
}
}
]
}
PageDeviceCommandHistoryResponse: object
- items:
- size:
- index:
Example
{
"items": [
{
"deviceSerial": "string",
"organizationId": "string",
"deviceModelName": "string",
"deviceTypeName": "string",
"authorId": "string",
"authorEmail": "string",
"authorName": "string",
"authorLastName": "string",
"authorAvatar": "string",
"authorPhone": "string",
"commandTypeCode": "string",
"commandTypeName": "string",
"status": "string",
"params": "object",
"createdAt": "object",
"updatedAt": "object",
"group": {
"organizationId": "string",
"id": "object",
"name": "string",
"path": "string",
"latitude": "number",
"longitude": "number",
"positionType": "string",
"positionY": "number",
"positionX": "number",
"timeZone": "string",
"createdAt": "object",
"updatedAt": "object",
"countDevices": "number",
"countDevicesDeep": "number",
"countChildren": "number",
"countChildrenDeep": "number",
"currency": "string",
"type": "string",
"groupMap": {
"id": "number",
"height": "number",
"width": "number",
"url": "string",
"createdAt": "object",
"updatedAt": "object"
},
"children": [
{
"organizationId": "string",
"id": "object",
"name": "string",
"path": "string"
}
]
}
}
]
}
PageDeviceCommentResponse: object
- items:
- size:
- index:
Example
{
"items": [
{
"id": "string",
"comment": "string",
"deviceSerial": "string",
"authorId": "string",
"authorEmail": "string",
"authorName": "string",
"authorPhone": "string",
"authorAvatar": "string",
"attachments": [
{
"id": "string",
"path": "string",
"filename": "string",
"url": "string",
"contentType": "string",
"size": "number",
"createdAt": "object",
"updatedAt": "object"
}
],
"createdAt": "object"
}
],
"size": "number",
"index": "number"
}
PageDeviceInstallationInfoResponse: object
- items:
- size:
- index:
Example
{
"items": [
{
"id": "string",
"name": "string",
"description": "string",
"url": "string",
"deviceSerial": "string",
"attachments": [
{
"id": "string",
"path": "string",
"filename": "string",
"url": "string",
"contentType": "string",
"size": "number",
"createdAt": "object",
"updatedAt": "object"
}
],
"createdAt": "object",
"updatedAt": "object"
}
],
"size": "number",
"index": "number"
}
PageDeviceResponse: object
Example
{
"items": [
{
"id": "object",
"organizationId": "string",
"deviceHash": "string",
"serial": "string",
"name": "string",
"supplier": "string",
"tag": "string",
"latitude": "number",
"longitude": "number",
"positionType": "string",
"positionY": "number",
"positionX": "number",
"timeZone": "string",
"networkType": "string",
"loraParams": {
"id": "number",
"deviceEUI": "string",
"applicationEUI": "string",
"joinEUI": "string",
"version": "string",
"loraClass": "string",
"regionalParametersRevision": "string",
"region": "string",
"activationType": "string",
"createdAt": "object",
"updatedAt": "object"
},
"mqttParams": {
"id": "number",
"version": "string",
"createdAt": "object",
"updatedAt": "object"
},
"maxLifetimeHours": "number",
"maxLifetimeWarningPercentage": "number",
"statusUpdateHoursOffset": "number",
"referenceNumber": "string",
"online": "boolean",
"errors": [
"string"
],
"statusUpdatedAt": "object",
"createdAt": "object",
"updatedAt": "object",
"model": {
"id": "number",
"name": "string",
"code": "string",
"createdAt": "object",
"updatedAt": "object",
"type": {}
}
}
]
}
PageDownloadTemplateResponse: object
- items:
- size:
- index:
Example
{
"items": [
{
"id": "number",
"organizationId": "string",
"name": "string",
"readingFrequency": "string",
"groups": [
"string"
],
"deviceTypes": [
"string"
],
"deviceModels": [
"string"
],
"deviceInfos": [
"string"
],
"deviceDataTypes": [
{
"code": "string",
"customLabel": "string"
}
],
"lastSentTo": [
"string"
],
"lastSentDate": "object",
"lastDownloadRequestedBy": {
"id": "object",
"name": "string",
"lastName": "string",
"email": "string",
"gender": "string",
"phoneNumber": "string",
"avatar": "string",
"confirmedAt": "object",
"createdAt": "object",
"updatedAt": "object",
"lastAccess": "object",
"createdBy": {
"id": "object",
"name": "string",
"lastName": "string",
"email": "string",
"gender": "string",
"phoneNumber": "string",
"avatar": "string",
"confirmedAt": "object",
"createdAt": "object",
"updatedAt": "object",
"lastAccess": "object",
"createdBy": {
"id": "object",
"name": "string",
"lastName": "string",
"email": "string",
"gender": "string",
"phoneNumber": "string",
"avatar": "string"
}
}
}
}
]
}
PageEnvironmentAM03StatusResponse: object
- items:
- size:
- index:
Example
{
"items": [
{
"methaneAlarm": "boolean",
"online": "boolean",
"signal": "number",
"receivedAt": "object",
"createdAt": "object",
"updatedAt": "object"
}
],
"size": "number",
"index": "number"
}
PageEnvironmentAM04BatteryStatusResponse: object
- items:
- size:
- index:
Example
{
"items": [
{
"batteryPercentage": "number",
"waterLeakageStatus": "boolean",
"magnetStatus": "boolean",
"online": "boolean",
"signal": "number",
"receivedAt": "object",
"createdAt": "object",
"updatedAt": "object"
}
],
"size": "number",
"index": "number"
}
PageEnvironmentAM04StatusResponse: object
- items:
- size:
- index:
Example
{
"items": [
{
"batteryPercentage": {
"value": "number",
"receivedAt": "object"
},
"temperature": "number",
"humidity": "number",
"waterLeakageStatus": "boolean",
"magnetStatus": "boolean",
"online": "boolean",
"signal": "number",
"receivedAt": "object",
"createdAt": "object",
"updatedAt": "object"
}
],
"size": "number",
"index": "number"
}
PageEnvironmentAM05BatteryStatusResponse: object
- items:
- size:
- index:
Example
{
"items": [
{
"batteryPercentage": "number",
"online": "boolean",
"signal": "number",
"receivedAt": "object",
"createdAt": "object",
"updatedAt": "object"
}
],
"size": "number",
"index": "number"
}
PageEnvironmentAM05StatusResponse: object
- items:
- size:
- index:
Example
{
"items": [
{
"batteryPercentage": {
"value": "number",
"receivedAt": "object"
},
"temperature": "number",
"humidity": "number",
"online": "boolean",
"signal": "number",
"receivedAt": "object",
"createdAt": "object",
"updatedAt": "object"
}
],
"size": "number",
"index": "number"
}
PageEnvironmentBatteryStatusResponse: object
- items:
- size:
- index:
Example
{
"items": [
{
"batteryPercentage": "number",
"receivedAt": "object"
}
],
"size": "number",
"index": "number"
}
PageEnvironmentPL03StatusResponse: object
- items:
- size:
- index:
Example
{
"items": [
{
"occupied": "boolean",
"illuminance": "number",
"temperature": "number",
"batteryPercentage": "number",
"battery": "number",
"online": "boolean",
"signal": "number",
"receivedAt": "object"
}
],
"size": "number",
"index": "number"
}
PageEnvironmentPM02StatusResponse: object
- items:
- size:
- index:
Example
{
"items": [
{
"batteryPercentage": "number",
"pmMass010": "number",
"pmMass025": "number",
"pmMass040": "number",
"pmMass100": "number",
"pmNumber005": "number",
"pmNumber010": "number",
"pmNumber025": "number",
"pmNumber040": "number",
"pmNumber100": "number",
"online": "boolean",
"signal": "number",
"receivedAt": "object",
"createdAt": "object",
"updatedAt": "object"
}
],
"size": "number",
"index": "number"
}
PageEnvironmentPMSensorStatusResponse: object
- items:
- size:
- index:
Example
{
"items": [
{
"temperature": "number",
"humidity": "number",
"pressure": "number",
"pm_010": "number",
"pm_025": "number",
"pm_100": "number",
"batteryPercentage": "number",
"online": "boolean",
"signal": "number",
"receivedAt": "object",
"createdAt": "object",
"updatedAt": "object"
}
],
"size": "number",
"index": "number"
}
PageEnvironmentSM01StatusResponse: object
- items:
- size:
- index:
Example
{
"items": [
{
"highTemperatureAlarm": "boolean",
"fireAlarm": "boolean",
"batteryPercentage": "number",
"battery": "number",
"online": "boolean",
"signal": "number",
"receivedAt": "object",
"createdAt": "object",
"updatedAt": "object"
}
],
"size": "number",
"index": "number"
}
PageEnvironmentSO01StatusResponse: object
- items:
- size:
- index:
Example
{
"items": [
{
"temperature": "number",
"moisture": "number",
"conductivity": "number",
"online": "boolean",
"signal": "number",
"receivedAt": "object",
"createdAt": "object",
"updatedAt": "object"
}
],
"size": "number",
"index": "number"
}
PageEnvironmentSO03StatusResponse: object
- items:
- size:
- index:
Example
{
"items": [
{
"signal": "number",
"dielectricPermittivity": "number",
"volumetricWaterContent": "number",
"soilTemperature": "number",
"electricalConductivity": "number",
"batteryVoltage": "number",
"batteryPercentage": "number",
"error": "string",
"receivedAt": "object",
"online": "boolean"
}
],
"size": "number",
"index": "number"
}
PageEnvironmentSo02StatusResponse: object
- items:
- size:
- index:
Example
{
"items": [
{
"soilMoistureAtDepthLevel0": "number",
"soilTemperatureAtDepthLevel0": "number",
"soilMoistureAtDepthLevel1": "number",
"soilTemperatureAtDepthLevel1": "number",
"soilMoistureAtDepthLevel2": "number",
"soilTemperatureAtDepthLevel2": "number",
"soilMoistureAtDepthLevel3": "number",
"soilTemperatureAtDepthLevel3": "number",
"soilMoistureAtDepthLevel4": "number",
"soilTemperatureAtDepthLevel4": "number",
"soilMoistureAtDepthLevel5": "number",
"soilTemperatureAtDepthLevel5": "number",
"soilMoistureAtDepthLevel6": "number",
"soilTemperatureAtDepthLevel6": "number",
"soilMoistureAtDepthLevel7": "number",
"soilTemperatureAtDepthLevel7": "number",
"batteryVoltage": "number",
"batteryPercentage": "number",
"online": "boolean",
"signal": "number",
"receivedAt": "object",
"createdAt": "object",
"updatedAt": "object"
}
],
"size": "number",
"index": "number"
}
PageEnvironmentStatusResponse: object
- items:
- size:
- index:
Example
{
"items": [
{
"tvoc": "number",
"illumination": "number",
"activity": "number",
"co2": "number",
"temperature": "number",
"humidity": "number",
"infrared": "number",
"infrared_and_visible": "number",
"pressure": "number",
"online": "boolean",
"signal": "number",
"receivedAt": "object",
"createdAt": "object",
"updatedAt": "object"
}
],
"size": "number",
"index": "number"
}
PageEnvironmentTH01StatusResponse: object
- items:
- size:
- index:
Example
{
"items": [
{
"temperature": "number",
"humidity": "number",
"batteryStatus": {
"batteryPercentage": "number",
"receivedAt": "object"
},
"online": "boolean",
"signal": "number",
"receivedAt": "object"
}
],
"size": "number",
"index": "number"
}
PageEnvironmentWH01StatusResponse: object
- items:
- size:
- index:
Example
{
"items": [
{
"signal": "number",
"barometerData": "number",
"temperature": "number",
"windSpeed": "number",
"avgWindSpeed": "number",
"windDirection": "number",
"humidityPercentage": "number",
"rainRate": "number",
"UV": "number",
"solarRadiation": "number",
"dayRain": "number",
"dayEt": "number",
"soilMoisture1": "number",
"soilMoisture2": "number",
"soilMoisture3": "number",
"soilMoisture4": "number",
"leafWetness1": "number",
"leafWetness2": "number",
"leafWetness3": "number",
"leafWetness4": "number",
"forecastIcon": "string",
"barTrend": "number",
"error": "string",
"receivedAt": "object",
"online": "boolean"
}
],
"size": "number",
"index": "number"
}
PageGeneralPermissionResponse: object
- items:
- size:
- index:
Example
{
"items": [
{
"code": "string",
"permissionsType": "string",
"orderSequence": "number"
}
],
"size": "number",
"index": "number"
}
PageGroupResponse: object
Example
{
"items": [
{
"organizationId": "string",
"id": "object",
"name": "string",
"path": "string",
"latitude": "number",
"longitude": "number",
"positionType": "string",
"positionY": "number",
"positionX": "number",
"timeZone": "string",
"createdAt": "object",
"updatedAt": "object",
"countDevices": "number",
"countDevicesDeep": "number",
"countChildren": "number",
"countChildrenDeep": "number",
"currency": "string",
"type": "string",
"groupMap": {
"id": "number",
"height": "number",
"width": "number",
"url": "string",
"createdAt": "object",
"updatedAt": "object"
},
"children": [
{
"organizationId": "string",
"id": "object",
"name": "string",
"path": "string",
"latitude": "number",
"longitude": "number",
"positionType": "string",
"positionY": "number",
"positionX": "number",
"timeZone": "string",
"createdAt": "object",
"updatedAt": "object",
"countDevices": "number",
"countDevicesDeep": "number",
"countChildren": "number",
"countChildrenDeep": "number",
"currency": "string",
"type": "string"
}
],
"devices": [
{
"id": "object",
"organizationId": "string"
}
]
}
]
}
PageLightingAstroProgramCommandDeviceResponse: object
- items:
- size:
- index:
Example
{
"items": [
{
"id": "number",
"deviceSerial": "string",
"programCommandId": "number",
"status": "string",
"sendAttempts": "number",
"lastSendAttemptDate": "object",
"createdAt": "object",
"updatedAt": "object",
"programCommand": {
"id": "number",
"label": "string",
"groupId": "string",
"sunriseOffsetMinutes": "number",
"sunsetOffsetMinutes": "number",
"dimmingLevel": "number",
"group": {
"organizationId": "string",
"id": "object",
"name": "string",
"path": "string",
"latitude": "number",
"longitude": "number",
"positionType": "string",
"positionY": "number",
"positionX": "number",
"timeZone": "string",
"createdAt": "object",
"updatedAt": "object",
"countDevices": "number",
"countDevicesDeep": "number",
"countChildren": "number",
"countChildrenDeep": "number",
"currency": "string",
"type": "string",
"groupMap": {
"id": "number",
"height": "number",
"width": "number",
"url": "string",
"createdAt": "object",
"updatedAt": "object"
},
"children": [
{
"organizationId": "string",
"id": "object",
"name": "string",
"path": "string",
"latitude": "number"
}
]
}
}
}
]
}
PageLightingAstroProgramCommandResponse: object
- items:
- size:
- index:
Example
{
"items": [
{
"id": "number",
"label": "string",
"groupId": "string",
"sunriseOffsetMinutes": "number",
"sunsetOffsetMinutes": "number",
"dimmingLevel": "number",
"group": {
"organizationId": "string",
"id": "object",
"name": "string",
"path": "string",
"latitude": "number",
"longitude": "number",
"positionType": "string",
"positionY": "number",
"positionX": "number",
"timeZone": "string",
"createdAt": "object",
"updatedAt": "object",
"countDevices": "number",
"countDevicesDeep": "number",
"countChildren": "number",
"countChildrenDeep": "number",
"currency": "string",
"type": "string",
"groupMap": {
"id": "number",
"height": "number",
"width": "number",
"url": "string",
"createdAt": "object",
"updatedAt": "object"
},
"children": [
{
"organizationId": "string",
"id": "object",
"name": "string",
"path": "string",
"latitude": "number",
"longitude": "number",
"positionType": "string",
"positionY": "number",
"positionX": "number",
"timeZone": "string",
"createdAt": "object",
"updatedAt": "object",
"countDevices": "number",
"countDevicesDeep": "number"
}
]
}
}
]
}
PageLightingAstroProgramResponse: object
- items:
- size:
- index:
Example
{
"items": [
{
"id": "number",
"name": "string",
"description": "string",
"organizationId": "string",
"sunriseOffsetMinutes": "number",
"sunsetOffsetMinutes": "number",
"dimmingLevel": "number",
"createdBy": {
"id": "object",
"name": "string",
"lastName": "string",
"email": "string",
"gender": "string",
"phoneNumber": "string",
"avatar": "string",
"confirmedAt": "object",
"createdAt": "object",
"updatedAt": "object",
"lastAccess": "object",
"createdBy": {
"id": "object",
"name": "string",
"lastName": "string",
"email": "string",
"gender": "string",
"phoneNumber": "string",
"avatar": "string",
"confirmedAt": "object",
"createdAt": "object",
"updatedAt": "object",
"lastAccess": "object",
"createdBy": {
"id": "object",
"name": "string",
"lastName": "string",
"email": "string",
"gender": "string",
"phoneNumber": "string",
"avatar": "string",
"confirmedAt": "object",
"createdAt": "object",
"updatedAt": "object",
"lastAccess": "object",
"createdBy": {
"id": "object",
"name": "string",
"lastName": "string",
"email": "string"
}
}
}
}
}
]
}
PageLightingProgramCommandDeviceDayStatusResponse: object
- items:
- size:
- index:
Example
{
"items": [
{
"id": "number",
"programCommandDeviceId": "number",
"dayOfWeek": "string",
"status": "string",
"sendAttempts": "number",
"lastSendAttemptDate": "object",
"createdAt": "object",
"updatedAt": "object",
"programCommandDevice": {
"id": "number",
"deviceSerial": "string",
"programCommandId": "number",
"statuses": [
{
"id": "number",
"programCommandDeviceId": "number",
"dayOfWeek": "string",
"status": "string",
"sendAttempts": "number",
"lastSendAttemptDate": "object",
"createdAt": "object",
"updatedAt": "object",
"programCommandDevice": {
"id": "number",
"deviceSerial": "string",
"programCommandId": "number",
"statuses": [
{
"id": "number",
"programCommandDeviceId": "number",
"dayOfWeek": "string",
"status": "string",
"sendAttempts": "number",
"lastSendAttemptDate": "object",
"createdAt": "object",
"updatedAt": "object",
"programCommandDevice": {
"id": "number",
"deviceSerial": "string",
"programCommandId": "number",
"statuses": [
{
"id": "number",
"programCommandDeviceId": "number",
"dayOfWeek": "string",
"status": "string",
"sendAttempts": "number",
"lastSendAttemptDate": "object",
"createdAt": "object"
}
]
}
}
]
}
}
]
}
}
]
}
PageLightingProgramCommandDeviceResponse: object
- items:
- size:
- index:
Example
{
"items": [
{
"id": "number",
"deviceSerial": "string",
"programCommandId": "number",
"statuses": [
{
"id": "number",
"programCommandDeviceId": "number",
"dayOfWeek": "string",
"status": "string",
"sendAttempts": "number",
"lastSendAttemptDate": "object",
"createdAt": "object",
"updatedAt": "object",
"programCommandDevice": {
"id": "number",
"deviceSerial": "string",
"programCommandId": "number",
"statuses": [
{
"id": "number",
"programCommandDeviceId": "number",
"dayOfWeek": "string",
"status": "string",
"sendAttempts": "number",
"lastSendAttemptDate": "object",
"createdAt": "object",
"updatedAt": "object",
"programCommandDevice": {
"id": "number",
"deviceSerial": "string",
"programCommandId": "number",
"statuses": [
{
"id": "number",
"programCommandDeviceId": "number",
"dayOfWeek": "string",
"status": "string",
"sendAttempts": "number",
"lastSendAttemptDate": "object",
"createdAt": "object",
"updatedAt": "object",
"programCommandDevice": {
"id": "number",
"deviceSerial": "string",
"programCommandId": "number",
"statuses": [
{
"id": "number",
"programCommandDeviceId": "number",
"dayOfWeek": "string"
}
]
}
}
]
}
}
]
}
}
]
}
]
}
PageLightingProgramCommandResponse: object
- items:
- size:
- index:
Example
{
"items": [
{
"id": "number",
"label": "string",
"groupId": "string",
"group": {
"organizationId": "string",
"id": "object",
"name": "string",
"path": "string",
"latitude": "number",
"longitude": "number",
"positionType": "string",
"positionY": "number",
"positionX": "number",
"timeZone": "string",
"createdAt": "object",
"updatedAt": "object",
"countDevices": "number",
"countDevicesDeep": "number",
"countChildren": "number",
"countChildrenDeep": "number",
"currency": "string",
"type": "string",
"groupMap": {
"id": "number",
"height": "number",
"width": "number",
"url": "string",
"createdAt": "object",
"updatedAt": "object"
},
"children": [
{
"organizationId": "string",
"id": "object",
"name": "string",
"path": "string",
"latitude": "number",
"longitude": "number",
"positionType": "string",
"positionY": "number",
"positionX": "number",
"timeZone": "string",
"createdAt": "object",
"updatedAt": "object",
"countDevices": "number",
"countDevicesDeep": "number",
"countChildren": "number",
"countChildrenDeep": "number",
"currency": "string"
}
]
}
}
]
}
PageLightingProgramResponse: object
- items:
- size:
- index:
Example
{
"items": [
{
"id": "number",
"name": "string",
"organizationId": "string",
"description": "string",
"createdBy": {
"id": "object",
"name": "string",
"lastName": "string",
"email": "string",
"gender": "string",
"phoneNumber": "string",
"avatar": "string",
"confirmedAt": "object",
"createdAt": "object",
"updatedAt": "object",
"lastAccess": "object",
"createdBy": {
"id": "object",
"name": "string",
"lastName": "string",
"email": "string",
"gender": "string",
"phoneNumber": "string",
"avatar": "string",
"confirmedAt": "object",
"createdAt": "object",
"updatedAt": "object",
"lastAccess": "object",
"createdBy": {
"id": "object",
"name": "string",
"lastName": "string",
"email": "string",
"gender": "string",
"phoneNumber": "string",
"avatar": "string",
"confirmedAt": "object",
"createdAt": "object",
"updatedAt": "object",
"lastAccess": "object",
"createdBy": {
"id": "object",
"name": "string",
"lastName": "string",
"email": "string",
"gender": "string",
"phoneNumber": "string",
"avatar": "string"
}
}
}
}
}
]
}
PageLightingProgramTemplateResponse: object
- items:
- size:
- index:
Example
{
"items": [
{
"id": "number",
"groupId": "string",
"dimmingPoints": [
{
"timeIndex": "number",
"dimmingLevel": "number"
}
],
"templateName": "string",
"editedBy": {
"id": "object",
"name": "string",
"lastName": "string",
"email": "string",
"gender": "string",
"phoneNumber": "string",
"avatar": "string",
"confirmedAt": "object",
"createdAt": "object",
"updatedAt": "object",
"lastAccess": "object",
"createdBy": {
"id": "object",
"name": "string",
"lastName": "string",
"email": "string",
"gender": "string",
"phoneNumber": "string",
"avatar": "string",
"confirmedAt": "object",
"createdAt": "object",
"updatedAt": "object",
"lastAccess": "object",
"createdBy": {
"id": "object",
"name": "string",
"lastName": "string",
"email": "string",
"gender": "string",
"phoneNumber": "string",
"avatar": "string",
"confirmedAt": "object",
"createdAt": "object",
"updatedAt": "object",
"lastAccess": "object",
"createdBy": {
"id": "object",
"name": "string",
"lastName": "string",
"email": "string"
}
}
}
}
}
]
}
PageLightingStatusResponse: object
- items:
- size:
- index:
Example
{
"items": [
{
"signal": "number",
"dimmingLevel": "number",
"temperature": "number",
"activeEnergy": "number",
"apparentEnergy": "number",
"activePower": "number",
"apparentPower": "number",
"energyReactive": "number",
"lampRunningHours": "number",
"nodeRunningHours": "number",
"onOffCycles": "number",
"errors": "string",
"lightingMode": "string",
"online": "boolean",
"deviceUnixEpoch": "number",
"receivedAt": "object",
"createdAt": "object",
"updatedAt": "object"
}
],
"size": "number",
"index": "number"
}
PageMaintenanceFormResponse: object
- items:
- size:
- index:
Example
{
"items": [
{
"id": "number",
"organizationId": "string",
"name": "string",
"group": {
"organizationId": "string",
"id": "object",
"name": "string",
"path": "string",
"latitude": "number",
"longitude": "number",
"positionType": "string",
"positionY": "number",
"positionX": "number",
"timeZone": "string",
"createdAt": "object",
"updatedAt": "object",
"countDevices": "number",
"countDevicesDeep": "number",
"countChildren": "number",
"countChildrenDeep": "number",
"currency": "string",
"type": "string",
"groupMap": {
"id": "number",
"height": "number",
"width": "number",
"url": "string",
"createdAt": "object",
"updatedAt": "object"
},
"children": [
{
"organizationId": "string",
"id": "object",
"name": "string",
"path": "string",
"latitude": "number",
"longitude": "number",
"positionType": "string",
"positionY": "number",
"positionX": "number",
"timeZone": "string",
"createdAt": "object",
"updatedAt": "object",
"countDevices": "number",
"countDevicesDeep": "number",
"countChildren": "number",
"countChildrenDeep": "number",
"currency": "string"
}
]
}
}
]
}
PageMaintenanceNotificationResponse: object
- items:
- size:
- index:
Example
{
"items": [
{
"id": "number",
"operationId": "number",
"notificationType": "string",
"detectionDate": "object",
"deviceSerial": "string",
"organizationId": "string",
"deviceName": "string",
"deviceTypeName": "string",
"deviceGroupId": "string",
"deviceGroupName": "string",
"latestDeviceStatus": "string",
"latestDeviceStatusMessage": "string",
"lastStatusUpdateDate": "object",
"deviceMaxLifetimeHours": "number",
"deviceRemainingLifetimeHours": "number"
}
],
"size": "number",
"index": "number"
}
PageMaintenanceOperationFormHistoryResponse: object
- items:
- size:
- index:
Example
{
"items": [
{
"id": "string",
"userId": "string",
"userFirstName": "string",
"userLastName": "string",
"operationId": "number",
"action": "string",
"formId": "number",
"formName": "string",
"timestamp": "object",
"configurationJson": "object",
"responsesJson": "object"
}
],
"size": "number",
"index": "number"
}
PageMaintenanceOperationResponse: object
- items:
- size:
- index:
Example
{
"items": [
{
"id": "number",
"name": "string",
"organizationId": "object",
"groupId": "object",
"groupName": "string",
"categoryId": "number",
"status": "string",
"lastStatusUpdateDate": "object",
"managerEmails": [
"string"
],
"managerEmailSent": "boolean",
"maintainerEmails": [
"string"
],
"maintainerEmailSent": "boolean",
"scheduledDate": "object",
"description": "string",
"createdAt": "object",
"updatedAt": "object",
"category": {
"id": "number",
"color": "string",
"name": "string"
},
"expectedCost": {
"id": "number",
"operationId": "number",
"value": "number",
"currency": "string"
},
"repetitionPattern": "string",
"repetitionOffset": "number",
"numberOfRepetition": "number",
"repetitionEndDate": "object",
"externalData": "object",
"form": {
"id": "number",
"operationId": "number",
"name": "string",
"configurationJson": "object",
"responsesJson": "object",
"editedBy": {
"id": "object",
"name": "string",
"lastName": "string",
"email": "string",
"gender": "string",
"phoneNumber": "string",
"avatar": "string",
"confirmedAt": "object",
"createdAt": "object",
"updatedAt": "object"
}
}
}
]
}
PageMeteringAnalyticsAnomalyResponse: object
- items:
- size:
- index:
Example
{
"items": [
{
"date": "object",
"groupId": "string",
"group": {
"organizationId": "string",
"id": "object",
"name": "string",
"path": "string",
"latitude": "number",
"longitude": "number",
"positionType": "string",
"positionY": "number",
"positionX": "number",
"timeZone": "string",
"createdAt": "object",
"updatedAt": "object",
"countDevices": "number",
"countDevicesDeep": "number",
"countChildren": "number",
"countChildrenDeep": "number",
"currency": "string",
"type": "string",
"groupMap": {
"id": "number",
"height": "number",
"width": "number",
"url": "string",
"createdAt": "object",
"updatedAt": "object"
},
"children": [
{
"organizationId": "string",
"id": "object",
"name": "string",
"path": "string",
"latitude": "number",
"longitude": "number",
"positionType": "string",
"positionY": "number",
"positionX": "number",
"timeZone": "string",
"createdAt": "object",
"updatedAt": "object",
"countDevices": "number",
"countDevicesDeep": "number",
"countChildren": "number",
"countChildrenDeep": "number",
"currency": "string",
"type": "string"
}
],
"devices": [
null
]
}
}
]
}
PageMeteringEnergyStatusResponse: object
- items:
- size:
- index:
Example
{
"items": [
{
"enabled485": "boolean",
"pulseOneEnabled": "boolean",
"pulseTwoEnabled": "boolean",
"activeEnergyImpEnabled": "boolean",
"totalActiveEnergyImpEnabled": "boolean",
"activeEnergyExpEnabled": "boolean",
"totalActiveEnergyExpEnabled": "boolean",
"reactiveEnergyImpEnabled": "boolean",
"totalReactiveEnergyImpEnabled": "boolean",
"reactiveEnergyExpEnabled": "boolean",
"totalReactiveEnergyExpEnabled": "boolean",
"temperature": "number",
"activeEnergyImpL1": "number",
"activeEnergyImpL2": "number",
"activeEnergyImpL3": "number",
"activeEnergyImpTotal": "number",
"activeEnergyExpL1": "number",
"activeEnergyExpL2": "number",
"activeEnergyExpL3": "number",
"activeEnergyExpTotal": "number",
"reactiveEnergyImpL1": "number",
"reactiveEnergyImpL2": "number",
"reactiveEnergyImpL3": "number",
"reactiveEnergyImpTotal": "number",
"reactiveEnergyExpL1": "number",
"reactiveEnergyExpL2": "number",
"reactiveEnergyExpL3": "number",
"reactiveEnergyExpTotal": "number",
"pulseOne": "number",
"pulseTwo": "number",
"signal": "number",
"online": "boolean",
"errors": "string",
"receivedAt": "object",
"createdAt": "object",
"updatedAt": "object"
}
],
"size": "number",
"index": "number"
}
PageMeteringGenericStatusResponse: object
- items:
- size:
- index:
Example
{
"items": [
{
"productManufacturer": "string",
"productSupplier": "string",
"productModel": "string",
"error": "string",
"timestamp": "number",
"battery": "number",
"signalLevel": "number",
"electricVoltageL1": "number",
"electricVoltageL2": "number",
"electricVoltageL3": "number",
"electricVoltageL12": "number",
"electricVoltageL23": "number",
"electricVoltageL31": "number",
"electricCurrentL1": "number",
"electricCurrentL2": "number",
"electricCurrentL3": "number",
"electricFrequency": "number",
"electricPowerFactorL1": "number",
"electricPowerFactorL2": "number",
"electricPowerFactorL3": "number",
"electricTotalPowerFactor": "number",
"electricActivePowerL1": "number",
"electricActivePowerL2": "number",
"electricActivePowerL3": "number",
"electricTotalActivePower": "number",
"electricReactivePowerL1": "number",
"electricReactivePowerL2": "number",
"electricReactivePowerL3": "number",
"electricTotalReactivePower": "number",
"electricApparentPowerL1": "number",
"electricApparentPowerL2": "number",
"electricApparentPowerL3": "number",
"electricTotalApparentPower": "number",
"electricActiveEnergyImpL1": "number",
"electricActiveEnergyImpL2": "number",
"electricActiveEnergyImpL3": "number",
"electricTotalActiveEnergyImp": "number",
"electricActiveEnergyExpL1": "number",
"electricActiveEnergyExpL2": "number",
"electricActiveEnergyExpL3": "number",
"electricTotalActiveEnergyExp": "number",
"electricReactiveEnergyImpL1": "number",
"electricReactiveEnergyImpL2": "number",
"electricReactiveEnergyImpL3": "number",
"electricTotalReactiveEnergyImp": "number",
"electricReactiveEnergyExpL1": "number",
"electricReactiveEnergyExpL2": "number",
"electricReactiveEnergyExpL3": "number"
}
]
}
PageMeteringInstantStatusResponse: object
- items:
- size:
- index:
Example
{
"items": [
{
"activePowerEnabled": "boolean",
"totalActivePowerEnabled": "boolean",
"reactivePowerEnabled": "boolean",
"totalReactivePowerEnabled": "boolean",
"voltageEnabled": "boolean",
"ptpVoltageEnabled": "boolean",
"currentEnabled": "boolean",
"powerFactorEnabled": "boolean",
"powerFactorTotalEnabled": "boolean",
"apparentPowerEnabled": "boolean",
"totalApparentPowerEnabled": "boolean",
"frequencyEnabled": "boolean",
"temperature": "number",
"voltageL1": "number",
"voltageL2": "number",
"voltageL3": "number",
"voltageL12": "number",
"voltageL23": "number",
"voltageL31": "number",
"currentL1": "number",
"currentL2": "number",
"currentL3": "number",
"frequency": "number",
"powerFactorL1": "number",
"powerFactorL2": "number",
"powerFactorL3": "number",
"totalPowerFactor": "number",
"activePowerL1": "number",
"activePowerL2": "number",
"activePowerL3": "number",
"totalActivePower": "number",
"reactivePowerL1": "number",
"reactivePowerL2": "number",
"reactivePowerL3": "number",
"totalReactivePower": "number",
"apparentPowerL1": "number",
"apparentPowerL2": "number",
"apparentPowerL3": "number",
"totalApparentPower": "number",
"signal": "number",
"online": "boolean",
"errors": "string",
"receivedAt": "object",
"createdAt": "object",
"updatedAt": "object"
}
],
"size": "number",
"index": "number"
}
PageMeteringProgramResponse: object
- items:
- size:
- index:
Example
{
"items": [
{
"id": "number",
"name": "string",
"description": "string",
"organizationId": "string",
"groupId": "string",
"group": {
"organizationId": "string",
"id": "object",
"name": "string",
"path": "string",
"latitude": "number",
"longitude": "number",
"positionType": "string",
"positionY": "number",
"positionX": "number",
"timeZone": "string",
"createdAt": "object",
"updatedAt": "object",
"countDevices": "number",
"countDevicesDeep": "number",
"countChildren": "number",
"countChildrenDeep": "number",
"currency": "string",
"type": "string",
"groupMap": {
"id": "number",
"height": "number",
"width": "number",
"url": "string",
"createdAt": "object",
"updatedAt": "object"
},
"children": [
{
"organizationId": "string",
"id": "object",
"name": "string",
"path": "string",
"latitude": "number",
"longitude": "number",
"positionType": "string",
"positionY": "number",
"positionX": "number",
"timeZone": "string",
"createdAt": "object",
"updatedAt": "object",
"countDevices": "number",
"countDevicesDeep": "number",
"countChildren": "number"
}
]
}
}
]
}
PageMeteringScheduleResponse: object
- items:
- size:
- index:
Example
{
"items": [
{
"id": "number",
"programId": "number",
"organizationId": "string",
"program": {
"id": "number",
"name": "string",
"description": "string",
"organizationId": "string",
"groupId": "string",
"group": {
"organizationId": "string",
"id": "object",
"name": "string",
"path": "string",
"latitude": "number",
"longitude": "number",
"positionType": "string",
"positionY": "number",
"positionX": "number",
"timeZone": "string",
"createdAt": "object",
"updatedAt": "object",
"countDevices": "number",
"countDevicesDeep": "number",
"countChildren": "number",
"countChildrenDeep": "number",
"currency": "string",
"type": "string",
"groupMap": {
"id": "number",
"height": "number",
"width": "number",
"url": "string",
"createdAt": "object",
"updatedAt": "object"
},
"children": [
{
"organizationId": "string",
"id": "object",
"name": "string",
"path": "string",
"latitude": "number",
"longitude": "number",
"positionType": "string",
"positionY": "number",
"positionX": "number",
"timeZone": "string",
"createdAt": "object"
}
]
}
}
}
]
}
PageMeteringStatusResponse: object
- items:
- size:
- index:
Example
{
"items": [
{
"signal": "number",
"enabled485": "boolean",
"pulseOneEnabled": "boolean",
"pulseTwoEnabled": "boolean",
"totalActiveEnergyEnabled": "boolean",
"activePowerEnabled": "boolean",
"voltageEnabled": "boolean",
"currentEnabled": "boolean",
"powerFactorEnabled": "boolean",
"frequencyEnabled": "boolean",
"temperature": "number",
"voltage": "number",
"current": "number",
"powerFactor": "number",
"frequency": "number",
"activePower": "number",
"totalActiveEnergy": "number",
"pulseOne": "number",
"pulseTwo": "number",
"errors": "string",
"online": "boolean",
"receivedAt": "object",
"createdAt": "object",
"updatedAt": "object"
}
],
"size": "number",
"index": "number"
}
PageMeteringUK1StatusResponse: object
- items:
- size:
- index:
Example
{
"items": [
{
"signal": "number",
"energyConsumption": "number",
"heatEnergy": "number",
"coolingEnergy": "number",
"volume": "number",
"power": "number",
"flow": "number",
"forwardTemperature": "number",
"returnTemperature": "number",
"meterId": "number",
"errors": "string",
"online": "boolean",
"receivedAt": "object",
"createdAt": "object",
"updatedAt": "object"
}
],
"size": "number",
"index": "number"
}
PageOrganizationResponse: object
- items:
- size:
- index:
Example
{
"items": [
{
"id": "object",
"name": "string",
"address": "string",
"contactNumber": "string",
"contactEmail": "string",
"vatNumber": "string",
"website": "string",
"licenceType": "string",
"expirationDate": "object",
"maximumDevices": "number",
"image": {
"path": "string",
"filename": "string",
"url": "string",
"contentType": "string",
"size": "number"
},
"policy": {
"licenceModules": [
"string"
],
"licenceAccess": [
"string"
]
},
"createdBy": {
"id": "object",
"name": "string",
"lastName": "string",
"email": "string",
"gender": "string",
"phoneNumber": "string",
"avatar": "string",
"confirmedAt": "object",
"createdAt": "object",
"updatedAt": "object",
"lastAccess": "object",
"createdBy": {
"id": "object",
"name": "string",
"lastName": "string",
"email": "string",
"gender": "string",
"phoneNumber": "string",
"avatar": "string",
"confirmedAt": "object",
"createdAt": "object",
"updatedAt": "object",
"lastAccess": "object",
"createdBy": {
"id": "object",
"name": "string",
"lastName": "string"
}
}
}
}
]
}
PageOrganizationRoleResponse: object
- items:
- size:
- index:
Example
{
"items": [
{
"id": "object",
"name": "string",
"userCount": "number",
"createdBy": {
"id": "object",
"name": "string",
"lastName": "string",
"email": "string",
"gender": "string",
"phoneNumber": "string",
"avatar": "string",
"confirmedAt": "object",
"createdAt": "object",
"updatedAt": "object",
"lastAccess": "object",
"createdBy": {
"id": "object",
"name": "string",
"lastName": "string",
"email": "string",
"gender": "string",
"phoneNumber": "string",
"avatar": "string",
"confirmedAt": "object",
"createdAt": "object",
"updatedAt": "object",
"lastAccess": "object",
"createdBy": {
"id": "object",
"name": "string",
"lastName": "string",
"email": "string",
"gender": "string",
"phoneNumber": "string",
"avatar": "string",
"confirmedAt": "object",
"createdAt": "object",
"updatedAt": "object",
"lastAccess": "object",
"createdBy": {
"id": "object",
"name": "string",
"lastName": "string",
"email": "string",
"gender": "string",
"phoneNumber": "string",
"avatar": "string",
"confirmedAt": "object"
}
}
}
}
}
]
}
PageOrganizationUserListItemResponse: object
- items:
- size:
- index:
Example
{
"items": [
{
"id": "object",
"name": "string",
"lastName": "string",
"email": "string",
"avatar": "string",
"status": "string",
"roleName": "string",
"organizationName": "string",
"lastAccess": "object",
"organizationLastAccess": "object"
}
],
"size": "number",
"index": "number"
}
PageParkingProgramResponse: object
- items:
- size:
- index:
Example
{
"items": [
{
"id": "number",
"name": "string",
"organizationId": "string",
"description": "string",
"groupId": "string",
"group": {
"organizationId": "string",
"id": "object",
"name": "string",
"path": "string",
"latitude": "number",
"longitude": "number",
"positionType": "string",
"positionY": "number",
"positionX": "number",
"timeZone": "string",
"createdAt": "object",
"updatedAt": "object",
"countDevices": "number",
"countDevicesDeep": "number",
"countChildren": "number",
"countChildrenDeep": "number",
"currency": "string",
"type": "string",
"groupMap": {
"id": "number",
"height": "number",
"width": "number",
"url": "string",
"createdAt": "object",
"updatedAt": "object"
},
"children": [
{
"organizationId": "string",
"id": "object",
"name": "string",
"path": "string",
"latitude": "number",
"longitude": "number",
"positionType": "string",
"positionY": "number",
"positionX": "number",
"timeZone": "string",
"createdAt": "object",
"updatedAt": "object",
"countDevices": "number",
"countDevicesDeep": "number",
"countChildren": "number"
}
]
}
}
]
}
PageParkingScheduleResponse: object
- items:
- size:
- index:
Example
{
"items": [
{
"id": "number",
"programId": "number",
"organizationId": "string",
"program": {
"id": "number",
"name": "string",
"organizationId": "string",
"description": "string",
"groupId": "string",
"group": {
"organizationId": "string",
"id": "object",
"name": "string",
"path": "string",
"latitude": "number",
"longitude": "number",
"positionType": "string",
"positionY": "number",
"positionX": "number",
"timeZone": "string",
"createdAt": "object",
"updatedAt": "object",
"countDevices": "number",
"countDevicesDeep": "number",
"countChildren": "number",
"countChildrenDeep": "number",
"currency": "string",
"type": "string",
"groupMap": {
"id": "number",
"height": "number",
"width": "number",
"url": "string",
"createdAt": "object",
"updatedAt": "object"
},
"children": [
{
"organizationId": "string",
"id": "object",
"name": "string",
"path": "string",
"latitude": "number",
"longitude": "number",
"positionType": "string",
"positionY": "number",
"positionX": "number",
"timeZone": "string",
"createdAt": "object"
}
]
}
}
}
]
}
PageTriggersListItemResponse: object
- items:
- size:
- index:
Example
{
"items": [
{
"id": "number",
"name": "string",
"group": {
"organizationId": "string",
"id": "object",
"name": "string",
"path": "string",
"latitude": "number",
"longitude": "number",
"positionType": "string",
"positionY": "number",
"positionX": "number",
"timeZone": "string",
"createdAt": "object",
"updatedAt": "object",
"countDevices": "number",
"countDevicesDeep": "number",
"countChildren": "number",
"countChildrenDeep": "number",
"currency": "string",
"type": "string",
"groupMap": {
"id": "number",
"height": "number",
"width": "number",
"url": "string",
"createdAt": "object",
"updatedAt": "object"
},
"children": [
{
"organizationId": "string",
"id": "object",
"name": "string",
"path": "string",
"latitude": "number",
"longitude": "number",
"positionType": "string",
"positionY": "number",
"positionX": "number",
"timeZone": "string",
"createdAt": "object",
"updatedAt": "object",
"countDevices": "number",
"countDevicesDeep": "number",
"countChildren": "number",
"countChildrenDeep": "number",
"currency": "string",
"type": "string"
}
],
"devices": [
null
]
}
}
]
}
PageUserResponse: object
Example
{
"items": [
{
"id": "object",
"name": "string",
"lastName": "string",
"email": "string",
"gender": "string",
"phoneNumber": "string",
"avatar": "string",
"confirmedAt": "object",
"createdAt": "object",
"updatedAt": "object",
"lastAccess": "object",
"createdBy": {
"id": "object",
"name": "string",
"lastName": "string",
"email": "string",
"gender": "string",
"phoneNumber": "string",
"avatar": "string",
"confirmedAt": "object",
"createdAt": "object",
"updatedAt": "object",
"lastAccess": "object",
"createdBy": {
"id": "object",
"name": "string",
"lastName": "string",
"email": "string",
"gender": "string",
"phoneNumber": "string",
"avatar": "string",
"confirmedAt": "object",
"createdAt": "object",
"updatedAt": "object",
"lastAccess": "object",
"createdBy": {
"id": "object",
"name": "string",
"lastName": "string",
"email": "string",
"gender": "string",
"phoneNumber": "string",
"avatar": "string",
"confirmedAt": "object",
"createdAt": "object",
"updatedAt": "object",
"lastAccess": "object",
"createdBy": {}
}
}
}
}
]
}
PageWearableSB01StatusResponse: object
- items:
- size:
- index:
Example
{
"items": [
{
"latitude": "number",
"longitude": "number",
"altitude": "number",
"motionMode": "string",
"alarm": "boolean",
"ledStatus": "boolean",
"battery": "number",
"batteryPercentage": "number",
"roll": "number",
"pitch": "number",
"online": "boolean",
"signal": "number",
"receivedAt": "object",
"createdAt": "object",
"updatedAt": "object"
}
],
"size": "number",
"index": "number"
}
Parking: object
- class:
- generatedBy:
- deviceStatus:
- slotStatus:
- todayOccupancy:
Example
{
"class": "string",
"generatedBy": {
"id": "object",
"organizationId": "string",
"deviceHash": "string",
"serial": "string",
"name": "string",
"supplier": "string",
"tag": "string",
"latitude": "number",
"longitude": "number",
"positionType": "string",
"positionY": "number",
"positionX": "number",
"timeZone": "string",
"networkType": "string",
"loraParams": {
"id": "number",
"deviceEUI": "string",
"applicationEUI": "string",
"joinEUI": "string",
"version": "string",
"loraClass": "string",
"regionalParametersRevision": "string",
"region": "string",
"activationType": "string",
"createdAt": "object",
"updatedAt": "object"
},
"mqttParams": {
"id": "number",
"version": "string",
"createdAt": "object",
"updatedAt": "object"
},
"maxLifetimeHours": "number",
"maxLifetimeWarningPercentage": "number",
"statusUpdateHoursOffset": "number",
"referenceNumber": "string",
"online": "boolean",
"errors": [
"string"
],
"statusUpdatedAt": "object",
"createdAt": "object",
"updatedAt": "object",
"model": {
"id": "number",
"name": "string",
"code": "string",
"createdAt": "object",
"updatedAt": "object"
}
}
}
ParkingAICameraConfigurationStatusResponse: object
- status:
- items:
Example
{
"status": "string",
"items": [
{
"serial": "string",
"name": "string"
}
]
}
ParkingAnalyticsEconomic: object
- date:
- groupId:
- totalCost:
- totalCostHandicap:
- totalCostPregnant:
- totalCostPrivate:
- totalCostReserved:
- totalCostStandard:
- totalCostSubscriber:
Example
{
"date": "object",
"groupId": "string",
"totalCost": "number",
"totalCostHandicap": "number",
"totalCostPregnant": "number",
"totalCostPrivate": "number",
"totalCostReserved": "number",
"totalCostStandard": "number",
"totalCostSubscriber": "number"
}
ParkingAnalyticsEconomicArrayResponse: object
- status:
- items:
Example
{
"status": "string",
"items": [
{
"date": "object",
"groupId": "string",
"totalCost": "number",
"totalCostHandicap": "number",
"totalCostPregnant": "number",
"totalCostPrivate": "number",
"totalCostReserved": "number",
"totalCostStandard": "number",
"totalCostSubscriber": "number"
}
]
}
ParkingAnalyticsOccupancy: object
- date:
- groupId:
- totalTime:
- totalTimeHandicap:
- totalTimePregnant:
- totalTimePrivate:
- totalTimeReserved:
- totalTimeStandard:
- totalTimeSubscriber:
Example
{
"date": "object",
"groupId": "string",
"totalTime": "number",
"totalTimeHandicap": "number",
"totalTimePregnant": "number",
"totalTimePrivate": "number",
"totalTimeReserved": "number",
"totalTimeStandard": "number",
"totalTimeSubscriber": "number"
}
ParkingAnalyticsOccupancyArrayResponse: object
- status:
- items:
Example
{
"status": "string",
"items": [
{
"date": "object",
"groupId": "string",
"totalTime": "number",
"totalTimeHandicap": "number",
"totalTimePregnant": "number",
"totalTimePrivate": "number",
"totalTimeReserved": "number",
"totalTimeStandard": "number",
"totalTimeSubscriber": "number"
}
]
}
ParkingAnalyticsUtilizationResponse: object
- status:
- item:
Example
{
"status": "string",
"item": {
"busyPercentage": "number",
"freePercentage": "number",
"groupId": "string",
"totalBusy": "number",
"totalFree": "number",
"totalPerDeviceGroup": "number"
}
}
ParkingClass: string
Parking class
-
objectPREGNANT
-
objectHANDICAP
-
objectSUBSCRIBER
-
objectPRIVATE
-
objectRESERVED
ParkingClassStatsArrayResponse: object
- status:
- items:
Example
{
"status": "string",
"items": [
{
"className": "string",
"count": "number"
}
]
}
ParkingDeviceStatus: object
- signal:
- temperature:
- batteryVoltage:
- batteryPercentage:
- online:
- receivedAt:
- createdAt:
- updatedAt:
Example
{
"signal": "number",
"temperature": {
"global": "number",
"CPU": "number",
"GPU": "number"
},
"batteryVoltage": "number",
"batteryPercentage": "number",
"online": "boolean",
"receivedAt": "object",
"createdAt": "object",
"updatedAt": "object"
}
ParkingProgram: object
- id:
- name:
- organizationId:
- description:
- groupId:
- group:
- type:
- dailyCostSlots:
- dailyTimeSlots:
- schedules:
- editedBy:
- createdBy:
- createdAt:
- updatedAt:
Example
{
"id": "number",
"name": "string",
"organizationId": "string",
"description": "string",
"groupId": "string",
"group": {
"organizationId": "string",
"id": "object",
"name": "string",
"path": "string",
"latitude": "number",
"longitude": "number",
"positionType": "string",
"positionY": "number",
"positionX": "number",
"timeZone": "string",
"createdAt": "object",
"updatedAt": "object",
"countDevices": "number",
"countDevicesDeep": "number",
"countChildren": "number",
"countChildrenDeep": "number",
"currency": "string",
"type": "string",
"groupMap": {
"id": "number",
"height": "number",
"width": "number",
"url": "string",
"createdAt": "object",
"updatedAt": "object"
},
"children": [
{
"organizationId": "string",
"id": "object",
"name": "string",
"path": "string",
"latitude": "number",
"longitude": "number",
"positionType": "string",
"positionY": "number",
"positionX": "number",
"timeZone": "string",
"createdAt": "object",
"updatedAt": "object",
"countDevices": "number",
"countDevicesDeep": "number",
"countChildren": "number",
"countChildrenDeep": "number",
"currency": "string"
}
]
}
}
ParkingProgramAllowedSortingFields: string
Parking program allowed sorting fields
-
objectname
-
objectid
-
objecttype
-
objectcreatedAt
-
objectupdatedAt
ParkingProgramPaginatedResponse: object
- status:
- total:
- page:
Example
{
"status": "string",
"total": "number",
"page": {
"items": [
{
"id": "number",
"name": "string",
"organizationId": "string",
"description": "string",
"groupId": "string",
"group": {
"organizationId": "string",
"id": "object",
"name": "string",
"path": "string",
"latitude": "number",
"longitude": "number",
"positionType": "string",
"positionY": "number",
"positionX": "number",
"timeZone": "string",
"createdAt": "object",
"updatedAt": "object",
"countDevices": "number",
"countDevicesDeep": "number",
"countChildren": "number",
"countChildrenDeep": "number",
"currency": "string",
"type": "string",
"groupMap": {
"id": "number",
"height": "number",
"width": "number",
"url": "string",
"createdAt": "object",
"updatedAt": "object"
},
"children": [
{
"organizationId": "string",
"id": "object",
"name": "string",
"path": "string",
"latitude": "number",
"longitude": "number",
"positionType": "string",
"positionY": "number",
"positionX": "number",
"timeZone": "string",
"createdAt": "object",
"updatedAt": "object"
}
]
}
}
]
}
}
ParkingProgramResponse: object
- status:
- item:
Example
{
"status": "string",
"item": {
"id": "number",
"name": "string",
"organizationId": "string",
"description": "string",
"groupId": "string",
"group": {
"organizationId": "string",
"id": "object",
"name": "string",
"path": "string",
"latitude": "number",
"longitude": "number",
"positionType": "string",
"positionY": "number",
"positionX": "number",
"timeZone": "string",
"createdAt": "object",
"updatedAt": "object",
"countDevices": "number",
"countDevicesDeep": "number",
"countChildren": "number",
"countChildrenDeep": "number",
"currency": "string",
"type": "string",
"groupMap": {
"id": "number",
"height": "number",
"width": "number",
"url": "string",
"createdAt": "object",
"updatedAt": "object"
},
"children": [
{
"organizationId": "string",
"id": "object",
"name": "string",
"path": "string",
"latitude": "number",
"longitude": "number",
"positionType": "string",
"positionY": "number",
"positionX": "number",
"timeZone": "string",
"createdAt": "object",
"updatedAt": "object",
"countDevices": "number",
"countDevicesDeep": "number",
"countChildren": "number"
}
]
}
}
}
ParkingProgramSortingConditionInput: object
- field:
- order:
Example
{
"field": "string",
"order": "string"
}
ParkingSchedule: object
- id:
- programId:
- organizationId:
- program:
- date:
- createdAt:
- updatedAt:
Example
{
"id": "number",
"programId": "number",
"organizationId": "string",
"program": {
"id": "number",
"name": "string",
"organizationId": "string",
"description": "string",
"groupId": "string",
"group": {
"organizationId": "string",
"id": "object",
"name": "string",
"path": "string",
"latitude": "number",
"longitude": "number",
"positionType": "string",
"positionY": "number",
"positionX": "number",
"timeZone": "string",
"createdAt": "object",
"updatedAt": "object",
"countDevices": "number",
"countDevicesDeep": "number",
"countChildren": "number",
"countChildrenDeep": "number",
"currency": "string",
"type": "string",
"groupMap": {
"id": "number",
"height": "number",
"width": "number",
"url": "string",
"createdAt": "object",
"updatedAt": "object"
},
"children": [
{
"organizationId": "string",
"id": "object",
"name": "string",
"path": "string",
"latitude": "number",
"longitude": "number",
"positionType": "string",
"positionY": "number",
"positionX": "number",
"timeZone": "string",
"createdAt": "object",
"updatedAt": "object",
"countDevices": "number"
}
]
}
}
}
ParkingScheduleArrayResponse: object
- status:
- items:
Example
{
"status": "string",
"items": [
{
"id": "number",
"programId": "number",
"organizationId": "string",
"program": {
"id": "number",
"name": "string",
"organizationId": "string",
"description": "string",
"groupId": "string",
"group": {
"organizationId": "string",
"id": "object",
"name": "string",
"path": "string",
"latitude": "number",
"longitude": "number",
"positionType": "string",
"positionY": "number",
"positionX": "number",
"timeZone": "string",
"createdAt": "object",
"updatedAt": "object",
"countDevices": "number",
"countDevicesDeep": "number",
"countChildren": "number",
"countChildrenDeep": "number",
"currency": "string",
"type": "string",
"groupMap": {
"id": "number",
"height": "number",
"width": "number",
"url": "string",
"createdAt": "object",
"updatedAt": "object"
},
"children": [
{
"organizationId": "string",
"id": "object",
"name": "string",
"path": "string",
"latitude": "number",
"longitude": "number",
"positionType": "string",
"positionY": "number",
"positionX": "number",
"timeZone": "string"
}
]
}
}
}
]
}
ParkingSchedulePaginatedResponse: object
- status:
- total:
- page:
Example
{
"status": "string",
"total": "number",
"page": {
"items": [
{
"id": "number",
"programId": "number",
"organizationId": "string",
"program": {
"id": "number",
"name": "string",
"organizationId": "string",
"description": "string",
"groupId": "string",
"group": {
"organizationId": "string",
"id": "object",
"name": "string",
"path": "string",
"latitude": "number",
"longitude": "number",
"positionType": "string",
"positionY": "number",
"positionX": "number",
"timeZone": "string",
"createdAt": "object",
"updatedAt": "object",
"countDevices": "number",
"countDevicesDeep": "number",
"countChildren": "number",
"countChildrenDeep": "number",
"currency": "string",
"type": "string",
"groupMap": {
"id": "number",
"height": "number",
"width": "number",
"url": "string",
"createdAt": "object",
"updatedAt": "object"
},
"children": [
{
"organizationId": "string",
"id": "object",
"name": "string",
"path": "string",
"latitude": "number",
"longitude": "number",
"positionType": "string",
"positionY": "number"
}
]
}
}
}
]
}
}
ParkingScheduleResponse: object
- status:
- item:
Example
{
"status": "string",
"item": {
"id": "number",
"programId": "number",
"organizationId": "string",
"program": {
"id": "number",
"name": "string",
"organizationId": "string",
"description": "string",
"groupId": "string",
"group": {
"organizationId": "string",
"id": "object",
"name": "string",
"path": "string",
"latitude": "number",
"longitude": "number",
"positionType": "string",
"positionY": "number",
"positionX": "number",
"timeZone": "string",
"createdAt": "object",
"updatedAt": "object",
"countDevices": "number",
"countDevicesDeep": "number",
"countChildren": "number",
"countChildrenDeep": "number",
"currency": "string",
"type": "string",
"groupMap": {
"id": "number",
"height": "number",
"width": "number",
"url": "string",
"createdAt": "object",
"updatedAt": "object"
},
"children": [
{
"organizationId": "string",
"id": "object",
"name": "string",
"path": "string",
"latitude": "number",
"longitude": "number",
"positionType": "string",
"positionY": "number",
"positionX": "number",
"timeZone": "string",
"createdAt": "object"
}
]
}
}
}
}
ParkingSlotStatus: object
- signal:
- status:
- detectedObjects:
- timestamp:
- online:
- receivedAt:
- createdAt:
- updatedAt:
Example
{
"signal": "number",
"status": "string",
"detectedObjects": "number",
"timestamp": "number",
"online": "boolean",
"receivedAt": "object",
"createdAt": "object",
"updatedAt": "object"
}
ParkingSlotStatusArrayResponse: object
- status:
- items:
Example
{
"status": "string",
"items": [
{
"signal": "number",
"status": "string",
"detectedObjects": "number",
"timestamp": "number",
"online": "boolean",
"receivedAt": "object",
"createdAt": "object",
"updatedAt": "object"
}
]
}
ParkingStatus: object
- deviceStatus:
- slotStatus:
Example
{
"deviceStatus": {
"signal": "number",
"temperature": {
"global": "number",
"CPU": "number",
"GPU": "number"
},
"batteryVoltage": "number",
"batteryPercentage": "number",
"online": "boolean",
"receivedAt": "object",
"createdAt": "object",
"updatedAt": "object"
},
"slotStatus": {
"signal": "number",
"status": "string",
"detectedObjects": "number",
"timestamp": "number",
"online": "boolean",
"receivedAt": "object",
"createdAt": "object",
"updatedAt": "object"
}
}
ProgramDayInput: object
- dayOfWeek:
- dimmingPoints:
Example
{
"dayOfWeek": "string",
"dimmingPoints": [
{
"timeIndex": "number",
"dimmingLevel": "number"
}
]
}
ProgramStatus: string
Lighting program status
-
objectPROCESSING
-
objectCONFIRMED
-
objectFAILED
-
objectTIMEOUT
QuickActionResponse: object
- status:
- item:
Example
{
"status": "string",
"item": {
"success": [
"string"
],
"errors": [
"string"
],
"offlines": [
"string"
]
}
}
RawStatus: object
- data:
- online:
- receivedAt:
- createdAt:
- updatedAt:
Example
{
"data": "object",
"online": "boolean",
"receivedAt": "object",
"createdAt": "object",
"updatedAt": "object"
}
RawStatusPaginatedResponse: object
- status:
- total:
- page:
Example
{
"status": "string",
"total": "number",
"page": {
"items": [
{
"data": "object",
"online": "boolean",
"receivedAt": "object",
"createdAt": "object",
"updatedAt": "object"
}
],
"size": "number",
"index": "number"
}
}
ReadingFrequency: string
Reading frequency
-
objectAllReading
-
objectLastReading
-
objectFirstLastReading
-
objectFirstMidLastReading
RegisterReadCommandInput: object
- type:
- registerAddress:
- numberOfRegister:
Example
{
"type": "string",
"registerAddress": "number",
"numberOfRegister": "number"
}
RepetitionPattern: string
Repetition pattern
-
objectDaily
-
objectWeekly
-
objectMonthly
-
objectQuarterly
-
objectBiannually
RequestAction: object
- controlElementType:
- dataResponse:
- commandResponse:
Example
{
"controlElementType": "string",
"dataResponse": [
{
"deviceModel": "string",
"code": "string",
"label": "string",
"deviceType": "string",
"fieldName": "string",
"data": "object"
}
],
"commandResponse": "boolean"
}
RequestActionResponse: object
- status:
- item:
Example
{
"status": "string",
"item": {
"controlElementType": "string",
"dataResponse": [
{
"deviceModel": "string",
"code": "string",
"label": "string",
"deviceType": "string",
"fieldName": "string",
"data": "object"
}
],
"commandResponse": "boolean"
}
}
String: string
The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
TimeUnits: string
Time units
-
objectyears
-
objectmonths
-
objectweeks
-
objectdays
-
objecthours
-
objectminutes
Trigger: object
- id:
- name:
- groupId:
- group:
- groupTimezone:
- active:
- createdBy:
- editedBy:
- description:
- createdAt:
- updatedAt:
- timeConstraints:
- deviceCauseGroup:
- deviceEffects:
- systemEffects:
Example
{
"id": "number",
"name": "string",
"groupId": "object",
"group": {
"organizationId": "string",
"id": "object",
"name": "string",
"path": "string",
"latitude": "number",
"longitude": "number",
"positionType": "string",
"positionY": "number",
"positionX": "number",
"timeZone": "string",
"createdAt": "object",
"updatedAt": "object",
"countDevices": "number",
"countDevicesDeep": "number",
"countChildren": "number",
"countChildrenDeep": "number",
"currency": "string",
"type": "string",
"groupMap": {
"id": "number",
"height": "number",
"width": "number",
"url": "string",
"createdAt": "object",
"updatedAt": "object"
},
"children": [
{
"organizationId": "string",
"id": "object",
"name": "string",
"path": "string",
"latitude": "number",
"longitude": "number",
"positionType": "string",
"positionY": "number",
"positionX": "number",
"timeZone": "string",
"createdAt": "object",
"updatedAt": "object",
"countDevices": "number",
"countDevicesDeep": "number",
"countChildren": "number",
"countChildrenDeep": "number",
"currency": "string",
"type": "string"
}
],
"devices": [
null
]
}
}
TriggerAllowedSortingFields: string
Trigger allowed sorting fields
-
objectname
-
objectid
-
objectcreatedAt
-
objectupdatedAt
TriggerComparisonOperators: string
Trigger comparison operators
-
objectGREATER_THAN
-
objectLOWER_THAN
-
objectGREATER_THAN_EQUAL
-
objectLOWER_THAN_EQUAL
-
objectEQUAL
-
objectNOT_EQUAL
TriggerDeviceCause: object
- id:
- triggerId:
- deviceModel:
- deviceSerial:
- fieldToMonitor:
- comparisonOperator:
- referenceValue:
- lastEvaluationDate:
- fulfilled:
- device:
Example
{
"id": "number",
"triggerId": "number",
"deviceModel": "number",
"deviceSerial": "string",
"fieldToMonitor": "string",
"comparisonOperator": "string",
"referenceValue": "number",
"lastEvaluationDate": "object",
"fulfilled": "boolean",
"device": {
"id": "object",
"organizationId": "string",
"deviceHash": "string",
"serial": "string",
"name": "string",
"supplier": "string",
"tag": "string",
"latitude": "number",
"longitude": "number",
"positionType": "string",
"positionY": "number",
"positionX": "number",
"timeZone": "string",
"networkType": "string",
"loraParams": {
"id": "number",
"deviceEUI": "string",
"applicationEUI": "string",
"joinEUI": "string",
"version": "string",
"loraClass": "string",
"regionalParametersRevision": "string",
"region": "string",
"activationType": "string",
"createdAt": "object",
"updatedAt": "object"
},
"mqttParams": {
"id": "number",
"version": "string",
"createdAt": "object",
"updatedAt": "object"
},
"maxLifetimeHours": "number",
"maxLifetimeWarningPercentage": "number",
"statusUpdateHoursOffset": "number",
"referenceNumber": "string",
"online": "boolean",
"errors": [
"string"
],
"statusUpdatedAt": "object"
}
}
TriggerDeviceCauseGroup: object
- id:
- parentCauseGroupId:
- name:
- causesOperator:
- lastEvaluationDate:
- fulfilled:
- deviceCauses:
- deviceCauseGroups:
Example
{
"id": "number",
"parentCauseGroupId": "number",
"name": "string",
"causesOperator": "string",
"lastEvaluationDate": "object",
"fulfilled": "boolean",
"deviceCauses": [
{
"id": "number",
"triggerId": "number",
"deviceModel": "number",
"deviceSerial": "string",
"fieldToMonitor": "string",
"comparisonOperator": "string",
"referenceValue": "number",
"lastEvaluationDate": "object",
"fulfilled": "boolean",
"device": {
"id": "object",
"organizationId": "string",
"deviceHash": "string",
"serial": "string",
"name": "string",
"supplier": "string",
"tag": "string",
"latitude": "number",
"longitude": "number",
"positionType": "string",
"positionY": "number",
"positionX": "number",
"timeZone": "string",
"networkType": "string",
"loraParams": {
"id": "number",
"deviceEUI": "string",
"applicationEUI": "string",
"joinEUI": "string",
"version": "string",
"loraClass": "string",
"regionalParametersRevision": "string",
"region": "string",
"activationType": "string",
"createdAt": "object",
"updatedAt": "object"
},
"mqttParams": {
"id": "number",
"version": "string",
"createdAt": "object",
"updatedAt": "object"
}
}
}
]
}
TriggerDeviceCauseGroupArrayResponse: object
- status:
- items:
Example
{
"status": "string",
"items": [
{
"id": "number",
"parentCauseGroupId": "number",
"name": "string",
"causesOperator": "string",
"lastEvaluationDate": "object",
"fulfilled": "boolean",
"deviceCauses": [
{
"id": "number",
"triggerId": "number",
"deviceModel": "number",
"deviceSerial": "string",
"fieldToMonitor": "string",
"comparisonOperator": "string",
"referenceValue": "number",
"lastEvaluationDate": "object",
"fulfilled": "boolean",
"device": {
"id": "object",
"organizationId": "string",
"deviceHash": "string",
"serial": "string",
"name": "string",
"supplier": "string",
"tag": "string",
"latitude": "number",
"longitude": "number",
"positionType": "string",
"positionY": "number",
"positionX": "number",
"timeZone": "string",
"networkType": "string",
"loraParams": {
"id": "number",
"deviceEUI": "string",
"applicationEUI": "string",
"joinEUI": "string",
"version": "string",
"loraClass": "string",
"regionalParametersRevision": "string",
"region": "string",
"activationType": "string",
"createdAt": "object",
"updatedAt": "object"
},
"mqttParams": {
"id": "number",
"version": "string"
}
}
}
]
}
]
}
TriggerDeviceCauseGroupInput: object
- name:
- causesOperator:
- deviceCauseGroups:
- deviceCauses:
Example
{
"name": "string",
"causesOperator": "string",
"deviceCauseGroups": [
{
"name": "string",
"causesOperator": "string",
"deviceCauseGroups": [
{
"name": "string",
"causesOperator": "string",
"deviceCauseGroups": [
{
"name": "string",
"causesOperator": "string",
"deviceCauseGroups": [
{
"name": "string",
"causesOperator": "string",
"deviceCauseGroups": [
{
"name": "string",
"causesOperator": "string",
"deviceCauseGroups": [
{
"name": "string",
"causesOperator": "string",
"deviceCauseGroups": [
{
"name": "string",
"causesOperator": "string",
"deviceCauseGroups": [
{
"name": "string",
"causesOperator": "string",
"deviceCauseGroups": [
{
"name": "string",
"causesOperator": "string",
"deviceCauseGroups": [
{
"name": "string",
"causesOperator": "string",
"deviceCauseGroups": [
{
"name": "string",
"causesOperator": "string",
"deviceCauseGroups": [
{
"name": "string",
"causesOperator": "string",
"deviceCauseGroups": [
{
"name": "string",
"causesOperator": "string",
"deviceCauseGroups": [
{}
]
}
]
}
]
}
]
}
]
}
]
}
]
}
]
}
]
}
]
}
]
}
]
}
]
}
]
}
TriggerDeviceCauseInput: object
- deviceModel:
- deviceSerial:
- fieldToMonitor:
- comparisonOperator:
- referenceValue:
Example
{
"deviceModel": "number",
"deviceSerial": "string",
"fieldToMonitor": "string",
"comparisonOperator": "string",
"referenceValue": "number"
}
TriggerDeviceEffect: object
- id:
- triggerId:
- deviceType:
- deviceModel:
- deviceSerial:
- commandId:
- params:
- lastExecutionDate:
- executionCount:
- executionOffsetMinutes:
- maxExecutionsCount:
- device:
Example
{
"id": "number",
"triggerId": "number",
"deviceType": "number",
"deviceModel": "number",
"deviceSerial": "string",
"commandId": "number",
"params": "object",
"lastExecutionDate": "object",
"executionCount": "number",
"executionOffsetMinutes": "number",
"maxExecutionsCount": "number",
"device": {
"id": "object",
"organizationId": "string",
"deviceHash": "string",
"serial": "string",
"name": "string",
"supplier": "string",
"tag": "string",
"latitude": "number",
"longitude": "number",
"positionType": "string",
"positionY": "number",
"positionX": "number",
"timeZone": "string",
"networkType": "string",
"loraParams": {
"id": "number",
"deviceEUI": "string",
"applicationEUI": "string",
"joinEUI": "string",
"version": "string",
"loraClass": "string",
"regionalParametersRevision": "string",
"region": "string",
"activationType": "string",
"createdAt": "object",
"updatedAt": "object"
},
"mqttParams": {
"id": "number",
"version": "string",
"createdAt": "object",
"updatedAt": "object"
},
"maxLifetimeHours": "number",
"maxLifetimeWarningPercentage": "number",
"statusUpdateHoursOffset": "number",
"referenceNumber": "string",
"online": "boolean",
"errors": [
null
]
}
}
TriggerDeviceEffectInput: object
- deviceType:
- deviceModel:
- deviceSerial:
- commandId:
- params:
- executionOffsetMinutes:
- maxExecutionsCount:
Example
{
"deviceType": "number",
"deviceModel": "number",
"deviceSerial": "string",
"commandId": "number",
"params": "object",
"executionOffsetMinutes": "number",
"maxExecutionsCount": "number"
}
TriggerPaginatedResponse: object
- status:
- total:
- page:
Example
{
"status": "string",
"total": "number",
"page": {
"items": [
{
"id": "number",
"name": "string",
"group": {
"organizationId": "string",
"id": "object",
"name": "string",
"path": "string",
"latitude": "number",
"longitude": "number",
"positionType": "string",
"positionY": "number",
"positionX": "number",
"timeZone": "string",
"createdAt": "object",
"updatedAt": "object",
"countDevices": "number",
"countDevicesDeep": "number",
"countChildren": "number",
"countChildrenDeep": "number",
"currency": "string",
"type": "string",
"groupMap": {
"id": "number",
"height": "number",
"width": "number",
"url": "string",
"createdAt": "object",
"updatedAt": "object"
},
"children": [
{
"organizationId": "string",
"id": "object",
"name": "string",
"path": "string",
"latitude": "number",
"longitude": "number",
"positionType": "string",
"positionY": "number",
"positionX": "number",
"timeZone": "string",
"createdAt": "object",
"updatedAt": "object",
"countDevices": "number",
"countDevicesDeep": "number",
"countChildren": "number"
}
]
}
}
]
}
}
TriggerResponse: object
- status:
- item:
Example
{
"status": "string",
"item": {
"id": "number",
"name": "string",
"groupId": "object",
"group": {
"organizationId": "string",
"id": "object",
"name": "string",
"path": "string",
"latitude": "number",
"longitude": "number",
"positionType": "string",
"positionY": "number",
"positionX": "number",
"timeZone": "string",
"createdAt": "object",
"updatedAt": "object",
"countDevices": "number",
"countDevicesDeep": "number",
"countChildren": "number",
"countChildrenDeep": "number",
"currency": "string",
"type": "string",
"groupMap": {
"id": "number",
"height": "number",
"width": "number",
"url": "string",
"createdAt": "object",
"updatedAt": "object"
},
"children": [
{
"organizationId": "string",
"id": "object",
"name": "string",
"path": "string",
"latitude": "number",
"longitude": "number",
"positionType": "string",
"positionY": "number",
"positionX": "number",
"timeZone": "string",
"createdAt": "object",
"updatedAt": "object",
"countDevices": "number",
"countDevicesDeep": "number",
"countChildren": "number",
"countChildrenDeep": "number",
"currency": "string"
}
]
}
}
}
TriggerSystemEffect: object
- id:
- triggerId:
- type:
-
params:
object
- lastExecutionDate:
- executionCount:
- executionOffsetMinutes:
- maxExecutionsCount:
Example
{
"id": "number",
"triggerId": "number",
"type": "string",
"lastExecutionDate": "object",
"executionCount": "number",
"executionOffsetMinutes": "number",
"maxExecutionsCount": "number"
}
TriggerSystemEffectInput: object
- type:
- params:
- executionOffsetMinutes:
- maxExecutionsCount:
Example
{
"type": "string",
"params": "object",
"executionOffsetMinutes": "number",
"maxExecutionsCount": "number"
}
TriggerSystemEffectPushParams: object
- userIds:
- appCode:
- users:
Example
{
"userIds": [
"string"
],
"appCode": "string",
"users": [
{
"id": "object",
"name": "string",
"lastName": "string",
"email": "string",
"gender": "string",
"phoneNumber": "string",
"avatar": "string",
"confirmedAt": "object",
"createdAt": "object",
"updatedAt": "object",
"lastAccess": "object",
"createdBy": {
"id": "object",
"name": "string",
"lastName": "string",
"email": "string",
"gender": "string",
"phoneNumber": "string",
"avatar": "string",
"confirmedAt": "object",
"createdAt": "object",
"updatedAt": "object",
"lastAccess": "object",
"createdBy": {
"id": "object",
"name": "string",
"lastName": "string",
"email": "string",
"gender": "string",
"phoneNumber": "string",
"avatar": "string",
"confirmedAt": "object",
"createdAt": "object",
"updatedAt": "object",
"lastAccess": "object",
"createdBy": {
"id": "object",
"name": "string",
"lastName": "string",
"email": "string",
"gender": "string",
"phoneNumber": "string",
"avatar": "string",
"confirmedAt": "object",
"createdAt": "object"
}
}
}
}
]
}
TriggersListItem: object
- id:
- name:
- group:
- groupTimezone:
- active:
- createdBy:
- editedBy:
- description:
- createdAt:
- updatedAt:
- effects:
- causes:
- causesDevices:
- effectsDevices:
Example
{
"id": "number",
"name": "string",
"group": {
"organizationId": "string",
"id": "object",
"name": "string",
"path": "string",
"latitude": "number",
"longitude": "number",
"positionType": "string",
"positionY": "number",
"positionX": "number",
"timeZone": "string",
"createdAt": "object",
"updatedAt": "object",
"countDevices": "number",
"countDevicesDeep": "number",
"countChildren": "number",
"countChildrenDeep": "number",
"currency": "string",
"type": "string",
"groupMap": {
"id": "number",
"height": "number",
"width": "number",
"url": "string",
"createdAt": "object",
"updatedAt": "object"
},
"children": [
{
"organizationId": "string",
"id": "object",
"name": "string",
"path": "string",
"latitude": "number",
"longitude": "number",
"positionType": "string",
"positionY": "number",
"positionX": "number",
"timeZone": "string",
"createdAt": "object",
"updatedAt": "object",
"countDevices": "number",
"countDevicesDeep": "number",
"countChildren": "number",
"countChildrenDeep": "number",
"currency": "string",
"type": "string"
}
],
"devices": [
{}
]
}
}
TriggersSortingConditionInput: object
- field:
- order:
Example
{
"field": "string",
"order": "string"
}
UpdateControlCommandInput: object
- deviceSerial:
- deviceCommandId:
- deviceCommandCode:
- defaultTiming:
- defaultDimming:
- params:
Example
{
"deviceSerial": "string",
"deviceCommandId": "number",
"deviceCommandCode": "string",
"defaultTiming": "boolean",
"defaultDimming": "boolean",
"params": "object"
}
UpdateControlElementInput: object
- type:
- title:
- description:
- orderSequence:
- enabled:
- controlCommands:
- controlData:
Example
{
"type": "string",
"title": "string",
"description": "string",
"orderSequence": "number",
"enabled": "boolean",
"controlCommands": [
{
"deviceSerial": "string",
"deviceCommandId": "number",
"deviceCommandCode": "string",
"defaultTiming": "boolean",
"defaultDimming": "boolean",
"params": "object"
}
],
"controlData": [
{
"deviceSerial": "string",
"deviceCommandCode": "string"
}
]
}
User: object
- id:
- name:
- lastName:
- email:
- gender:
- phoneNumber:
- avatar:
- confirmedAt:
- createdAt:
- updatedAt:
- lastAccess:
- createdBy:
- organizations:
Example
{
"id": "object",
"name": "string",
"lastName": "string",
"email": "string",
"gender": "string",
"phoneNumber": "string",
"avatar": "string",
"confirmedAt": "object",
"createdAt": "object",
"updatedAt": "object",
"lastAccess": "object",
"createdBy": {
"id": "object",
"name": "string",
"lastName": "string",
"email": "string",
"gender": "string",
"phoneNumber": "string",
"avatar": "string",
"confirmedAt": "object",
"createdAt": "object",
"updatedAt": "object",
"lastAccess": "object",
"createdBy": {
"id": "object",
"name": "string",
"lastName": "string",
"email": "string",
"gender": "string",
"phoneNumber": "string",
"avatar": "string",
"confirmedAt": "object",
"createdAt": "object",
"updatedAt": "object",
"lastAccess": "object",
"createdBy": {
"id": "object",
"name": "string",
"lastName": "string",
"email": "string",
"gender": "string",
"phoneNumber": "string",
"avatar": "string",
"confirmedAt": "object",
"createdAt": "object",
"updatedAt": "object",
"lastAccess": "object",
"createdBy": {
"id": "object"
}
}
}
}
}
UserGroupAccessPolicy: object
- groupId:
- groupPermission:
Example
{
"groupId": "string",
"groupPermission": [
"string"
]
}
UserGroupAccessPolicyResponse: object
- status:
- item:
Example
{
"status": "string",
"item": {
"groupId": "string",
"groupPermission": [
"string"
]
}
}
UserLicenceAccessPolicy: object
- type:
- activeModules:
- access:
Example
{
"type": "string",
"activeModules": [
"string"
],
"access": [
"string"
]
}
UserPaginatedResponse: object
- status:
- total:
- page:
Example
{
"status": "string",
"total": "number",
"page": {
"items": [
{
"id": "object",
"name": "string",
"lastName": "string",
"email": "string",
"gender": "string",
"phoneNumber": "string",
"avatar": "string",
"confirmedAt": "object",
"createdAt": "object",
"updatedAt": "object",
"lastAccess": "object",
"createdBy": {
"id": "object",
"name": "string",
"lastName": "string",
"email": "string",
"gender": "string",
"phoneNumber": "string",
"avatar": "string",
"confirmedAt": "object",
"createdAt": "object",
"updatedAt": "object",
"lastAccess": "object",
"createdBy": {
"id": "object",
"name": "string",
"lastName": "string",
"email": "string",
"gender": "string",
"phoneNumber": "string",
"avatar": "string",
"confirmedAt": "object",
"createdAt": "object",
"updatedAt": "object",
"lastAccess": "object",
"createdBy": {
"id": "object",
"name": "string",
"lastName": "string",
"email": "string",
"gender": "string",
"phoneNumber": "string",
"avatar": "string",
"confirmedAt": "object",
"createdAt": "object"
}
}
}
}
]
}
}
UserPlatformPermissions: string
User Platform Permissions Types
-
objectEditUser
-
objectDeleteUser
-
objectCreateNewOrganization
-
objectDeleteOrganization
UserResponse: object
- status:
- item:
Example
{
"status": "string",
"item": {
"id": "object",
"name": "string",
"lastName": "string",
"email": "string",
"gender": "string",
"phoneNumber": "string",
"avatar": "string",
"confirmedAt": "object",
"createdAt": "object",
"updatedAt": "object",
"lastAccess": "object",
"createdBy": {
"id": "object",
"name": "string",
"lastName": "string",
"email": "string",
"gender": "string",
"phoneNumber": "string",
"avatar": "string",
"confirmedAt": "object",
"createdAt": "object",
"updatedAt": "object",
"lastAccess": "object",
"createdBy": {
"id": "object",
"name": "string",
"lastName": "string",
"email": "string",
"gender": "string",
"phoneNumber": "string",
"avatar": "string",
"confirmedAt": "object",
"createdAt": "object",
"updatedAt": "object",
"lastAccess": "object",
"createdBy": {
"id": "object",
"name": "string",
"lastName": "string",
"email": "string",
"gender": "string",
"phoneNumber": "string",
"avatar": "string",
"confirmedAt": "object",
"createdAt": "object",
"updatedAt": "object",
"lastAccess": "object"
}
}
}
}
}
VirtualAsset: object
- id:
- urlInfo:
- note:
- deviceCategory:
- pictureUrl:
- createdAt:
- updatedAt:
Example
{
"id": "number",
"urlInfo": "string",
"note": "string",
"deviceCategory": {
"id": "number",
"name": "string",
"iconName": "string",
"createdAt": "object",
"updatedAt": "object"
},
"pictureUrl": "string",
"createdAt": "object",
"updatedAt": "object"
}
WearableGPSSearchModes: string
Wearable GPS Search Modes
-
objectDEFAULT
-
objectGPS_GLONASS
-
objectGPS_BEIDOU
-
objectGPS_GALILEO
-
objectGPS_GLONASS_GALILEO
WearableMovementDetectionModeInput: object
- detectionMode:
- threshold:
- outputDataRate:
Example
{
"detectionMode": "string",
"threshold": "number",
"outputDataRate": "number"
}
WearableMovementDetectionModes: string
Wearable Movement Detection Modes
-
objectDISABLE
-
objectMOVE
-
objectCOLLIDE
-
objectCUSTOM
WearableSB01Status: object
- latitude:
- longitude:
- altitude:
- motionMode:
- alarm:
- ledStatus:
- battery:
- batteryPercentage:
- roll:
- pitch:
- online:
- signal:
- receivedAt:
- createdAt:
- updatedAt:
Example
{
"latitude": "number",
"longitude": "number",
"altitude": "number",
"motionMode": "string",
"alarm": "boolean",
"ledStatus": "boolean",
"battery": "number",
"batteryPercentage": "number",
"roll": "number",
"pitch": "number",
"online": "boolean",
"signal": "number",
"receivedAt": "object",
"createdAt": "object",
"updatedAt": "object"
}
WearableSB01StatusPaginatedResponse: object
- status:
- total:
- page:
Example
{
"status": "string",
"total": "number",
"page": {
"items": [
{
"latitude": "number",
"longitude": "number",
"altitude": "number",
"motionMode": "string",
"alarm": "boolean",
"ledStatus": "boolean",
"battery": "number",
"batteryPercentage": "number",
"roll": "number",
"pitch": "number",
"online": "boolean",
"signal": "number",
"receivedAt": "object",
"createdAt": "object",
"updatedAt": "object"
}
],
"size": "number",
"index": "number"
}
}