/
ditto-api-1.yml
2914 lines (2746 loc) · 122 KB
/
ditto-api-1.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
# Copyright (c) 2017 Contributors to the Eclipse Foundation
#
# See the NOTICE file(s) distributed with this work for additional
# information regarding copyright ownership.
#
# This program and the accompanying materials are made available under the
# terms of the Eclipse Public License 2.0 which is available at
# http://www.eclipse.org/legal/epl-2.0
#
# SPDX-License-Identifier: EPL-2.0
openapi: 3.0.0
info:
title: Eclipse Ditto HTTP API
description: JSON-based, REST-like API for Eclipse Ditto
version: "1"
servers:
- url: https://ditto.eclipse.org/api/1
description: "online Ditto Sandbox"
- url: /api/1
description: "local Ditto"
tags:
- name: Things
description: Manage every Thing
- name: Features
description: Structure the Features of your Things
- name: Things-Search
description: Find every Thing
- name: Messages
description: Talk with your Things
security:
# - Google:
# - openid
- basicAuth: []
- bearerAuth: []
paths:
/things:
get:
summary: List all available Things
description: |-
Returns all Things passed in by the required parameter `ids`.
Optionally you can use field selectors (see parameter `fields`) to only get the specified fields.
To retrieve all Things the logged in user is allowed to read, please use the `GET /search/things` operation.
tags:
- Things
parameters:
- name: ids
in: query
description: Contains a comma separated list of `thingId`s to retrieve in one single request.
required: true
schema:
type: string
- $ref: '#/components/parameters/thingFieldsQueryParam'
responses:
'200':
description: The successfully completed request contains as its result the first 200 for the user available Things, sorted by their `thingId`.
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Thing'
'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 the Thing defined in the optional JSON body.
The ID of the created Thing is a UUID generated by the service with the default namespace `org.eclipse.ditto`.
Any `thingId`
specified in the request body is therefore ignored. The ACL of the created Thing must include at least one
entry with `READ`, `WRITE` and `ADMINISTRATE` permissions set to `true`.
If no ACL is provided, a default ACL with an entry for the authorized subject with all permissions set to
`true` will be created.
tags:
- Things
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. The JSON of the Thing to be created was invalid or the `thingId` was
wrongly set in the request body.
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'
'412':
$ref: '#/components/responses/preconditionFailed'
'413':
$ref: '#/components/responses/entityTooLarge'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/NewThing'
example: {}
description: |-
JSON representation of the Thing to be created.
Use the placeholder `{{ request:subjectId }}` in order to let the backend insert the authenticated subjectId of the HTTP request.
/things/{thingId}:
get:
summary: Retrieve a specific Thing
description: |-
Returns the Thing identified by the `thingId` path parameter.
The response includes all details about the Thing.
Optionally you can use field selectors (see parameter `fields`) to only get the specified fields.
tags:
- Things
parameters:
- $ref: '#/components/parameters/thingIdPathParam'
- $ref: '#/components/parameters/thingFieldsQueryParam'
- $ref: '#/components/parameters/ifMatchHeaderParam'
- $ref: '#/components/parameters/ifNoneMatchHeaderParam'
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
content:
application/json:
schema:
$ref: '#/components/schemas/Thing'
'304':
$ref: '#/components/responses/notModified'
'400':
description: |-
The request could not be completed. Either the `thingId` does not conform to the namespaced entity ID notation
(see [Ditto documentation on namespaced entity IDs](https://www.eclipse.org/ditto/basic-namespaces-and-names.html#namespaced-id))
or 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'
'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. The `thingId` has to
conform to the [namespaced entity ID notation](https://www.eclipse.org/ditto/basic-namespaces-and-names.html#namespaced-id).
#### Valid examples
* `org.eclipse.ditto.myproject:myFridge1`
* `mynamespace:myFridge1`
#### Invalid examples
* `42:myFridge1`
* `.foo:myFridge1`
* `bar.:myFridge1`
The ID of a Thing can't be changed after creation. Any `thingId` specified in the request body is therefore ignored.
### Creation of a new Thing
The ACL of the created Thing must include at least one entry with `READ`, `WRITE` and `ADMINISTRATE` permissions set to `true`.
If no ACL is provided, a default ACL with an entry for the authorized subject with all permissions set to `true` will be created.
Use the placeholder `{{ request:subjectId }}` in order to let the backend insert the authenticated subjectId of the HTTP request.
### Permissions for updating an existing Thing
For updating an existing Thing the authorized subject has to have the `WRITE` permission.
If the new Thing to update contains an `acl` entry, the authorized subject additionally has to have the `ADMINISTRATE` permission.
For authorized subjects which don't have the `ADMINISTRATE` permission, the complete Thing may be updated if the `acl` entry is not set.
### Partially updating an existing Thing
When updating an existing Thing already containing `attributes`, `acl` or `features` the already existing fields
must not explicitly be provided again. For this "PUT Thing" request (and only for this top-level update on the
Thing) the top-level field to update is merged with the existing top-level fields of the Thing.
For example: A Thing already exists with this content:
```
{
"thingId": "namespace:thing-name",
"acl": {...},
"attributes": {
"foo": 1
},
"features": {...}
}
```
The Thing's `attributes` may be modified without having to pass the `acl` or the `features` in again. The content
of the request's body would be sufficient for updating the `attributes`:
```
{
"attributes": {
"foo": 2,
"bar": false
}
}
```
The `acl` and `features` of the Thing will not be overwritten, the Thing will be merged as one would expect it:
```
{
"thingId": "namespace:thing-name",
"acl": {...},
"attributes": {
"foo": 2,
"bar": false
},
"features": {...}
}
```
tags:
- Things
parameters:
- $ref: '#/components/parameters/thingIdPathParam'
- $ref: '#/components/parameters/ifMatchHeaderParam'
- $ref: '#/components/parameters/ifNoneMatchHeaderParam'
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. Either the `thingId` does not conform to the namespaced entity ID notation
(see [Ditto documentation on namespaced entity IDs](https://www.eclipse.org/ditto/basic-namespaces-and-names.html#namespaced-id))
or the JSON of the Thing to be created/modified was either invalid or did contain a `thingId` which did not match the ID in the URL.
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 as the caller had insufficient permissions.
For modifying an existing Thing `WRITE` permission is required.
If the `acl` of the Thing should be updated as well, the permission `ADMINISTRATE` is additionally required.
The complete Thing without `acl` can however be updated with `WRITE` permission if the body does not contain an `acl` entry.
content:
application/json:
schema:
$ref: '#/components/schemas/AdvancedError'
'412':
$ref: '#/components/responses/preconditionFailed'
'413':
$ref: '#/components/responses/entityTooLarge'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/NewThing'
example: {}
description: |-
JSON representation of the Thing to be modified.
Use the placeholder `{{ request:subjectId }}` in order to let the backend insert the authenticated subjectId of the HTTP request.
delete:
summary: Delete a specific Thing
description: |-
Deletes the Thing identified by the `thingId` path parameter.
tags:
- Things
parameters:
- $ref: '#/components/parameters/thingIdPathParam'
- $ref: '#/components/parameters/ifMatchHeaderParam'
- $ref: '#/components/parameters/ifNoneMatchHeaderParam'
responses:
'204':
description: The Thing was successfully deleted.
'400':
description: |-
The request could not be completed. The `thingId` does not conform to the namespaced entity ID notation
(see [Ditto documentation on namespaced entity IDs](https://www.eclipse.org/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 as the caller had insufficient permissions.
For deleting an existing Thing `WRITE` and `ADMINISTRATE` permissions are 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'
/things/{thingId}/acl:
get:
summary: Retrieve the complete ACL of a Thing
description: |-
Returns the Access Control List (ACL) of the Thing identified by the `thingId` path parameter.
The response contains the ACL as JSON object containing a key for each subject having ACL permissions.
tags:
- Things
parameters:
- $ref: '#/components/parameters/thingIdPathParam'
- $ref: '#/components/parameters/ifMatchHeaderParam'
- $ref: '#/components/parameters/ifNoneMatchHeaderParam'
responses:
'200':
description: The request successfully returned completed and returned is the Access Control List.
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
content:
application/json:
schema:
$ref: '#/components/schemas/Acl'
example:
{
"authorizationSubject1": {
"READ": true,
"WRITE": true,
"ADMINISTRATE": true
},
"authorizationSubjectN": {
"READ": true,
"WRITE": true,
"ADMINISTRATE": true
}
}
'304':
$ref: '#/components/responses/notModified'
'400':
description: |-
The request could not be completed. The `thingId` does not conform to the namespaced entity ID notation
(see [Ditto documentation on namespaced entity IDs](https://www.eclipse.org/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'
'404':
description: The request could not be completed. The Thing with the given ID was not found in the context of the authenticated user.
content:
application/json:
schema:
$ref: '#/components/schemas/AdvancedError'
'412':
$ref: '#/components/responses/preconditionFailed'
put:
summary: Modify the complete ACL of a Thing
description: |-
Modify the complete Access Control List (ACL) of the Thing identified by the `thingId` path parameter.
The ACL must include at least one entry with `READ`, `WRITE` and `ADMINISTRATE` permissions set to `true`.
tags:
- Things
parameters:
- $ref: '#/components/parameters/thingIdPathParam'
- $ref: '#/components/parameters/ifMatchHeaderParam'
- $ref: '#/components/parameters/ifNoneMatchHeaderParam'
responses:
'204':
description: The Access Control List 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. Either the `thingId` does not conform to the namespaced entity ID notation
(see [Ditto documentation on namespaced entity IDs](https://www.eclipse.org/ditto/basic-namespaces-and-names.html#namespaced-id))
or the JSON was invalid, or no valid ACL 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 as the caller had insufficient permissions.
For modifying the ACL of an existing Thing `ADMINISTRATE` 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 in the context of the authenticated user.
content:
application/json:
schema:
$ref: '#/components/schemas/AdvancedError'
'412':
$ref: '#/components/responses/preconditionFailed'
'413':
$ref: '#/components/responses/entityTooLarge'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Acl'
example:
{
"{{ request:subjectId }}":{
"READ": true,
"WRITE": true,
"ADMINISTRATE": true
}
}
description: |-
JSON representation of the Access Control List (ACL).
Use the placeholder `{{ request:subjectId }}` in order to let the backend insert the authenticated subjectId of the HTTP request.
required: true
/things/{thingId}/acl/{authorizationSubject}:
get:
summary: Retrieve one ACL entry of a Thing for a specific subject
description: |-
Returns one Access Control List (ACL) entry of the Thing identified by the `thingId` path parameter and for the subject
identified by the `authorizationSubject` path parameter.
tags:
- Things
parameters:
- $ref: '#/components/parameters/thingIdPathParam'
- $ref: '#/components/parameters/authorizationSubjectPathParam'
- $ref: '#/components/parameters/ifMatchHeaderParam'
- $ref: '#/components/parameters/ifNoneMatchHeaderParam'
responses:
'200':
description: The request successfully returned completed and returned is the ACL entry.
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
content:
application/json:
schema:
$ref: '#/components/schemas/AclEntry'
'304':
$ref: '#/components/responses/notModified'
'400':
description: |-
The request could not be completed. The `thingId` does not conform to the namespaced entity ID notation
(see [Ditto documentation on namespaced entity IDs](https://www.eclipse.org/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'
'404':
description: The request could not be completed. The Thing with the given ID or the ACL entry was not found in the context of the authenticated user.
content:
application/json:
schema:
$ref: '#/components/schemas/AdvancedError'
'412':
$ref: '#/components/responses/preconditionFailed'
put:
summary: Create or modify one ACL entry of a Thing for a specific subject
description: |-
Create or modify the Access Control List (ACL) entry of the Thing identified by the `thingId` path parameter and for the subject
identified by the `authorizationSubject` path parameter.
An ACL entry must contain values for `READ`, `WRITE` and `ADMINISTRATE` permissions, all other permissions will be ignored.
The ACL must contain at least one entry with all permissions set to `true`.
tags:
- Things
parameters:
- $ref: '#/components/parameters/thingIdPathParam'
- $ref: '#/components/parameters/authorizationSubjectPathParam'
- $ref: '#/components/parameters/ifMatchHeaderParam'
- $ref: '#/components/parameters/ifNoneMatchHeaderParam'
responses:
'201':
description: The ACL entry 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 ACL entry
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/AclEntry'
'204':
description: The ACL entry 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. Either the `thingId` does not conform to the namespaced entity ID notation
(see [Ditto documentation on namespaced entity IDs](https://www.eclipse.org/ditto/basic-namespaces-and-names.html#namespaced-id))
or the JSON was invalid, or no valid ACL 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 as the caller had insufficient permissions.
For modifying an ACL entry of an existing Thing `ADMINISTRATE` 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 in the context of the authenticated user.
content:
application/json:
schema:
$ref: '#/components/schemas/AdvancedError'
'412':
$ref: '#/components/responses/preconditionFailed'
'413':
$ref: '#/components/responses/entityTooLarge'
requestBody:
$ref: '#/components/requestBodies/AclEntry'
delete:
summary: Delete one ACL entry of a Thing for a specific subject
description: |-
Deletes the the Access Control List (ACL) entry of the Thing identified by the `thingId` path parameter and for the subject
identified by the `authorizationSubject` path parameter.
The ACL must contain at least one entry with all permissions set to `true`.
tags:
- Things
parameters:
- $ref: '#/components/parameters/thingIdPathParam'
- $ref: '#/components/parameters/authorizationSubjectPathParam'
- $ref: '#/components/parameters/ifMatchHeaderParam'
- $ref: '#/components/parameters/ifNoneMatchHeaderParam'
responses:
'204':
description: The ACL entry was successfully deleted.
'400':
description: |-
The request could not be completed. The `thingId` does not conform to the namespaced entity ID notation
(see [Ditto documentation on namespaced entity IDs](https://www.eclipse.org/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 as the caller had insufficient permissions.
For deleting an ACL entry of an existing Thing `ADMINISTRATE` 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 in the context of the authenticated user.
content:
application/json:
schema:
$ref: '#/components/schemas/AdvancedError'
'412':
$ref: '#/components/responses/preconditionFailed'
'/things/{thingId}/attributes':
get:
summary: List all Attributes of a specific Thing
description: |-
Returns all Attributes of the Thing identified by the `thingId` path parameter.
tags:
- Things
parameters:
- $ref: '#/components/parameters/thingIdPathParam'
- $ref: '#/components/parameters/attributesFieldsQueryParam'
- $ref: '#/components/parameters/ifMatchHeaderParam'
- $ref: '#/components/parameters/ifNoneMatchHeaderParam'
responses:
'200':
description: The Attributes of the specific Thing were successfully retrieved.
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
content:
application/json:
schema:
$ref: '#/components/schemas/Attributes'
'304':
$ref: '#/components/responses/notModified'
'400':
description: |-
The request could not be completed. The `thingId` does not conform to the namespaced entity ID notation
(see [Ditto documentation on namespaced entity IDs](https://www.eclipse.org/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'
'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 all Attributes of a specific Thing at once
description: |-
Create or update the Attributes of a Thing identified by the `thingId` path parameter at once.
The Attributes will be replaced by the request body's JSON.
tags:
- Things
parameters:
- $ref: '#/components/parameters/thingIdPathParam'
- $ref: '#/components/parameters/ifMatchHeaderParam'
- $ref: '#/components/parameters/ifNoneMatchHeaderParam'
responses:
'201':
description: The Attributes were 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 Attribute resource
schema:
type: string
content:
application/json:
schema:
$ref: '#/components/schemas/Attributes'
'204':
description: The Attributes were 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. Either the `thingId` does not conform to the namespaced entity ID notation
(see [Ditto documentation on namespaced entity IDs](https://www.eclipse.org/ditto/basic-namespaces-and-names.html#namespaced-id))
or the JSON was invalid or 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 as the caller had insufficient permissions.
For modifying the Attributes 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'
requestBody:
$ref: '#/components/requestBodies/Attributes'
delete:
summary: Delete all Attributes of a specific Thing at once
description: |-
Deletes all Attributes of the Thing identified by the `thingId` path parameter at once.
tags:
- Things
parameters:
- $ref: '#/components/parameters/thingIdPathParam'
- $ref: '#/components/parameters/ifMatchHeaderParam'
- $ref: '#/components/parameters/ifNoneMatchHeaderParam'
responses:
'204':
description: The Attributes were successfully deleted.
'400':
description: |-
The request could not be completed. The `thingId` does not conform to the namespaced entity ID notation
(see [Ditto documentation on namespaced entity IDs](https://www.eclipse.org/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 as the caller had insufficient permissions.
For deleting all Attributes 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 or its Attributes were not found.
content:
application/json:
schema:
$ref: '#/components/schemas/AdvancedError'
'412':
$ref: '#/components/responses/preconditionFailed'
'/things/{thingId}/attributes/{attributePath}':
get:
ummary: Retrieve a specific Attribute of a specific Thing
description: |-
Returns a specific Attribute of the Thing identified by the `thingId` path parameter. The Attribute (JSON) can be referenced hierarchically by applying JSON Pointer notation (RFC-6901), e.g.:
`/things/{thingId}/attributes/address/city` in order to retrieve the `city` field of an `address` object.
tags:
- Things
parameters:
- $ref: '#/components/parameters/thingIdPathParam'
- $ref: '#/components/parameters/attributePathPathParam'
- $ref: '#/components/parameters/ifMatchHeaderParam'
- $ref: '#/components/parameters/ifNoneMatchHeaderParam'
responses:
'200':
description: The Attribute was successfully retrieved.
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
'304':
$ref: '#/components/responses/notModified'
'400':
description: |-
The request could not be completed. The `thingId` does not conform to the namespaced entity ID notation
(see [Ditto documentation on namespaced entity IDs](https://www.eclipse.org/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'
'404':
description: The request could not be completed. The Thing with the given ID or the Attribute at the specified path was not found.
content:
application/json:
schema:
$ref: '#/components/schemas/AdvancedError'
'412':
$ref: '#/components/responses/preconditionFailed'
put:
summary: Create or update a specific Attribute of a specific Thing
description: |-
Create or update a specific Attribute of the Thing identified by the `thingId` path parameter.
The Attribute will be created if it doesn't exist or else updated. The Attribute (JSON) can be referenced hierarchically by applying JSON Pointer notation (RFC-6901), e.g.:
`/things/{thingId}/attributes/address/city` in order to create/update the `city` field of an `address` object.
tags:
- Things
parameters:
- $ref: '#/components/parameters/thingIdPathParam'
- $ref: '#/components/parameters/attributePathPathParam'
- $ref: '#/components/parameters/ifMatchHeaderParam'
- $ref: '#/components/parameters/ifNoneMatchHeaderParam'
responses:
'201':
description: The Attribute 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 Attribute resource
schema:
type: string
'204':
description: The Attribute 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. The `thingId` does not conform to the namespaced entity ID notation
(see [Ditto documentation on namespaced entity IDs](https://www.eclipse.org/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 as the caller had insufficient permissions. For modifying a single Attribute 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'
requestBody:
$ref: '#/components/requestBodies/Value'
delete:
summary: Delete a specific Attribute of a specific Thing
description: |-
Deletes a specific Attribute of the Thing identified by the `thingId` path parameter. The Attribute (JSON) can be referenced hierarchically by applying JSON Pointer notation (RFC-6901), e.g.:
`/things/{thingId}/attributes/address/city` in order to delete the `city` field of an `address` object.
tags:
- Things
parameters:
- $ref: '#/components/parameters/thingIdPathParam'
- $ref: '#/components/parameters/attributePathPathParam'
- $ref: '#/components/parameters/ifMatchHeaderParam'
- $ref: '#/components/parameters/ifNoneMatchHeaderParam'
responses:
'204':
description: The Attribute was successfully deleted.
'400':