Models

MigrateThingDefinitionResponse

object

Response payload after applying or simulating a migration to a Thing.

thingIdstringrequired

Unique identifier representing the migrated Thing.

patchobjectrequired

The patch containing updates to the Thing.

Show child attributes
definitionDefinition

A single fully qualified identifier of a definition in the form '::' or a valid HTTP(s) URL

attributesAttributes

An arbitrary JSON object describing the attributes of a thing.

featuresFeatures

List of features where the key represents the featureId of each feature. The featureId key must be unique in the list.

Show child attributes
[key: string]Feature
Show child attributes
definitionArray<string>

The definitions of a feature.

propertiesFeatureProperties

An arbitrary JSON object describing the properties of a feature.

desiredPropertiesFeatureDesiredProperties

An arbitrary JSON object describing the desired properties of a feature.

mergeStatusstringAPPLIEDDRY_RUNrequired

Indicates the result of the migration process.

  • APPLIED: The migration was successfully applied.
  • DRY_RUN: The migration result was calculated but not applied.
Example
APPLIED
Docs by Sourcey
↑↓ navigate↵ selectesc close