Models

MigrateThingDefinitionRequest

object

JSON payload to migrate the definition of a Thing.

thingDefinitionUrlstring<uri>required

The URL of the new Thing definition to be applied.

Example

https://models.example.com/thing-definition-1.0.0.tm.jsonld

migrationPayloadobject

Optional migration payload with updates to attributes and features. String values may contain {{ thing-json: }} placeholders to reference existing Thing data (e.g. attributes/location, features/sensor/properties/temp). Resolved values keep their JSON type; missing paths cause the request to fail.

Show child attributes

attributesobject

Attributes to be updated in the thing.

Example

{
  "manufacturer": "New Corp",
  "location": "Berlin, main floor"
}

featuresobject

Features to be updated in the thing.

Show child attributes

[key: string]object

Show child attributes

propertiesobject

Example

{
  "thermostat": {
    "properties": {
      "status": {
        "temperature": {
          "value": 23.5,
          "unit": "DEGREE_CELSIUS"
        }
      }
    }
  }
}

patchConditionsobject

Optional conditions to apply the migration only if the existing thing matches the specified values.

Show child attributes

[key: string]string

Example

{
  "thing:/features/thermostat": "not(exists(/features/thermostat))"
}

initializeMissingPropertiesFromDefaultsbooleanfalse

Flag indicating whether missing properties should be initialized with default values.

Example

true

Example

{
  "thingDefinitionUrl": "https://models.example.com/thing-definition-1.0.0.tm.jsonld",
  "migrationPayload": {
    "attributes": {
      "manufacturer": "New Corp",
      "location": "Berlin, main floor"
    },
    "features": {
      "thermostat": {
        "properties": {
          "status": {
            "temperature": {
              "value": 23.5,
              "unit": "DEGREE_CELSIUS"
            }
          }
        }
      }
    }
  },
  "patchConditions": {
    "thing:/features/thermostat": "not(exists(/features/thermostat))"
  },
  "initializeMissingPropertiesFromDefaults": true
}

Docs by Sourcey