-
Notifications
You must be signed in to change notification settings - Fork 8
Expand file tree
/
Copy pathJSON_for_IO-Link.yaml
More file actions
6296 lines (6234 loc) · 200 KB
/
JSON_for_IO-Link.yaml
File metadata and controls
6296 lines (6234 loc) · 200 KB
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.1
info:
description: >-
This is a sample IO-Link Master server. You can find out more about IO-Link
at [http://www.io-link.com](http://www.io-link.com)
# Description
## Error messages
### General errors
* [101] HTTP Status 500: Internal server error
* [102] HTTP Status 500: Internal communication error
* [103] HTTP Status 404: Operation not supported
* [104] HTTP Status 400: Action locked by another client
- Remark: Fieldbus controller or another gateway protocol has claimed priority
* [105] HTTP Status 501: IODD feature not supported
* [106] HTTP Status 501: MQTT feature not supported
* [150] HTTP Status 403: Permission denied
- Remark: due to user management restrictions
### JSON Parsing errors
* [201] HTTP Status 400: JSON parsing failed
- Remark: Error while parsing the incoming JSON object
* [202] HTTP Status 400: JSON data value invalid
- Remark: Error while parsing a specific JSON value, e.g. malformed IP address
* [203] HTTP Status 400: JSON data type invalid
- Remark: e.g. string instead of number
* [204] HTTP Status 400: Enumeration value unknown
* [205] HTTP Status 400: JSON data value out of range
- Remark: Exceeds the minimum or maximum value
* [206] HTTP Status 400: JSON data value out of bounds
- Remark: An array/string was accessed exceeding its maximum length
* [207] HTTP Status 400: deviceAlias is not unique
* [208] HTTP Status 400: POST request without content
### Resource access errors
* [301] HTTP Status 404: Resource not found
- Remark: e.g. wrong URL
* [302] HTTP Status 404: masterNumber not found
* [303] HTTP Status 404: portNumber not found
* [304] HTTP Status 404: deviceAlias not found
* [305] HTTP Status 400: Query parameter name invalid
* [306] HTTP Status 400: Query parameter value invalid
* [307] HTTP Status 400: Port is not configured to IO-Link
- Remark: e.g. not in IOLINK_MANUAL or IOLINK_AUTOSTART mode
* [308] HTTP Status 404: IO-Link Device is not accessible
- Remark: e.g. not connected or communication error
* [309] HTTP Status 404: IO-Link parameter not found
* [310] HTTP Status 404: IO-Link parameter access not supported by the Device
* [311] HTTP Status 400: IO-Link parameter access error
- Remark: The additional iolinkErrorCode and iolinkErrorMessage fields contain
the IO-Link error code and the incident text from the ErrorTypes table
* [312] HTTP Status 404: IO-Link parameter name is not unique
- Remark: Please use the {name}_{index} format
### Data Storage errors
* [401] HTTP Status 400: Data storage mismatch
- Remark: Mismatch between meta data of device and data storage
### Process Data handling
* [501] HTTP Status 400: I/Q is not configured as DIGITAL_OUTPUT
* [502] HTTP Status 400: C/Q is not configured as DIGITAL_OUTPUT
* [503] HTTP Status 400: IO-Link device has no output process data
### IODD errors
* [601] HTTP Status 400: IODD (representation) is not available
- Remark: IODD representation for this IO-Link Device is not available
* [602] HTTP Status 500: IODD upload failed: not enough memory
* [603] HTTP Status 400: IODD upload failed: IODD XML invalid
- Remark: Check the file content superficially to ensure that the
IODD is an XML and an IODD (e.g. vendorId, deviceId, VendorName, ProductName
and other mandatory elements or attributes)
* [604] HTTP Status 400: IODD upload failed: CRC error
* [605] HTTP Status 400: IODD upload failed: parsing error
- Remark: All those systems that do not want to store the IODD have to parse
it immediately
### Data content errors
* [701] HTTP Status 400: Data set incomplete
* [702] HTTP Status 400: Data set not applicable
- Remark: whole data set is rejected
* [703] HTTP Status 400: Data set combination incompatible
- Remark: whole data set is rejected
### Implementation hints:
* If there is more than one error in the request, the parsing is stopped and
just the first detected error is returned.
* Errors [101], [150] can be returned to every request.
* Error [103] can be returned to every request which is not included
in the base facet.
* Specific error messages have to be provided only if the corresponding
operation is supported. So you do not need to give specific errors for bad
IODDs if you do not support the IODD Facet, just indicate error [105].
* Error [301] can be returned to every request where there is a
variable in the URL.
* If the request was successful and no body is specified, the response
contains nothing in the body.
version: 1.0.0
title: Swagger IO-Link Master
contact:
email: lorand.molnar@teconcept.de
license:
name: Apache 2.0
url: 'http://www.apache.org/licenses/LICENSE-2.0.html'
servers:
- url: '{scheme}://{host}/{basePath}'
variables:
basePath:
default: iolink/v1
host:
default: 'iolmaster.io-link.com'
scheme:
description: 'The IO-Link gateway can expose the API over https and/or http'
enum:
- 'https'
- 'http'
default: 'http'
tags:
- name: gateway
description: Access to parameters of the JSON gateway
- name: mqtt
description: Access to the parameters of the MQTT client
- name: iodds
description: Access to the IODDs
- name: masters
description: Access to parameters of the IO-Link master itself
- name: ports
description: Access to the IO-Link ports of the IO-Link master
- name: devices
description: Access to the IO-Link Devices connected to the Master
paths:
'/gateway/identification':
get:
description: Read the identification data of the Gateway
operationId: getGateywayIdentification
tags:
- gateway
summary: Read the identification of the Gateway.
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/gatewayIdentificationGet'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/errorObject'
examples:
"150":
value:
code: 150
message: Permission denied
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/errorObject'
examples:
"101":
value:
code: 101
message: Internal server error
'/gateway/capabilities':
get:
description: Read the capatibities of the Gateway
operationId: getGateywayCapabilities
tags:
- gateway
summary: Read the capabilities of the Gateway.
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/gatewayCapabilitiesGet'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/errorObject'
examples:
"150":
value:
code: 150
message: Permission denied
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/errorObject'
examples:
"101":
value:
code: 101
message: Internal server error
'/gateway/configuration':
get:
tags:
- gateway
summary: Read the network configuration of the Gateway.
description: Read the actual active configuration of the IO-Link Gateway. The Gateway may support multiple IPv4 interfaces
operationId: getGatewayConfiguration
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/gatewayConfigurationGetPost'
examples:
Manual:
value:
ethIpv4:
- ipConfiguration: MANUAL
ipAddress: 192.168.1.13
subnetMask: 255.255.255.0
standardGateway: 192.168.1.1
DHCP:
value:
ethIpv4:
- ipConfiguration: DHCP
Multiple ethernet interfaces:
value:
ethIpv4:
- ipConfiguration: MANUAL
ipAddress: 192.168.1.13
subnetMask: 255.255.255.0
standardGateway: 192.168.1.1
- ipConfiguration: MANUAL
ipAddress: 192.168.2.10
subnetMask: 255.255.255.0
standardGateway: 192.168.2.1
- ipConfiguration: DHCP
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/errorObject'
examples:
"150":
value:
code: 150
message: Permission denied
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/errorObject'
examples:
"101":
value:
code: 101
message: Internal server error
post:
description: Write a new network configuration of the Gateway
operationId: postGatewayConfiguration
tags:
- gateway
summary: Write the network configuration of the Gateway.
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/gatewayConfigurationGetPost'
examples:
Manual:
value:
ethIpv4:
- ipConfiguration: MANUAL
ipAddress: 192.168.1.13
subnetMask: 255.255.255.0
standardGateway: 192.168.1.1
DHCP:
value:
ethIpv4:
- ipConfiguration: DHCP
Multiple ethernet interfaces:
value:
ethIpv4:
- ipConfiguration: MANUAL
ipAddress: 192.168.1.13
subnetMask: 255.255.255.0
standardGateway: 192.168.1.1
- ipConfiguration: MANUAL
ipAddress: 192.168.2.10
subnetMask: 255.255.255.0
standardGateway: 192.168.2.1
- ipConfiguration: DHCP
responses:
'204':
description: Successful operation
'400':
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/errorObject'
examples:
"104":
value:
code: 104
message: Action locked by another client
"201":
value:
code: 201
message: JSON parsing failed
"202":
value:
code: 202
message: JSON data value invalid
"203":
value:
code: 203
message: JSON data type invalid
"204":
value:
code: 204
message: Enumeration value unknown
"205":
value:
code: 205
message: JSON data value out of range
"206":
value:
code: 206
message: JSON data value out of bounds
"208":
value:
code: 208
message: POST request without content
"701":
value:
code: 701
message: Data set incomplete
"702":
value:
code: 702
message: Data set not applicable
"703":
value:
code: 703
message: Data set combination incompatible
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/errorObject'
examples:
"150":
value:
code: 150
message: Permission denied
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/errorObject'
examples:
"101":
value:
code: 101
message: Internal server error
'/gateway/reset':
post:
tags:
- gateway
summary: Reset the Gateway including all Masters. Optional.
description: Invoke a reset of the IO-Link Gateway. This may reset all configuration data and interrupt all communications channels. It is recommended to log this within the EventLog
operationId: postGatewayReset
responses:
'204':
description: Successful operation
'400':
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/errorObject'
examples:
"104":
value:
code: 104
message: Action locked by another client
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/errorObject'
examples:
"150":
value:
code: 150
message: Permission denied
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/errorObject'
examples:
"101":
value:
code: 101
message: Internal server error
'/gateway/reboot':
post:
tags:
- gateway
summary: Reboot the Gateway including all Masters. Optional.
description: Invoke a reboot of the IO-Link Gateway. This may reset all configuration data and interrupt all communications channels. It is recommended to log this within the EventLog
operationId: postGatewayReboot
responses:
'204':
description: Successful operation
'400':
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/errorObject'
examples:
"104":
value:
code: 104
message: Action locked by another client
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/errorObject'
examples:
"150":
value:
code: 150
message: Permission denied
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/errorObject'
examples:
"101":
value:
code: 101
message: Internal server error
'/gateway/events':
get:
tags:
- gateway
summary: Read the EventLog containing all events from Gateway, Masters, Ports and Devices.
description: >
Each Gateway shall have an Event Log object containing the events of the devices, ports and
the masters. The content of the Event Log can be read by getting the object “Gateway Event Log”
operationId: getGatewayEvents
parameters:
- $ref: '#/components/parameters/eventOrigin'
- $ref: '#/components/parameters/eventMasterNumber'
- $ref: '#/components/parameters/eventPortNumber'
- $ref: '#/components/parameters/eventdeviceAlias'
- $ref: '#/components/parameters/eventTop'
- $ref: '#/components/parameters/eventBottom'
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/gatewayEventsGet'
examples:
origin=ALL:
value:
- time: '2018-05-18T07:31:54.123Z'
severity: WARNING
origin:
masterNumber: 1
message:
text: IO-Link Master has restarted
- time: '2018-05-18T07:32:42.023Z'
severity: ERROR
origin:
masterNumber: 1
portNumber: 1
message:
code: 6163
mode: APPEARS
text: Overcurrent at C/Q (if digital output) - check load
- time: '2018-05-18T07:31:54.123Z'
severity: WARNING
origin:
masterNumber: 1
portNumber: 1
deviceAlias: Temp_sensor_1
message:
code: 16912
mode: APPEARS
text: Device temperature over-run – Clear source of heat
origin=MASTERS:
value:
- time: '2018-05-18T07:31:54.123Z'
severity: WARNING
origin:
masterNumber: 1
message:
text: IO-Link Master has restarted
origin=PORTS:
value:
- time: '2018-05-18T07:32:42.023Z'
severity: ERROR
origin:
masterNumber: 1
port: 1
message:
code: 6163
mode: APPEARS
text: Overcurrent at C/Q (if digital output) - check load
- time: '2018-05-18T07:33:42.023Z'
severity: ERROR
origin:
masterNumber: 1
portNumber: 1
message:
code: 6163
mode: DISAPPEARS
text: Overcurrent at C/Q (if digital output) - check load
- time: '2018-05-18T07:35:54.123Z'
severity: NOTICE
origin:
masterNumber: 1
portNumber: 2
message:
code: 65313
mode: SINGLESHOT
text: New slave
origin=DEVICES:
value:
- time: '2018-05-18T07:31:54.123Z'
severity: WARNING
origin:
masterNumber: 1
portNumber: 1
deviceAlias: Temp_sensor_1
message:
code: 16912
mode: APPEARS
text: Device temperature over-run – Clear source of heat
- time: '2018-05-18T08:31:54.123Z'
severity: ERROR
origin:
masterNumber: 1
portNumber: 3
deviceAlias: Distance_Laser_3
message:
code: 20480
mode: APPEARS
text: Device hardware fault – Device exchange
'400':
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/errorObject'
examples:
"305":
value:
code: 305
message: Query parameter name invalid
"306":
value:
code: 306
message: Query parameter value invalid
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/errorObject'
examples:
"150":
value:
code: 150
message: Permission denied
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/errorObject'
examples:
"101":
value:
code: 101
message: Internal server error
'/mqtt/configuration':
get:
tags:
- mqtt
summary: >-
Read the MQTT configuration of the Gateway.
description: Read the MQTT configuraiton of the Gateway
operationId: getMqttConfiguration
responses:
'200':
description: Successful operation
content:
application/json:
schema:
$ref: '#/components/schemas/mqttConfigurationGetPost'
examples:
Active client:
value:
clientMode: "ACTIVE"
serverAddress: 192.168.2.1/mqttbroker
username: iolink_json
password: '1234'
lastwill:
- topic: process_data
message: Process data transfer stopped.
qos: 0_ONLY_ONCE
retain: true
keepAliveTime: 10
Inactive client:
value:
clientMode: "INACTIVE"
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/errorObject'
examples:
"150":
value:
code: 150
message: Permission denied
'404':
description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/errorObject'
examples:
"103":
value:
code: 103
message: Operation not supported
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/errorObject'
examples:
"101":
value:
code: 101
message: Internal server error
'501':
description: Not Implemented
content:
application/json:
schema:
$ref: '#/components/schemas/errorObject'
examples:
"106":
value:
code: 106
message: MQTT feature not supported
post:
tags:
- mqtt
summary: >-
Update the MQTT configuration of the Gateway.
description: Update the MQTT configuration of the Gateway.
operationId: postMqttConfiguration
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/mqttConfigurationGetPost'
examples:
Active Client:
value:
clientMode: ACTIVE
serverAddress: 192.168.2.1/mqttbroker
username: iolink_json
password: '1234'
lastwill:
- topic: process_data
message: Process data transfer stopped.
qos: 0_ONLY_ONCE
retain: true
keepAliveTime: 10
Inactive Client:
value:
clientMode: INACTIVE
responses:
'204':
description: Successful operation
'400':
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/errorObject'
examples:
"104":
value:
code: 104
message: Action locked by another client
"201":
value:
code: 201
message: JSON parsing failed
"202":
value:
code: 202
message: JSON data value invalid
"203":
value:
code: 203
message: JSON data type invalid
"204":
value:
code: 204
message: Enumeration value unknown
"205":
value:
code: 205
message: JSON data value out of range
"206":
value:
code: 206
message: JSON data value out of bounds
"208":
value:
code: 208
message: POST request without content
"701":
value:
code: 701
message: Data set incomplete
"702":
value:
code: 702
message: Data set not applicable
"703":
value:
code: 703
message: Data set combination incompatible
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/errorObject'
examples:
"150":
value:
code: 150
message: Permission denied
'404':
description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/errorObject'
examples:
"103":
value:
code: 103
message: Operation not supported
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/errorObject'
examples:
"101":
value:
code: 101
message: Internal server error
'501':
description: Not Implemented
content:
application/json:
schema:
$ref: '#/components/schemas/errorObject'
examples:
"106":
value:
code: 106
message: MQTT feature not supported
'/mqtt/topics':
get:
tags:
- mqtt
summary: Get the list of MQTT topics.
description: Get the list of MQTT topics.
operationId: GetMqttTopics
responses:
'200':
description: Successful operation
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/mqttConfigurationTopicGet'
example:
- topicId: 1
topicName: Sensor34/processData
qos: 1_AT_LEAST_ONCE
deviceAlias: DT35
processData:
direction: getData
format: iodd
interval:
value: 10
unit: ms
- topicId: 2
topicName: Sensor34/event
qos: 1_AT_LEAST_ONCE
deviceAlias: TAD081
event: {}
- topicId: 3
topicName: PD
qos: 0_ONLY_ONCE
deviceAlias: BNI_IOL
processData:
direction: getSetData
format: iodd
onChange: true
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/errorObject'
examples:
"150":
value:
code: 150
message: Permission denied
'404':
description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/errorObject'
examples:
"103":
value:
code: 103
message: Operation not supported
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/errorObject'
examples:
"101":
value:
code: 101
message: Internal server error
'501':
description: Not Implemented
content:
application/json:
schema:
$ref: '#/components/schemas/errorObject'
examples:
"106":
value:
code: 106
message: MQTT feature not supported
post:
tags:
- mqtt
summary: Create a new MQTT topic.
description: Create a new MQTT topic.
operationId: postMqttTopics
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/mqttConfigurationTopicPost'
examples:
Process Data:
value:
qos: 1_AT_LEAST_ONCE
deviceAlias: DT35
processData:
direction: getData
format: iodd
interval:
value: 10
unit: ms
Event:
value:
qos: 1_AT_LEAST_ONCE
deviceAlias: TAD081
event: {}
responses:
'200':
description: Successful operation returning the topic ID
content:
application/json:
schema:
type: integer
'400':
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/errorObject'
examples:
"104":
value:
code: 104
message: Action locked by another client
"201":
value:
code: 201
message: JSON parsing failed
"202":
value:
code: 202
message: JSON data value invalid