Skip to content

Commit aa706bc

Browse files
Merge pull request #185325 from baanders/1-18-properties
ADT: Remove unused twin properties
2 parents 8197286 + ff48ce7 commit aa706bc

File tree

1 file changed

+17
-46
lines changed

1 file changed

+17
-46
lines changed

articles/digital-twins/concepts-twins-graph.md

Lines changed: 17 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -77,63 +77,34 @@ When represented as a JSON object, a digital twin will display the following fie
7777
| --- | --- |
7878
| `$dtId` | A user-provided string representing the ID of the digital twin |
7979
| `$etag` | Standard HTTP field assigned by the web server |
80-
| `$conformance` | An enum containing the conformance status of this digital twin (*conformant*, *non-conformant*, *unknown*) |
80+
| `$metadata.$model` | The ID of the model interface that characterizes this digital twin |
81+
| `$metadata.<property-name>` | Other metadata information about properties of the digital twin |
8182
| `<property-name>` | The value of a property in JSON (`string`, number type, or object) |
8283
| `$relationships` | The URL of the path to the relationships collection. This field is absent if the digital twin has no outgoing relationship edges. |
83-
| `$metadata.$model` | [Optional] The ID of the model interface that characterizes this digital twin |
84-
| `$metadata.<property-name>.desiredValue` | [Only for writable properties] The desired value of the specified property |
85-
| `$metadata.<property-name>.desiredVersion` | [Only for writable properties] The version of the desired value |
86-
| `$metadata.<property-name>.ackVersion` | The version acknowledged by the device app implementing the digital twin |
87-
| `$metadata.<property-name>.ackCode` | [Only for writable properties] The `ack` code returned by the device app implementing the digital twin |
88-
| `$metadata.<property-name>.ackDescription` | [Only for writable properties] The `ack` description returned by the device app implementing the digital twin |
8984
| `<component-name>` | A JSON object containing the component's property values and metadata, similar to those of the root object. This object exists even if the component has no properties. |
90-
| `<component-name>.<property-name>` | The value of the component's property in JSON (`string`, number type, or object) |
9185
| `<component-name>.$metadata` | The metadata information for the component, similar to the root-level `$metadata` |
86+
| `<component-name>.<property-name>` | The value of the component's property in JSON (`string`, number type, or object) |
9287

93-
Here's an example of a digital twin formatted as a JSON object:
88+
Here's an example of a digital twin formatted as a JSON object. This twin has two properties, Humidity and Temperature, and a component called Thermostat.
9489

9590
```json
9691
{
97-
"$dtId": "Cafe",
98-
"$etag": "W/\"e59ce8f5-03c0-4356-aea9-249ecbdc07f9\"",
99-
"Temperature": 72,
100-
"Location": {
101-
"x": 101,
102-
"y": 33
103-
},
104-
"component": {
105-
"TableOccupancy": 1,
92+
"$dtId": "myRoomID",
93+
"$etag": "W/\"8e6d3e89-1166-4a1d-9a99-8accd8fef43f\"",
10694
"$metadata": {
107-
"TableOccupancy": {
108-
"desiredValue": 1,
109-
"desiredVersion": 3,
110-
"ackVersion": 2,
111-
"ackCode": 200,
112-
"ackDescription": "OK"
113-
}
114-
}
115-
},
116-
"$metadata": {
117-
"$model": "dtmi:com:contoso:Room;1",
118-
"Temperature": {
119-
"desiredValue": 72,
120-
"desiredVersion": 5,
121-
"ackVersion": 4,
122-
"ackCode": 200,
123-
"ackDescription": "OK"
95+
"$model": "dtmi:example:Room23;1",
96+
"Humidity": {
97+
"lastUpdateTime": "2021-11-30T18:47:53.7648958Z"
98+
},
99+
"Temperature": {
100+
"lastUpdateTime": "2021-11-30T18:47:53.7648958Z"
101+
}
124102
},
125-
"Location": {
126-
"desiredValue": {
127-
"x": 101,
128-
"y": 33,
129-
},
130-
"desiredVersion": 8,
131-
"ackVersion": 8,
132-
"ackCode": 200,
133-
"ackDescription": "OK"
103+
"Humidity": 55,
104+
"Temperature": 35,
105+
"Thermostat": {
106+
"$metadata": {}
134107
}
135-
}
136-
}
137108
```
138109

139110
### Relationship JSON format

0 commit comments

Comments
 (0)