REST API API Reference

REST

API Endpoint
http://localhost:8081/
Terms of Service: NO TERMS OF SERVICE
Contact: Feng.Yang@things-matrix.com
Version: 1.0

Device

Device API

create

POST /api/device

Create a device.

The request body to create a device.

Authorization: string
in header

The token to access API, including API key (recommended, available until it is reset; obtained from account center on the platform) and Bearer token (available for at most 24 hours; obtained by calling "User - log in" API). Example:

  1. "ApiKey obtained_api_key";
  2. "Bearer obtained_bearer_token".
Request Content-Types: application/json
Request Example
{
  "alias": "string",
  "attributes": "object",
  "cerOverwrite": "integer (int32)",
  "certificateId": "string",
  "description": "string",
  "groupId": "string",
  "iccid": "string",
  "iccidOverwrite": "integer (int32)",
  "imei": "string",
  "modelId": "string",
  "sensorOverwrite": "integer (int32)",
  "sensorSn": "string",
  "sn": "string",
  "tags": [
    "string"
  ]
}

OK

201 Created

Created

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK)
{
  "code": "integer (int32)",
  "data": {
    "alias": "string",
    "attributes": "object",
    "availableActions": [
      "string"
    ],
    "cerOverwrite": "integer (int32)",
    "certificate": {
      "associatedCertificateId": "string",
      "associatedCertificateName": "string",
      "beginTime": "string (date-time)",
      "caFlag": "integer (int32)",
      "certificate": "string",
      "certificateType": "integer (int32)",
      "createTime": "string (date-time)",
      "creator": "string",
      "description": "string",
      "endTime": "string (date-time)",
      "id": "string",
      "name": "string",
      "overdueStatus": "integer (int32)",
      "sn": "string",
      "status": "integer (int32)",
      "updateTime": "string (date-time)",
      "updater": "string"
    },
    "createTime": "string (date-time)",
    "creator": "string",
    "defaultActions": [
      "string"
    ],
    "description": "string",
    "extend": "object",
    "group": {
      "certificate": {
        "associatedCertificateId": "string",
        "associatedCertificateName": "string",
        "beginTime": "string (date-time)",
        "caFlag": "integer (int32)",
        "certificate": "string",
        "certificateType": "integer (int32)",
        "createTime": "string (date-time)",
        "creator": "string",
        "description": "string",
        "endTime": "string (date-time)",
        "id": "string",
        "name": "string",
        "overdueStatus": "integer (int32)",
        "sn": "string",
        "status": "integer (int32)",
        "updateTime": "string (date-time)",
        "updater": "string"
      },
      "createTime": "string (date-time)",
      "creator": "string",
      "description": "string",
      "id": "string",
      "model": {
        "authMode": "integer (int32)",
        "code": "string",
        "configure": "string",
        "createTime": "string (date-time)",
        "creator": "string",
        "dataType": "integer (int32)",
        "description": "string",
        "iconUrl": "string",
        "id": "string",
        "name": "string",
        "networkType": "integer (int32)",
        "protocolType": "integer (int32)",
        "records": [
          {
            "accuracy": "string",
            "category": "string",
            "createTime": "string (date-time)",
            "creator": "string",
            "description": "string",
            "id": "string",
            "isShow": false,
            "isStore": false,
            "max": "number (float)",
            "min": "number (float)",
            "model": {
              "authMode": "integer (int32)",
              "code": "string",
              "configure": "string",
              "createTime": "string (date-time)",
              "creator": "string",
              "dataType": "integer (int32)",
              "description": "string",
              "iconUrl": "string",
              "id": "string",
              "name": "string",
              "networkType": "integer (int32)"
            }
          }
        ]
      }
    }
  }
}

batch import

POST /api/device/batch/add

Import devices in batch.

Authorization: string
in header

The token to access API, including API key (recommended, available until it is reset; obtained from account center on the platform) and Bearer token (available for at most 24 hours; obtained by calling "User - log in" API). Example:

  1. "ApiKey obtained_api_key";
  2. "Bearer obtained_bearer_token".
deviceFile: file
in formData

The file used to import devices in batch in CSV format.

covered: integer (int32) 0, 1
in query

The value to configure if the device is allowed to overwrite its information with the existing serial number. (0: not allowed, 1: allowed)

200 OK

OK

201 Created

Created

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK)
{
  "code": "integer (int32)",
  "data": "object",
  "msg": "string"
}

batch update

POST /api/device/batch/update

Update the groupId, iccidOverwrite, sensorOverwrite or description of the devices in batch.

The request body to update devices in batch.

Authorization: string
in header

The token to access API, including API key (recommended, available until it is reset; obtained from account center on the platform) and Bearer token (available for at most 24 hours; obtained by calling "User - log in" API). Example:

  1. "ApiKey obtained_api_key";
  2. "Bearer obtained_bearer_token".
Request Content-Types: application/json
Request Example
{
  "description": "string",
  "groupId": "string",
  "iccidOverwrite": "integer (int32)",
  "ids": [
    "string"
  ],
  "sensorOverwrite": "integer (int32)"
}
200 OK

OK

201 Created

Created

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK)
{
  "code": "integer (int32)",
  "data": "object",
  "msg": "string"
}

get by query condition

POST /api/device/list

Return paginated result of the information of the devices by query condition.

The request body to query devices.

Authorization: string
in header

The token to access API, including API key (recommended, available until it is reset; obtained from account center on the platform) and Bearer token (available for at most 24 hours; obtained by calling "User - log in" API). Example:

  1. "ApiKey obtained_api_key";
  2. "Bearer obtained_bearer_token".
attributes: string
in query

The attributes you wish to query for devices. e.g., "attribute_key_1 attribute_value_1,attribute_key_2 attribute_value_2".

tags: string
in query

The tag you wish to query for devices. e.g., "tag_1".

page: string
in query

The page number, default 1.

size: string
in query

The page size, default 15.

sort: string
in query

The result sort, default "createTime,DESC". Example:

  1. "id" or "id,ASC";
  2. "id,DESC";
  3. "id,createTime,ASC";
  4. "id,createTime,DESC";
  5. (Multiple sort parameters) "id,ASC" and "createTime,DESC".
Request Content-Types: application/json
Request Example
{
  "groupId": "string",
  "modelId": "string",
  "searchTerm": "string",
  "status": "integer (int32)"
}
201 Created

Created

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK)
{
  "code": "integer (int32)",
  "data": {
    "content": [
      {
        "alias": "string",
        "attributes": "object",
        "availableActions": [
          "string"
        ],
        "cerOverwrite": "integer (int32)",
        "certificate": {
          "associatedCertificateId": "string",
          "associatedCertificateName": "string",
          "beginTime": "string (date-time)",
          "caFlag": "integer (int32)",
          "certificate": "string",
          "certificateType": "integer (int32)",
          "createTime": "string (date-time)",
          "creator": "string",
          "description": "string",
          "endTime": "string (date-time)",
          "id": "string",
          "name": "string",
          "overdueStatus": "integer (int32)",
          "sn": "string",
          "status": "integer (int32)",
          "updateTime": "string (date-time)",
          "updater": "string"
        },
        "createTime": "string (date-time)",
        "creator": "string",
        "defaultActions": [
          "string"
        ],
        "description": "string",
        "extend": "object",
        "group": {
          "certificate": {
            "associatedCertificateId": "string",
            "associatedCertificateName": "string",
            "beginTime": "string (date-time)",
            "caFlag": "integer (int32)",
            "certificate": "string",
            "certificateType": "integer (int32)",
            "createTime": "string (date-time)",
            "creator": "string",
            "description": "string",
            "endTime": "string (date-time)",
            "id": "string",
            "name": "string",
            "overdueStatus": "integer (int32)",
            "sn": "string",
            "status": "integer (int32)",
            "updateTime": "string (date-time)",
            "updater": "string"
          },
          "createTime": "string (date-time)",
          "creator": "string",
          "description": "string",
          "id": "string",
          "model": {
            "authMode": "integer (int32)",
            "code": "string",
            "configure": "string",
            "createTime": "string (date-time)",
            "creator": "string",
            "dataType": "integer (int32)",
            "description": "string",
            "iconUrl": "string",
            "id": "string",
            "name": "string",
            "networkType": "integer (int32)",
            "protocolType": "integer (int32)",
            "records": [
              {
                "accuracy": "string",
                "category": "string",
                "createTime": "string (date-time)",
                "creator": "string",
                "description": "string",
                "id": "string",
                "isShow": false,
                "isStore": false,
                "max": "number (float)",
                "min": "number (float)",
                "model": {
                  "authMode": "integer (int32)",
                  "code": "string",
                  "configure": "string",
                  "createTime": "string (date-time)",
                  "creator": "string",
                  "dataType": "integer (int32)",
                  "description": "string",
                  "iconUrl": "string"
                }
              }
            ]
          }
        }
      }
    ]
  }
}

export by query condition

POST /api/device/list/export

Export paginated result of the information of the devices by query condition in CSV or EXCEL format.

The request body to query devices.

Authorization: string
in header

The token to access API, including API key (recommended, available until it is reset; obtained from account center on the platform) and Bearer token (available for at most 24 hours; obtained by calling "User - log in" API). Example:

  1. "ApiKey obtained_api_key";
  2. "Bearer obtained_bearer_token".
attributes: string
in query

The attributes you wish to query for devices. e.g., "attribute_key_1 attribute_value_1,attribute_key_2 attribute_value_2".

tags: string
in query

The tag you wish to query for device. e.g., "tag_1".

timezone: string
in query

The timezone of the time `in the result.

type: string csv, excel excel
in query

The format of the export file, default "excel". Example:

  1. "csv";
  2. "excel"
page: string
in query

The page number, default 1.

size: string
in query

The page size, default 15.

sort: string
in query

The result sort, default "createTime,DESC". Example:

  1. "id" or "id,ASC";
  2. "id,DESC";
  3. "id,createTime,ASC";
  4. "id,createTime,DESC";
  5. (Multiple sort parameters) "id,ASC" and "createTime,DESC".
Request Content-Types: application/json
Request Example
{
  "groupId": "string",
  "modelId": "string",
  "searchTerm": "string",
  "status": "integer (int32)"
}
200 OK

OK

201 Created

Created

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: application/octet-stream, */*

get status by query condition

POST /api/device/list/status

Return paginated result of the serial number, status, longitude and latitude of the devices by query condition.

The request body to query devices.

Authorization: string
in header

The token to access API, including API key (recommended, available until it is reset; obtained from account center on the platform) and Bearer token (available for at most 24 hours; obtained by calling "User - log in" API). Example:

  1. "ApiKey obtained_api_key";
  2. "Bearer obtained_bearer_token".
page: string
in query

The page number, default 1.

size: string
in query

The page size, default 15.

sort: string
in query

The result sort, default "createTime,DESC". Example:

  1. "id" or "id,ASC";
  2. "id,DESC";
  3. "id,createTime,ASC";
  4. "id,createTime,DESC";
  5. (Multiple sort parameters) "id,ASC" and "createTime,DESC".
Request Content-Types: application/json
Request Example
{
  "groupId": "string",
  "modelId": "string",
  "searchTerm": "string",
  "status": "integer (int32)"
}
201 Created

Created

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK)
{
  "code": "integer (int32)",
  "data": {
    "content": [
      {
        "sn": "string",
        "status": "string"
      }
    ],
    "first": "boolean",
    "last": "boolean",
    "number": "integer (int32)",
    "numberOfElements": "integer (int32)",
    "size": "integer (int32)",
    "sort": {
      "sorted": "boolean",
      "unsorted": "boolean"
    },
    "totalElements": "integer (int64)",
    "totalPages": "integer (int32)"
  },
  "msg": "string"
}

get by serial number

GET /api/device/sn/{sn}

Get information of the device by serial number.

Authorization: string
in header

The token to access API, including API key (recommended, available until it is reset; obtained from account center on the platform) and Bearer token (available for at most 24 hours; obtained by calling "User - log in" API). Example:

  1. "ApiKey obtained_api_key";
  2. "Bearer obtained_bearer_token".
sn: string
in path

The serial number of the device.

OK

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK)
{
  "code": "integer (int32)",
  "data": {
    "alias": "string",
    "attributes": "object",
    "availableActions": [
      "string"
    ],
    "cerOverwrite": "integer (int32)",
    "certificate": {
      "associatedCertificateId": "string",
      "associatedCertificateName": "string",
      "beginTime": "string (date-time)",
      "caFlag": "integer (int32)",
      "certificate": "string",
      "certificateType": "integer (int32)",
      "createTime": "string (date-time)",
      "creator": "string",
      "description": "string",
      "endTime": "string (date-time)",
      "id": "string",
      "name": "string",
      "overdueStatus": "integer (int32)",
      "sn": "string",
      "status": "integer (int32)",
      "updateTime": "string (date-time)",
      "updater": "string"
    },
    "createTime": "string (date-time)",
    "creator": "string",
    "defaultActions": [
      "string"
    ],
    "description": "string",
    "extend": "object",
    "group": {
      "certificate": {
        "associatedCertificateId": "string",
        "associatedCertificateName": "string",
        "beginTime": "string (date-time)",
        "caFlag": "integer (int32)",
        "certificate": "string",
        "certificateType": "integer (int32)",
        "createTime": "string (date-time)",
        "creator": "string",
        "description": "string",
        "endTime": "string (date-time)",
        "id": "string",
        "name": "string",
        "overdueStatus": "integer (int32)",
        "sn": "string",
        "status": "integer (int32)",
        "updateTime": "string (date-time)",
        "updater": "string"
      },
      "createTime": "string (date-time)",
      "creator": "string",
      "description": "string",
      "id": "string",
      "model": {
        "authMode": "integer (int32)",
        "code": "string",
        "configure": "string",
        "createTime": "string (date-time)",
        "creator": "string",
        "dataType": "integer (int32)",
        "description": "string",
        "iconUrl": "string",
        "id": "string",
        "name": "string",
        "networkType": "integer (int32)",
        "protocolType": "integer (int32)",
        "records": [
          {
            "accuracy": "string",
            "category": "string",
            "createTime": "string (date-time)",
            "creator": "string",
            "description": "string",
            "id": "string",
            "isShow": false,
            "isStore": false,
            "max": "number (float)",
            "min": "number (float)",
            "model": {
              "authMode": "integer (int32)",
              "code": "string",
              "configure": "string",
              "createTime": "string (date-time)",
              "creator": "string",
              "dataType": "integer (int32)",
              "description": "string",
              "iconUrl": "string",
              "id": "string",
              "name": "string",
              "networkType": "integer (int32)"
            }
          }
        ]
      }
    }
  }
}

get

GET /api/device/{deviceId}

Get information of the device.

Authorization: string
in header

The token to access API, including API key (recommended, available until it is reset; obtained from account center on the platform) and Bearer token (available for at most 24 hours; obtained by calling "User - log in" API). Example:

  1. "ApiKey obtained_api_key";
  2. "Bearer obtained_bearer_token".
deviceId: string
in path

The ID of the device.

OK

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK)
{
  "code": "integer (int32)",
  "data": {
    "alias": "string",
    "attributes": "object",
    "availableActions": [
      "string"
    ],
    "cerOverwrite": "integer (int32)",
    "certificate": {
      "associatedCertificateId": "string",
      "associatedCertificateName": "string",
      "beginTime": "string (date-time)",
      "caFlag": "integer (int32)",
      "certificate": "string",
      "certificateType": "integer (int32)",
      "createTime": "string (date-time)",
      "creator": "string",
      "description": "string",
      "endTime": "string (date-time)",
      "id": "string",
      "name": "string",
      "overdueStatus": "integer (int32)",
      "sn": "string",
      "status": "integer (int32)",
      "updateTime": "string (date-time)",
      "updater": "string"
    },
    "createTime": "string (date-time)",
    "creator": "string",
    "defaultActions": [
      "string"
    ],
    "description": "string",
    "extend": "object",
    "group": {
      "certificate": {
        "associatedCertificateId": "string",
        "associatedCertificateName": "string",
        "beginTime": "string (date-time)",
        "caFlag": "integer (int32)",
        "certificate": "string",
        "certificateType": "integer (int32)",
        "createTime": "string (date-time)",
        "creator": "string",
        "description": "string",
        "endTime": "string (date-time)",
        "id": "string",
        "name": "string",
        "overdueStatus": "integer (int32)",
        "sn": "string",
        "status": "integer (int32)",
        "updateTime": "string (date-time)",
        "updater": "string"
      },
      "createTime": "string (date-time)",
      "creator": "string",
      "description": "string",
      "id": "string",
      "model": {
        "authMode": "integer (int32)",
        "code": "string",
        "configure": "string",
        "createTime": "string (date-time)",
        "creator": "string",
        "dataType": "integer (int32)",
        "description": "string",
        "iconUrl": "string",
        "id": "string",
        "name": "string",
        "networkType": "integer (int32)",
        "protocolType": "integer (int32)",
        "records": [
          {
            "accuracy": "string",
            "category": "string",
            "createTime": "string (date-time)",
            "creator": "string",
            "description": "string",
            "id": "string",
            "isShow": false,
            "isStore": false,
            "max": "number (float)",
            "min": "number (float)",
            "model": {
              "authMode": "integer (int32)",
              "code": "string",
              "configure": "string",
              "createTime": "string (date-time)",
              "creator": "string",
              "dataType": "integer (int32)",
              "description": "string",
              "iconUrl": "string",
              "id": "string",
              "name": "string",
              "networkType": "integer (int32)"
            }
          }
        ]
      }
    }
  }
}

update

PUT /api/device/{deviceId}

Update a device.

The request body to update a device.

Authorization: string
in header

The token to access API, including API key (recommended, available until it is reset; obtained from account center on the platform) and Bearer token (available for at most 24 hours; obtained by calling "User - log in" API). Example:

  1. "ApiKey obtained_api_key";
  2. "Bearer obtained_bearer_token".
deviceId: string
in path

The ID of the device.

Request Content-Types: application/json
Request Example
{
  "alias": "string",
  "attributes": "object",
  "cerOverwrite": "integer (int32)",
  "certificateId": "string",
  "description": "string",
  "groupId": "string",
  "iccid": "string",
  "iccidOverwrite": "integer (int32)",
  "imei": "string",
  "modelId": "string",
  "sensorOverwrite": "integer (int32)",
  "sensorSn": "string",
  "sn": "string",
  "status": "integer (int32)",
  "tags": [
    "string"
  ]
}

OK

201 Created

Created

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK)
{
  "code": "integer (int32)",
  "data": {
    "alias": "string",
    "attributes": "object",
    "availableActions": [
      "string"
    ],
    "cerOverwrite": "integer (int32)",
    "certificate": {
      "associatedCertificateId": "string",
      "associatedCertificateName": "string",
      "beginTime": "string (date-time)",
      "caFlag": "integer (int32)",
      "certificate": "string",
      "certificateType": "integer (int32)",
      "createTime": "string (date-time)",
      "creator": "string",
      "description": "string",
      "endTime": "string (date-time)",
      "id": "string",
      "name": "string",
      "overdueStatus": "integer (int32)",
      "sn": "string",
      "status": "integer (int32)",
      "updateTime": "string (date-time)",
      "updater": "string"
    },
    "createTime": "string (date-time)",
    "creator": "string",
    "defaultActions": [
      "string"
    ],
    "description": "string",
    "extend": "object",
    "group": {
      "certificate": {
        "associatedCertificateId": "string",
        "associatedCertificateName": "string",
        "beginTime": "string (date-time)",
        "caFlag": "integer (int32)",
        "certificate": "string",
        "certificateType": "integer (int32)",
        "createTime": "string (date-time)",
        "creator": "string",
        "description": "string",
        "endTime": "string (date-time)",
        "id": "string",
        "name": "string",
        "overdueStatus": "integer (int32)",
        "sn": "string",
        "status": "integer (int32)",
        "updateTime": "string (date-time)",
        "updater": "string"
      },
      "createTime": "string (date-time)",
      "creator": "string",
      "description": "string",
      "id": "string",
      "model": {
        "authMode": "integer (int32)",
        "code": "string",
        "configure": "string",
        "createTime": "string (date-time)",
        "creator": "string",
        "dataType": "integer (int32)",
        "description": "string",
        "iconUrl": "string",
        "id": "string",
        "name": "string",
        "networkType": "integer (int32)",
        "protocolType": "integer (int32)",
        "records": [
          {
            "accuracy": "string",
            "category": "string",
            "createTime": "string (date-time)",
            "creator": "string",
            "description": "string",
            "id": "string",
            "isShow": false,
            "isStore": false,
            "max": "number (float)",
            "min": "number (float)",
            "model": {
              "authMode": "integer (int32)",
              "code": "string",
              "configure": "string",
              "createTime": "string (date-time)",
              "creator": "string",
              "dataType": "integer (int32)",
              "description": "string",
              "iconUrl": "string",
              "id": "string",
              "name": "string",
              "networkType": "integer (int32)"
            }
          }
        ]
      }
    }
  }
}

delete

DELETE /api/device/{deviceId}

Delete a device.

Authorization: string
in header

The token to access API, including API key (recommended, available until it is reset; obtained from account center on the platform) and Bearer token (available for at most 24 hours; obtained by calling "User - log in" API). Example:

  1. "ApiKey obtained_api_key";
  2. "Bearer obtained_bearer_token".
deviceId: string
in path

The ID of the device.

200 OK

OK

204 No Content

No Content

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

Response Content-Types: */*
Response Example (200 OK)
{
  "code": "integer (int32)",
  "data": "object",
  "msg": "string"
}

Group

Group API

create

POST /api/group

Create a group.

The request body to create a group.

Authorization: string
in header

The token to access API, including API key (recommended, available until it is reset; obtained from account center on the platform) and Bearer token (available for at most 24 hours; obtained by calling "User - log in" API). Example:

  1. "ApiKey obtained_api_key";
  2. "Bearer obtained_bearer_token".
Request Content-Types: application/json
Request Example
{
  "certificateId": "string",
  "description": "string",
  "modelId": "string",
  "name": "string",
  "notification": [
    "string"
  ],
  "pushTo": "string",
  "sharewith": [
    "string"
  ],
  "templateId": "string"
}

OK

201 Created

Created

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK)
{
  "code": "integer (int32)",
  "data": {
    "certificate": {
      "associatedCertificateId": "string",
      "associatedCertificateName": "string",
      "beginTime": "string (date-time)",
      "caFlag": "integer (int32)",
      "certificate": "string",
      "certificateType": "integer (int32)",
      "createTime": "string (date-time)",
      "creator": "string",
      "description": "string",
      "endTime": "string (date-time)",
      "id": "string",
      "name": "string",
      "overdueStatus": "integer (int32)",
      "sn": "string",
      "status": "integer (int32)",
      "updateTime": "string (date-time)",
      "updater": "string"
    },
    "createTime": "string (date-time)",
    "creator": "string",
    "description": "string",
    "id": "string",
    "model": {
      "authMode": "integer (int32)",
      "code": "string",
      "configure": "string",
      "createTime": "string (date-time)",
      "creator": "string",
      "dataType": "integer (int32)",
      "description": "string",
      "iconUrl": "string",
      "id": "string",
      "name": "string",
      "networkType": "integer (int32)",
      "protocolType": "integer (int32)",
      "records": [
        {
          "accuracy": "string",
          "category": "string",
          "createTime": "string (date-time)",
          "creator": "string",
          "description": "string",
          "id": "string",
          "isShow": false,
          "isStore": false,
          "max": "number (float)",
          "min": "number (float)",
          "model": {
            "authMode": "integer (int32)",
            "code": "string",
            "configure": "string",
            "createTime": "string (date-time)",
            "creator": "string",
            "dataType": "integer (int32)",
            "description": "string",
            "iconUrl": "string",
            "id": "string",
            "name": "string",
            "networkType": "integer (int32)",
            "protocolType": "integer (int32)",
            "records": [
              {
                "accuracy": "string",
                "category": "string",
                "createTime": "string (date-time)",
                "creator": "string",
                "description": "string",
                "id": "string",
                "isShow": false,
                "isStore": false,
                "max": "number (float)",
                "min": "number (float)",
                "model": {
                  "authMode": "integer (int32)",
                  "code": "string",
                  "configure": "string",
                  "createTime": "string (date-time)",
                  "creator": "string",
                  "dataType": "integer (int32)",
                  "description": "string",
                  "iconUrl": "string",
                  "id": "string",
                  "name": "string",
                  "networkType": "integer (int32)",
                  "protocolType": "integer (int32)",
                  "records": [
                    {
                      "accuracy": "string"
                    }
                  ]
                }
              }
            ]
          }
        }
      ]
    }
  }
}

get by query condition

POST /api/group/list

Return paginated result of the information of the groups by query condition.

The request body to query groups.

Authorization: string
in header

The token to access API, including API key (recommended, available until it is reset; obtained from account center on the platform) and Bearer token (available for at most 24 hours; obtained by calling "User - log in" API). Example:

  1. "ApiKey obtained_api_key";
  2. "Bearer obtained_bearer_token".
page: string
in query

The page number, default 1.

size: string
in query

The page size, default 15.

sort: string
in query

The result sort, default "createTime,DESC". Example:

  1. "id" or "id,ASC";
  2. "id,DESC";
  3. "id,createTime,ASC";
  4. "id,createTime,DESC";
  5. (Multiple sort parameters) "id,ASC" and "createTime,DESC".
Request Content-Types: application/json
Request Example
{
  "modelId": "string",
  "searchTerm": "string"
}
201 Created

Created

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK)
{
  "code": "integer (int32)",
  "data": {
    "content": [
      {
        "certificate": {
          "associatedCertificateId": "string",
          "associatedCertificateName": "string",
          "beginTime": "string (date-time)",
          "caFlag": "integer (int32)",
          "certificate": "string",
          "certificateType": "integer (int32)",
          "createTime": "string (date-time)",
          "creator": "string",
          "description": "string",
          "endTime": "string (date-time)",
          "id": "string",
          "name": "string",
          "overdueStatus": "integer (int32)",
          "sn": "string",
          "status": "integer (int32)",
          "updateTime": "string (date-time)",
          "updater": "string"
        },
        "createTime": "string (date-time)",
        "creator": "string",
        "description": "string",
        "id": "string",
        "model": {
          "authMode": "integer (int32)",
          "code": "string",
          "configure": "string",
          "createTime": "string (date-time)",
          "creator": "string",
          "dataType": "integer (int32)",
          "description": "string",
          "iconUrl": "string",
          "id": "string",
          "name": "string",
          "networkType": "integer (int32)",
          "protocolType": "integer (int32)",
          "records": [
            {
              "accuracy": "string",
              "category": "string",
              "createTime": "string (date-time)",
              "creator": "string",
              "description": "string",
              "id": "string",
              "isShow": false,
              "isStore": false,
              "max": "number (float)",
              "min": "number (float)",
              "model": {
                "authMode": "integer (int32)",
                "code": "string",
                "configure": "string",
                "createTime": "string (date-time)",
                "creator": "string",
                "dataType": "integer (int32)",
                "description": "string",
                "iconUrl": "string",
                "id": "string",
                "name": "string",
                "networkType": "integer (int32)",
                "protocolType": "integer (int32)",
                "records": [
                  {
                    "accuracy": "string",
                    "category": "string",
                    "createTime": "string (date-time)",
                    "creator": "string",
                    "description": "string",
                    "id": "string",
                    "isShow": false,
                    "isStore": false,
                    "max": "number (float)",
                    "min": "number (float)",
                    "model": {
                      "authMode": "integer (int32)",
                      "code": "string",
                      "configure": "string",
                      "createTime": "string (date-time)",
                      "creator": "string",
                      "dataType": "integer (int32)",
                      "description": "string",
                      "iconUrl": "string",
                      "id": "string",
                      "name": "string",
                      "networkType": "integer (int32)",
                      "protocolType": "integer (int32)",
                      "records": [
                        null
                      ]
                    }
                  }
                ]
              }
            }
          ]
        }
      }
    ]
  }
}

get by model ID

GET /api/group/list/{modelId}

Get information of the groups by model ID.

Authorization: string
in header

The token to access API, including API key (recommended, available until it is reset; obtained from account center on the platform) and Bearer token (available for at most 24 hours; obtained by calling "User - log in" API). Example:

  1. "ApiKey obtained_api_key";
  2. "Bearer obtained_bearer_token".
modelId: string
in path

The ID of the model.

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK)
{
  "code": "integer (int32)",
  "data": [
    {
      "certificate": {
        "associatedCertificateId": "string",
        "associatedCertificateName": "string",
        "beginTime": "string (date-time)",
        "caFlag": "integer (int32)",
        "certificate": "string",
        "certificateType": "integer (int32)",
        "createTime": "string (date-time)",
        "creator": "string",
        "description": "string",
        "endTime": "string (date-time)",
        "id": "string",
        "name": "string",
        "overdueStatus": "integer (int32)",
        "sn": "string",
        "status": "integer (int32)",
        "updateTime": "string (date-time)",
        "updater": "string"
      },
      "createTime": "string (date-time)",
      "creator": "string",
      "description": "string",
      "id": "string",
      "model": {
        "authMode": "integer (int32)",
        "code": "string",
        "configure": "string",
        "createTime": "string (date-time)",
        "creator": "string",
        "dataType": "integer (int32)",
        "description": "string",
        "iconUrl": "string",
        "id": "string",
        "name": "string",
        "networkType": "integer (int32)",
        "protocolType": "integer (int32)",
        "records": [
          {
            "accuracy": "string",
            "category": "string",
            "createTime": "string (date-time)",
            "creator": "string",
            "description": "string",
            "id": "string",
            "isShow": false,
            "isStore": false,
            "max": "number (float)",
            "min": "number (float)",
            "model": {
              "authMode": "integer (int32)",
              "code": "string",
              "configure": "string",
              "createTime": "string (date-time)",
              "creator": "string",
              "dataType": "integer (int32)",
              "description": "string",
              "iconUrl": "string",
              "id": "string",
              "name": "string",
              "networkType": "integer (int32)",
              "protocolType": "integer (int32)",
              "records": [
                {
                  "accuracy": "string",
                  "category": "string",
                  "createTime": "string (date-time)",
                  "creator": "string",
                  "description": "string",
                  "id": "string",
                  "isShow": false,
                  "isStore": false,
                  "max": "number (float)",
                  "min": "number (float)",
                  "model": {
                    "authMode": "integer (int32)",
                    "code": "string",
                    "configure": "string",
                    "createTime": "string (date-time)",
                    "creator": "string",
                    "dataType": "integer (int32)",
                    "description": "string",
                    "iconUrl": "string",
                    "id": "string",
                    "name": "string",
                    "networkType": "integer (int32)",
                    "protocolType": "integer (int32)",
                    "records": [
                      {}
                    ]
                  }
                }
              ]
            }
          }
        ]
      }
    }
  ]
}

list

GET /api/group/listAll

Return the list of the groups.

Authorization: string
in header

The token to access API, including API key (recommended, available until it is reset; obtained from account center on the platform) and Bearer token (available for at most 24 hours; obtained by calling "User - log in" API). Example:

  1. "ApiKey obtained_api_key";
  2. "Bearer obtained_bearer_token".
401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK)
{
  "code": "integer (int32)",
  "data": [
    {
      "certificate": {
        "associatedCertificateId": "string",
        "associatedCertificateName": "string",
        "beginTime": "string (date-time)",
        "caFlag": "integer (int32)",
        "certificate": "string",
        "certificateType": "integer (int32)",
        "createTime": "string (date-time)",
        "creator": "string",
        "description": "string",
        "endTime": "string (date-time)",
        "id": "string",
        "name": "string",
        "overdueStatus": "integer (int32)",
        "sn": "string",
        "status": "integer (int32)",
        "updateTime": "string (date-time)",
        "updater": "string"
      },
      "createTime": "string (date-time)",
      "creator": "string",
      "description": "string",
      "id": "string",
      "model": {
        "authMode": "integer (int32)",
        "code": "string",
        "configure": "string",
        "createTime": "string (date-time)",
        "creator": "string",
        "dataType": "integer (int32)",
        "description": "string",
        "iconUrl": "string",
        "id": "string",
        "name": "string",
        "networkType": "integer (int32)",
        "protocolType": "integer (int32)",
        "records": [
          {
            "accuracy": "string",
            "category": "string",
            "createTime": "string (date-time)",
            "creator": "string",
            "description": "string",
            "id": "string",
            "isShow": false,
            "isStore": false,
            "max": "number (float)",
            "min": "number (float)",
            "model": {
              "authMode": "integer (int32)",
              "code": "string",
              "configure": "string",
              "createTime": "string (date-time)",
              "creator": "string",
              "dataType": "integer (int32)",
              "description": "string",
              "iconUrl": "string",
              "id": "string",
              "name": "string",
              "networkType": "integer (int32)",
              "protocolType": "integer (int32)",
              "records": [
                {
                  "accuracy": "string",
                  "category": "string",
                  "createTime": "string (date-time)",
                  "creator": "string",
                  "description": "string",
                  "id": "string",
                  "isShow": false,
                  "isStore": false,
                  "max": "number (float)",
                  "min": "number (float)",
                  "model": {
                    "authMode": "integer (int32)",
                    "code": "string",
                    "configure": "string",
                    "createTime": "string (date-time)",
                    "creator": "string",
                    "dataType": "integer (int32)",
                    "description": "string",
                    "iconUrl": "string",
                    "id": "string",
                    "name": "string",
                    "networkType": "integer (int32)",
                    "protocolType": "integer (int32)",
                    "records": [
                      {}
                    ]
                  }
                }
              ]
            }
          }
        ]
      }
    }
  ]
}

get

GET /api/group/{groupId}

Get information of the group.

Authorization: string
in header

The token to access API, including API key (recommended, available until it is reset; obtained from account center on the platform) and Bearer token (available for at most 24 hours; obtained by calling "User - log in" API). Example:

  1. "ApiKey obtained_api_key";
  2. "Bearer obtained_bearer_token".
groupId: string
in path

The ID of the group.

OK

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK)
{
  "code": "integer (int32)",
  "data": {
    "certificate": {
      "associatedCertificateId": "string",
      "associatedCertificateName": "string",
      "beginTime": "string (date-time)",
      "caFlag": "integer (int32)",
      "certificate": "string",
      "certificateType": "integer (int32)",
      "createTime": "string (date-time)",
      "creator": "string",
      "description": "string",
      "endTime": "string (date-time)",
      "id": "string",
      "name": "string",
      "overdueStatus": "integer (int32)",
      "sn": "string",
      "status": "integer (int32)",
      "updateTime": "string (date-time)",
      "updater": "string"
    },
    "createTime": "string (date-time)",
    "creator": "string",
    "description": "string",
    "id": "string",
    "model": {
      "authMode": "integer (int32)",
      "code": "string",
      "configure": "string",
      "createTime": "string (date-time)",
      "creator": "string",
      "dataType": "integer (int32)",
      "description": "string",
      "iconUrl": "string",
      "id": "string",
      "name": "string",
      "networkType": "integer (int32)",
      "protocolType": "integer (int32)",
      "records": [
        {
          "accuracy": "string",
          "category": "string",
          "createTime": "string (date-time)",
          "creator": "string",
          "description": "string",
          "id": "string",
          "isShow": false,
          "isStore": false,
          "max": "number (float)",
          "min": "number (float)",
          "model": {
            "authMode": "integer (int32)",
            "code": "string",
            "configure": "string",
            "createTime": "string (date-time)",
            "creator": "string",
            "dataType": "integer (int32)",
            "description": "string",
            "iconUrl": "string",
            "id": "string",
            "name": "string",
            "networkType": "integer (int32)",
            "protocolType": "integer (int32)",
            "records": [
              {
                "accuracy": "string",
                "category": "string",
                "createTime": "string (date-time)",
                "creator": "string",
                "description": "string",
                "id": "string",
                "isShow": false,
                "isStore": false,
                "max": "number (float)",
                "min": "number (float)",
                "model": {
                  "authMode": "integer (int32)",
                  "code": "string",
                  "configure": "string",
                  "createTime": "string (date-time)",
                  "creator": "string",
                  "dataType": "integer (int32)",
                  "description": "string",
                  "iconUrl": "string",
                  "id": "string",
                  "name": "string",
                  "networkType": "integer (int32)",
                  "protocolType": "integer (int32)",
                  "records": [
                    {
                      "accuracy": "string"
                    }
                  ]
                }
              }
            ]
          }
        }
      ]
    }
  }
}

update

PUT /api/group/{groupId}

Update a group.

The request body to update a group.

Authorization: string
in header

The token to access API, including API key (recommended, available until it is reset; obtained from account center on the platform) and Bearer token (available for at most 24 hours; obtained by calling "User - log in" API). Example:

  1. "ApiKey obtained_api_key";
  2. "Bearer obtained_bearer_token".
groupId: string
in path

The ID of the group.

Request Content-Types: application/json
Request Example
{
  "certificateId": "string",
  "description": "string",
  "modelId": "string",
  "name": "string",
  "notification": [
    "string"
  ],
  "pushTo": "string",
  "sharewith": [
    "string"
  ],
  "templateId": "string"
}

OK

201 Created

Created

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK)
{
  "code": "integer (int32)",
  "data": {
    "certificate": {
      "associatedCertificateId": "string",
      "associatedCertificateName": "string",
      "beginTime": "string (date-time)",
      "caFlag": "integer (int32)",
      "certificate": "string",
      "certificateType": "integer (int32)",
      "createTime": "string (date-time)",
      "creator": "string",
      "description": "string",
      "endTime": "string (date-time)",
      "id": "string",
      "name": "string",
      "overdueStatus": "integer (int32)",
      "sn": "string",
      "status": "integer (int32)",
      "updateTime": "string (date-time)",
      "updater": "string"
    },
    "createTime": "string (date-time)",
    "creator": "string",
    "description": "string",
    "id": "string",
    "model": {
      "authMode": "integer (int32)",
      "code": "string",
      "configure": "string",
      "createTime": "string (date-time)",
      "creator": "string",
      "dataType": "integer (int32)",
      "description": "string",
      "iconUrl": "string",
      "id": "string",
      "name": "string",
      "networkType": "integer (int32)",
      "protocolType": "integer (int32)",
      "records": [
        {
          "accuracy": "string",
          "category": "string",
          "createTime": "string (date-time)",
          "creator": "string",
          "description": "string",
          "id": "string",
          "isShow": false,
          "isStore": false,
          "max": "number (float)",
          "min": "number (float)",
          "model": {
            "authMode": "integer (int32)",
            "code": "string",
            "configure": "string",
            "createTime": "string (date-time)",
            "creator": "string",
            "dataType": "integer (int32)",
            "description": "string",
            "iconUrl": "string",
            "id": "string",
            "name": "string",
            "networkType": "integer (int32)",
            "protocolType": "integer (int32)",
            "records": [
              {
                "accuracy": "string",
                "category": "string",
                "createTime": "string (date-time)",
                "creator": "string",
                "description": "string",
                "id": "string",
                "isShow": false,
                "isStore": false,
                "max": "number (float)",
                "min": "number (float)",
                "model": {
                  "authMode": "integer (int32)",
                  "code": "string",
                  "configure": "string",
                  "createTime": "string (date-time)",
                  "creator": "string",
                  "dataType": "integer (int32)",
                  "description": "string",
                  "iconUrl": "string",
                  "id": "string",
                  "name": "string",
                  "networkType": "integer (int32)",
                  "protocolType": "integer (int32)",
                  "records": [
                    {
                      "accuracy": "string"
                    }
                  ]
                }
              }
            ]
          }
        }
      ]
    }
  }
}

delete

DELETE /api/group/{groupId}

Delete a group.

Authorization: string
in header

The token to access API, including API key (recommended, available until it is reset; obtained from account center on the platform) and Bearer token (available for at most 24 hours; obtained by calling "User - log in" API). Example:

  1. "ApiKey obtained_api_key";
  2. "Bearer obtained_bearer_token".
groupId: string
in path

The ID of the group.

200 OK

OK

204 No Content

No Content

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

Response Content-Types: */*
Response Example (200 OK)
{
  "code": "integer (int32)",
  "data": "object",
  "msg": "string"
}

Inventory

Inventory API

create buy device order

POST /api/inventory/device/buy

Create an order to buy new device(s).

The request body to buy new device(s).

Authorization: string
in header

The token to access API, including API key (recommended, available until it is reset; obtained from account center on the platform) and Bearer token (available for at most 24 hours; obtained by calling "User - log in" API). Example:

  1. "ApiKey obtained_api_key";
  2. "Bearer obtained_bearer_token".
Request Content-Types: application/json
Request Example
{
  "companyContact": "string",
  "deliveryAddress": "string",
  "deliveryTimeStr": "string",
  "productName": "string",
  "quantity": "integer (int32)",
  "shippingMethod": "string"
}

OK

201 Created

Created

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK)
{
  "code": "integer (int32)",
  "data": "string",
  "msg": "string"
}

distribute device(s) to company

POST /api/inventory/device/changeDeviceCompany

Distribute device(s) to a specific company.

The request body to distribute device(s) to a specific company.

Authorization: string
in header

The token to access API, including API key (recommended, available until it is reset; obtained from account center on the platform) and Bearer token (available for at most 24 hours; obtained by calling "User - log in" API). Example:

  1. "ApiKey obtained_api_key";
  2. "Bearer obtained_bearer_token".
reassignCompany: integer (int32) 0
in query

The value to configure if you wish to force to edit SIM card(s) ownership. (0: no, 1: yes)

Request Content-Types: application/json
Request Example
{
  "param": [
    {
      "company": "string",
      "sn": "string"
    }
  ]
}
200 OK

OK

201 Created

Created

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK)
{
  "code": "integer (int32)",
  "data": "object",
  "msg": "string"
}

edit device status

POST /api/inventory/device/changeDeviceStatus

Edit device status.

The request body to edit the status of the device(s).

Authorization: string
in header

The token to access API, including API key (recommended, available until it is reset; obtained from account center on the platform) and Bearer token (available for at most 24 hours; obtained by calling "User - log in" API). Example:

  1. "ApiKey obtained_api_key";
  2. "Bearer obtained_bearer_token".
Request Content-Types: application/json
Request Example
{
  "param": [
    {
      "sn": "string",
      "status": "string"
    }
  ]
}
200 OK

OK

201 Created

Created

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK)
{
  "code": "integer (int32)",
  "data": "object",
  "msg": "string"
}

get device inventory

POST /api/inventory/device/list

Return paginated result of the inventory of the devices by query condition.

The request body to query the inventory of the devices.

Authorization: string
in header

The token to access API, including API key (recommended, available until it is reset; obtained from account center on the platform) and Bearer token (available for at most 24 hours; obtained by calling "User - log in" API). Example:

  1. "ApiKey obtained_api_key";
  2. "Bearer obtained_bearer_token".
pageNum: integer (int32)
in query

The page number, default 1.

pageSize: integer (int32)
in query

The page size, default 15.

direction: string
in query

The result sort by serial number, default "ASC". Example:

  1. "ASC";
  2. "DESC".
Request Content-Types: application/json
Request Example
{
  "companyName": "string",
  "modelName": "string",
  "statusName": "string"
}

OK

201 Created

Created

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK)
{
  "code": "integer (int32)",
  "data": "object",
  "msg": "string"
}

create buy SIM card order

POST /api/inventory/simCard/buySimCard

The request body to buy new SIM card(s).

Authorization: string
in header

The token to access API, including API key (recommended, available until it is reset; obtained from account center on the platform) and Bearer token (available for at most 24 hours; obtained by calling "User - log in" API). Example:

  1. "ApiKey obtained_api_key";
  2. "Bearer obtained_bearer_token".
Request Content-Types: application/json
Request Example
{
  "companyContact": "string",
  "deliveryAddress": "string",
  "deliveryTimeStr": "string",
  "operator": "string",
  "quantity": "integer (int32)",
  "shippingMethod": "string",
  "size": "string"
}

OK

201 Created

Created

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK)
{
  "code": "integer (int32)",
  "data": "string",
  "msg": "string"
}

edit SIM card(s) ownership

POST /api/inventory/simCard/changeSimCardCompany

Edit the ownership/company of the SIM card(s).

The request body to edit the ownership/company of the SIM card(s).

Authorization: string
in header

The token to access API, including API key (recommended, available until it is reset; obtained from account center on the platform) and Bearer token (available for at most 24 hours; obtained by calling "User - log in" API). Example:

  1. "ApiKey obtained_api_key";
  2. "Bearer obtained_bearer_token".
reassignCompany: integer (int32)
in query

reassignCompany

Request Content-Types: application/json
Request Example
{
  "param": [
    {
      "company": "string",
      "iccid": "string"
    }
  ]
}
200 OK

OK

201 Created

Created

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK)
{
  "code": "integer (int32)",
  "data": "object",
  "msg": "string"
}

get SIM card inventory

POST /api/inventory/simCard/pageForIo

Return paginated result of the inventory of the SIM cards by query condition.

The request body to query the inventory of the SIM cards.

Authorization: string
in header

The token to access API, including API key (recommended, available until it is reset; obtained from account center on the platform) and Bearer token (available for at most 24 hours; obtained by calling "User - log in" API). Example:

  1. "ApiKey obtained_api_key";
  2. "Bearer obtained_bearer_token".
pageNum: integer (int32)
in query

The page number, default 1.

pageSize: integer (int32)
in query

The page size, default 20.

Request Content-Types: application/json
Request Example
{
  "companyName": "string",
  "keyword": "string",
  "status": "string"
}

OK

201 Created

Created

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK)
{
  "code": "integer (int32)",
  "data": "object",
  "msg": "string"
}

Connection

Connection Management API

get devices information nearby location

POST /api/conn/around

Get basic information of the devices nearby location. The basic information includes ID, serial number, alias, status, longitude, latitude, locating mode, alarm status and extra information of the field.

The request body to get basic information of the devices nearby location.

Authorization: string
in header

The token to access API, including API key (recommended, available until it is reset; obtained from account center on the platform) and Bearer token (available for at most 24 hours; obtained by calling "User - log in" API). Example:

  1. "ApiKey obtained_api_key";
  2. "Bearer obtained_bearer_token".
Request Content-Types: application/json
Request Example
{
  "field": "string",
  "latitude": "number (double)",
  "longitude": "number (double)",
  "modelName": "string",
  "radius": "number (double)",
  "sn": "string",
  "status": "integer (int32)"
}
201 Created

Created

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK)
{
  "code": "integer (int32)",
  "data": [
    {
      "alias": "string",
      "field": "object",
      "gpsLocating": "integer (int32)",
      "id": "string",
      "isAlarm": "integer (int32)",
      "lat": "number (double)",
      "lng": "number (double)",
      "sn": "string",
      "status": "integer (int32)"
    }
  ],
  "msg": "string"
}

batch close device connections

POST /api/conn/close

Close the connections between the platform and the devices in batch by serial number list.

The request body to close the connections between the platform and the devices in batch by serial number list.

Authorization: string
in header

The token to access API, including API key (recommended, available until it is reset; obtained from account center on the platform) and Bearer token (available for at most 24 hours; obtained by calling "User - log in" API). Example:

  1. "ApiKey obtained_api_key";
  2. "Bearer obtained_bearer_token".
Request Content-Types: application/json
Request Example
{
  "sns": [
    "string"
  ]
}
200 OK

OK

201 Created

Created

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK)
{
  "code": "integer (int32)",
  "data": "object",
  "msg": "string"
}

get latest data

GET /api/conn/device/{sn}

Get latest report data of a device.

Authorization: string
in header

The token to access API, including API key (recommended, available until it is reset; obtained from account center on the platform) and Bearer token (available for at most 24 hours; obtained by calling "User - log in" API). Example:

  1. "ApiKey obtained_api_key";
  2. "Bearer obtained_bearer_token".
sn: string
in path

The serial number of the device.

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK)
{
  "code": "integer (int32)",
  "data": "object",
  "msg": "string"
}

get devices information

POST /api/conn/devices

Get basic information of the devices by serial number list. The basic information includes serial number, ICCID, sensor serial number, status, longitude, latitude and error. "sensor serial number" is Only available for TMA model series.

The request body to get basic information of the devices by serial number list.

Authorization: string
in header

The token to access API, including API key (recommended, available until it is reset; obtained from account center on the platform) and Bearer token (available for at most 24 hours; obtained by calling "User - log in" API). Example:

  1. "ApiKey obtained_api_key";
  2. "Bearer obtained_bearer_token".
Request Content-Types: application/json
Request Example
{
  "sns": [
    "string"
  ]
}
201 Created

Created

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK)
{
  "code": "integer (int32)",
  "data": [
    {
      "error": "string",
      "iccid": "string",
      "lat": "number (double)",
      "lng": "number (double)",
      "sensorSn": "string",
      "sn": "string",
      "status": "integer (int32)"
    }
  ],
  "msg": "string"
}

batch reset devices

POST /api/conn/reset

Reset the devices in batch by serial number list.

The request body to reset the devices in batch by serial number list.

Authorization: string
in header

The token to access API, including API key (recommended, available until it is reset; obtained from account center on the platform) and Bearer token (available for at most 24 hours; obtained by calling "User - log in" API). Example:

  1. "ApiKey obtained_api_key";
  2. "Bearer obtained_bearer_token".
Request Content-Types: application/json
Request Example
{
  "sns": [
    "string"
  ]
}
200 OK

OK

201 Created

Created

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK)
{
  "code": "integer (int32)",
  "data": "object",
  "msg": "string"
}

batch restart devices

POST /api/conn/restart

Restart the devices in batch by serial number list.

The request body to restart the devices in batch by serial number list.

Authorization: string
in header

The token to access API, including API key (recommended, available until it is reset; obtained from account center on the platform) and Bearer token (available for at most 24 hours; obtained by calling "User - log in" API). Example:

  1. "ApiKey obtained_api_key";
  2. "Bearer obtained_bearer_token".
Request Content-Types: application/json
Request Example
{
  "sns": [
    "string"
  ]
}
200 OK

OK

201 Created

Created

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK)
{
  "code": "integer (int32)",
  "data": "object",
  "msg": "string"
}

User

User API

log in

POST /api/user/login

For a registered user to log in.

The request body for a registered user to log in.

Authorization: string
in header

The token to access API, including API key (recommended, available until it is reset; obtained from account center on the platform) and Bearer token (available for at most 24 hours; obtained by calling "User - log in" API). Example:

  1. "ApiKey obtained_api_key";
  2. "Bearer obtained_bearer_token".
Request Content-Types: application/json
Request Example
{
  "loginName": "string",
  "password": "string"
}

OK

201 Created

Created

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK)
{
  "code": "integer (int32)",
  "data": "string",
  "msg": "string"
}

log out

GET /api/user/logout

For a logged in user to log out.

Authorization: string
in header

The authentication parameter.

200 OK

OK

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK)
{
  "code": "integer (int32)",
  "data": "object",
  "msg": "string"
}

Data

Data API

get bucket data by query condition

POST /api/report/bucket/data

Return paginated result of the bucket data by query condition.

The request body to query bucket data.

Authorization: string
in header

The token to access API, including API key (recommended, available until it is reset; obtained from account center on the platform) and Bearer token (available for at most 24 hours; obtained by calling "User - log in" API). Example:

  1. "ApiKey obtained_api_key";
  2. "Bearer obtained_bearer_token".
page: string
in query

The page number, default 1.

size: string
in query

The page size, default 15.

sort: string
in query

The result sort, only time sorting is supported, default "time,DESC". Example:

  1. "time" or "time,ASC";
  2. "time,DESC".
Request Content-Types: application/json
Request Example
{
  "bucketId": "string",
  "columns": [
    "string"
  ],
  "endTime": "string",
  "sn": "string",
  "startTime": "string"
}
201 Created

Created

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK)
{
  "code": "integer (int32)",
  "data": {
    "content": [
      "object"
    ],
    "first": "boolean",
    "last": "boolean",
    "number": "integer (int32)",
    "numberOfElements": "integer (int32)",
    "size": "integer (int32)",
    "sort": {
      "sorted": "boolean",
      "unsorted": "boolean"
    },
    "totalElements": "integer (int64)",
    "totalPages": "integer (int32)"
  },
  "msg": "string"
}

get channel data by query condition

POST /api/report/channel/data

Return paginated result of the channel data by query condition.

The request body to query channel data.

Authorization: string
in header

The token to access API, including API key (recommended, available until it is reset; obtained from account center on the platform) and Bearer token (available for at most 24 hours; obtained by calling "User - log in" API). Example:

  1. "ApiKey obtained_api_key";
  2. "Bearer obtained_bearer_token".
page: string
in query

The page number, default 1.

size: string
in query

The page size, default 15.

sort: string
in query

The result sort, only time sorting is supported, default "time,DESC". Example:

  1. "time" or "time,ASC";
  2. "time,DESC".
Request Content-Types: application/json
Request Example
{
  "channelId": "string",
  "endTime": "string",
  "startTime": "string"
}
201 Created

Created

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK)
{
  "code": "integer (int32)",
  "data": {
    "content": [
      "object"
    ],
    "first": "boolean",
    "last": "boolean",
    "number": "integer (int32)",
    "numberOfElements": "integer (int32)",
    "size": "integer (int32)",
    "sort": {
      "sorted": "boolean",
      "unsorted": "boolean"
    },
    "totalElements": "integer (int64)",
    "totalPages": "integer (int32)"
  },
  "msg": "string"
}

get event data by query condition

POST /api/report/device/alarms

Return paginated result of the event data by query condition.

The request body to query event data.

Authorization: string
in header

The token to access API, including API key (recommended, available until it is reset; obtained from account center on the platform) and Bearer token (available for at most 24 hours; obtained by calling "User - log in" API). Example:

  1. "ApiKey obtained_api_key";
  2. "Bearer obtained_bearer_token".
page: string
in query

The page number, default 1.

size: string
in query

The page size, default 15.

sort: string
in query

The result sort, only time sorting is supported, default "time,DESC". Example:

  1. "time" or "time,ASC";
  2. "time,DESC".
Request Content-Types: application/json
Request Example
{
  "endTime": "string",
  "groupName": "string",
  "modelName": "string",
  "sn": "string",
  "startTime": "string"
}
201 Created

Created

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK)
{
  "code": "integer (int32)",
  "data": {
    "content": [
      "object"
    ],
    "first": "boolean",
    "last": "boolean",
    "number": "integer (int32)",
    "numberOfElements": "integer (int32)",
    "size": "integer (int32)",
    "sort": {
      "sorted": "boolean",
      "unsorted": "boolean"
    },
    "totalElements": "integer (int64)",
    "totalPages": "integer (int32)"
  },
  "msg": "string"
}

get report data by query condition

POST /api/report/device/data

Return paginated result of the report data by query condition.

The request body to query report data.

Authorization: string
in header

The token to access API, including API key (recommended, available until it is reset; obtained from account center on the platform) and Bearer token (available for at most 24 hours; obtained by calling "User - log in" API). Example:

  1. "ApiKey obtained_api_key";
  2. "Bearer obtained_bearer_token".
page: string
in query

The page number, default 1.

size: string
in query

The page size, default 15.

sort: string
in query

The result sort, only time sorting is supported, default "time,DESC". Example:

  1. "time" or "time,ASC";
  2. "time,DESC".
Request Content-Types: application/json
Request Example
{
  "columns": [
    "string"
  ],
  "endTime": "string",
  "groupName": "string",
  "modelName": "string",
  "sn": "string",
  "startTime": "string"
}
201 Created

Created

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK)
{
  "code": "integer (int32)",
  "data": {
    "content": [
      "object"
    ],
    "first": "boolean",
    "last": "boolean",
    "number": "integer (int32)",
    "numberOfElements": "integer (int32)",
    "size": "integer (int32)",
    "sort": {
      "sorted": "boolean",
      "unsorted": "boolean"
    },
    "totalElements": "integer (int64)",
    "totalPages": "integer (int32)"
  },
  "msg": "string"
}

get event data by query condition

POST /api/report/device/events

Return paginated result of the event data by query condition.

The request body to query event data.

Authorization: string
in header

The token to access API, including API key (recommended, available until it is reset; obtained from account center on the platform) and Bearer token (available for at most 24 hours; obtained by calling "User - log in" API). Example:

  1. "ApiKey obtained_api_key";
  2. "Bearer obtained_bearer_token".
page: string
in query

The page number, default 1.

size: string
in query

The page size, default 15.

sort: string
in query

The result sort, only time sorting is supported, default "time,DESC". Example:

  1. "time" or "time,ASC";
  2. "time,DESC".
Request Content-Types: application/json
Request Example
{
  "endTime": "string",
  "groupName": "string",
  "modelName": "string",
  "sn": "string",
  "startTime": "string"
}
201 Created

Created

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK)
{
  "code": "integer (int32)",
  "data": {
    "content": [
      "object"
    ],
    "first": "boolean",
    "last": "boolean",
    "number": "integer (int32)",
    "numberOfElements": "integer (int32)",
    "size": "integer (int32)",
    "sort": {
      "sorted": "boolean",
      "unsorted": "boolean"
    },
    "totalElements": "integer (int64)",
    "totalPages": "integer (int32)"
  },
  "msg": "string"
}

get bucket statistics data by query condition

POST /api/statistics/bucket

Return unpaginated result of the bucket statistics data by query condition.

The request body to query bucket statistics data.

Authorization: string
in header

The token to access API, including API key (recommended, available until it is reset; obtained from account center on the platform) and Bearer token (available for at most 24 hours; obtained by calling "User - log in" API). Example:

  1. "ApiKey obtained_api_key";
  2. "Bearer obtained_bearer_token".
Request Content-Types: application/json
Request Example
{
  "bucketId": "string",
  "columns": [
    "string"
  ],
  "endTime": "string",
  "queryCount": "integer (int32)",
  "startTime": "string",
  "type": "integer (int32)"
}
200 OK

OK

201 Created

Created

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK)
{
  "code": "integer (int32)",
  "data": "object",
  "msg": "string"
}

get report statistics data by query condition

POST /api/statistics/device

Return paginated result of the report statistics data by query condition.

The request body to query report statistics data.

Authorization: string
in header

The token to access API, including API key (recommended, available until it is reset; obtained from account center on the platform) and Bearer token (available for at most 24 hours; obtained by calling "User - log in" API). Example:

  1. "ApiKey obtained_api_key";
  2. "Bearer obtained_bearer_token".
page: string
in query

The page number, default 1.

size: string
in query

The page size, default 15.

Request Content-Types: application/json
Request Example
{
  "columns": [
    "string"
  ],
  "endTime": "string",
  "queryCount": "integer (int32)",
  "sn": "string",
  "startTime": "string",
  "type": "integer (int32)"
}
200 OK

OK

201 Created

Created

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK)
{
  "code": "integer (int32)",
  "data": "object",
  "msg": "string"
}

Command

Command Management API

issue

POST /api/command/issue

Issue a command to the devices.

Supported Commands Table

Model restart reset close snapshot start tracking stop tracking info
TMA01
TMA11
TMF01
TMM01
TMX01
TMX02
TMX03
TMX04
TMX06
TMX07
TMX08
TMX09
TMY01
TMY02
TMY03
TMY05
TMY07
TMY09

The request body to issue a command to the devices.

Authorization: string
in header

The token to access API, including API key (recommended, available until it is reset; obtained from account center on the platform) and Bearer token (available for at most 24 hours; obtained by calling "User - log in" API). Example:

  1. "ApiKey obtained_api_key";
  2. "Bearer obtained_bearer_token".
Request Content-Types: application/json
Request Example
{
  "description": "string",
  "name": "string",
  "parameters": "object",
  "retry": "integer (int32)",
  "sns": [
    "string"
  ]
}

OK

201 Created

Created

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK)
{
  "code": "integer (int32)",
  "data": "string",
  "msg": "string"
}

get status

GET /api/command/status/{commandId}

Get the status of a command execution.

Authorization: string
in header

The token to access API, including API key (recommended, available until it is reset; obtained from account center on the platform) and Bearer token (available for at most 24 hours; obtained by calling "User - log in" API). Example:

  1. "ApiKey obtained_api_key";
  2. "Bearer obtained_bearer_token".
commandId: string
in path

The ID of the command.

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK)
{
  "code": "integer (int32)",
  "data": {
    "commandId": "string",
    "status": "integer (int32)"
  },
  "msg": "string"
}

transport

POST /api/command/transport

Only valid during: version 2.4.5 - 2.4.13
Issue a pass-through command to devices.

The request body to issue a pass-through command to the devices.

Authorization: string
in header

The token to access API, including API key (recommended, available until it is reset; obtained from account center on the platform) and Bearer token (available for at most 24 hours; obtained by calling "User - log in" API). Example:

  1. "ApiKey obtained_api_key";
  2. "Bearer obtained_bearer_token".
Request Content-Types: application/json
Request Example
{
  "communicationInterface": "integer (int32)",
  "data": "string",
  "sns": [
    "string"
  ]
}
200 OK

OK

201 Created

Created

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK)
{
  "code": "integer (int32)",
  "data": "object",
  "msg": "string"
}

Template

Template API

add

POST /api/template

Create a config template.

The request body to create a config template.

Authorization: string
in header

The token to access API, including API key (recommended, available until it is reset; obtained from account center on the platform) and Bearer token (available for at most 24 hours; obtained by calling "User - log in" API). Example:

  1. "ApiKey obtained_api_key";
  2. "Bearer obtained_bearer_token".
Request Content-Types: application/json
Request Example
{
  "configure": "string",
  "description": "string",
  "modelId": "string",
  "name": "string",
  "type": "integer (int32)"
}
201 Created

Created

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK)
{
  "code": "integer (int32)",
  "data": {
    "configure": "string",
    "createTime": "string (date-time)",
    "creator": "string",
    "description": "string",
    "id": "string",
    "model": {
      "authMode": "integer (int32)",
      "code": "string",
      "configure": "string",
      "createTime": "string (date-time)",
      "creator": "string",
      "dataType": "integer (int32)",
      "description": "string",
      "iconUrl": "string",
      "id": "string",
      "name": "string",
      "networkType": "integer (int32)",
      "protocolType": "integer (int32)",
      "records": [
        {
          "accuracy": "string",
          "category": "string",
          "createTime": "string (date-time)",
          "creator": "string",
          "description": "string",
          "id": "string",
          "isShow": false,
          "isStore": false,
          "max": "number (float)",
          "min": "number (float)",
          "model": {
            "authMode": "integer (int32)",
            "code": "string",
            "configure": "string",
            "createTime": "string (date-time)",
            "creator": "string",
            "dataType": "integer (int32)",
            "description": "string",
            "iconUrl": "string",
            "id": "string",
            "name": "string",
            "networkType": "integer (int32)",
            "protocolType": "integer (int32)",
            "records": [
              {
                "accuracy": "string",
                "category": "string",
                "createTime": "string (date-time)",
                "creator": "string",
                "description": "string",
                "id": "string",
                "isShow": false,
                "isStore": false,
                "max": "number (float)",
                "min": "number (float)",
                "model": {
                  "authMode": "integer (int32)",
                  "code": "string",
                  "configure": "string",
                  "createTime": "string (date-time)",
                  "creator": "string",
                  "dataType": "integer (int32)",
                  "description": "string",
                  "iconUrl": "string",
                  "id": "string",
                  "name": "string",
                  "networkType": "integer (int32)",
                  "protocolType": "integer (int32)",
                  "records": [
                    {
                      "accuracy": "string",
                      "category": "string",
                      "createTime": "string (date-time)",
                      "creator": "string",
                      "description": "string",
                      "id": "string",
                      "isShow": false,
                      "isStore": false,
                      "max": "number (float)",
                      "min": "number (float)",
                      "model": {
                        "authMode": "integer (int32)",
                        "code": "string",
                        "configure": "string",
                        "createTime": "string (date-time)",
                        "creator": "string",
                        "dataType": "integer (int32)",
                        "description": "string"
                      }
                    }
                  ]
                }
              }
            ]
          }
        }
      ]
    }
  }
}

get by query condition

POST /api/template/list

Return paginated result of the information of the templates by query condition.

The request body to query templates.

Authorization: string
in header

The token to access API, including API key (recommended, available until it is reset; obtained from account center on the platform) and Bearer token (available for at most 24 hours; obtained by calling "User - log in" API). Example:

  1. "ApiKey obtained_api_key";
  2. "Bearer obtained_bearer_token".
page: string
in query

The page number, default 1.

size: string
in query

The page size, default 15.

sort: string
in query

The result sort, default "createTime,DESC". Example:

  1. "id" or "id,ASC";
  2. "id,DESC";
  3. "id,createTime,ASC";
  4. "id,createTime,DESC";
  5. (Multiple sort parameters) "id,ASC" and "createTime,DESC".
Request Content-Types: application/json
Request Example
{
  "modelId": "string",
  "searchTerm": "string"
}
201 Created

Created

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK)
{
  "code": "integer (int32)",
  "data": {
    "content": [
      {
        "configure": "string",
        "createTime": "string (date-time)",
        "creator": "string",
        "description": "string",
        "id": "string",
        "model": {
          "authMode": "integer (int32)",
          "code": "string",
          "configure": "string",
          "createTime": "string (date-time)",
          "creator": "string",
          "dataType": "integer (int32)",
          "description": "string",
          "iconUrl": "string",
          "id": "string",
          "name": "string",
          "networkType": "integer (int32)",
          "protocolType": "integer (int32)",
          "records": [
            {
              "accuracy": "string",
              "category": "string",
              "createTime": "string (date-time)",
              "creator": "string",
              "description": "string",
              "id": "string",
              "isShow": false,
              "isStore": false,
              "max": "number (float)",
              "min": "number (float)",
              "model": {
                "authMode": "integer (int32)",
                "code": "string",
                "configure": "string",
                "createTime": "string (date-time)",
                "creator": "string",
                "dataType": "integer (int32)",
                "description": "string",
                "iconUrl": "string",
                "id": "string",
                "name": "string",
                "networkType": "integer (int32)",
                "protocolType": "integer (int32)",
                "records": [
                  {
                    "accuracy": "string",
                    "category": "string",
                    "createTime": "string (date-time)",
                    "creator": "string",
                    "description": "string",
                    "id": "string",
                    "isShow": false,
                    "isStore": false,
                    "max": "number (float)",
                    "min": "number (float)",
                    "model": {
                      "authMode": "integer (int32)",
                      "code": "string",
                      "configure": "string",
                      "createTime": "string (date-time)",
                      "creator": "string",
                      "dataType": "integer (int32)",
                      "description": "string",
                      "iconUrl": "string",
                      "id": "string",
                      "name": "string",
                      "networkType": "integer (int32)",
                      "protocolType": "integer (int32)",
                      "records": [
                        {
                          "accuracy": "string",
                          "category": "string",
                          "createTime": "string (date-time)",
                          "creator": "string",
                          "description": "string",
                          "id": "string",
                          "isShow": false,
                          "isStore": false,
                          "max": "number (float)",
                          "min": "number (float)",
                          "model": {
                            "authMode": "integer (int32)",
                            "code": "string",
                            "configure": "string",
                            "createTime": "string (date-time)"
                          }
                        }
                      ]
                    }
                  }
                ]
              }
            }
          ]
        }
      }
    ]
  }
}

get by model ID

GET /api/template/list/{modelId}

Get information of the template by model ID.

Authorization: string
in header

The token to access API, including API key (recommended, available until it is reset; obtained from account center on the platform) and Bearer token (available for at most 24 hours; obtained by calling "User - log in" API). Example:

  1. "ApiKey obtained_api_key";
  2. "Bearer obtained_bearer_token".
modelId: string
in path

The ID of the model.

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK)
{
  "code": "integer (int32)",
  "data": [
    {
      "configure": "string",
      "createTime": "string (date-time)",
      "creator": "string",
      "description": "string",
      "id": "string",
      "model": {
        "authMode": "integer (int32)",
        "code": "string",
        "configure": "string",
        "createTime": "string (date-time)",
        "creator": "string",
        "dataType": "integer (int32)",
        "description": "string",
        "iconUrl": "string",
        "id": "string",
        "name": "string",
        "networkType": "integer (int32)",
        "protocolType": "integer (int32)",
        "records": [
          {
            "accuracy": "string",
            "category": "string",
            "createTime": "string (date-time)",
            "creator": "string",
            "description": "string",
            "id": "string",
            "isShow": false,
            "isStore": false,
            "max": "number (float)",
            "min": "number (float)",
            "model": {
              "authMode": "integer (int32)",
              "code": "string",
              "configure": "string",
              "createTime": "string (date-time)",
              "creator": "string",
              "dataType": "integer (int32)",
              "description": "string",
              "iconUrl": "string",
              "id": "string",
              "name": "string",
              "networkType": "integer (int32)",
              "protocolType": "integer (int32)",
              "records": [
                {
                  "accuracy": "string",
                  "category": "string",
                  "createTime": "string (date-time)",
                  "creator": "string",
                  "description": "string",
                  "id": "string",
                  "isShow": false,
                  "isStore": false,
                  "max": "number (float)",
                  "min": "number (float)",
                  "model": {
                    "authMode": "integer (int32)",
                    "code": "string",
                    "configure": "string",
                    "createTime": "string (date-time)",
                    "creator": "string",
                    "dataType": "integer (int32)",
                    "description": "string",
                    "iconUrl": "string",
                    "id": "string",
                    "name": "string",
                    "networkType": "integer (int32)",
                    "protocolType": "integer (int32)",
                    "records": [
                      {
                        "accuracy": "string",
                        "category": "string",
                        "createTime": "string (date-time)",
                        "creator": "string",
                        "description": "string",
                        "id": "string",
                        "isShow": false,
                        "isStore": false,
                        "max": "number (float)",
                        "min": "number (float)",
                        "model": {
                          "authMode": "integer (int32)",
                          "code": "string",
                          "configure": "string",
                          "createTime": "string (date-time)",
                          "creator": "string",
                          "dataType": "integer (int32)"
                        }
                      }
                    ]
                  }
                }
              ]
            }
          }
        ]
      }
    }
  ]
}

list

GET /api/template/listAll

Return the list of the templates.

Authorization: string
in header

The token to access API, including API key (recommended, available until it is reset; obtained from account center on the platform) and Bearer token (available for at most 24 hours; obtained by calling "User - log in" API). Example:

  1. "ApiKey obtained_api_key";
  2. "Bearer obtained_bearer_token".
401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK)
{
  "code": "integer (int32)",
  "data": [
    {
      "configure": "string",
      "createTime": "string (date-time)",
      "creator": "string",
      "description": "string",
      "id": "string",
      "model": {
        "authMode": "integer (int32)",
        "code": "string",
        "configure": "string",
        "createTime": "string (date-time)",
        "creator": "string",
        "dataType": "integer (int32)",
        "description": "string",
        "iconUrl": "string",
        "id": "string",
        "name": "string",
        "networkType": "integer (int32)",
        "protocolType": "integer (int32)",
        "records": [
          {
            "accuracy": "string",
            "category": "string",
            "createTime": "string (date-time)",
            "creator": "string",
            "description": "string",
            "id": "string",
            "isShow": false,
            "isStore": false,
            "max": "number (float)",
            "min": "number (float)",
            "model": {
              "authMode": "integer (int32)",
              "code": "string",
              "configure": "string",
              "createTime": "string (date-time)",
              "creator": "string",
              "dataType": "integer (int32)",
              "description": "string",
              "iconUrl": "string",
              "id": "string",
              "name": "string",
              "networkType": "integer (int32)",
              "protocolType": "integer (int32)",
              "records": [
                {
                  "accuracy": "string",
                  "category": "string",
                  "createTime": "string (date-time)",
                  "creator": "string",
                  "description": "string",
                  "id": "string",
                  "isShow": false,
                  "isStore": false,
                  "max": "number (float)",
                  "min": "number (float)",
                  "model": {
                    "authMode": "integer (int32)",
                    "code": "string",
                    "configure": "string",
                    "createTime": "string (date-time)",
                    "creator": "string",
                    "dataType": "integer (int32)",
                    "description": "string",
                    "iconUrl": "string",
                    "id": "string",
                    "name": "string",
                    "networkType": "integer (int32)",
                    "protocolType": "integer (int32)",
                    "records": [
                      {
                        "accuracy": "string",
                        "category": "string",
                        "createTime": "string (date-time)",
                        "creator": "string",
                        "description": "string",
                        "id": "string",
                        "isShow": false,
                        "isStore": false,
                        "max": "number (float)",
                        "min": "number (float)",
                        "model": {
                          "authMode": "integer (int32)",
                          "code": "string",
                          "configure": "string",
                          "createTime": "string (date-time)",
                          "creator": "string",
                          "dataType": "integer (int32)"
                        }
                      }
                    ]
                  }
                }
              ]
            }
          }
        ]
      }
    }
  ]
}

get

GET /api/template/{templateId}

Get information of the template.

Authorization: string
in header

The token to access API, including API key (recommended, available until it is reset; obtained from account center on the platform) and Bearer token (available for at most 24 hours; obtained by calling "User - log in" API). Example:

  1. "ApiKey obtained_api_key";
  2. "Bearer obtained_bearer_token".
templateId: string
in path

The ID of the template.

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK)
{
  "code": "integer (int32)",
  "data": {
    "configure": "string",
    "createTime": "string (date-time)",
    "creator": "string",
    "description": "string",
    "id": "string",
    "model": {
      "authMode": "integer (int32)",
      "code": "string",
      "configure": "string",
      "createTime": "string (date-time)",
      "creator": "string",
      "dataType": "integer (int32)",
      "description": "string",
      "iconUrl": "string",
      "id": "string",
      "name": "string",
      "networkType": "integer (int32)",
      "protocolType": "integer (int32)",
      "records": [
        {
          "accuracy": "string",
          "category": "string",
          "createTime": "string (date-time)",
          "creator": "string",
          "description": "string",
          "id": "string",
          "isShow": false,
          "isStore": false,
          "max": "number (float)",
          "min": "number (float)",
          "model": {
            "authMode": "integer (int32)",
            "code": "string",
            "configure": "string",
            "createTime": "string (date-time)",
            "creator": "string",
            "dataType": "integer (int32)",
            "description": "string",
            "iconUrl": "string",
            "id": "string",
            "name": "string",
            "networkType": "integer (int32)",
            "protocolType": "integer (int32)",
            "records": [
              {
                "accuracy": "string",
                "category": "string",
                "createTime": "string (date-time)",
                "creator": "string",
                "description": "string",
                "id": "string",
                "isShow": false,
                "isStore": false,
                "max": "number (float)",
                "min": "number (float)",
                "model": {
                  "authMode": "integer (int32)",
                  "code": "string",
                  "configure": "string",
                  "createTime": "string (date-time)",
                  "creator": "string",
                  "dataType": "integer (int32)",
                  "description": "string",
                  "iconUrl": "string",
                  "id": "string",
                  "name": "string",
                  "networkType": "integer (int32)",
                  "protocolType": "integer (int32)",
                  "records": [
                    {
                      "accuracy": "string",
                      "category": "string",
                      "createTime": "string (date-time)",
                      "creator": "string",
                      "description": "string",
                      "id": "string",
                      "isShow": false,
                      "isStore": false,
                      "max": "number (float)",
                      "min": "number (float)",
                      "model": {
                        "authMode": "integer (int32)",
                        "code": "string",
                        "configure": "string",
                        "createTime": "string (date-time)",
                        "creator": "string",
                        "dataType": "integer (int32)",
                        "description": "string"
                      }
                    }
                  ]
                }
              }
            ]
          }
        }
      ]
    }
  }
}

update

PUT /api/template/{templateId}

Update a template.

The request body to update a template.

Authorization: string
in header

The token to access API, including API key (recommended, available until it is reset; obtained from account center on the platform) and Bearer token (available for at most 24 hours; obtained by calling "User - log in" API). Example:

  1. "ApiKey obtained_api_key";
  2. "Bearer obtained_bearer_token".
templateId: string
in path

The ID of the template.

Request Content-Types: application/json
Request Example
{
  "configure": "string",
  "description": "string",
  "modelId": "string",
  "name": "string",
  "type": "integer (int32)"
}
201 Created

Created

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK)
{
  "code": "integer (int32)",
  "data": {
    "configure": "string",
    "createTime": "string (date-time)",
    "creator": "string",
    "description": "string",
    "id": "string",
    "model": {
      "authMode": "integer (int32)",
      "code": "string",
      "configure": "string",
      "createTime": "string (date-time)",
      "creator": "string",
      "dataType": "integer (int32)",
      "description": "string",
      "iconUrl": "string",
      "id": "string",
      "name": "string",
      "networkType": "integer (int32)",
      "protocolType": "integer (int32)",
      "records": [
        {
          "accuracy": "string",
          "category": "string",
          "createTime": "string (date-time)",
          "creator": "string",
          "description": "string",
          "id": "string",
          "isShow": false,
          "isStore": false,
          "max": "number (float)",
          "min": "number (float)",
          "model": {
            "authMode": "integer (int32)",
            "code": "string",
            "configure": "string",
            "createTime": "string (date-time)",
            "creator": "string",
            "dataType": "integer (int32)",
            "description": "string",
            "iconUrl": "string",
            "id": "string",
            "name": "string",
            "networkType": "integer (int32)",
            "protocolType": "integer (int32)",
            "records": [
              {
                "accuracy": "string",
                "category": "string",
                "createTime": "string (date-time)",
                "creator": "string",
                "description": "string",
                "id": "string",
                "isShow": false,
                "isStore": false,
                "max": "number (float)",
                "min": "number (float)",
                "model": {
                  "authMode": "integer (int32)",
                  "code": "string",
                  "configure": "string",
                  "createTime": "string (date-time)",
                  "creator": "string",
                  "dataType": "integer (int32)",
                  "description": "string",
                  "iconUrl": "string",
                  "id": "string",
                  "name": "string",
                  "networkType": "integer (int32)",
                  "protocolType": "integer (int32)",
                  "records": [
                    {
                      "accuracy": "string",
                      "category": "string",
                      "createTime": "string (date-time)",
                      "creator": "string",
                      "description": "string",
                      "id": "string",
                      "isShow": false,
                      "isStore": false,
                      "max": "number (float)",
                      "min": "number (float)",
                      "model": {
                        "authMode": "integer (int32)",
                        "code": "string",
                        "configure": "string",
                        "createTime": "string (date-time)",
                        "creator": "string",
                        "dataType": "integer (int32)",
                        "description": "string"
                      }
                    }
                  ]
                }
              }
            ]
          }
        }
      ]
    }
  }
}

delete

DELETE /api/template/{templateId}

Delete a template.

Authorization: string
in header

The token to access API, including API key (recommended, available until it is reset; obtained from account center on the platform) and Bearer token (available for at most 24 hours; obtained by calling "User - log in" API). Example:

  1. "ApiKey obtained_api_key";
  2. "Bearer obtained_bearer_token".
templateId: string
in path

The ID of the template.

200 OK

OK

204 No Content

No Content

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

Response Content-Types: */*
Response Example (200 OK)
{
  "code": "integer (int32)",
  "data": "object",
  "msg": "string"
}

Flow

Flow API

batch export

POST /api/flow/export/batch

Export flows in batch.

Authorization: string
in header

The token to access API, including API key (recommended, available until it is reset; obtained from account center on the platform) and Bearer token (available for at most 24 hours; obtained by calling "User - log in" API). Example:

  1. "ApiKey obtained_api_key";
  2. "Bearer obtained_bearer_token".
modelId: string
in query

The ID of the model of the flow.

200 OK

OK

201 Created

Created

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: application/octet-stream, */*

export

POST /api/flow/export/single

Export a flow.

Authorization: string
in header

The token to access API, including API key (recommended, available until it is reset; obtained from account center on the platform) and Bearer token (available for at most 24 hours; obtained by calling "User - log in" API). Example:

  1. "ApiKey obtained_api_key";
  2. "Bearer obtained_bearer_token".
flowId: string
in query

The ID of the flow.

200 OK

OK

201 Created

Created

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: application/octet-stream, */*

batch import

POST /api/flow/import/batch

Import flows in batch.

Authorization: string
in header

The token to access API, including API key (recommended, available until it is reset; obtained from account center on the platform) and Bearer token (available for at most 24 hours; obtained by calling "User - log in" API). Example:

  1. "ApiKey obtained_api_key";
  2. "Bearer obtained_bearer_token".
flowFile: file
in formData

The file used to import flows in batch in JSON format.

modelId: string
in query

The ID of the model of the flows.

200 OK

OK

201 Created

Created

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK)
{
  "code": "integer (int32)",
  "data": "object",
  "msg": "string"
}

import

POST /api/flow/import/single

Import a flow.

Authorization: string
in header

The token to access API, including API key (recommended, available until it is reset; obtained from account center on the platform) and Bearer token (available for at most 24 hours; obtained by calling "User - log in" API). Example:

  1. "ApiKey obtained_api_key";
  2. "Bearer obtained_bearer_token".
flowFile: file
in formData

The file used to import a flow in JSON format.

flowId: string
in query

The ID of the existing flow to determine the insert location.

type: integer (int32) 1, 2
in query

The value to configure if insert the flow above or under the existing flow. (1: above, 2: under)

200 OK

OK

201 Created

Created

401 Unauthorized

Unauthorized

403 Forbidden

Forbidden

404 Not Found

Not Found

Response Content-Types: */*
Response Example (200 OK)
{
  "code": "integer (int32)",
  "data": "object",
  "msg": "string"
}

Schema Definitions

APIResult: object

code: integer (int32)
data: object
msg: string
Example
{
  "code": "integer (int32)",
  "data": "object",
  "msg": "string"
}

APIResultOfCommandStatusVo: object

code: integer (int32)
data: CommandStatusVo
msg: string
Example
{
  "code": "integer (int32)",
  "data": {
    "commandId": "string",
    "status": "integer (int32)"
  },
  "msg": "string"
}

APIResultOfDevice: object

code: integer (int32)
data: Device
msg: string
Example
{
  "code": "integer (int32)",
  "data": {
    "alias": "string",
    "attributes": "object",
    "availableActions": [
      "string"
    ],
    "cerOverwrite": "integer (int32)",
    "certificate": {
      "associatedCertificateId": "string",
      "associatedCertificateName": "string",
      "beginTime": "string (date-time)",
      "caFlag": "integer (int32)",
      "certificate": "string",
      "certificateType": "integer (int32)",
      "createTime": "string (date-time)",
      "creator": "string",
      "description": "string",
      "endTime": "string (date-time)",
      "id": "string",
      "name": "string",
      "overdueStatus": "integer (int32)",
      "sn": "string",
      "status": "integer (int32)",
      "updateTime": "string (date-time)",
      "updater": "string"
    },
    "createTime": "string (date-time)",
    "creator": "string",
    "defaultActions": [
      "string"
    ],
    "description": "string",
    "extend": "object",
    "group": {
      "certificate": {
        "associatedCertificateId": "string",
        "associatedCertificateName": "string",
        "beginTime": "string (date-time)",
        "caFlag": "integer (int32)",
        "certificate": "string",
        "certificateType": "integer (int32)",
        "createTime": "string (date-time)",
        "creator": "string",
        "description": "string",
        "endTime": "string (date-time)",
        "id": "string",
        "name": "string",
        "overdueStatus": "integer (int32)",
        "sn": "string",
        "status": "integer (int32)",
        "updateTime": "string (date-time)",
        "updater": "string"
      },
      "createTime": "string (date-time)",
      "creator": "string",
      "description": "string",
      "id": "string",
      "model": {
        "authMode": "integer (int32)",
        "code": "string",
        "configure": "string",
        "createTime": "string (date-time)",
        "creator": "string",
        "dataType": "integer (int32)",
        "description": "string",
        "iconUrl": "string",
        "id": "string",
        "name": "string",
        "networkType": "integer (int32)",
        "protocolType": "integer (int32)",
        "records": [
          {
            "accuracy": "string",
            "category": "string",
            "createTime": "string (date-time)",
            "creator": "string",
            "description": "string",
            "id": "string",
            "isShow": false,
            "isStore": false,
            "max": "number (float)",
            "min": "number (float)",
            "model": {
              "authMode": "integer (int32)",
              "code": "string",
              "configure": "string",
              "createTime": "string (date-time)",
              "creator": "string",
              "dataType": "integer (int32)",
              "description": "string",
              "iconUrl": "string",
              "id": "string",
              "name": "string",
              "networkType": "integer (int32)",
              "protocolType": "integer (int32)"
            }
          }
        ]
      }
    }
  }
}

APIResultOfGroup: object

code: integer (int32)
data: Group
msg: string
Example
{
  "code": "integer (int32)",
  "data": {
    "certificate": {
      "associatedCertificateId": "string",
      "associatedCertificateName": "string",
      "beginTime": "string (date-time)",
      "caFlag": "integer (int32)",
      "certificate": "string",
      "certificateType": "integer (int32)",
      "createTime": "string (date-time)",
      "creator": "string",
      "description": "string",
      "endTime": "string (date-time)",
      "id": "string",
      "name": "string",
      "overdueStatus": "integer (int32)",
      "sn": "string",
      "status": "integer (int32)",
      "updateTime": "string (date-time)",
      "updater": "string"
    },
    "createTime": "string (date-time)",
    "creator": "string",
    "description": "string",
    "id": "string",
    "model": {
      "authMode": "integer (int32)",
      "code": "string",
      "configure": "string",
      "createTime": "string (date-time)",
      "creator": "string",
      "dataType": "integer (int32)",
      "description": "string",
      "iconUrl": "string",
      "id": "string",
      "name": "string",
      "networkType": "integer (int32)",
      "protocolType": "integer (int32)",
      "records": [
        {
          "accuracy": "string",
          "category": "string",
          "createTime": "string (date-time)",
          "creator": "string",
          "description": "string",
          "id": "string",
          "isShow": false,
          "isStore": false,
          "max": "number (float)",
          "min": "number (float)",
          "model": {
            "authMode": "integer (int32)",
            "code": "string",
            "configure": "string",
            "createTime": "string (date-time)",
            "creator": "string",
            "dataType": "integer (int32)",
            "description": "string",
            "iconUrl": "string",
            "id": "string",
            "name": "string",
            "networkType": "integer (int32)",
            "protocolType": "integer (int32)",
            "records": [
              {
                "accuracy": "string",
                "category": "string",
                "createTime": "string (date-time)",
                "creator": "string",
                "description": "string",
                "id": "string",
                "isShow": false,
                "isStore": false,
                "max": "number (float)",
                "min": "number (float)",
                "model": {
                  "authMode": "integer (int32)",
                  "code": "string",
                  "configure": "string",
                  "createTime": "string (date-time)",
                  "creator": "string",
                  "dataType": "integer (int32)",
                  "description": "string",
                  "iconUrl": "string",
                  "id": "string",
                  "name": "string",
                  "networkType": "integer (int32)",
                  "protocolType": "integer (int32)",
                  "records": [
                    {
                      "accuracy": "string",
                      "category": "string"
                    }
                  ]
                }
              }
            ]
          }
        }
      ]
    }
  }
}

APIResultOfListOfAround: object

code: integer (int32)
data: Around
Around
msg: string
Example
{
  "code": "integer (int32)",
  "data": [
    {
      "alias": "string",
      "field": "object",
      "gpsLocating": "integer (int32)",
      "id": "string",
      "isAlarm": "integer (int32)",
      "lat": "number (double)",
      "lng": "number (double)",
      "sn": "string",
      "status": "integer (int32)"
    }
  ],
  "msg": "string"
}

APIResultOfListOfGeofencing: object

code: integer (int32)
data: Geofencing
Geofencing
msg: string
Example
{
  "code": "integer (int32)",
  "data": [
    {
      "error": "string",
      "iccid": "string",
      "lat": "number (double)",
      "lng": "number (double)",
      "sensorSn": "string",
      "sn": "string",
      "status": "integer (int32)"
    }
  ],
  "msg": "string"
}

APIResultOfListOfGroup: object

code: integer (int32)
data: Group
Group
msg: string
Example
{
  "code": "integer (int32)",
  "data": [
    {
      "certificate": {
        "associatedCertificateId": "string",
        "associatedCertificateName": "string",
        "beginTime": "string (date-time)",
        "caFlag": "integer (int32)",
        "certificate": "string",
        "certificateType": "integer (int32)",
        "createTime": "string (date-time)",
        "creator": "string",
        "description": "string",
        "endTime": "string (date-time)",
        "id": "string",
        "name": "string",
        "overdueStatus": "integer (int32)",
        "sn": "string",
        "status": "integer (int32)",
        "updateTime": "string (date-time)",
        "updater": "string"
      },
      "createTime": "string (date-time)",
      "creator": "string",
      "description": "string",
      "id": "string",
      "model": {
        "authMode": "integer (int32)",
        "code": "string",
        "configure": "string",
        "createTime": "string (date-time)",
        "creator": "string",
        "dataType": "integer (int32)",
        "description": "string",
        "iconUrl": "string",
        "id": "string",
        "name": "string",
        "networkType": "integer (int32)",
        "protocolType": "integer (int32)",
        "records": [
          {
            "accuracy": "string",
            "category": "string",
            "createTime": "string (date-time)",
            "creator": "string",
            "description": "string",
            "id": "string",
            "isShow": false,
            "isStore": false,
            "max": "number (float)",
            "min": "number (float)",
            "model": {
              "authMode": "integer (int32)",
              "code": "string",
              "configure": "string",
              "createTime": "string (date-time)",
              "creator": "string",
              "dataType": "integer (int32)",
              "description": "string",
              "iconUrl": "string",
              "id": "string",
              "name": "string",
              "networkType": "integer (int32)",
              "protocolType": "integer (int32)",
              "records": [
                {
                  "accuracy": "string",
                  "category": "string",
                  "createTime": "string (date-time)",
                  "creator": "string",
                  "description": "string",
                  "id": "string",
                  "isShow": false,
                  "isStore": false,
                  "max": "number (float)",
                  "min": "number (float)",
                  "model": {
                    "authMode": "integer (int32)",
                    "code": "string",
                    "configure": "string",
                    "createTime": "string (date-time)",
                    "creator": "string",
                    "dataType": "integer (int32)",
                    "description": "string",
                    "iconUrl": "string",
                    "id": "string",
                    "name": "string",
                    "networkType": "integer (int32)",
                    "protocolType": "integer (int32)",
                    "records": [
                      {
                        "accuracy": "string"
                      }
                    ]
                  }
                }
              ]
            }
          }
        ]
      }
    }
  ]
}

APIResultOfListOfTemplate: object

code: integer (int32)
data: Template
Template
msg: string
Example
{
  "code": "integer (int32)",
  "data": [
    {
      "configure": "string",
      "createTime": "string (date-time)",
      "creator": "string",
      "description": "string",
      "id": "string",
      "model": {
        "authMode": "integer (int32)",
        "code": "string",
        "configure": "string",
        "createTime": "string (date-time)",
        "creator": "string",
        "dataType": "integer (int32)",
        "description": "string",
        "iconUrl": "string",
        "id": "string",
        "name": "string",
        "networkType": "integer (int32)",
        "protocolType": "integer (int32)",
        "records": [
          {
            "accuracy": "string",
            "category": "string",
            "createTime": "string (date-time)",
            "creator": "string",
            "description": "string",
            "id": "string",
            "isShow": false,
            "isStore": false,
            "max": "number (float)",
            "min": "number (float)",
            "model": {
              "authMode": "integer (int32)",
              "code": "string",
              "configure": "string",
              "createTime": "string (date-time)",
              "creator": "string",
              "dataType": "integer (int32)",
              "description": "string",
              "iconUrl": "string",
              "id": "string",
              "name": "string",
              "networkType": "integer (int32)",
              "protocolType": "integer (int32)",
              "records": [
                {
                  "accuracy": "string",
                  "category": "string",
                  "createTime": "string (date-time)",
                  "creator": "string",
                  "description": "string",
                  "id": "string",
                  "isShow": false,
                  "isStore": false,
                  "max": "number (float)",
                  "min": "number (float)",
                  "model": {
                    "authMode": "integer (int32)",
                    "code": "string",
                    "configure": "string",
                    "createTime": "string (date-time)",
                    "creator": "string",
                    "dataType": "integer (int32)",
                    "description": "string",
                    "iconUrl": "string",
                    "id": "string",
                    "name": "string",
                    "networkType": "integer (int32)",
                    "protocolType": "integer (int32)",
                    "records": [
                      {
                        "accuracy": "string",
                        "category": "string",
                        "createTime": "string (date-time)",
                        "creator": "string",
                        "description": "string",
                        "id": "string",
                        "isShow": false,
                        "isStore": false,
                        "max": "number (float)",
                        "min": "number (float)",
                        "model": {
                          "authMode": "integer (int32)",
                          "code": "string",
                          "configure": "string",
                          "createTime": "string (date-time)",
                          "creator": "string",
                          "dataType": "integer (int32)",
                          "description": "string"
                        }
                      }
                    ]
                  }
                }
              ]
            }
          }
        ]
      }
    }
  ]
}

APIResultOfMapOfstringAndobject: object

code: integer (int32)
data: object
msg: string
Example
{
  "code": "integer (int32)",
  "data": "object",
  "msg": "string"
}

APIResultOfPageOfDevice: object

code: integer (int32)
data: PageOfDevice
msg: string
Example
{
  "code": "integer (int32)",
  "data": {
    "content": [
      {
        "alias": "string",
        "attributes": "object",
        "availableActions": [
          "string"
        ],
        "cerOverwrite": "integer (int32)",
        "certificate": {
          "associatedCertificateId": "string",
          "associatedCertificateName": "string",
          "beginTime": "string (date-time)",
          "caFlag": "integer (int32)",
          "certificate": "string",
          "certificateType": "integer (int32)",
          "createTime": "string (date-time)",
          "creator": "string",
          "description": "string",
          "endTime": "string (date-time)",
          "id": "string",
          "name": "string",
          "overdueStatus": "integer (int32)",
          "sn": "string",
          "status": "integer (int32)",
          "updateTime": "string (date-time)",
          "updater": "string"
        },
        "createTime": "string (date-time)",
        "creator": "string",
        "defaultActions": [
          "string"
        ],
        "description": "string",
        "extend": "object",
        "group": {
          "certificate": {
            "associatedCertificateId": "string",
            "associatedCertificateName": "string",
            "beginTime": "string (date-time)",
            "caFlag": "integer (int32)",
            "certificate": "string",
            "certificateType": "integer (int32)",
            "createTime": "string (date-time)",
            "creator": "string",
            "description": "string",
            "endTime": "string (date-time)",
            "id": "string",
            "name": "string",
            "overdueStatus": "integer (int32)",
            "sn": "string",
            "status": "integer (int32)",
            "updateTime": "string (date-time)",
            "updater": "string"
          },
          "createTime": "string (date-time)",
          "creator": "string",
          "description": "string",
          "id": "string",
          "model": {
            "authMode": "integer (int32)",
            "code": "string",
            "configure": "string",
            "createTime": "string (date-time)",
            "creator": "string",
            "dataType": "integer (int32)",
            "description": "string",
            "iconUrl": "string",
            "id": "string",
            "name": "string",
            "networkType": "integer (int32)",
            "protocolType": "integer (int32)",
            "records": [
              {
                "accuracy": "string",
                "category": "string",
                "createTime": "string (date-time)",
                "creator": "string",
                "description": "string",
                "id": "string",
                "isShow": false,
                "isStore": false,
                "max": "number (float)",
                "min": "number (float)",
                "model": {
                  "authMode": "integer (int32)",
                  "code": "string",
                  "configure": "string",
                  "createTime": "string (date-time)",
                  "creator": "string",
                  "dataType": "integer (int32)",
                  "description": "string",
                  "iconUrl": "string",
                  "id": "string"
                }
              }
            ]
          }
        }
      }
    ]
  }
}

APIResultOfPageOfDeviceStatus: object

code: integer (int32)
data: PageOfDeviceStatus
msg: string
Example
{
  "code": "integer (int32)",
  "data": {
    "content": [
      {
        "sn": "string",
        "status": "string"
      }
    ],
    "first": "boolean",
    "last": "boolean",
    "number": "integer (int32)",
    "numberOfElements": "integer (int32)",
    "size": "integer (int32)",
    "sort": {
      "sorted": "boolean",
      "unsorted": "boolean"
    },
    "totalElements": "integer (int64)",
    "totalPages": "integer (int32)"
  },
  "msg": "string"
}

APIResultOfPageOfGroup: object

code: integer (int32)
data: PageOfGroup
msg: string
Example
{
  "code": "integer (int32)",
  "data": {
    "content": [
      {
        "certificate": {
          "associatedCertificateId": "string",
          "associatedCertificateName": "string",
          "beginTime": "string (date-time)",
          "caFlag": "integer (int32)",
          "certificate": "string",
          "certificateType": "integer (int32)",
          "createTime": "string (date-time)",
          "creator": "string",
          "description": "string",
          "endTime": "string (date-time)",
          "id": "string",
          "name": "string",
          "overdueStatus": "integer (int32)",
          "sn": "string",
          "status": "integer (int32)",
          "updateTime": "string (date-time)",
          "updater": "string"
        },
        "createTime": "string (date-time)",
        "creator": "string",
        "description": "string",
        "id": "string",
        "model": {
          "authMode": "integer (int32)",
          "code": "string",
          "configure": "string",
          "createTime": "string (date-time)",
          "creator": "string",
          "dataType": "integer (int32)",
          "description": "string",
          "iconUrl": "string",
          "id": "string",
          "name": "string",
          "networkType": "integer (int32)",
          "protocolType": "integer (int32)",
          "records": [
            {
              "accuracy": "string",
              "category": "string",
              "createTime": "string (date-time)",
              "creator": "string",
              "description": "string",
              "id": "string",
              "isShow": false,
              "isStore": false,
              "max": "number (float)",
              "min": "number (float)",
              "model": {
                "authMode": "integer (int32)",
                "code": "string",
                "configure": "string",
                "createTime": "string (date-time)",
                "creator": "string",
                "dataType": "integer (int32)",
                "description": "string",
                "iconUrl": "string",
                "id": "string",
                "name": "string",
                "networkType": "integer (int32)",
                "protocolType": "integer (int32)",
                "records": [
                  {
                    "accuracy": "string",
                    "category": "string",
                    "createTime": "string (date-time)",
                    "creator": "string",
                    "description": "string",
                    "id": "string",
                    "isShow": false,
                    "isStore": false,
                    "max": "number (float)",
                    "min": "number (float)",
                    "model": {
                      "authMode": "integer (int32)",
                      "code": "string",
                      "configure": "string",
                      "createTime": "string (date-time)",
                      "creator": "string",
                      "dataType": "integer (int32)",
                      "description": "string",
                      "iconUrl": "string",
                      "id": "string",
                      "name": "string",
                      "networkType": "integer (int32)",
                      "protocolType": "integer (int32)",
                      "records": [
                        null
                      ]
                    }
                  }
                ]
              }
            }
          ]
        }
      }
    ]
  }
}

APIResultOfPageOfMapOfstringAndobject: object

code: integer (int32)
data: PageOfMapOfstringAndobject
msg: string
Example
{
  "code": "integer (int32)",
  "data": {
    "content": [
      "object"
    ],
    "first": "boolean",
    "last": "boolean",
    "number": "integer (int32)",
    "numberOfElements": "integer (int32)",
    "size": "integer (int32)",
    "sort": {
      "sorted": "boolean",
      "unsorted": "boolean"
    },
    "totalElements": "integer (int64)",
    "totalPages": "integer (int32)"
  },
  "msg": "string"
}

APIResultOfPageOfTemplate: object

code: integer (int32)
data: PageOfTemplate
msg: string
Example
{
  "code": "integer (int32)",
  "data": {
    "content": [
      {
        "configure": "string",
        "createTime": "string (date-time)",
        "creator": "string",
        "description": "string",
        "id": "string",
        "model": {
          "authMode": "integer (int32)",
          "code": "string",
          "configure": "string",
          "createTime": "string (date-time)",
          "creator": "string",
          "dataType": "integer (int32)",
          "description": "string",
          "iconUrl": "string",
          "id": "string",
          "name": "string",
          "networkType": "integer (int32)",
          "protocolType": "integer (int32)",
          "records": [
            {
              "accuracy": "string",
              "category": "string",
              "createTime": "string (date-time)",
              "creator": "string",
              "description": "string",
              "id": "string",
              "isShow": false,
              "isStore": false,
              "max": "number (float)",
              "min": "number (float)",
              "model": {
                "authMode": "integer (int32)",
                "code": "string",
                "configure": "string",
                "createTime": "string (date-time)",
                "creator": "string",
                "dataType": "integer (int32)",
                "description": "string",
                "iconUrl": "string",
                "id": "string",
                "name": "string",
                "networkType": "integer (int32)",
                "protocolType": "integer (int32)",
                "records": [
                  {
                    "accuracy": "string",
                    "category": "string",
                    "createTime": "string (date-time)",
                    "creator": "string",
                    "description": "string",
                    "id": "string",
                    "isShow": false,
                    "isStore": false,
                    "max": "number (float)",
                    "min": "number (float)",
                    "model": {
                      "authMode": "integer (int32)",
                      "code": "string",
                      "configure": "string",
                      "createTime": "string (date-time)",
                      "creator": "string",
                      "dataType": "integer (int32)",
                      "description": "string",
                      "iconUrl": "string",
                      "id": "string",
                      "name": "string",
                      "networkType": "integer (int32)",
                      "protocolType": "integer (int32)",
                      "records": [
                        {
                          "accuracy": "string",
                          "category": "string",
                          "createTime": "string (date-time)",
                          "creator": "string",
                          "description": "string",
                          "id": "string",
                          "isShow": false,
                          "isStore": false,
                          "max": "number (float)",
                          "min": "number (float)",
                          "model": {
                            "authMode": "integer (int32)",
                            "code": "string",
                            "configure": "string",
                            "createTime": "string (date-time)",
                            "creator": "string"
                          }
                        }
                      ]
                    }
                  }
                ]
              }
            }
          ]
        }
      }
    ]
  }
}

APIResultOfTemplate: object

code: integer (int32)
data: Template
msg: string
Example
{
  "code": "integer (int32)",
  "data": {
    "configure": "string",
    "createTime": "string (date-time)",
    "creator": "string",
    "description": "string",
    "id": "string",
    "model": {
      "authMode": "integer (int32)",
      "code": "string",
      "configure": "string",
      "createTime": "string (date-time)",
      "creator": "string",
      "dataType": "integer (int32)",
      "description": "string",
      "iconUrl": "string",
      "id": "string",
      "name": "string",
      "networkType": "integer (int32)",
      "protocolType": "integer (int32)",
      "records": [
        {
          "accuracy": "string",
          "category": "string",
          "createTime": "string (date-time)",
          "creator": "string",
          "description": "string",
          "id": "string",
          "isShow": false,
          "isStore": false,
          "max": "number (float)",
          "min": "number (float)",
          "model": {
            "authMode": "integer (int32)",
            "code": "string",
            "configure": "string",
            "createTime": "string (date-time)",
            "creator": "string",
            "dataType": "integer (int32)",
            "description": "string",
            "iconUrl": "string",
            "id": "string",
            "name": "string",
            "networkType": "integer (int32)",
            "protocolType": "integer (int32)",
            "records": [
              {
                "accuracy": "string",
                "category": "string",
                "createTime": "string (date-time)",
                "creator": "string",
                "description": "string",
                "id": "string",
                "isShow": false,
                "isStore": false,
                "max": "number (float)",
                "min": "number (float)",
                "model": {
                  "authMode": "integer (int32)",
                  "code": "string",
                  "configure": "string",
                  "createTime": "string (date-time)",
                  "creator": "string",
                  "dataType": "integer (int32)",
                  "description": "string",
                  "iconUrl": "string",
                  "id": "string",
                  "name": "string",
                  "networkType": "integer (int32)",
                  "protocolType": "integer (int32)",
                  "records": [
                    {
                      "accuracy": "string",
                      "category": "string",
                      "createTime": "string (date-time)",
                      "creator": "string",
                      "description": "string",
                      "id": "string",
                      "isShow": false,
                      "isStore": false,
                      "max": "number (float)",
                      "min": "number (float)",
                      "model": {
                        "authMode": "integer (int32)",
                        "code": "string",
                        "configure": "string",
                        "createTime": "string (date-time)",
                        "creator": "string",
                        "dataType": "integer (int32)",
                        "description": "string",
                        "iconUrl": "string"
                      }
                    }
                  ]
                }
              }
            ]
          }
        }
      ]
    }
  }
}

APIResultOfobject: object

code: integer (int32)
data: object
msg: string
Example
{
  "code": "integer (int32)",
  "data": "object",
  "msg": "string"
}

APIResultOfstring: object

code: integer (int32)
data: string
msg: string
Example
{
  "code": "integer (int32)",
  "data": "string",
  "msg": "string"
}

Around: object

The data transfer object of basic information of device nearby location.

alias: string

The alias you gave to the device.

field: object

Extra information of the field of the device in JSON format. e.g., {"field_name":"field_value"}.

gpsLocating: integer (int32)

The location mode of the device. (-1: unknown, 0: LBS, 1: GPS, 2: BeiDou, 3: GLONASS, 4: Galileo)

id: string

The ID of the device.

isAlarm: integer (int32)

The alarm status of the device. (0: off, 1: on)

lat: number (double)

The latitude of the device.

lng: number (double)

The longitude of the device.

sn: string

The serial number of the device.

status: integer (int32)

The current status of the device. (-1: suspended, 0: disabled, 1: offline, 2: online, 3: standby, 4: tracking, 5: inactive)

Example
{
  "alias": "string",
  "field": "object",
  "gpsLocating": "integer (int32)",
  "id": "string",
  "isAlarm": "integer (int32)",
  "lat": "number (double)",
  "lng": "number (double)",
  "sn": "string",
  "status": "integer (int32)"
}

BucketDataParam: object

The request body to query bucket data.

bucketId: string

The ID of the bucket.

columns: string[]

The field list you wish to query for bucket data. e.g., ["field_1","field_2"].

string
endTime: string

The end time you wish to query for bucket data in UTC time format: "yyyy-mm-dd HH:mm:ss".

sn: string

The serial number of the device.

startTime: string

The start time you wish to query for bucket data in UTC time format: "yyyy-mm-dd HH:mm:ss".

Example
{
  "bucketId": "string",
  "columns": [
    "string"
  ],
  "endTime": "string",
  "sn": "string",
  "startTime": "string"
}

BucketStatParam: object

The request body to query bucket statistics data.

bucketId: string

The ID of the bucket.

columns: string[]

The field list you wish to query for bucket statistics data. (temperature: temp, humidity: humi)

string
endTime: string

The end time you wish to query for bucket statistics data in UTC time format: "yyyy-mm-dd HH:mm:ss".

queryCount: integer (int32)

The value to configure the volume of the result. (>0: non-paging with the volume of the value, <=0 or no-filling: non-paging with full volume)

startTime: string

The start time you wish to query for bucket statistics data in UTC time format: "yyyy-mm-dd HH:mm:ss".

type: integer (int32)

The interval type you wish to query for bucket statistics data. (3: 1 hour, 4: 1 day, 5: 1 week, 6: 30 days)

Example
{
  "bucketId": "string",
  "columns": [
    "string"
  ],
  "endTime": "string",
  "queryCount": "integer (int32)",
  "startTime": "string",
  "type": "integer (int32)"
}

BuyDeviceParam: object

The request body to buy new device(s).

companyContact: string

The contact number of the device buyer.

deliveryAddress: string

The address you wish to ship the device(s) to.

deliveryTimeStr: string

The date you wish ThingsMatrix to deliver the device(s).

productName: string

The PID of the device(s) you wish to buy. e.g., "TMX08-EX".

quantity: integer (int32)

The quantity of the device(s) you wish to buy.

shippingMethod: string

The method of shipping you wish to use. ("single", "multiple")

Example
{
  "companyContact": "string",
  "deliveryAddress": "string",
  "deliveryTimeStr": "string",
  "productName": "string",
  "quantity": "integer (int32)",
  "shippingMethod": "string"
}

BuySimCardAddParam: object

The request body to buy new SIM card(s).

companyContact: string

The contact number of the SIM card buyer.

deliveryAddress: string

The address you wish to ship the SIM card(s) to.

deliveryTimeStr: string

The date you wish ThingsMatrix to deliver the SIM card(s).

operator: string

The operator of the SIM card(s) you wish to select. ("AT&T", "ARM")

quantity: integer (int32)

The quantity of the SIM card(s) you wish to buy.

shippingMethod: string

The method of shipping you wish to use. ("single", "multiple")

size: string

The size of the SIM card(s) you wish to select. ("Standard", "Micro", "Nano")

Example
{
  "companyContact": "string",
  "deliveryAddress": "string",
  "deliveryTimeStr": "string",
  "operator": "string",
  "quantity": "integer (int32)",
  "shippingMethod": "string",
  "size": "string"
}

Certificate: object

The data transfer object of certificate.

associatedCertificateId: string

The ID of the associated certificate.

associatedCertificateName: string

The name of the associated certificate.

beginTime: string (date-time)

The time when the certificate becomes effective.

caFlag: integer (int32)

The value to configure if the certificate is a CA certificate or not. (0: no, 1: yes)

certificate: string

The device's certificate.

certificateType: integer (int32)

The type of the certificate. (0: PEM, 1: PFX, 2: JKS)

createTime: string (date-time)

The time when the certificate was created.

creator: string

The creator of the certificate.

description: string

The description you gave to the certificate.

endTime: string (date-time)

The time when the certificate becomes expired.

id: string

The ID of the certificate.

name: string

The name you gave to the certificate.

overdueStatus: integer (int32)

The value to represent if the certificate has expired or not. (0: expired, 1: effective)

sn: string

The serial number of the device.

status: integer (int32)

The value to represent if the certificate has bound to the devices in a group. (0: not bound, 1: bound)

updateTime: string (date-time)

The time when the certificate was updated.

updater: string

The updater of the certificate.

Example
{
  "associatedCertificateId": "string",
  "associatedCertificateName": "string",
  "beginTime": "string (date-time)",
  "caFlag": "integer (int32)",
  "certificate": "string",
  "certificateType": "integer (int32)",
  "createTime": "string (date-time)",
  "creator": "string",
  "description": "string",
  "endTime": "string (date-time)",
  "id": "string",
  "name": "string",
  "overdueStatus": "integer (int32)",
  "sn": "string",
  "status": "integer (int32)",
  "updateTime": "string (date-time)",
  "updater": "string"
}

ChangeDeviceCompanyParam: object

The request body to distribute device(s) to a specific company.

param: DeviceCompany

The object of the serial number of the device and the name of the company you wish to distribute to.

DeviceCompany
Example
{
  "param": [
    {
      "company": "string",
      "sn": "string"
    }
  ]
}

ChangeDeviceStatusParam: object

The request body to edit the status of the device(s).

param: DeviceStatus

The object of the serial number of the device and the status of the device you wish to set.

DeviceStatus
Example
{
  "param": [
    {
      "sn": "string",
      "status": "string"
    }
  ]
}

ChangeSimCardCompanyParam: object

The request body to edit the ownership/company of the SIM card(s).

param: SimCardCompany

The object of the ICCID of the SIM card and the name of the company you wish to distribute to.

SimCardCompany
Example
{
  "param": [
    {
      "company": "string",
      "iccid": "string"
    }
  ]
}

CloseConnParam: object

The request body to close the connections between the platform and the devices in batch by serial number list.

sns: string[]

The serial number list of the devices you wish to close connections in batch.

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

CommandIssueParam: object

The request body to issue a command to the devices.

description: string

The description you wish to give to the command.

name: string

The name of the command you wish to issue to the devices. e.g., "restart", "start tracking". For more information, please refer to Supported Commands Table.

parameters: object

The possible parameters to configure the command you wish to issue to the devices in JSON format. For the models in Supported Commands Table, this value is only available for the command of "start tracking". (interval: 5 seconds ~ 300 seconds, expiration: 300 seconds ~ 3000000 seconds). e.g., {"interval":5,"expiration":300}.

retry: integer (int32)

The number of retries when command execution fails. Default 0.

sns: string[]

The serial number list of the devices you wish to issue the command to.

string
Example
{
  "description": "string",
  "name": "string",
  "parameters": "object",
  "retry": "integer (int32)",
  "sns": [
    "string"
  ]
}

CommandStatusVo: object

The value object of command status.

commandId: string

The ID of the command.

status: integer (int32)

The current status of the command execution. (1: Ready, 2: Processing, 3: completed)

Example
{
  "commandId": "string",
  "status": "integer (int32)"
}

Device: object

The data transfer object of device.

alias: string

The alias you gave to the device.

attributes: object

The attributes you gave to the device in JSON format.

availableActions: string[]

The available commands the device supports in current status.

string
cerOverwrite: integer (int32)

The value to configure if you wish to assign the device the same certificate as its group. (0: yes, 1: no).

certificate: Certificate

The information of the certificate.

createTime: string (date-time)

The time when the device was created.

creator: string

The creator of the device.

defaultActions: string[]

The available commands the device supports.

string
description: string

The description you gave to the device.

extend: object

The latest report data of the device in JSON format.

group: Group

The information of the group of the device.

iccid: string

The ICCID of the SIM card applied by the device.

iccidOverwrite: integer (int32)

The value to represent if the device is allowed to overwrite existing ICCID. (0: not allowed, 1: allowed)

id: string

The ID of the device.

imei: string

The IMEI of the SIM card applied by the device.

model: Model

The information of the model of the device.

sensorOverwrite: integer (int32)

The value to represent if the sensor is allowed to overwrite existing sensor serial number. Only available for TMA model series. (0: not allowed, 1: allowed)

sensorSn: string

The serial number of the sensor. Only available for TMA model series.

sku: string

The storage keeping unit of the device.

sn: string

The serial number of the device.

status: integer (int32)

The current status of the device. (-1: suspended, 0: disabled, 1: offline, 2: online, 3: standby, 4: tracking, 5: inactive)

tags: string[]

The tag list you gave to the device.

string
updateTime: string (date-time)

The time when the device was updated.

updator: string

The updater of the device.

Example
{
  "alias": "string",
  "attributes": "object",
  "availableActions": [
    "string"
  ],
  "cerOverwrite": "integer (int32)",
  "certificate": {
    "associatedCertificateId": "string",
    "associatedCertificateName": "string",
    "beginTime": "string (date-time)",
    "caFlag": "integer (int32)",
    "certificate": "string",
    "certificateType": "integer (int32)",
    "createTime": "string (date-time)",
    "creator": "string",
    "description": "string",
    "endTime": "string (date-time)",
    "id": "string",
    "name": "string",
    "overdueStatus": "integer (int32)",
    "sn": "string",
    "status": "integer (int32)",
    "updateTime": "string (date-time)",
    "updater": "string"
  },
  "createTime": "string (date-time)",
  "creator": "string",
  "defaultActions": [
    "string"
  ],
  "description": "string",
  "extend": "object",
  "group": {
    "certificate": {
      "associatedCertificateId": "string",
      "associatedCertificateName": "string",
      "beginTime": "string (date-time)",
      "caFlag": "integer (int32)",
      "certificate": "string",
      "certificateType": "integer (int32)",
      "createTime": "string (date-time)",
      "creator": "string",
      "description": "string",
      "endTime": "string (date-time)",
      "id": "string",
      "name": "string",
      "overdueStatus": "integer (int32)",
      "sn": "string",
      "status": "integer (int32)",
      "updateTime": "string (date-time)",
      "updater": "string"
    },
    "createTime": "string (date-time)",
    "creator": "string",
    "description": "string",
    "id": "string",
    "model": {
      "authMode": "integer (int32)",
      "code": "string",
      "configure": "string",
      "createTime": "string (date-time)",
      "creator": "string",
      "dataType": "integer (int32)",
      "description": "string",
      "iconUrl": "string",
      "id": "string",
      "name": "string",
      "networkType": "integer (int32)",
      "protocolType": "integer (int32)",
      "records": [
        {
          "accuracy": "string",
          "category": "string",
          "createTime": "string (date-time)",
          "creator": "string",
          "description": "string",
          "id": "string",
          "isShow": false,
          "isStore": false,
          "max": "number (float)",
          "min": "number (float)",
          "model": {
            "authMode": "integer (int32)",
            "code": "string",
            "configure": "string",
            "createTime": "string (date-time)",
            "creator": "string",
            "dataType": "integer (int32)",
            "description": "string",
            "iconUrl": "string",
            "id": "string",
            "name": "string",
            "networkType": "integer (int32)",
            "protocolType": "integer (int32)",
            "records": [
              {}
            ]
          }
        }
      ]
    }
  }
}

DeviceAddParam: object

The request body to create a device.

alias: string

The alias you wish to give to the device.

attributes: object

The attributes you wish to give to the device in JSON format. e.g., {"attribute_key":"attribute_value"}.

cerOverwrite: integer (int32)

The value to configure if you wish to assign the device the same certificate as its group. (0: yes, 1: no).

certificateId: string

The ID of the device certificate.

description: string

The description you wish to give to the device.

groupId: string

The ID of the group you wish to add the device to.

iccid: string

The ICCID of the SIM card applied by the device.

iccidOverwrite: integer (int32)

The value to configure if the device is allowed to overwrite existing ICCID. (0: not allowed, 1: allowed)

imei: string

The IMEI of the SIM card applied by the device.

modelId: string

The ID of the model of the device.

sensorOverwrite: integer (int32)

The value to configure if the sensor is allowed to overwrite existing sensor serial number. Only available for TMA model series. (0: not allowed, 1: allowed)

sensorSn: string

The serial number of the sensor. Only available for TMA model series.

sn: string

The serial number of the device.

tags: string[]

The tag list you wish to give to the device. e.g., ["tag_1","tag_2"].

string
Example
{
  "alias": "string",
  "attributes": "object",
  "cerOverwrite": "integer (int32)",
  "certificateId": "string",
  "description": "string",
  "groupId": "string",
  "iccid": "string",
  "iccidOverwrite": "integer (int32)",
  "imei": "string",
  "modelId": "string",
  "sensorOverwrite": "integer (int32)",
  "sensorSn": "string",
  "sn": "string",
  "tags": [
    "string"
  ]
}

DeviceBatchUpdParam: object

batch update request body

description: string

The description you wish to give to the devices.

groupId: string

The ID of the group you wish to add the devices to.

iccidOverwrite: integer (int32)

The value to configure if each device is allowed to overwrite existing ICCID. (0: not allowed, 1: allowed)

ids: string[]

The ID list of the devices you wish to be modified.

string
sensorOverwrite: integer (int32)

The value to configure if each sensor is allowed to overwrite existing sensor serial number. Only available for TMA model series. (0: not allowed, 1: allowed)

Example
{
  "description": "string",
  "groupId": "string",
  "iccidOverwrite": "integer (int32)",
  "ids": [
    "string"
  ],
  "sensorOverwrite": "integer (int32)"
}

DeviceCalParam: object

The request body to query report statistics data.

columns: string[]

The field list you wish to query for report statistics data. (temperature: temp, humidity: humi)

string
endTime: string

The end time you wish to query for report statistics data in UTC time format: "yyyy-mm-dd HH:mm:ss".

queryCount: integer (int32)

The value to configure the volume of the result. (>0: non-paging with the volume of the value, =0 or no-filling: paging, <0: non-paging with full volume)

sn: string

The serial number of the device you wish to query for report statistics data.

startTime: string

The start time you wish to query for report statistics data in UTC time format: "yyyy-mm-dd HH:mm:ss".

type: integer (int32)

The interval type you wish to query for report statistics data. (3: 1 hour, 4: 1 day, 5: 1 week, 6: 30 days)

Example
{
  "columns": [
    "string"
  ],
  "endTime": "string",
  "queryCount": "integer (int32)",
  "sn": "string",
  "startTime": "string",
  "type": "integer (int32)"
}

DeviceCompany: object

The object of the serial number of the device and the name of the company you wish to distribute to.

company: string

The name of the company you wish to distribute to.

sn: string

The serial number of the device.

Example
{
  "company": "string",
  "sn": "string"
}

DeviceQueryParam: object

The request body to query devices.

groupId: string

The ID of the group you wish to query for devices.

modelId: string

The ID of the model you wish to query for devices.

searchTerm: string

The search terms you wish to query for devices. The search terms include serial number, alias, ICCID, sensor serial number, description, attributes and tags. "sensor serial number" is Only available for TMA model series.

status: integer (int32)

The current status you wish to query for devices. (-1: suspended, 0: disabled, 1: offline, 2: online, 3: standby, 4: tracking, 5: inactive)

Example
{
  "groupId": "string",
  "modelId": "string",
  "searchTerm": "string",
  "status": "integer (int32)"
}

DeviceStatus: object

The object of the serial number of the device and the status of the device you wish to set.

sn: string

The serial number of the device.

status: string

The status of the device you wish to set. ("In Use", "In Hold")

Example
{
  "sn": "string",
  "status": "string"
}

DeviceUpdateParam: object

The request body to update a device.

alias: string

The alias you wish to give to the device.

attributes: object

The attributes you wish to give to the device in JSON format. e.g., {"attribute_key":"attribute_value"}.

cerOverwrite: integer (int32)

The value to configure if you wish to assign the device the same certificate as its group. (0: yes, 1: no).

certificateId: string

The ID of the device certificate.

description: string

The description you wish to give to the device.

groupId: string

The ID of the group you wish to add the device to.

iccid: string

The ICCID of the SIM card applied by the device.

iccidOverwrite: integer (int32)

The value to configure if the device is allowed to overwrite existing ICCID. (0: not allowed, 1: allowed)

imei: string

The IMEI of the SIM card applied by the device.

modelId: string

The ID of the model of the device.

sensorOverwrite: integer (int32)

The value to configure if the sensor is allowed to overwrite existing sensor serial number. Only available for TMA model series. (0: not allowed, 1: allowed)

sensorSn: string

The serial number of the sensor. Only available for TMA model series.

sn: string

The serial number of the device.

status: integer (int32)

The current status of the device. (0: disable, 1: enable)

tags: string[]

The tag list you wish to give to the device. e.g., ["tag_1","tag_2"].

string
Example
{
  "alias": "string",
  "attributes": "object",
  "cerOverwrite": "integer (int32)",
  "certificateId": "string",
  "description": "string",
  "groupId": "string",
  "iccid": "string",
  "iccidOverwrite": "integer (int32)",
  "imei": "string",
  "modelId": "string",
  "sensorOverwrite": "integer (int32)",
  "sensorSn": "string",
  "sn": "string",
  "status": "integer (int32)",
  "tags": [
    "string"
  ]
}

Geofencing: object

The data transfer object of basic information of device by serial number list.

error: string

The error message to indicate the serial number does not exist.

iccid: string

The ICCID of the SIM card applied by the device.

lat: number (double)

The latitude of the device.

lng: number (double)

The longitude of the device.

sensorSn: string

The serial number of the sensor. Only available for TMA model series.

sn: string

The serial number of the device.

status: integer (int32)

The current status of the device. (-1: suspended, 0: disabled, 1: offline, 2: online, 3: standby, 4: tracking, 5: inactive)

Example
{
  "error": "string",
  "iccid": "string",
  "lat": "number (double)",
  "lng": "number (double)",
  "sensorSn": "string",
  "sn": "string",
  "status": "integer (int32)"
}

Group: object

The data transfer object of group.

certificate: Certificate

The information of the certificate bounded by the devices in the group.

createTime: string (date-time)

The time when the group was created.

creator: string

The creator of the group.

description: string

The description you gave to the group.

id: string

The ID of the group.

model: Model

The information of the model of the devices in the group.

name: string

The name you gave to the group.

notification: string[]

The type list of notification you gave to the group to push.

string
pushTo: string

The URL you gave to the group to push the notification to.

sharewith: string[]

The ID list of user you gave access to the group.

string
status: integer (int32)

The current status of the group. (0: disabled, 1: enabled)

template: Template

The information of the config template applied by the devices in the group.

updateTime: string (date-time)

The time when the group was updated.

updator: string

The updater of the group.

Example
{
  "certificate": {
    "associatedCertificateId": "string",
    "associatedCertificateName": "string",
    "beginTime": "string (date-time)",
    "caFlag": "integer (int32)",
    "certificate": "string",
    "certificateType": "integer (int32)",
    "createTime": "string (date-time)",
    "creator": "string",
    "description": "string",
    "endTime": "string (date-time)",
    "id": "string",
    "name": "string",
    "overdueStatus": "integer (int32)",
    "sn": "string",
    "status": "integer (int32)",
    "updateTime": "string (date-time)",
    "updater": "string"
  },
  "createTime": "string (date-time)",
  "creator": "string",
  "description": "string",
  "id": "string",
  "model": {
    "authMode": "integer (int32)",
    "code": "string",
    "configure": "string",
    "createTime": "string (date-time)",
    "creator": "string",
    "dataType": "integer (int32)",
    "description": "string",
    "iconUrl": "string",
    "id": "string",
    "name": "string",
    "networkType": "integer (int32)",
    "protocolType": "integer (int32)",
    "records": [
      {
        "accuracy": "string",
        "category": "string",
        "createTime": "string (date-time)",
        "creator": "string",
        "description": "string",
        "id": "string",
        "isShow": false,
        "isStore": false,
        "max": "number (float)",
        "min": "number (float)",
        "model": {
          "authMode": "integer (int32)",
          "code": "string",
          "configure": "string",
          "createTime": "string (date-time)",
          "creator": "string",
          "dataType": "integer (int32)",
          "description": "string",
          "iconUrl": "string",
          "id": "string",
          "name": "string",
          "networkType": "integer (int32)",
          "protocolType": "integer (int32)",
          "records": [
            {
              "accuracy": "string",
              "category": "string",
              "createTime": "string (date-time)",
              "creator": "string",
              "description": "string",
              "id": "string",
              "isShow": false,
              "isStore": false,
              "max": "number (float)",
              "min": "number (float)",
              "model": {
                "authMode": "integer (int32)",
                "code": "string",
                "configure": "string",
                "createTime": "string (date-time)",
                "creator": "string",
                "dataType": "integer (int32)",
                "description": "string",
                "iconUrl": "string",
                "id": "string",
                "name": "string",
                "networkType": "integer (int32)",
                "protocolType": "integer (int32)",
                "records": [
                  {
                    "accuracy": "string",
                    "category": "string",
                    "createTime": "string (date-time)",
                    "creator": "string",
                    "description": "string"
                  }
                ]
              }
            }
          ]
        }
      }
    ]
  }
}

GroupAddParam: object

The request body to create a group.

certificateId: string

The ID of the certificate bounded by the devices in the group.

description: string

The description you wish to give to the group.

modelId: string

The ID of the model of the devices in the group.

name: string

The name you wish to give to the group.

notification: string[]

The type list of notification you wish to give to the group push. e.g., ["alarm","event"].

string
pushTo: string

The URL you wish to give to the group to push the notification to.

sharewith: string[]

sharewith(user id list)

string
templateId: string

The ID of the config template applied by the devices in the group.

Example
{
  "certificateId": "string",
  "description": "string",
  "modelId": "string",
  "name": "string",
  "notification": [
    "string"
  ],
  "pushTo": "string",
  "sharewith": [
    "string"
  ],
  "templateId": "string"
}

GroupQueryParam: object

The request body to query groups.

modelId: string

The ID of the model you wish to query for group.

searchTerm: string

The search terms you wish to query for devices. The search terms include name and description.

Example
{
  "modelId": "string",
  "searchTerm": "string"
}

GroupUpdateParam: object

The request body to update a group.

certificateId: string

The ID of the certificate bounded by the devices in the group.

description: string

The description you wish to give to the group.

modelId: string

The ID of the model of the devices in the group.

name: string

The name you wish to give to the group.

notification: string[]

The type list of notification you wish to give to the group push. e.g., ["alarm","event"].

string
pushTo: string

The URL you wish to give to the group to push the notification to.

sharewith: string[]

sharewith(user id list)

string
templateId: string

The ID of the config template applied by the devices in the group.

Example
{
  "certificateId": "string",
  "description": "string",
  "modelId": "string",
  "name": "string",
  "notification": [
    "string"
  ],
  "pushTo": "string",
  "sharewith": [
    "string"
  ],
  "templateId": "string"
}

InventoryDeviceParam: object

The request body to query the inventory of the devices.

companyName: string

The name of the company you wish to query.

modelName: string

The name of the model you wish to query.

statusName: string

The current status of the device you wish to query. ("In Stock", "Borrowed Out", "In Transition", "In Use", "In Hold", "Replacing", "In Repair")

Example
{
  "companyName": "string",
  "modelName": "string",
  "statusName": "string"
}

MapOfstringAndobject: object

object
Example
"object"

Model: object

The data transfer object of model.

authMode: integer (int32)

The authentication mode of the model. (1: Device Secret)

code: string

The code of the model.

configure: string

The default config template of the model.

createTime: string (date-time)

The time when the model was created.

creator: string

The creator of the model.

dataType: integer (int32)

The data type of the model. (1: JSON)

description: string

The description you gave to the model.

iconUrl: string

The URL of the image of the model.

id: string

The ID of the model.

name: string

The name you gave to the model.

networkType: integer (int32)

The network type of the model. (1: Cellular(2G/3G/4G/5G), 2: WiFi, 3: Ethernet, 4: Other)

protocolType: integer (int32)

The protocol type of the model. (1: MQTT)

records: Record

The schema list of the model.

Record
status: integer (int32)

The status of the model. (1: disable, 2: enable)

type: integer (int32)

The type of the model. (1: device, 2: sensor, 3: custom)

updateTime: string (date-time)

The time when the model was updated.

updator: string

The updater of the model.

vendor: string

The vendor of the model.

Example
{
  "authMode": "integer (int32)",
  "code": "string",
  "configure": "string",
  "createTime": "string (date-time)",
  "creator": "string",
  "dataType": "integer (int32)",
  "description": "string",
  "iconUrl": "string",
  "id": "string",
  "name": "string",
  "networkType": "integer (int32)",
  "protocolType": "integer (int32)",
  "records": [
    {
      "accuracy": "string",
      "category": "string",
      "createTime": "string (date-time)",
      "creator": "string",
      "description": "string",
      "id": "string",
      "isShow": false,
      "isStore": false,
      "max": "number (float)",
      "min": "number (float)",
      "model": {
        "authMode": "integer (int32)",
        "code": "string",
        "configure": "string",
        "createTime": "string (date-time)",
        "creator": "string",
        "dataType": "integer (int32)",
        "description": "string",
        "iconUrl": "string",
        "id": "string",
        "name": "string",
        "networkType": "integer (int32)",
        "protocolType": "integer (int32)",
        "records": [
          {
            "accuracy": "string",
            "category": "string",
            "createTime": "string (date-time)",
            "creator": "string",
            "description": "string",
            "id": "string",
            "isShow": false,
            "isStore": false,
            "max": "number (float)",
            "min": "number (float)",
            "model": {
              "authMode": "integer (int32)",
              "code": "string",
              "configure": "string",
              "createTime": "string (date-time)",
              "creator": "string",
              "dataType": "integer (int32)",
              "description": "string",
              "iconUrl": "string",
              "id": "string",
              "name": "string",
              "networkType": "integer (int32)",
              "protocolType": "integer (int32)",
              "records": [
                {
                  "accuracy": "string",
                  "category": "string",
                  "createTime": "string (date-time)",
                  "creator": "string",
                  "description": "string",
                  "id": "string",
                  "isShow": false,
                  "isStore": false,
                  "max": "number (float)",
                  "min": "number (float)",
                  "model": {
                    "authMode": "integer (int32)",
                    "code": "string",
                    "configure": "string",
                    "createTime": "string (date-time)",
                    "creator": "string",
                    "dataType": "integer (int32)",
                    "description": "string",
                    "iconUrl": "string",
                    "id": "string",
                    "name": "string",
                    "networkType": "integer (int32)",
                    "protocolType": "integer (int32)",
                    "records": [
                      {
                        "accuracy": "string",
                        "category": "string",
                        "createTime": "string (date-time)"
                      }
                    ]
                  }
                }
              ]
            }
          }
        ]
      }
    }
  ]
}

PageOfDevice: object

content: Device
Device
first: boolean
last: boolean
number: integer (int32)
numberOfElements: integer (int32)
size: integer (int32)
sort: Sort
totalElements: integer (int64)
totalPages: integer (int32)
Example
{
  "content": [
    {
      "alias": "string",
      "attributes": "object",
      "availableActions": [
        "string"
      ],
      "cerOverwrite": "integer (int32)",
      "certificate": {
        "associatedCertificateId": "string",
        "associatedCertificateName": "string",
        "beginTime": "string (date-time)",
        "caFlag": "integer (int32)",
        "certificate": "string",
        "certificateType": "integer (int32)",
        "createTime": "string (date-time)",
        "creator": "string",
        "description": "string",
        "endTime": "string (date-time)",
        "id": "string",
        "name": "string",
        "overdueStatus": "integer (int32)",
        "sn": "string",
        "status": "integer (int32)",
        "updateTime": "string (date-time)",
        "updater": "string"
      },
      "createTime": "string (date-time)",
      "creator": "string",
      "defaultActions": [
        "string"
      ],
      "description": "string",
      "extend": "object",
      "group": {
        "certificate": {
          "associatedCertificateId": "string",
          "associatedCertificateName": "string",
          "beginTime": "string (date-time)",
          "caFlag": "integer (int32)",
          "certificate": "string",
          "certificateType": "integer (int32)",
          "createTime": "string (date-time)",
          "creator": "string",
          "description": "string",
          "endTime": "string (date-time)",
          "id": "string",
          "name": "string",
          "overdueStatus": "integer (int32)",
          "sn": "string",
          "status": "integer (int32)",
          "updateTime": "string (date-time)",
          "updater": "string"
        },
        "createTime": "string (date-time)",
        "creator": "string",
        "description": "string",
        "id": "string",
        "model": {
          "authMode": "integer (int32)",
          "code": "string",
          "configure": "string",
          "createTime": "string (date-time)",
          "creator": "string",
          "dataType": "integer (int32)",
          "description": "string",
          "iconUrl": "string",
          "id": "string",
          "name": "string",
          "networkType": "integer (int32)",
          "protocolType": "integer (int32)",
          "records": [
            {
              "accuracy": "string",
              "category": "string",
              "createTime": "string (date-time)",
              "creator": "string",
              "description": "string",
              "id": "string",
              "isShow": false,
              "isStore": false,
              "max": "number (float)",
              "min": "number (float)",
              "model": {
                "authMode": "integer (int32)",
                "code": "string",
                "configure": "string",
                "createTime": "string (date-time)",
                "creator": "string",
                "dataType": "integer (int32)",
                "description": "string",
                "iconUrl": "string",
                "id": "string",
                "name": "string",
                "networkType": "integer (int32)",
                "protocolType": "integer (int32)"
              }
            }
          ]
        }
      }
    }
  ]
}

PageOfDeviceStatus: object

content: DeviceStatus
DeviceStatus
first: boolean
last: boolean
number: integer (int32)
numberOfElements: integer (int32)
size: integer (int32)
sort: Sort
totalElements: integer (int64)
totalPages: integer (int32)
Example
{
  "content": [
    {
      "sn": "string",
      "status": "string"
    }
  ],
  "first": "boolean",
  "last": "boolean",
  "number": "integer (int32)",
  "numberOfElements": "integer (int32)",
  "size": "integer (int32)",
  "sort": {
    "sorted": "boolean",
    "unsorted": "boolean"
  },
  "totalElements": "integer (int64)",
  "totalPages": "integer (int32)"
}

PageOfGroup: object

content: Group
Group
first: boolean
last: boolean
number: integer (int32)
numberOfElements: integer (int32)
size: integer (int32)
sort: Sort
totalElements: integer (int64)
totalPages: integer (int32)
Example
{
  "content": [
    {
      "certificate": {
        "associatedCertificateId": "string",
        "associatedCertificateName": "string",
        "beginTime": "string (date-time)",
        "caFlag": "integer (int32)",
        "certificate": "string",
        "certificateType": "integer (int32)",
        "createTime": "string (date-time)",
        "creator": "string",
        "description": "string",
        "endTime": "string (date-time)",
        "id": "string",
        "name": "string",
        "overdueStatus": "integer (int32)",
        "sn": "string",
        "status": "integer (int32)",
        "updateTime": "string (date-time)",
        "updater": "string"
      },
      "createTime": "string (date-time)",
      "creator": "string",
      "description": "string",
      "id": "string",
      "model": {
        "authMode": "integer (int32)",
        "code": "string",
        "configure": "string",
        "createTime": "string (date-time)",
        "creator": "string",
        "dataType": "integer (int32)",
        "description": "string",
        "iconUrl": "string",
        "id": "string",
        "name": "string",
        "networkType": "integer (int32)",
        "protocolType": "integer (int32)",
        "records": [
          {
            "accuracy": "string",
            "category": "string",
            "createTime": "string (date-time)",
            "creator": "string",
            "description": "string",
            "id": "string",
            "isShow": false,
            "isStore": false,
            "max": "number (float)",
            "min": "number (float)",
            "model": {
              "authMode": "integer (int32)",
              "code": "string",
              "configure": "string",
              "createTime": "string (date-time)",
              "creator": "string",
              "dataType": "integer (int32)",
              "description": "string",
              "iconUrl": "string",
              "id": "string",
              "name": "string",
              "networkType": "integer (int32)",
              "protocolType": "integer (int32)",
              "records": [
                {
                  "accuracy": "string",
                  "category": "string",
                  "createTime": "string (date-time)",
                  "creator": "string",
                  "description": "string",
                  "id": "string",
                  "isShow": false,
                  "isStore": false,
                  "max": "number (float)",
                  "min": "number (float)",
                  "model": {
                    "authMode": "integer (int32)",
                    "code": "string",
                    "configure": "string",
                    "createTime": "string (date-time)",
                    "creator": "string",
                    "dataType": "integer (int32)",
                    "description": "string",
                    "iconUrl": "string",
                    "id": "string",
                    "name": "string",
                    "networkType": "integer (int32)",
                    "protocolType": "integer (int32)",
                    "records": [
                      {
                        "accuracy": "string",
                        "category": "string"
                      }
                    ]
                  }
                }
              ]
            }
          }
        ]
      }
    }
  ]
}

PageOfMapOfstringAndobject: object

content: MapOfstringAndobject
MapOfstringAndobject
first: boolean
last: boolean
number: integer (int32)
numberOfElements: integer (int32)
size: integer (int32)
sort: Sort
totalElements: integer (int64)
totalPages: integer (int32)
Example
{
  "content": [
    "object"
  ],
  "first": "boolean",
  "last": "boolean",
  "number": "integer (int32)",
  "numberOfElements": "integer (int32)",
  "size": "integer (int32)",
  "sort": {
    "sorted": "boolean",
    "unsorted": "boolean"
  },
  "totalElements": "integer (int64)",
  "totalPages": "integer (int32)"
}

PageOfTemplate: object

content: Template
Template
first: boolean
last: boolean
number: integer (int32)
numberOfElements: integer (int32)
size: integer (int32)
sort: Sort
totalElements: integer (int64)
totalPages: integer (int32)
Example
{
  "content": [
    {
      "configure": "string",
      "createTime": "string (date-time)",
      "creator": "string",
      "description": "string",
      "id": "string",
      "model": {
        "authMode": "integer (int32)",
        "code": "string",
        "configure": "string",
        "createTime": "string (date-time)",
        "creator": "string",
        "dataType": "integer (int32)",
        "description": "string",
        "iconUrl": "string",
        "id": "string",
        "name": "string",
        "networkType": "integer (int32)",
        "protocolType": "integer (int32)",
        "records": [
          {
            "accuracy": "string",
            "category": "string",
            "createTime": "string (date-time)",
            "creator": "string",
            "description": "string",
            "id": "string",
            "isShow": false,
            "isStore": false,
            "max": "number (float)",
            "min": "number (float)",
            "model": {
              "authMode": "integer (int32)",
              "code": "string",
              "configure": "string",
              "createTime": "string (date-time)",
              "creator": "string",
              "dataType": "integer (int32)",
              "description": "string",
              "iconUrl": "string",
              "id": "string",
              "name": "string",
              "networkType": "integer (int32)",
              "protocolType": "integer (int32)",
              "records": [
                {
                  "accuracy": "string",
                  "category": "string",
                  "createTime": "string (date-time)",
                  "creator": "string",
                  "description": "string",
                  "id": "string",
                  "isShow": false,
                  "isStore": false,
                  "max": "number (float)",
                  "min": "number (float)",
                  "model": {
                    "authMode": "integer (int32)",
                    "code": "string",
                    "configure": "string",
                    "createTime": "string (date-time)",
                    "creator": "string",
                    "dataType": "integer (int32)",
                    "description": "string",
                    "iconUrl": "string",
                    "id": "string",
                    "name": "string",
                    "networkType": "integer (int32)",
                    "protocolType": "integer (int32)",
                    "records": [
                      {
                        "accuracy": "string",
                        "category": "string",
                        "createTime": "string (date-time)",
                        "creator": "string",
                        "description": "string",
                        "id": "string",
                        "isShow": false,
                        "isStore": false,
                        "max": "number (float)",
                        "min": "number (float)",
                        "model": {
                          "authMode": "integer (int32)",
                          "code": "string",
                          "configure": "string",
                          "createTime": "string (date-time)",
                          "creator": "string",
                          "dataType": "integer (int32)",
                          "description": "string",
                          "iconUrl": "string"
                        }
                      }
                    ]
                  }
                }
              ]
            }
          }
        ]
      }
    }
  ]
}

PassThroughParam: object

The request body to issue a pass-through command to the devices.

communicationInterface: integer (int32)

The location agreed with the manufacturer to identify the start of transparent information can be understood as the header of transparent information, and the value range is 0xf0 ~ 0xff. (decimalism: 240~255)

data: string

The data of Transparent transmission, support any form of string (including JSON, for example, data:"{\"param\":\"value\"}" ), with a length limit of 1000 characters.

sns: string[]

The serial number list of the devices you wish to issue a pass-through command to.

string
Example
{
  "communicationInterface": "integer (int32)",
  "data": "string",
  "sns": [
    "string"
  ]
}

QueryAroundParam: object

The request body to get basic information of the devices nearby location. The basic information includes ID, serial number, alias, status, longitude, latitude, locating mode, alarm status, extra field information.

field: string

The name of the field of extra information you wish to query for devices. e.g., "signalStrength".

latitude: number (double)

The latitude of the center of the location.

longitude: number (double)

The longitude of the center of the location.

modelName: string

The name of the model of the device.

radius: number (double)

The radius of the search area of the location in unit of meter.

sn: string

The serial number of the device.

status: integer (int32)

The current status you wish to query for devices. (-1: suspended, 0: disabled, 1: offline, 2: online, 3: standby, 4: tracking, 5: inactive)

Example
{
  "field": "string",
  "latitude": "number (double)",
  "longitude": "number (double)",
  "modelName": "string",
  "radius": "number (double)",
  "sn": "string",
  "status": "integer (int32)"
}

QueryChannelRptParam: object

The request body to query channel data.

channelId: string

The ID of the channel.

endTime: string

The end time you wish to query for channel data in UTC time format: "yyyy-mm-dd HH:mm:ss".

startTime: string

The start time you wish to query for channel data in UTC time format: "yyyy-mm-dd HH:mm:ss".

Example
{
  "channelId": "string",
  "endTime": "string",
  "startTime": "string"
}

QueryDevEventParam: object

The request body to query event data.

endTime: string

The end time you wish to query for event data in UTC time format: "yyyy-mm-dd HH:mm:ss".

groupName: string

The name of the group of the devices you wish to query for event data.

modelName: string

The name of the model of the devices you wish to query for event data.

sn: string

The serial number of the device you wish to query for event data.

startTime: string

The start time you wish to query for event data in UTC time format: "yyyy-mm-dd HH:mm:ss".

Example
{
  "endTime": "string",
  "groupName": "string",
  "modelName": "string",
  "sn": "string",
  "startTime": "string"
}

QueryDevRptParam: object

The request body to query report data.

columns: string[]

The field list you wish to query for report data. e.g., ["field_1","field_2"].

string
endTime: string

The end time you wish to query for report data in UTC time format: "yyyy-mm-dd HH:mm:ss".

groupName: string

The name of the group of the devices you wish to query for report data.

modelName: string

The name of the model of the devices you wish to query for report data.

sn: string

The serial number of the device you wish to query for report data.

startTime: string

The start time you wish to query for report data in UTC time format: "yyyy-mm-dd HH:mm:ss".

Example
{
  "columns": [
    "string"
  ],
  "endTime": "string",
  "groupName": "string",
  "modelName": "string",
  "sn": "string",
  "startTime": "string"
}

QueryDeviceParam: object

The request body to get basic information of the devices by serial number list. The basic information includes serial number, ICCID, sensor serial number, status, longitude, latitude and error. "sensor serial number" is Only available for TMA model series.

sns: string[]

The serial number list you wish to query for devices.

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

Record: object

The data transfer object of schema.

accuracy: string

The accuracy of the schema.

category: string

The category of the schema.

createTime: string (date-time)

The time when the schema was created.

creator: string

The creator of the schema.

description: string

The description you gave to the schema.

id: string

The ID of the schema.

isShow: boolean

The value to represent if the schema is shown or hidden. (false: hidden, true: shown)

isStore: boolean

The value to represent if the schema is storable or non-storable. (false: non-storable, true: storable)

max: number (float)

The maximum of the schema.

min: number (float)

The minimum of the schema.

model: Model

The information of the model of the schema.

name: string

The identifier you gave to the schema.

properties: object

The boolean properties of the schema.

sort: integer (int32)

The sequence number of the schema in the schema list to which it belongs.

status: integer (int32)

The status of the schema. (0: disabled, 1: enabled)

tag: integer (int32)

The tag of the schema.

title: string

The title you gave to the schema.

type: string

The type of the schema. e.g., int, float, string, boolean, time, JSON string.

unit: string

The unit of the schema. e.g., mm, m, km/h, ℃, %, dBm, min, s.

updateTime: string (date-time)

The time when the schema was updated.

updator: string

The updater of the schema.

Example
{
  "accuracy": "string",
  "category": "string",
  "createTime": "string (date-time)",
  "creator": "string",
  "description": "string",
  "id": "string",
  "isShow": false,
  "isStore": false,
  "max": "number (float)",
  "min": "number (float)",
  "model": {
    "authMode": "integer (int32)",
    "code": "string",
    "configure": "string",
    "createTime": "string (date-time)",
    "creator": "string",
    "dataType": "integer (int32)",
    "description": "string",
    "iconUrl": "string",
    "id": "string",
    "name": "string",
    "networkType": "integer (int32)",
    "protocolType": "integer (int32)",
    "records": [
      {
        "accuracy": "string",
        "category": "string",
        "createTime": "string (date-time)",
        "creator": "string",
        "description": "string",
        "id": "string",
        "isShow": false,
        "isStore": false,
        "max": "number (float)",
        "min": "number (float)",
        "model": {
          "authMode": "integer (int32)",
          "code": "string",
          "configure": "string",
          "createTime": "string (date-time)",
          "creator": "string",
          "dataType": "integer (int32)",
          "description": "string",
          "iconUrl": "string",
          "id": "string",
          "name": "string",
          "networkType": "integer (int32)",
          "protocolType": "integer (int32)",
          "records": [
            {
              "accuracy": "string",
              "category": "string",
              "createTime": "string (date-time)",
              "creator": "string",
              "description": "string",
              "id": "string",
              "isShow": false,
              "isStore": false,
              "max": "number (float)",
              "min": "number (float)",
              "model": {
                "authMode": "integer (int32)",
                "code": "string",
                "configure": "string",
                "createTime": "string (date-time)",
                "creator": "string",
                "dataType": "integer (int32)",
                "description": "string",
                "iconUrl": "string",
                "id": "string",
                "name": "string",
                "networkType": "integer (int32)",
                "protocolType": "integer (int32)",
                "records": [
                  {
                    "accuracy": "string",
                    "category": "string",
                    "createTime": "string (date-time)",
                    "creator": "string",
                    "description": "string",
                    "id": "string",
                    "isShow": false,
                    "isStore": false,
                    "max": "number (float)",
                    "min": "number (float)",
                    "model": {
                      "authMode": "integer (int32)",
                      "code": "string",
                      "configure": "string",
                      "createTime": "string (date-time)",
                      "creator": "string",
                      "dataType": "integer (int32)"
                    }
                  }
                ]
              }
            }
          ]
        }
      }
    ]
  }
}

ResetParam: object

The request body to reset the devices in batch by serial number list.

sns: string[]

The serial number list of the devices you wish to reset in batch.

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

RestartParam: object

The request body to restart the devices in batch by serial number list.

sns: string[]

The serial number list of the devices you wish to restart in batch.

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

SimCardCompany: object

The object of the ICCID of the SIM card and the name of the company you wish to distribute to.

company: string

The name of the company you wish to distribute to.

iccid: string

The ICCID of the SIM card.

Example
{
  "company": "string",
  "iccid": "string"
}

SimCardQueryForIoParam: object

The request body to query the inventory of the SIM cards.

companyName: string

The name of the company you wish to query.

keyword: string

The keyword you wish to query the SIM cards. ("iccid", "imsi")

status: string

THE status you wish to query the SIM cards. ("TEST_READY", "ACTIVATION_READY", "ACTIVATED", "DEACTIVATED", "RETIRED", "INVENTORY")

Example
{
  "companyName": "string",
  "keyword": "string",
  "status": "string"
}

Sort: object

sorted: boolean
unsorted: boolean
Example
{
  "sorted": "boolean&