File tree Expand file tree Collapse file tree 1 file changed +55
-0
lines changed
docs/src/operate/registration Expand file tree Collapse file tree 1 file changed +55
-0
lines changed Original file line number Diff line number Diff line change @@ -86,6 +86,61 @@ GET /v1/entities/{topic-id}
86
86
curl http://localhost:8000/tedge/entity-store/v1/entities/device/child01
87
87
```
88
88
89
+ ## Query Entities
90
+
91
+ ### Query All Entities
92
+
93
+ List all entities registered with thin-edge starting from the ` main ` device.
94
+
95
+ ** Endpoint**
96
+
97
+ ```
98
+ GET /v1/entities
99
+ ```
100
+
101
+ ** Responses**
102
+
103
+ * 200: OK
104
+ ``` json
105
+ [
106
+ {
107
+ "@topic-id" : " device/main//" ,
108
+ "@type" : " device"
109
+ },
110
+ {
111
+ "@topic-id" : " device/main/service/tedge-agent" ,
112
+ "@type" : " service" ,
113
+ "@parent" : " device/main//"
114
+ },
115
+ {
116
+ "@topic-id" : " device/child0//" ,
117
+ "@type" : " child-device" ,
118
+ "@parent" : " device/main//"
119
+ },
120
+ {
121
+ "@topic-id" : " device/child1//" ,
122
+ "@type" : " child-device" ,
123
+ "@parent" : " device/main//"
124
+ },
125
+ {
126
+ "@topic-id" : " device/child00//" ,
127
+ "@type" : " child-device" ,
128
+ "@parent" : " device/child0//"
129
+ },
130
+ {
131
+ "@topic-id" : " device/child01//" ,
132
+ "@type" : " child-device" ,
133
+ "@parent" : " device/child0//"
134
+ }
135
+ ]
136
+ ```
137
+
138
+ ** Example**
139
+
140
+ ``` shell
141
+ curl http://localhost:8000/tedge/entity-store/v1/entities
142
+ ```
143
+
89
144
## Delete entity
90
145
91
146
Deleting an entity results in the deletion of its immediate and nested child entities as well, to avoid leaving orphans behind.
You can’t perform that action at this time.
0 commit comments