-
Notifications
You must be signed in to change notification settings - Fork 214
/
ditto-api-2.yml
10724 lines (10215 loc) · 441 KB
/
ditto-api-2.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
openapi: 3.0.0
info:
title: Eclipse Ditto™ HTTP API
version: '2'
description: |-
JSON-based, REST-like API for Eclipse Ditto
The Eclipse Ditto HTTP API uses response status codes (see [RFC 7231](https://tools.ietf.org/html/rfc7231#section-6))
to indicate whether a specific request has been successfully completed, or not.
The information Ditto provides additionally to the status code (e.g. in API docs, or error codes like. "things:thing.tooLarge") might change without advance notice.
These are not be considered as official API, and must therefore not be applied in your applications or tests.
servers:
- url: 'https://ditto.eclipseprojects.io/'
description: online Ditto Sandbox
- url: /
description: local Ditto
tags:
- name: Things
description: Manage every thing
- name: Features
description: Structure the features of your things
- name: Policies
description: Control access to your things
- name: Things-Search
description: Find every thing
- name: Messages
description: Talk with your things
- name: CloudEvents
description: Process CloudEvents in Ditto
- name: Connections
description: Manage connections
- name: Devops
description: Devops APIs to manage log levels and configuration in runtime and send piggyback command
security:
- Google:
- openid
- NginxBasic: []
- Bearer: []
paths:
/api/2/things:
get:
summary: Retrieve visible things or things with specified IDs
description: |-
Returns all visible things or things passed in by the required parameter `ids`, which you (the authorized subject) are allowed to read.
Optionally, if you want to retrieve only some of the thing's fields, you can use the specific field selectors (see parameter `fields`) .
Tip: In order to formulate a `filter` which things to search for, take a look at the `/search` resource.
tags:
- Things
parameters:
- name: ids
in: query
description: Contains a comma-separated list of `thingId`s to retrieve in one single request.
required: false
schema:
type: string
- $ref: '#/components/parameters/ThingFieldsQueryParam'
- $ref: '#/components/parameters/TimeoutParam'
responses:
'200':
description: |-
The successfully completed request contains a list of the for the user available Things, or the Things asked for via the `ids` paramter.
The Things are sorted either by their ID, or in the same order as the Thing IDs were provided in the `ids` parameter.
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Thing'
application/td+json:
schema:
type: array
items:
$ref: '#/components/schemas/WotThingDescription'
'400':
description: The request could not be completed. At least one of the defined query parameters was invalid.
content:
application/json:
schema:
$ref: '#/components/schemas/AdvancedError'
'401':
description: The request could not be completed due to missing authentication.
content:
application/json:
schema:
$ref: '#/components/schemas/AdvancedError'
'414':
description: The request could not be completed due to an URI length exceeding 8k characters.
post:
summary: Create a new thing
description: |-
Creates a thing with a default `thingId` and a default `policyId`.
The thing will be empty, i.e. no features, definition, attributes etc. by default.
The default `thingId` consists of your default namespace and a UUID.
The default `policyId` is identical with the default `thingId`, and allows the currently authorized subject all permissions.
In case you need to create a thing with a specific ID, use a *PUT* request instead, as any `thingId` specified in the request body will be ignored.
The field `_created` is filled automatically with the timestamp of the creation. The field is read-only and can
be retrieved later by explicitly selecting it or used in search filters.
tags:
- Things
parameters:
- $ref: '#/components/parameters/RequestedAcksParam'
- $ref: '#/components/parameters/TimeoutParam'
- $ref: '#/components/parameters/ResponseRequiredParam'
- $ref: '#/components/parameters/AllowPolicyLockoutParam'
- $ref: '#/components/parameters/Namespace'
responses:
'201':
description: The thing was successfully created.
headers:
ETag:
description: |-
The (current server-side) ETag for this (sub-)resource. For top-level resources it is in the format
"rev:[revision]", for sub-resources it has the format "hash:[calculated-hash]".
schema:
type: string
Location:
description: The location of the created thing resource
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/Thing'
'400':
description: |-
The request could not be completed. Possible reasons:
* the `thingId` must not be set in the request body
* the JSON body of the thing to be created is invalid
content:
application/json:
schema:
$ref: '#/components/schemas/AdvancedError'
'401':
description: The request could not be completed due to missing authentication.
content:
application/json:
schema:
$ref: '#/components/schemas/AdvancedError'
'403':
description: |-
The request could not be completed.
Possible reasons:
* the caller would not have access to the thing after creating it with the given policy.
* the caller has insufficient permissions.
content:
application/json:
schema:
$ref: '#/components/schemas/AdvancedError'
'404':
description: |-
The request could not be completed. Possible reasons:
* the referenced thing does not exist.
* the caller had insufficient permissions to read the referenced thing.
* the policy that should be copied does not exist.
* the caller had insufficient permissions to read the policy that should be copied.
content:
application/json:
schema:
$ref: '#/components/schemas/AdvancedError'
'412':
$ref: '#/components/responses/PreconditionFailed'
'413':
$ref: '#/components/responses/EntityTooLarge'
'424':
$ref: '#/components/responses/DependencyFailed'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/NewThing'
example:
definition: 'com.acme:coffeebrewer:0.1.0'
attributes:
manufacturer: ACME demo corp.
location: 'Berlin, main floor'
serialno: '42'
model: Speaking coffee machine
features:
coffee-brewer:
definition:
- 'com.acme:coffeebrewer:0.1.0'
properties:
brewed-coffees: 0
water-tank:
properties:
configuration:
smartMode: true
brewingTemp: 87
tempToHold: 44
timeoutSeconds: 6000
status:
waterAmount: 731
temperature: 44
description: 'JSON representation of the thing to be created. Use ''{}'' to create an empty thing with a default policy.'
'/api/2/things/{thingId}':
get:
summary: Retrieve a specific thing
description: |-
Returns the thing identified by the `thingId` path parameter. The response includes details about the thing,
including the `policyId`, attributes, definition and features.
Optionally, you can use the field selectors (see parameter `fields`) to only get specific fields,
which you are interested in.
### Example:
Use the field selector `_policy` to retrieve the content of the policy.
tags:
- Things
parameters:
- $ref: '#/components/parameters/ThingIdPathParam'
- $ref: '#/components/parameters/ThingFieldsQueryParam'
- $ref: '#/components/parameters/IfMatchHeaderParam'
- $ref: '#/components/parameters/IfNoneMatchHeaderParam'
- $ref: '#/components/parameters/GetMetadataParam'
- $ref: '#/components/parameters/TimeoutParam'
- $ref: '#/components/parameters/ConditionParam'
- $ref: '#/components/parameters/ChannelParamPutDescription'
- $ref: '#/components/parameters/LiveChannelConditionParam'
- $ref: '#/components/parameters/LiveChannelTimeoutStrategyParam'
responses:
'200':
description: The request successfully returned the specific thing.
headers:
ETag:
description: |-
The (current server-side) ETag for this (sub-)resource. For top-level resources it is in the format
"rev:[revision]", for sub-resources it has the format "hash:[calculated-hash]".
schema:
type: string
live-channel-condition-matched:
description: Whether or not the live-channel-condition did match and the thing was retrieved from the device.
schema:
type: boolean
channel:
description: The cannel which was used to retrieve the thing.
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/Thing'
application/td+json:
schema:
$ref: '#/components/schemas/WotThingDescription'
'304':
$ref: '#/components/responses/NotModified'
'400':
description: |-
The request could not be completed. Possible reasons:
* the `thingId` does not conform to the namespaced entity ID notation (see [Ditto documentation on namespaced entity IDs](https://www.eclipse.dev/ditto/basic-namespaces-and-names.html#namespaced-id))
* at least one of the defined query parameters is invalid
content:
application/json:
schema:
$ref: '#/components/schemas/AdvancedError'
'401':
description: The request could not be completed due to missing authentication.
content:
application/json:
schema:
$ref: '#/components/schemas/AdvancedError'
'404':
description: The request could not be completed. The thing with the given ID was not found.
content:
application/json:
schema:
$ref: '#/components/schemas/AdvancedError'
'412':
$ref: '#/components/responses/PreconditionFailed'
put:
summary: Create or update a thing with a specified ID
description: |-
Create or update the thing specified by the `thingId` path parameter and the optional JSON body.
* If you set a new `thingId` in the path, a thing will be created.
* If you set an existing `thingId` in the path, the thing will be updated.
### Create a new thing
At the initial creation of a thing, only a valid `thingId` is required.
However, you can create a full-fledged thing all at once.
### Example:
To create a coffee maker thing, set the `thingId` in the path, e.g. to "com.acme.coffeemaker:BE-42"
and the body part, like in the following snippet.
```
{
"definition": "com.acme:coffeebrewer:0.1.0",
"attributes": {
"manufacturer": "ACME demo corp.",
"location": "Berlin, main floor",
"serialno": "42",
"model": "Speaking coffee machine"
},
"features": {
"coffee-brewer": {
"definition": [ "com.acme:coffeebrewer:0.1.0" ],
"properties": {
"brewed-coffees": 0
}
},
"water-tank": {
"properties": {
"configuration": {
"smartMode": true,
"brewingTemp": 87,
"tempToHold": 44,
"timeoutSeconds": 6000
},
"status": {
"waterAmount": 731,
"temperature": 44
}
}
}
}
}
```
As the example does not set a policy in the request body, but the thing concept requires one,
the service will create a default policy. The default policy, has the exactly same id
as the thing, and grants ALL permissions to the authorized subject.
In case you need to associate the new thing to an already existing policy you can additionally
set a policy e.g. "policyId": "com.acme.coffeemaker:policy-1" as the first element in the body part.
Keep in mind, that you can also change the assignment to another policy anytime,
with a request on the sub-resource "PUT /things/{thingId}/policyId"
The field `_created` is filled automatically with the timestamp of the creation. The field is read-only and can
be retrieved later by explicitly selecting it or used in search filters.
### Update an existing thing
For updating an existing thing, the authorized subject needs **WRITE** permission on the thing's root resource.
The ID of a thing cannot be changed after creation. Any `thingId`
specified in the request body is therefore ignored.
tags:
- Things
parameters:
- $ref: '#/components/parameters/ThingIdPathParam'
- $ref: '#/components/parameters/IfMatchHeaderParam'
- $ref: '#/components/parameters/IfNoneMatchHeaderParam'
- $ref: '#/components/parameters/IfEqualHeaderParam'
- $ref: '#/components/parameters/PutMetadataParam'
- $ref: '#/components/parameters/DeleteMetadataParam'
- $ref: '#/components/parameters/RequestedAcksParam'
- $ref: '#/components/parameters/TimeoutParam'
- $ref: '#/components/parameters/ResponseRequiredParam'
- $ref: '#/components/parameters/ConditionParam'
- $ref: '#/components/parameters/ChannelParam'
responses:
'201':
description: The thing was successfully created.
headers:
ETag:
description: |-
The (current server-side) ETag for this (sub-)resource. For top-level resources it is in the format
"rev:[revision]", for sub-resources it has the format "hash:[calculated-hash]".
schema:
type: string
Location:
description: The location of the created thing resource
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/Thing'
'204':
description: The thing was successfully modified.
headers:
ETag:
description: |-
The (current server-side) ETag for this (sub-)resource. For top-level resources it is in the format
"rev:[revision]", for sub-resources it has the format "hash:[calculated-hash]".
schema:
type: string
'400':
description: |-
The request could not be completed. Possible reasons:
* the `thingId` does not conform to the namespaced entity ID notation (see [Ditto documentation on namespaced entity IDs](https://www.eclipse.dev/ditto/basic-namespaces-and-names.html#namespaced-id))
* the JSON body of the thing to be created/modified is invalid
* the JSON body of the thing to be created/modified contains a `thingId`
which does not match the ID in the path
content:
application/json:
schema:
$ref: '#/components/schemas/AdvancedError'
'401':
description: The request could not be completed due to missing authentication.
content:
application/json:
schema:
$ref: '#/components/schemas/AdvancedError'
'403':
description: |-
The request could not be completed. Possible reasons:
* the caller would not have access to the thing after creating it with the given policy
* the caller has insufficient permissions.
For modifying an existing thing, an unrestricted `WRITE` permission on the thing's root resource is required.
content:
application/json:
schema:
$ref: '#/components/schemas/AdvancedError'
'404':
description: |-
The request could not be completed. Possible reasons:
* the referenced thing does not exist.
* the caller has insufficient permissions to read the referenced thing.
* the policy that should be copied does not exist.
* the caller has insufficient permissions to read the policy that should be copied.
content:
application/json:
schema:
$ref: '#/components/schemas/AdvancedError'
'412':
$ref: '#/components/responses/PreconditionFailed'
'413':
$ref: '#/components/responses/EntityTooLarge'
'424':
$ref: '#/components/responses/DependencyFailed'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/NewThing'
example:
definition: 'com.acme:coffeebrewer:0.1.0'
attributes:
manufacturer: ACME demo corp.
location: 'Berlin, main floor'
serialno: '42'
model: Speaking coffee machine
features:
coffee-brewer:
definition:
- 'com.acme:coffeebrewer:0.1.0'
properties:
brewed-coffees: 0
water-tank:
properties:
configuration:
smartMode: true
brewingTemp: 87
tempToHold: 44
timeoutSeconds: 6000
status:
waterAmount: 731
temperature: 44
description: JSON representation of the thing to be modified.
patch:
summary: Create or patch a thing with a specified ID
description: |-
Create or patch an existing thing specified by the `thingId` path parameter.
If the thing did not yet exist, it will be created.
For an existing thing, patching a thing will merge the provided request body with the existing thing values.
This makes it possible to change only some parts of a thing in single request without providing the full thing
structure in the request body.
### Patch a thing
With this resource it is possible to add, update or delete parts of an existing thing or to create the thing if it
does not yet exist.
The request body provided in *JSON merge patch* (RFC-7396) format will be merged with the existing thing.
Notice that the `null` value in the JSON body will delete the specified JSON key from the thing.
For further documentation of JSON merge patch see [RFC 7396](https://tools.ietf.org/html/rfc7396).
### Example
A Thing already exists with the following content:
```
{
"definition": "com.acme:coffeebrewer:0.1.0",
"attributes": {
"manufacturer": "ACME demo corp.",
"location": "Berlin, main floor",
"serialno": "42",
"model": "Speaking coffee machine"
},
"features": {
"coffee-brewer": {
"definition": ["com.acme:coffeebrewer:0.1.0"],
"properties": {
"brewed-coffees": 0
}
},
"water-tank": {
"properties": {
"configuration": {
"smartMode": true,
"brewingTemp": 87,
"tempToHold": 44,
"timeoutSeconds": 6000
},
"status": {
"waterAmount": 731,
"temperature": 44
}
}
}
}
}
```
To make changes that only affect parts of the existing thing, e.g. add some attribute and delete a
specific feature property, the content of the request body could look like this:
```
{
"attributes": {
"manufacturingYear": "2020"
},
"features": {
"water-tank": {
"properties": {
"configuration": {
"smartMode": null,
"tempToHold": 50,
}
}
}
}
}
```
The request body will be merged with the existing thing and the result will be the following thing:
```
{
"definition": "com.acme:coffeebrewer:0.1.0",
"attributes": {
"manufacturer": "ACME demo corp.",
"manufacturingYear": "2020",
"location": "Berlin, main floor",
"serialno": "42",
"model": "Speaking coffee machine"
},
"features": {
"coffee-brewer": {
"definition": ["com.acme:coffeebrewer:0.1.0"],
"properties": {
"brewed-coffees": 0
}
},
"water-tank": {
"properties": {
"configuration": {
"brewingTemp": 87,
"tempToHold": 50,
"timeoutSeconds": 6000
},
"status": {
"waterAmount": 731,
"temperature": 44
}
}
}
}
}
```
### Permissions for patching an existing Thing
For updating an existing thing, the authorized subject needs **WRITE** permission on those parts of the thing
that are affected by the merge update.
For example, to successfully execute the above example the authorized subject needs to have unrestricted
*WRITE* permissions on all affected paths of the JSON merge patch: `attributes/manufacturingYear`,
`features/water-tank/properties/configuration/smartMode`,
`features/water-tank/properties/configuration/tempToHold`. The *WRITE* permission must not be revoked on any
level further down the hierarchy. Consequently it is also sufficient for the authorized subject to have
unrestricted *WRITE* permission at root level or unrestricted *WRITE* permission at `/attributes` and
`/features` etc.
tags:
- Things
parameters:
- $ref: '#/components/parameters/ThingIdPathParam'
- $ref: '#/components/parameters/IfMatchHeaderParam'
- $ref: '#/components/parameters/IfNoneMatchHeaderParam'
- $ref: '#/components/parameters/IfEqualHeaderParam'
- $ref: '#/components/parameters/PutMetadataParam'
- $ref: '#/components/parameters/DeleteMetadataParam'
- $ref: '#/components/parameters/RequestedAcksParam'
- $ref: '#/components/parameters/TimeoutParam'
- $ref: '#/components/parameters/ResponseRequiredParam'
- $ref: '#/components/parameters/ConditionParam'
- $ref: '#/components/parameters/ChannelParam'
responses:
'201':
description: The thing was successfully created.
headers:
ETag:
description: |-
The (current server-side) ETag for this (sub-)resource. For top-level resources it is in the format
"rev:[revision]", for sub-resources it has the format "hash:[calculated-hash]".
schema:
type: string
Location:
description: The location of the created thing resource
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/Thing'
'204':
description: The thing was successfully patched.
headers:
ETag:
description: |-
The (current server-side) ETag for this (sub-)resource. For top-level resources it is in the format
"rev:[revision]", for sub-resources it has the format "hash:[calculated-hash]".
schema:
type: string
'400':
description: |-
The request could not be completed. Possible reasons:
* the JSON body of the thing to be patched is invalid
* the JSON body of the thing to be patched contains a `thingId` which does not match the ID in the path
content:
application/json:
schema:
$ref: '#/components/schemas/AdvancedError'
'401':
description: The request could not be completed due to missing authentication.
content:
application/json:
schema:
$ref: '#/components/schemas/AdvancedError'
'403':
description: |-
The request could not be completed. Possible reasons:
* the caller would not have access to the thing after creating it with the given policy
* the caller has insufficient permissions.
For modifying an existing thing, an unrestricted `WRITE` permission on the thing's root resource is required.
content:
application/json:
schema:
$ref: '#/components/schemas/AdvancedError'
'404':
description: |-
The request could not be completed. Possible reasons:
* the referenced thing does not exist.
* the caller has insufficient permissions to read the referenced thing.
* the policy that should be copied does not exist.
content:
application/json:
schema:
$ref: '#/components/schemas/AdvancedError'
'412':
$ref: '#/components/responses/PreconditionFailed'
'413':
$ref: '#/components/responses/EntityTooLarge'
'424':
$ref: '#/components/responses/DependencyFailed'
requestBody:
content:
application/merge-patch+json:
schema:
$ref: '#/components/schemas/PatchThing'
example:
attributes:
manufacturingYear: '2020'
features:
water-tank:
properties:
configuration:
smartMode: null
tempToHold: 50
description: JSON representation of the thing to be patched.
delete:
summary: Delete a specific thing
description: |-
Deletes the thing identified by the `thingId` path parameter.
This will not delete the policy, which is used for controlling access to this thing.
You can delete the policy afterwards via DELETE `/policies/{policyId}` if you don't need it for other things.
tags:
- Things
parameters:
- $ref: '#/components/parameters/ThingIdPathParam'
- $ref: '#/components/parameters/IfMatchHeaderParam'
- $ref: '#/components/parameters/IfNoneMatchHeaderParam'
- $ref: '#/components/parameters/RequestedAcksParam'
- $ref: '#/components/parameters/TimeoutParam'
- $ref: '#/components/parameters/ResponseRequiredParam'
- $ref: '#/components/parameters/ConditionParam'
- $ref: '#/components/parameters/ChannelParam'
responses:
'204':
description: The thing was successfully deleted.
'400':
description: |-
The request could not be completed. Possible reasons:
* the `thingId` does not conform to the namespaced entity ID notation (see [Ditto documentation on namespaced entity IDs](https://www.eclipse.dev/ditto/basic-namespaces-and-names.html#namespaced-id)).
content:
application/json:
schema:
$ref: '#/components/schemas/AdvancedError'
'401':
description: The request could not be completed due to missing authentication.
content:
application/json:
schema:
$ref: '#/components/schemas/AdvancedError'
'403':
description: |-
The request could not be completed. Possible reasons:
* the caller had insufficient permissions.
For deleting an existing thing, an unrestricted `WRITE` permission on the thing's root resource is required.
content:
application/json:
schema:
$ref: '#/components/schemas/AdvancedError'
'404':
description: The request could not be completed. The thing with the given ID was not found.
content:
application/json:
schema:
$ref: '#/components/schemas/AdvancedError'
'412':
$ref: '#/components/responses/PreconditionFailed'
'424':
$ref: '#/components/responses/DependencyFailed'
'/api/2/things/{thingId}/definition':
get:
summary: Retrieve the definition of a specific thing
description: Returns the definition of the thing identified by the `thingId` path parameter.
tags:
- Things
parameters:
- $ref: '#/components/parameters/ThingIdPathParam'
- $ref: '#/components/parameters/IfMatchHeaderParamHash'
- $ref: '#/components/parameters/IfNoneMatchHeaderParam'
- $ref: '#/components/parameters/GetMetadataParam'
- $ref: '#/components/parameters/TimeoutParam'
- $ref: '#/components/parameters/ConditionParam'
- $ref: '#/components/parameters/ChannelParam'
- $ref: '#/components/parameters/LiveChannelConditionParam'
- $ref: '#/components/parameters/LiveChannelTimeoutStrategyParam'
responses:
'200':
description: The request successfully returned the definition of the specific thing.
headers:
ETag:
description: |-
The (current server-side) ETag for this (sub-)resource. For top-level resources it is in the format
"rev:[revision]", for sub-resources it has the format "hash:[calculated-hash]".
schema:
type: string
live-channel-condition-matched:
description: Whether or not the live-channel-condition did match and the thing was retrieved from the device.
schema:
type: boolean
channel:
description: The cannel which was used to retrieve the thing.
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/Definition'
'304':
$ref: '#/components/responses/NotModified'
'400':
description: |-
The request could not be completed. Possible reasons:
* the `thingId` does not conform to the namespaced entity ID notation
(see [Ditto documentation on namespaced entity IDs](https://www.eclipse.dev/ditto/basic-namespaces-and-names.html#namespaced-id)).
content:
application/json:
schema:
$ref: '#/components/schemas/AdvancedError'
'401':
description: The request could not be completed due to missing authentication.
content:
application/json:
schema:
$ref: '#/components/schemas/AdvancedError'
'403':
description: |-
The request could not be completed. Possible reasons:
* the caller has insufficient permissions.
For modifying the definition of an existing thing, `WRITE` permission is required.
content:
application/json:
schema:
$ref: '#/components/schemas/AdvancedError'
'404':
description: The request could not be completed. The thing with the given ID was not found.
content:
application/json:
schema:
$ref: '#/components/schemas/AdvancedError'
'412':
$ref: '#/components/responses/PreconditionFailed'
put:
summary: Create or update the definition of a specific thing
description: |-
* If the thing does not have a definition yet, this request will create it.
* If the thing already has a definition you can assign it to a new one by setting the new definition in the request body.
tags:
- Things
parameters:
- $ref: '#/components/parameters/ThingIdPathParam'
- $ref: '#/components/parameters/IfMatchHeaderParamHash'
- $ref: '#/components/parameters/IfNoneMatchHeaderParam'
- $ref: '#/components/parameters/IfEqualHeaderParam'
- $ref: '#/components/parameters/PutMetadataParam'
- $ref: '#/components/parameters/DeleteMetadataParam'
- $ref: '#/components/parameters/RequestedAcksParam'
- $ref: '#/components/parameters/TimeoutParam'
- $ref: '#/components/parameters/ResponseRequiredParam'
- $ref: '#/components/parameters/ConditionParam'
- $ref: '#/components/parameters/ChannelParam'
responses:
'201':
description: The definition was successfully created.
headers:
ETag:
description: |-
The (current server-side) ETag for this (sub-)resource. For top-level resources it is in the format
"rev:[revision]", for sub-resources it has the format "hash:[calculated-hash]".
schema:
type: string
Location:
description: The location of the created definition resource
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/Definition'
'204':
description: The definition was successfully updated.
headers:
ETag:
description: |-
The (current server-side) ETag for this (sub-)resource. For top-level resources it is in the format
"rev:[revision]", for sub-resources it has the format "hash:[calculated-hash]".
schema:
type: string
'400':
description: |-
The request could not be completed. Possible reasons:
* the `thingId` does not conform to the namespaced entity ID notation
(see [Ditto documentation on namespaced entity IDs](https://www.eclipse.dev/ditto/basic-namespaces-and-names.html#namespaced-id))
* the JSON was invalid
* the request body was not a JSON object.
content:
application/json:
schema:
$ref: '#/components/schemas/AdvancedError'
'401':
description: The request could not be completed due to missing authentication.
content:
application/json:
schema:
$ref: '#/components/schemas/AdvancedError'
'403':
description: |-
The request could not be completed. Possible reasons:
* the caller has insufficient permissions.
For modifying a definition of an existing thing, `WRITE` permission is required.
content:
application/json:
schema:
$ref: '#/components/schemas/AdvancedError'
'404':
description: The request could not be completed. The thing with the given ID was not found.
content:
application/json:
schema:
$ref: '#/components/schemas/AdvancedError'
'412':
$ref: '#/components/responses/PreconditionFailed'
'413':
$ref: '#/components/responses/EntityTooLarge'
'424':
$ref: '#/components/responses/DependencyFailed'
requestBody:
$ref: '#/components/requestBodies/Definition'
patch:
summary: Patch the definition of a specific thing
description: |-
* If the thing does not have a definition yet, this request will create it.
* If the thing already has a definition you can replace it by providing the new definition in the request body.
* If the request body is set to `null` then the defintion will be deleted.
Notice that the `null` value in the JSON body has a special meaning and will delete the definition from the thing.
For further documentation see [RFC 7396](https://tools.ietf.org/html/rfc7396).
tags:
- Things
parameters:
- $ref: '#/components/parameters/ThingIdPathParam'
- $ref: '#/components/parameters/IfMatchHeaderParamHash'
- $ref: '#/components/parameters/IfNoneMatchHeaderParam'
- $ref: '#/components/parameters/IfEqualHeaderParam'
- $ref: '#/components/parameters/PutMetadataParam'
- $ref: '#/components/parameters/DeleteMetadataParam'
- $ref: '#/components/parameters/RequestedAcksParam'
- $ref: '#/components/parameters/TimeoutParam'
- $ref: '#/components/parameters/ResponseRequiredParam'
- $ref: '#/components/parameters/ConditionParam'
- $ref: '#/components/parameters/ChannelParam'
responses:
'204':
description: The definition was successfully patched.
headers:
ETag:
description: |-
The (current server-side) ETag for this (sub-)resource. For top-level resources it is in the format
"rev:[revision]", for sub-resources it has the format "hash:[calculated-hash]".
schema:
type: string
'400':
description: |-
The request could not be completed. Possible reasons:
* the `thingId` does not conform to the namespaced entity ID notation
(see [Ditto documentation on namespaced entity IDs](https://www.eclipse.dev/ditto/basic-namespaces-and-names.html#namespaced-id))
* the JSON was invalid
* the request body was not a JSON object.
content:
application/json:
schema:
$ref: '#/components/schemas/AdvancedError'
'401':
description: The request could not be completed due to missing authentication.
content:
application/json:
schema:
$ref: '#/components/schemas/AdvancedError'
'403':
description: |-
The request could not be completed. Possible reasons:
* the caller has insufficient permissions.
For modifying a definition of an existing thing, `WRITE` permission is required.
content:
application/json:
schema:
$ref: '#/components/schemas/AdvancedError'
'404':
description: The request could not be completed. The thing with the given ID was not found.
content:
application/json:
schema:
$ref: '#/components/schemas/AdvancedError'
'412':
$ref: '#/components/responses/PreconditionFailed'
'413':
$ref: '#/components/responses/EntityTooLarge'
'424':
$ref: '#/components/responses/DependencyFailed'
requestBody:
content:
application/merge-patch+json:
schema:
$ref: '#/components/schemas/Definition'
example: '"example:test:definition"'
description: |-
JSON string representation of the definition to be patched.
Consider that the value has to be a JSON string.
Examples:
* a string: `"value"` - Currently the definition should follow the pattern: [_a-zA-Z0-9\-]:[_a-zA-Z0-9\-]:[_a-zA-Z0-9\-]
* an empty string: `""`
* `null`: the definition will be deleted
delete:
summary: Delete the definition of a specific thing
description: Deletes the definition of the thing identified by the `thingId`.
tags:
- Things
parameters:
- $ref: '#/components/parameters/ThingIdPathParam'
- $ref: '#/components/parameters/IfMatchHeaderParamHash'
- $ref: '#/components/parameters/IfNoneMatchHeaderParam'
- $ref: '#/components/parameters/RequestedAcksParam'
- $ref: '#/components/parameters/TimeoutParam'