envelope.json

{
  "$udmi_version": "1.5.0",
  "title": "Envelope",
  "description": "The UDMI `envelope` is not a message itself, per se, but the attributes and other information that is delivered along with a message. [Message Envelope Documentation](../docs/messages/envelope.md)",
  "$section": "Messages",
  "additionalProperties": true,
  "properties": {
    "deviceId": {
      "type": "string",
      "pattern": "^[A-Z]{2,6}-[0-9]{1,6}$"
    },
    "deviceNumId": {
      "type": "string",
      "pattern": "^[0-9]+$"
    },
    "deviceRegistryId": {
      "type": "string",
      "pattern": "^[a-zA-Z][-a-zA-Z0-9._+~%]*[a-zA-Z0-9]$"
    },
    "deviceRegistryLocation": {
      "type": "string",
      "pattern": "^[a-z]+-[a-z]+1$"
    },
    "projectId": {
      "type": "string",
      "pattern": "^([.a-z]+:)?[a-z][-a-z0-9]*[a-z0-9]$"
    },
    "payload": {
      "type": "string"
    },
    "source": {
      "type": "string"
    },
    "gatewayId": {
      "type": "string",
      "pattern": "^[A-Z]{2,6}-[0-9]{1,6}$"
    },
    "transactionId": {
      "type": "string"
    },
    "publishTime": {
      "type": "string",
      "format": "date-time"
    },
    "subFolder": {
      "enum": [
        "udmi",
        "update",
        "invalid",
        "error",
        "cloud",
        "discovery",
        "mapping",
        "system",
        "gateway",
        "swarm",
        "localnet",
        "pointset",
        "validation",
        "blobset",
        "monitoring"
      ]
    },
    "subType": {
      "enum": [
        "invalid",
        "event",
        "command",
        "config",
        "state",
        "query",
        "reply",
        "model"
      ]
    }
  },
  "required": [
    "projectId",
    "deviceRegistryId",
    "deviceId",
    "subFolder"
  ]
}