Soracom · JSON Structure

Soracom Device Structure

JSON Structure documenting a Soracom Inventory (LwM2M) device record.

Type: object Properties: 9 Required: 2
IoTCellularLPWANSIMLoRaWANSigfoxMVNOConnectivityEdgeJapan

Soracom Device Structure is a JSON Structure definition published by Soracom, describing 9 properties, of which 2 are required. It conforms to the https://json-structure.org/draft-01/schema meta-schema.

Properties

deviceId endpoint operatorId name online lastSeen tags groupId instances

Meta-schema: https://json-structure.org/draft-01/schema

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/draft-01/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/soracom/main/json-structure/soracom-device-structure.json",
  "title": "Soracom Inventory Device Structure",
  "description": "JSON Structure documenting a Soracom Inventory (LwM2M) device record.",
  "type": "object",
  "properties": {
    "deviceId": {"type": "string"},
    "endpoint": {"type": "string"},
    "operatorId": {"type": "string"},
    "name": {"type": "string"},
    "online": {"type": "boolean"},
    "lastSeen": {"type": "integer"},
    "tags": {"type": "object"},
    "groupId": {"type": ["string", "null"]},
    "instances": {
      "type": "array",
      "items": {"type": "object"}
    }
  },
  "required": ["deviceId", "operatorId"]
}