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:

Flow

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:

playground


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.

docs


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.

schema


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

(no description)

(no description)

(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
        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
      }
      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"
}
Try it now
Response Content-Types: application/json
Response Example (200 OK)
{
  "data": {
    "devices": {
      "total": "integer",
      "page": {
        "items": [
          {
            "id": "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"
              }
            }
          }
        ]
      }
    }
  }
}

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
      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
    }
  }
}
Variables
{
  "serial": "string",
  "id": "string"
}
Try it now
Response Content-Types: application/json
Response Example (200 OK)
{
  "data": {
    "device": {
      "item": {
        "id": "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

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($search: String, $deviceTypes: [DeviceTypes!], $userId: String, $flat: Boolean, $page: Int, $pageSize: Int){
  groups(search: $search, deviceTypes: $deviceTypes, userId: $userId, flat: $flat, page: $page, pageSize: $pageSize){
    status
    total
    page{
      items{
        id
        name
        path
        latitude
        longitude
        positionType
        positionY
        positionX
        timeZone
        createdAt
        updatedAt
        countDevices
        countDevicesDeep
        countChildren
        countChildrenDeep
        currency
        type
        groupMap{
          id
          height
          width
          url
          createdAt
          updatedAt
        }
        children{
          id
          name
          path
          latitude
          longitude
          positionType
          positionY
          positionX
          timeZone
          createdAt
          updatedAt
          countDevices
          countDevicesDeep
          countChildren
          countChildrenDeep
          currency
          type
        }
        devices{
          id
          serial
          name
          supplier
          tag
          latitude
          longitude
          positionType
          positionY
          positionX
          timeZone
          networkType
          maxLifetimeHours
          maxLifetimeWarningPercentage
          statusUpdateHoursOffset
          referenceNumber
          online
          errors
          statusUpdatedAt
          createdAt
          updatedAt
          status
        }
      }
      size
      index
    }
  }
}
Variables
{
  "search": "string",
  "deviceTypes": [
    "string"
  ],
  "userId": "string",
  "flat": "boolean",
  "page": "integer",
  "pageSize": "integer"
}
Try it now
Response Content-Types: application/json
Response Example (200 OK)
{
  "data": {
    "groups": {
      "total": "integer",
      "page": {
        "items": [
          {
            "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": [
              {
                "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",
                "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"
                ]
              }
            ]
          }
        ],
        "size": "integer",
        "index": "integer"
      }
    }
  }
}

Get Single Group

Fetch single group details

userId:
string

(no description)

id:
string

(no description)

Example

Request Content-Types: application/json
Query
query group($userId: String, $id: String!){
  group(userId: $userId, id: $id){
    status
    item{
      id
      name
      path
      latitude
      longitude
      positionType
      positionY
      positionX
      timeZone
      createdAt
      updatedAt
      countDevices
      countDevicesDeep
      countChildren
      countChildrenDeep
      currency
      type
      groupMap{
        id
        height
        width
        url
        createdAt
        updatedAt
      }
      children{
        id
        name
        path
        latitude
        longitude
        positionType
        positionY
        positionX
        timeZone
        createdAt
        updatedAt
        countDevices
        countDevicesDeep
        countChildren
        countChildrenDeep
        currency
        type
      }
      devices{
        id
        serial
        name
        supplier
        tag
        latitude
        longitude
        positionType
        positionY
        positionX
        timeZone
        networkType
        maxLifetimeHours
        maxLifetimeWarningPercentage
        statusUpdateHoursOffset
        referenceNumber
        online
        errors
        statusUpdatedAt
        createdAt
        updatedAt
        group{
          id
          name
          path
          latitude
          longitude
          positionType
          positionY
          positionX
          timeZone
          createdAt
          updatedAt
          countDevices
          countDevicesDeep
          countChildren
          countChildrenDeep
          currency
          type
          groupMap{
            ...RecursiveGroupMapFragment
          }
          children{
            ...RecursiveGroupBaseFragment
          }
          devices{
            ...RecursiveDeviceFragment
          }
        }
        status
      }
    }
  }
}
Variables
{
  "userId": "string",
  "id": "string"
}
Try it now
Response Content-Types: application/json
Response Example (200 OK)
{
  "data": {
    "group": {
      "item": {
        "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": [
          {
            "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",
            "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"
            ]
          }
        ]
      }
    }
  }
}

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{
      id
      name
      path
      latitude
      longitude
      positionType
      positionY
      positionX
      timeZone
      createdAt
      updatedAt
      countDevices
      countDevicesDeep
      countChildren
      countChildrenDeep
      currency
      type
      groupMap{
        id
        height
        width
        url
        createdAt
        updatedAt
      }
      children{
        id
        name
        path
        latitude
        longitude
        positionType
        positionY
        positionX
        timeZone
        createdAt
        updatedAt
        countDevices
        countDevicesDeep
        countChildren
        countChildrenDeep
        currency
        type
      }
      devices{
        id
        serial
        name
        supplier
        tag
        latitude
        longitude
        positionType
        positionY
        positionX
        timeZone
        networkType
        maxLifetimeHours
        maxLifetimeWarningPercentage
        statusUpdateHoursOffset
        referenceNumber
        online
        errors
        statusUpdatedAt
        createdAt
        updatedAt
        status
      }
    }
  }
}
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"
}
Try it now
Response Content-Types: application/json
Response Example (200 OK)
{
  "data": {
    "createGroup": {
      "item": {
        "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": [
          {
            "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",
            "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"
            ]
          }
        ]
      }
    }
  }
}

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{
      id
      name
      path
      latitude
      longitude
      positionType
      positionY
      positionX
      timeZone
      createdAt
      updatedAt
      countDevices
      countDevicesDeep
      countChildren
      countChildrenDeep
      currency
      type
      groupMap{
        id
        height
        width
        url
        createdAt
        updatedAt
      }
      children{
        id
        name
        path
        latitude
        longitude
        positionType
        positionY
        positionX
        timeZone
        createdAt
        updatedAt
        countDevices
        countDevicesDeep
        countChildren
        countChildrenDeep
        currency
        type
      }
      devices{
        id
        serial
        name
        supplier
        tag
        latitude
        longitude
        positionType
        positionY
        positionX
        timeZone
        networkType
        maxLifetimeHours
        maxLifetimeWarningPercentage
        statusUpdateHoursOffset
        referenceNumber
        online
        errors
        statusUpdatedAt
        createdAt
        updatedAt
        status
      }
    }
  }
}
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"
}
Try it now
Response Content-Types: application/json
Response Example (200 OK)
{
  "data": {
    "editGroup": {
      "item": {
        "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": [
          {
            "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",
            "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"
            ]
          }
        ]
      }
    }
  }
}

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
        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"
}
Try it now
Response Content-Types: application/json
Response Example (200 OK)
{
  "data": {
    "lightingPrograms": {
      "total": "integer",
      "page": {
        "items": [
          {
            "id": "integer",
            "name": "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
      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"
}
Try it now
Response Content-Types: application/json
Response Example (200 OK)
{
  "data": {
    "lightingProgram": {
      "item": {
        "id": "integer",
        "name": "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
      programId
      program{
        id
        name
        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"
}
Try it now
Response Content-Types: application/json
Response Example (200 OK)
{
  "data": {
    "lightingSchedules": {
      "items": [
        {
          "id": "integer",
          "groupId": "string",
          "programId": "integer",
          "program": {
            "id": "integer",
            "name": "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
      programId
      program{
        id
        name
        description
        createdAt
        updatedAt
      }
      programCommandId
      programCommand{
        id
        label
        groupId
        status
        devicesCount
        confirmedDevicesCount
        errorDevicesCount
        commandsCount
        confirmedCommandsCount
        errorCommandsCount
        createdAt
        updatedAt
      }
      scheduledDate
      lastRetryDate
      createdAt
      updatedAt
    }
  }
}
Variables
{
  "scheduleId": "integer"
}
Try it now
Response Content-Types: application/json
Response Example (200 OK)
{
  "data": {
    "lightingSchedule": {
      "item": {
        "id": "integer",
        "groupId": "string",
        "programId": "integer",
        "program": {
          "id": "integer",
          "name": "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)

(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
        description
        groupId
        group{
          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
          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"
}
Try it now
Response Content-Types: application/json
Response Example (200 OK)
{
  "data": {
    "parkingPrograms": {
      "total": "integer",
      "page": {
        "items": [
          {
            "id": "integer",
            "name": "string",
            "description": "string",
            "groupId": "string",
            "group": {
              "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"
              }
            ],
            "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
      description
      groupId
      group{
        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
        date
        createdAt
        updatedAt
      }
      createdBy{
        id
        name
        lastName
        email
        gender
        phoneNumber
        avatar
        confirmedAt
        createdAt
        updatedAt
        lastAccess
        createdBy{
          ...RecursiveUserFragment
        }
      }
      createdAt
      updatedAt
    }
  }
}
Variables
{
  "programId": "integer"
}
Try it now
Response Content-Types: application/json
Response Example (200 OK)
{
  "data": {
    "parkingProgram": {
      "item": {
        "id": "integer",
        "name": "string",
        "description": "string",
        "groupId": "string",
        "group": {
          "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"
          }
        ],
        "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
        program{
          id
          name
          description
          groupId
          type
          createdAt
          updatedAt
        }
        date
        createdAt
        updatedAt
      }
      size
      index
    }
  }
}
Variables
{
  "page": "integer",
  "pageSize": "integer",
  "groupIds": [
    "string"
  ],
  "programId": "number"
}
Try it now
Response Content-Types: application/json
Response Example (200 OK)
{
  "data": {
    "parkingSchedules": {
      "total": "integer",
      "page": {
        "items": [
          {
            "id": "integer",
            "programId": "integer",
            "program": {
              "id": "integer",
              "name": "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
      program{
        id
        name
        description
        groupId
        type
        createdAt
        updatedAt
      }
      date
      createdAt
      updatedAt
    }
  }
}
Variables
{
  "scheduleId": "integer"
}
Try it now
Response Content-Types: application/json
Response Example (200 OK)
{
  "data": {
    "parkingSchedule": {
      "item": {
        "id": "integer",
        "programId": "integer",
        "program": {
          "id": "integer",
          "name": "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)

(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
        groupId
        group{
          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
          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"
}
Try it now
Response Content-Types: application/json
Response Example (200 OK)
{
  "data": {
    "meteringPrograms": {
      "total": "integer",
      "page": {
        "items": [
          {
            "id": "integer",
            "name": "string",
            "description": "string",
            "groupId": "string",
            "group": {
              "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"
              }
            ],
            "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
      groupId
      group{
        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
        date
        createdAt
        updatedAt
      }
      createdBy{
        id
        name
        lastName
        email
        gender
        phoneNumber
        avatar
        confirmedAt
        createdAt
        updatedAt
        lastAccess
        createdBy{
          ...RecursiveUserFragment
        }
      }
      createdAt
      updatedAt
    }
  }
}
Variables
{
  "programId": "integer"
}
Try it now
Response Content-Types: application/json
Response Example (200 OK)
{
  "data": {
    "meteringProgram": {
      "item": {
        "id": "integer",
        "name": "string",
        "description": "string",
        "groupId": "string",
        "group": {
          "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"
          }
        ],
        "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
        program{
          id
          name
          description
          groupId
          type
          createdAt
          updatedAt
        }
        date
        createdAt
        updatedAt
      }
      size
      index
    }
  }
}
Variables
{
  "page": "integer",
  "pageSize": "integer",
  "groupIds": [
    "string"
  ],
  "programId": "number"
}
Try it now
Response Content-Types: application/json
Response Example (200 OK)
{
  "data": {
    "meteringSchedules": {
      "total": "integer",
      "page": {
        "items": [
          {
            "id": "integer",
            "programId": "integer",
            "program": {
              "id": "integer",
              "name": "string",
              "description": "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
      program{
        id
        name
        description
        groupId
        type
        createdAt
        updatedAt
      }
      date
      createdAt
      updatedAt
    }
  }
}
Variables
{
  "scheduleId": "integer"
}
Try it now
Response Content-Types: application/json
Response Example (200 OK)
{
  "data": {
    "meteringSchedule": {
      "item": {
        "id": "integer",
        "programId": "integer",
        "program": {
          "id": "integer",
          "name": "string",
          "description": "string",
          "groupId": "string"
        }
      }
    }
  }
}

Schema Definitions

AstroProgramCommandDeviceStatus: string

Lighting device astro clock program status",

object
CREATED
object
SENT
object
CONFIRMED
object
FAILED
object
TIMEOUT

Automation: object

description:
ioConfig:
loadCellConfig:
Example
{
  "description": "string",
  "ioConfig": {
    "inputs": [
      {
        "key": "number",
        "label": "string",
        "connectedOutputs": [
          "number"
        ]
      }
    ],
    "outputs": [
      {
        "key": "number",
        "label": "string"
      }
    ]
  },
  "loadCellConfig": {
    "nominalLoad": "number",
    "thresholdOne": "number",
    "thresholdTwo": "number"
  }
}

AutomationDigitalInputStatus: object

signal:
Int
online:
createdAt:
updatedAt:
receivedAt:
digitalInputOne:
digitalInputTwo:
Example
{
  "signal": "number",
  "online": "boolean",
  "createdAt": "object",
  "updatedAt": "object",
  "receivedAt": "object",
  "digitalInputOne": "boolean",
  "digitalInputTwo": "boolean"
}

AutomationDigitalOutputStatus: object

signal:
Int
online:
createdAt:
updatedAt:
receivedAt:
digitalOutputOne:
digitalOutputTwo:
Example
{
  "signal": "number",
  "online": "boolean",
  "createdAt": "object",
  "updatedAt": "object",
  "receivedAt": "object",
  "digitalOutputOne": "boolean",
  "digitalOutputTwo": "boolean"
}

AutomationIO01DigitalInputStatusPaginatedResponse: object

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

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"
  }
}

AutomationLoadCellLoadStatus: object

nominalLoad:
Int
thresholdOne:
Int
thresholdTwo:
Int
Example
{
  "nominalLoad": "number",
  "thresholdOne": "number",
  "thresholdTwo": "number"
}

AutomationLoadCellLoadStatusResponse: object

Example
{
  "status": "string",
  "item": {
    "nominalLoad": "number",
    "thresholdOne": "number",
    "thresholdTwo": "number"
  }
}

AutomationLoadCellStatus: object

signal:
Int
weight:
batteryPercentage:
Int
timeShift:
Int
receivedAt:
online:
Example
{
  "signal": "number",
  "weight": "number",
  "batteryPercentage": "number",
  "timeShift": "number",
  "receivedAt": "object",
  "online": "boolean"
}

AutomationLoadCellStatusPaginatedResponse: object

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

object
NOMINAL_LOAD
object
THRESHOLD_ONE
object
THRESHOLD_TWO

AutomationLoadCellTotalLoad: object

total:
Example
{
  "total": "number"
}

AutomationLoadCellTotalLoadResponse: object

Example
{
  "status": "string",
  "item": {
    "total": "number"
  }
}

AutomationOutputInput: object

output:
Example
{
  "output": "boolean"
}

AutomationST02Status: object

tamper:
process:
battery:
Int
fraud:
hygrometry:
temperature:
di_0:
di_1:
power:
valve:
class:
cable:
leakage:
receivedAt:
online:
Example
{
  "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

Example
{
  "status": "string",
  "total": "number",
  "page": {
    "items": [
      {
        "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

tamper:
process:
battery:
Int
fraud:
hygrometry:
temperature:
di_0:
di_1:
power:
valve:
class:
cable:
leakage:
receivedAt:
online:
Example
{
  "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

Example
{
  "status": "string",
  "total": "number",
  "page": {
    "items": [
      {
        "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:
Int
Example
{
  "status": "string",
  "timeBase": "string",
  "interval": "number"
}

AutomationValveStatusUpdateIntervalsInput: object

closedIntervalUnit:
closedInterval:
Int
openedIntervalUnit:
openedInterval:
Int
Example
{
  "closedIntervalUnit": "string",
  "closedInterval": "number",
  "openedIntervalUnit": "string",
  "openedInterval": "number"
}

Boolean: boolean

The Boolean scalar type represents true or false.

Example
boolean

BooleanParamInput: object

value:
Example
{
  "value": "boolean"
}

CommandDeviceEffect: object

id:
Int
commandScheduleId:
Int
commandId:
Int
params:
lastExecutionDate:
executionCount:
Int
device:
Example
{
  "id": "number",
  "commandScheduleId": "number",
  "commandId": "number",
  "params": "object",
  "lastExecutionDate": "object",
  "executionCount": "number",
  "device": {
    "id": "object",
    "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"
    }
  }
}

CommandDeviceEffectInput: object

deviceSerial:
commandId:
Int
params:
Example
{
  "deviceSerial": "string",
  "commandId": "number",
  "params": "object"
}

CommandSchedule: object

id:
Int
name:
description:
groupId:
ID
group:
active:
months:
Int
daysOfMonth:
Int
daysOfWeek:
startDate:
repeatPattern:
createdBy:
editedBy:
createdAt:
updatedAt:
deviceEffects:
Example
{
  "id": "number",
  "name": "string",
  "description": "string",
  "groupId": "object",
  "group": {
    "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": [
      {
        "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": [
      {}
    ]
  }
}

CommandScheduleAllowedSortingFields: string

Command schedule allowed sorting fields

object
name
object
id
object
createdAt
object
updatedAt

CommandSchedulePaginatedResponse: object

Example
{
  "status": "string",
  "total": "number",
  "page": {
    "items": [
      {
        "id": "number",
        "name": "string",
        "description": "string",
        "groupId": "object",
        "group": {
          "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": [
            {
              "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"
            }
          ]
        }
      }
    ]
  }
}

CommandScheduleRepetitionPattern: string

Command Schedule Repetition pattern

object
Once
object
Daily
object
Weekly
object
Monthly
object
Quarterly
object
Biannually

CommandScheduleResponse: object

Example
{
  "status": "string",
  "item": {
    "id": "number",
    "name": "string",
    "description": "string",
    "groupId": "object",
    "group": {
      "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": [
        {
          "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"
        }
      ]
    }
  }
}

CommandSchedulesSortingConditionInput: object

Example
{
  "field": "string",
  "order": "string"
}

CreateAutomationInput: object

description:
ioConfig:
loadCellConfig:
Example
{
  "description": "string",
  "ioConfig": {
    "inputs": [
      {
        "key": "number",
        "label": "string",
        "connectedOutputs": [
          "number"
        ]
      }
    ],
    "outputs": [
      {
        "key": "number",
        "label": "string"
      }
    ]
  },
  "loadCellConfig": {
    "nominalLoad": "number",
    "thresholdOne": "number",
    "thresholdTwo": "number"
  }
}

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:
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"
    }
  }
}

CreateParkingInput: object

class:
Example
{
  "class": "string"
}

CreateParkingVirtualSlotInput: object

serial:
name:
latitude:
longitude:
positionY:
positionX:
Example
{
  "serial": "string",
  "name": "string",
  "latitude": "number",
  "longitude": "number",
  "positionY": "number",
  "positionX": "number"
}

CreateVirtualAssetInput: object

deviceCategoryId:
Int
urlInfo:
note:
Example
{
  "deviceCategoryId": "number",
  "urlInfo": "string",
  "note": "string"
}

DailyProgramStatus: string

Lighting daily program status

object
CREATED
object
SENT
object
CONFIRMED
object
FAILED
object
TIMEOUT

DataReportingIntervalInput: object

interval:
Example
{
  "interval": "number"
}

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

object
MONDAY
object
TUESDAY
object
WEDNESDAY
object
THURSDAY
object
FRIDAY
object
SATURDAY
object
SUNDAY

Device: object

id:
ID
serial:
name:
supplier:
tag:
latitude:
longitude:
positionType:
positionY:
positionX:
timeZone:
networkType:
loraParams:
mqttParams:
maxLifetimeHours:
Int
maxLifetimeWarningPercentage:
Int
statusUpdateHoursOffset:
Int
referenceNumber:
online:
errors:
statusUpdatedAt:
createdAt:
updatedAt:
model:
group:
virtualAsset:
metering:
lighting:
parking:
automation:
attachments:
images:
status:
object
Example
{
  "id": "object",
  "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",
      "name": "string",
      "code": "string"
    }
  }
}

DeviceAllowedSortingFields: string

Device allowed sorting fields

object
name
object
serial
object
typeName
object
modelName
object
groupName

DeviceArrayResponse: object

status:
items:
Example
{
  "status": "string",
  "items": [
    {
      "id": "object",
      "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"
        }
      }
    }
  ]
}

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

Example
{
  "status": "string",
  "items": [
    {
      "id": "string",
      "path": "string",
      "filename": "string",
      "url": "string",
      "contentType": "string",
      "size": "number",
      "createdAt": "object",
      "updatedAt": "object"
    }
  ]
}

DeviceCategory: object

id:
Int
name:
iconName:
createdAt:
updatedAt:
Example
{
  "id": "number",
  "name": "string",
  "iconName": "string",
  "createdAt": "object",
  "updatedAt": "object"
}

DeviceCategoryArrayResponse: object

Example
{
  "status": "string",
  "items": [
    {
      "id": "number",
      "name": "string",
      "iconName": "string",
      "createdAt": "object",
      "updatedAt": "object"
    }
  ]
}

DeviceCommandHistory: object

deviceSerial:
deviceModelName:
deviceTypeName:
authorId:
authorEmail:
authorName:
authorLastName:
authorAvatar:
authorPhone:
commandTypeCode:
commandTypeName:
status:
params:
createdAt:
updatedAt:
group:
Example
{
  "deviceSerial": "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": {
    "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": [
      {
        "id": "object",
        "name": "string",
        "path": "string",
        "latitude": "number",
        "longitude": "number",
        "positionType": "string",
        "positionY": "number",
        "positionX": "number"
      }
    ]
  }
}

DeviceCommandHistoryPaginatedResponse: object

Example
{
  "status": "string",
  "total": "number",
  "page": {
    "items": [
      {
        "deviceSerial": "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": {
          "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": [
            {
              "id": "object",
              "name": "string",
              "path": "string"
            }
          ]
        }
      }
    ]
  }
}

DeviceCommandResponse: object

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

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"
    }
  ]
}

DeviceInfos: string

Device infos

object
Name
object
Serial
object
ReferenceNumber

DeviceInsallationInfoAttachmentArrayResponse: object

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

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

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:
Int
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:
Int
name:
code:
mutation:
params:
createdAt:
updatedAt:
Example
{
  "id": "number",
  "name": "string",
  "code": "string",
  "mutation": "string",
  "params": "object",
  "createdAt": "object",
  "updatedAt": "object"
}

DeviceModelCommandsArrayResponse: object

Example
{
  "status": "string",
  "items": [
    {
      "id": "number",
      "name": "string",
      "code": "string",
      "mutation": "string",
      "params": "object",
      "createdAt": "object",
      "updatedAt": "object"
    }
  ]
}

DeviceModels: string

Device Models

object
UK1
object
RFTN
object
RFTZ
object
RFT0
object
RFT1
object
RF01
object
RN01
object
RZ01
object
MTMD
object
MTMT
object
PKI1
object
AM01
object
AM02
object
AM03
object
IO01
object
SB01
object
SM01
object
SO01
object
PL03
object
TH01
object
ST02
object
ST03
object
SO03
object
WH01
object
MDY050
object
MSH325
object
MSH475
object
QRCODE
object
RFT0_V1
object
RFTN_V2
object
RFTZ_V2
object
CAMERA_AI
object
LINEA_LIGHT
object
VIRTUAL_SLOT
object
MQTT_RAW
object
MQTT_METERING

DeviceNetworkStatusAllowedFilteringFields: string

Device Network Status Allowed Filtering Fields

object
ONLINE
object
OFFLINE
object
UNKNOWN

DevicePaginatedResponse: object

status:
total:
Int
page:
Example
{
  "status": "string",
  "total": "number",
  "page": {
    "items": [
      {
        "id": "object",
        "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"
        }
      }
    ]
  }
}

DeviceResponse: object

status:
item:
Example
{
  "status": "string",
  "item": {
    "id": "object",
    "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"
      }
    }
  }
}

DeviceStatusAllowedFilteringFields: string

Device Status Allowed Filtering Fields

object
OK
object
ERROR
object
UNKNOWN

DeviceType: object

id:
Int
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

object
lighting
object
metering
object
parking
object
virtual_asset
object
environment
object
automation
object
wearable
object
raw

DeviceURL: object

id:
deviceSerial:
name:
url:
createdAt:
updatedAt:
Example
{
  "id": "string",
  "deviceSerial": "string",
  "name": "string",
  "url": "string",
  "createdAt": "object",
  "updatedAt": "object"
}

DeviceURLPaginatedResponse: object

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"
  }
}

DevicesSortingConditionInput: object

Example
{
  "field": "string",
  "order": "string"
}

DimmingCommandInput: object

dimming:
Int
Example
{
  "dimming": "number"
}

DimmingPointInput: object

timeIndex:
Int
dimmingLevel:
Int
Example
{
  "timeIndex": "number",
  "dimmingLevel": "number"
}

DownloadDeviceDataTypes: object

code:
label:
deviceTypes:
Example
{
  "code": "string",
  "label": "string",
  "deviceTypes": [
    "string"
  ]
}

DownloadDeviceDataTypesArrayResponse: object

Example
{
  "status": "string",
  "items": [
    {
      "code": "string",
      "label": "string",
      "deviceTypes": [
        "string"
      ]
    }
  ]
}

DownloadTemplate: object

id:
Int
name:
readingFrequency:
groups:
deviceTypes:
deviceModels:
deviceInfos:
deviceDataTypes:
lastSentTo:
lastSentDate:
lastDownloadRequestedBy:
lastDownloadRequestDate:
url:
createdBy:
editedBy:
createdAt:
updatedAt:
schedule:
Example
{
  "id": "number",
  "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",
        "createdAt": "object"
      }
    }
  }
}

DownloadTemplateAllowedSortingFields: string

Download template allowed sorting fields

object
name
object
id
object
createdAt
object
updatedAt

DownloadTemplateDeviceDataTypes: object

code:
customLabel:
Example
{
  "code": "string",
  "customLabel": "string"
}

DownloadTemplateDeviceDataTypesInput: object

code:
customLabel:
Example
{
  "code": "string",
  "customLabel": "string"
}

DownloadTemplatePaginatedResponse: object

Example
{
  "status": "string",
  "total": "number",
  "page": {
    "items": [
      {
        "id": "number",
        "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"
            }
          }
        }
      }
    ]
  }
}

DownloadTemplateResponse: object

Example
{
  "status": "string",
  "item": {
    "id": "number",
    "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"
        }
      }
    }
  }
}

DownloadTemplateSchedule: object

id:
Int
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",
    "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"
      }
    }
  }
}

DownloadTemplateScheduleDestination: object

id:
Int
enabled:
type:
params:
object
Example
{
  "id": "number",
  "enabled": "boolean",
  "type": "string"
}

DownloadTemplateScheduleDestinationArray: object

Example
{
  "status": "string",
  "items": [
    {
      "id": "number",
      "enabled": "boolean",
      "type": "string"
    }
  ]
}

DownloadTemplateScheduleDestinationInput: object

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

object
SFTP
object
EMAIL

DownloadTemplateScheduleEmailDestination: object

emails:
Example
{
  "emails": [
    "string"
  ]
}

DownloadTemplateScheduleEmailDestinationInput: object

emails:
Example
{
  "emails": [
    "string"
  ]
}

DownloadTemplateScheduleResponse: object

Example
{
  "status": "string",
  "item": {
    "id": "number",
    "active": "boolean",
    "repeatPattern": "string",
    "startDate": "object",
    "destinations": [
      {
        "id": "number",
        "enabled": "boolean",
        "type": "string"
      }
    ],
    "template": {
      "id": "number",
      "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"
        }
      }
    }
  }
}

DownloadTemplateScheduleSFTPDestination: object

server:
port:
Int
url:
path:
user:
password:
passphrase:
filename:
Example
{
  "server": "string",
  "port": "number",
  "url": "string",
  "path": "string",
  "user": "string",
  "password": "string",
  "passphrase": "string",
  "filename": "string"
}

DownloadTemplateScheduleSFTPDestinationInput: object

server:
port:
Int
url:
path:
user:
password:
passphrase:
privateKey:
Example
{
  "server": "string",
  "port": "number",
  "url": "string",
  "path": "string",
  "user": "string",
  "password": "string",
  "passphrase": "string",
  "privateKey": "object"
}

DownloadTemplateSortingConditionInput: object

Example
{
  "field": "string",
  "order": "string"
}

EditAutomationInput: object

description:
ioConfig:
loadCellConfig:
Example
{
  "description": "string",
  "ioConfig": {
    "inputs": [
      {
        "key": "number",
        "label": "string",
        "connectedOutputs": [
          "number"
        ]
      }
    ],
    "outputs": [
      {
        "key": "number",
        "label": "string"
      }
    ]
  },
  "loadCellConfig": {
    "nominalLoad": "number",
    "thresholdOne": "number",
    "thresholdTwo": "number"
  }
}

EditDeviceLoadCellConfigArgs: object

nominalLoad:
thresholdOne:
thresholdTwo:
Example
{
  "nominalLoad": "number",
  "thresholdOne": "number",
  "thresholdTwo": "number"
}

EditDevicePositionArgs: object

id:
ID
latitude:
longitude:
positionType:
positionY:
positionX:
Example
{
  "id": "object",
  "latitude": "number",
  "longitude": "number",
  "positionType": "string",
  "positionY": "number",
  "positionX": "number"
}

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:
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"
    }
  }
}

EditParkingInput: object

class:
Example
{
  "class": "string"
}

EditVirtualAssetInput: object

deviceCategoryId:
Int
urlInfo:
note:
Example
{
  "deviceCategoryId": "number",
  "urlInfo": "string",
  "note": "string"
}

EnvironmentAM03Status: object

methaneAlarm:
online:
signal:
Int
receivedAt:
createdAt:
updatedAt:
Example
{
  "methaneAlarm": "boolean",
  "online": "boolean",
  "signal": "number",
  "receivedAt": "object",
  "createdAt": "object",
  "updatedAt": "object"
}

EnvironmentAM03StatusPaginatedResponse: object

Example
{
  "status": "string",
  "total": "number",
  "page": {
    "items": [
      {
        "methaneAlarm": "boolean",
        "online": "boolean",
        "signal": "number",
        "receivedAt": "object",
        "createdAt": "object",
        "updatedAt": "object"
      }
    ],
    "size": "number",
    "index": "number"
  }
}

EnvironmentBatteryStatus: object

batteryPercentage:
Int
receivedAt:
Example
{
  "batteryPercentage": "number",
  "receivedAt": "object"
}

EnvironmentBatteryStatusResponse: object

Example
{
  "status": "string",
  "total": "number",
  "page": {
    "items": [
      {
        "batteryPercentage": "number",
        "receivedAt": "object"
      }
    ],
    "size": "number",
    "index": "number"
  }
}

EnvironmentPL03Status: object

occupied:
illuminance:
Int
temperature:
batteryPercentage:
Int
battery:
online:
signal:
Int
receivedAt:
Example
{
  "occupied": "boolean",
  "illuminance": "number",
  "temperature": "number",
  "batteryPercentage": "number",
  "battery": "number",
  "online": "boolean",
  "signal": "number",
  "receivedAt": "object"
}

EnvironmentPL03StatusPaginatedResponse: object

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"
  }
}

EnvironmentPirInfraredDisableTimeInput: object

infraredDisableTime:
Int
infraredDetectionTime:
Int
Example
{
  "infraredDisableTime": "number",
  "infraredDetectionTime": "number"
}

EnvironmentPirReportConfigurationInput: object

minTime:
Int
maxTime:
Int
batteryChange:
temperatureChange:
Int
illuminance:
Int
Example
{
  "minTime": "number",
  "maxTime": "number",
  "batteryChange": "number",
  "temperatureChange": "number",
  "illuminance": "number"
}

EnvironmentReportConfigurationInput: object

minTime:
Int
maxTime:
Int
batteryChange:
Example
{
  "minTime": "number",
  "maxTime": "number",
  "batteryChange": "number"
}

EnvironmentSM01Status: object

highTemperatureAlarm:
fireAlarm:
batteryPercentage:
Int
battery:
online:
signal:
Int
receivedAt:
createdAt:
updatedAt:
Example
{
  "highTemperatureAlarm": "boolean",
  "fireAlarm": "boolean",
  "batteryPercentage": "number",
  "battery": "number",
  "online": "boolean",
  "signal": "number",
  "receivedAt": "object",
  "createdAt": "object",
  "updatedAt": "object"
}

EnvironmentSM01StatusPaginatedResponse: object

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:
Int
online:
signal:
Int
receivedAt:
createdAt:
updatedAt:
Example
{
  "temperature": "number",
  "moisture": "number",
  "conductivity": "number",
  "online": "boolean",
  "signal": "number",
  "receivedAt": "object",
  "createdAt": "object",
  "updatedAt": "object"
}

EnvironmentSO01StatusPaginatedResponse: object

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

dielectricPermittivity:
volumetricWaterContent:
soilTemperature:
electricalConductivity:
batteryVoltage:
batteryPercentage:
Int
error:
receivedAt:
online:
Example
{
  "dielectricPermittivity": "number",
  "volumetricWaterContent": "number",
  "soilTemperature": "number",
  "electricalConductivity": "number",
  "batteryVoltage": "number",
  "batteryPercentage": "number",
  "error": "string",
  "receivedAt": "object",
  "online": "boolean"
}

EnvironmentSO03StatusPaginatedResponse: object

Example
{
  "status": "string",
  "total": "number",
  "page": {
    "items": [
      {
        "dielectricPermittivity": "number",
        "volumetricWaterContent": "number",
        "soilTemperature": "number",
        "electricalConductivity": "number",
        "batteryVoltage": "number",
        "batteryPercentage": "number",
        "error": "string",
        "receivedAt": "object",
        "online": "boolean"
      }
    ],
    "size": "number",
    "index": "number"
  }
}

EnvironmentStatus: object

tvoc:
illumination:
activity:
co2:
temperature:
humidity:
infrared:
infrared_and_visible:
pressure:
online:
signal:
Int
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

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:
Int
receivedAt:
Example
{
  "temperature": "number",
  "humidity": "number",
  "batteryStatus": {
    "batteryPercentage": "number",
    "receivedAt": "object"
  },
  "online": "boolean",
  "signal": "number",
  "receivedAt": "object"
}

EnvironmentTH01StatusPaginatedResponse: object

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:
Int
continueTime:
Int
Example
{
  "mode": "string",
  "minTemperature": "number",
  "maxTemperature": "number",
  "lockTime": "number",
  "continueTime": "number"
}

EnvironmentTemperatureModes: string

Environment Temperature Modes

object
DISABLE
object
BELOW
object
ABOVE
object
WITHIN

EnvironmentWH01Status: object

barometerData:
temperature:
windSpeed:
avgWindSpeed:
windDirection:
humidityPercentage:
rainRate:
UV:
solarRadiation:
dayRain:
dayEt:
soilMoisture1:
soilMoisture2: