-
Notifications
You must be signed in to change notification settings - Fork 0
/
TMF621-Trouble_Ticket-v5.0.0.oas.yaml
6695 lines (6692 loc) · 264 KB
/
TMF621-Trouble_Ticket-v5.0.0.oas.yaml
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:
title: Trouble Ticket
description: "**TMF API Reference : TMF - 621 Trouble Ticket**\nThe Trouble Ticket API provides a standardized client interface to Trouble Ticket Management Systems for creating, tracking and managing trouble tickets as a result of an issue or problem identified by a customer or another system. \nExamples of Trouble Ticket API originators (clients) include CRM applications, network management or fault management systems, or other Trouble Ticket management systems (e.g. B2B).\nThe API supports the ability to send requests to create a new trouble ticket specifying the nature and severity of the trouble or issue as well as all necessary related information. The API also includes mechanisms to search for and update existing trouble tickets. Notifications are defined to provide information when a trouble ticket has been updated, including status changes. A basic set of states of a trouble ticket has been specified (as an example) to handle trouble ticket lifecycle management.\nTrouble Ticketing API manages trouble ticket resource:\n -\tA trouble ticket represents a record, or an issue raised by requestor that need to be solved, used for reporting and managing the resolution of problems, incidents or request \n -\tMain trouble ticket attributes are its description, severity, type, related dates (creation, expected resolution, resolution), state and related information (change reason and change date), related parties (originator, owner, reviser, etc.), related entities (product, product order, customer bill) and notes \n Trouble Ticket API performs the following operations on trouble ticket: \n -\tRetrieval of a trouble ticket or a collection of trouble ticket depending on filter criteria \n -\tPartial update of a trouble ticket \n -\tCreation of a trouble ticket \n \tNotification of events on trouble ticket: \n \t-\tTrouble ticket state change \n \t-\tTrouble ticket attribute value change \n \t-\tTrouble ticket resoled \n \t-\tTrouble ticket delete (typically restricted to admin role) \n \t-\tTrouble ticket created \n \t-\tTrouble ticket Information required \n Trouble Ticket API performs the following operations on trouble ticket specification \n-\tRetrieval of a trouble ticket specification or a collection of trouble ticket specification depending on filter criteria \n -\tPartial update of a trouble ticket specification \n-\tCreation of a trouble ticket specification \n-\tNotification of events on trouble ticket specification: \n \t-\tTrouble ticket specification state change \n \t-\tTrouble ticket specification attribute value change \n \t-\tTrouble ticket specification delete (typically restricted to admin role) \n \t-\tTrouble ticket specification created "
version: 5.0.0
servers:
- url: 'https://serverRoot'
tags:
- name: troubleTicket
description: Operations for TroubleTicket Resource
- name: troubleTicketSpecification
description: Operations for TroubleTicketSpecification Resource
- name: notification listener
description: Notifications for Resource Lifecycle and event notifications
- name: events subscription
description: Endpoints to register and terminate an Event Listener
paths:
/troubleTicket:
get:
tags:
- troubleTicket
summary: List or find TroubleTicket objects
description: List or find TroubleTicket objects
operationId: listTroubleTicket
parameters:
- $ref: '#/components/parameters/Fields'
- $ref: '#/components/parameters/Offset'
- $ref: '#/components/parameters/Limit'
responses:
'200':
$ref: '#/components/responses/200TroubleTicketArray'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'503':
$ref: '#/components/responses/503'
post:
tags:
- troubleTicket
summary: Creates a TroubleTicket
description: This operation creates a TroubleTicket entity.
operationId: createTroubleTicket
parameters:
- $ref: '#/components/parameters/Fields'
requestBody:
$ref: '#/components/requestBodies/TroubleTicket_FVO'
responses:
'201':
$ref: '#/components/responses/201TroubleTicket'
'202':
description: Accepted
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'409':
$ref: '#/components/responses/409'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'503':
$ref: '#/components/responses/503'
'/troubleTicket/{id}':
get:
tags:
- troubleTicket
summary: Retrieves a TroubleTicket by ID
description: >-
This operation retrieves a TroubleTicket entity. Attribute selection enabled for all first
level attributes.
operationId: retrieveTroubleTicket
parameters:
- $ref: '#/components/parameters/Id'
- $ref: '#/components/parameters/Fields'
responses:
'200':
$ref: '#/components/responses/200TroubleTicket_Get'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'503':
$ref: '#/components/responses/503'
patch:
tags:
- troubleTicket
summary: Updates partially a TroubleTicket
description: This operation updates partially a TroubleTicket entity.
operationId: patchTroubleTicket
parameters:
- $ref: '#/components/parameters/Id'
- $ref: '#/components/parameters/Fields'
requestBody:
$ref: '#/components/requestBodies/TroubleTicket_MVO'
responses:
'200':
$ref: '#/components/responses/200TroubleTicket_Patch'
'202':
description: Accepted
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'409':
$ref: '#/components/responses/409'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'503':
$ref: '#/components/responses/503'
delete:
tags:
- troubleTicket
summary: Deletes a TroubleTicket
description: This operation deletes a TroubleTicket entity.
operationId: deleteTroubleTicket
parameters:
- $ref: '#/components/parameters/Id'
responses:
'202':
$ref: '#/components/responses/202'
'204':
$ref: '#/components/responses/204'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'409':
$ref: '#/components/responses/409'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'503':
$ref: '#/components/responses/503'
/listener/troubleTicketCreateEvent:
post:
tags:
- notification listener
summary: Client listener for entity TroubleTicketCreateEvent
description: Example of a client listener for receiving the notification TroubleTicketCreateEvent
operationId: troubleTicketCreateEvent
requestBody:
$ref: '#/components/requestBodies/TroubleTicketCreateEvent'
responses:
'204':
description: Notified
default:
$ref: '#/components/responses/Error'
/listener/troubleTicketAttributeValueChangeEvent:
post:
tags:
- notification listener
summary: Client listener for entity TroubleTicketAttributeValueChangeEvent
description: >-
Example of a client listener for receiving the notification
TroubleTicketAttributeValueChangeEvent
operationId: troubleTicketAttributeValueChangeEvent
requestBody:
$ref: '#/components/requestBodies/TroubleTicketAttributeValueChangeEvent'
responses:
'204':
description: Notified
default:
$ref: '#/components/responses/Error'
/listener/troubleTicketStatusChangeEvent:
post:
tags:
- notification listener
summary: Client listener for entity TroubleTicketStatusChangeEvent
description: Example of a client listener for receiving the notification TroubleTicketStatusChangeEvent
operationId: troubleTicketStatusChangeEvent
requestBody:
$ref: '#/components/requestBodies/TroubleTicketStatusChangeEvent'
responses:
'204':
description: Notified
default:
$ref: '#/components/responses/Error'
/listener/troubleTicketDeleteEvent:
post:
tags:
- notification listener
summary: Client listener for entity TroubleTicketDeleteEvent
description: Example of a client listener for receiving the notification TroubleTicketDeleteEvent
operationId: troubleTicketDeleteEvent
requestBody:
$ref: '#/components/requestBodies/TroubleTicketDeleteEvent'
responses:
'204':
description: Notified
default:
$ref: '#/components/responses/Error'
/listener/troubleTicketResolvedEvent:
post:
tags:
- notification listener
summary: Client listener for entity TroubleTicketResolvedEvent
description: Example of a client listener for receiving the notification TroubleTicketResolvedEvent
operationId: troubleTicketResolvedEvent
requestBody:
$ref: '#/components/requestBodies/TroubleTicketResolvedEvent'
responses:
'204':
description: Notified
default:
$ref: '#/components/responses/Error'
/listener/troubleTicketInformationRequiredEvent:
post:
tags:
- notification listener
summary: Client listener for entity TroubleTicketInformationRequiredEvent
description: >-
Example of a client listener for receiving the notification
TroubleTicketInformationRequiredEvent
operationId: troubleTicketInformationRequiredEvent
requestBody:
$ref: '#/components/requestBodies/TroubleTicketInformationRequiredEvent'
responses:
'204':
description: Notified
default:
$ref: '#/components/responses/Error'
/troubleTicketSpecification:
get:
tags:
- troubleTicketSpecification
summary: List or find TroubleTicketSpecification objects
description: List or find TroubleTicketSpecification objects
operationId: listTroubleTicketSpecification
parameters:
- $ref: '#/components/parameters/Fields'
- $ref: '#/components/parameters/Offset'
- $ref: '#/components/parameters/Limit'
responses:
'200':
$ref: '#/components/responses/200TroubleTicketSpecificationArray'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'503':
$ref: '#/components/responses/503'
post:
tags:
- troubleTicketSpecification
summary: Creates a TroubleTicketSpecification
description: This operation creates a TroubleTicketSpecification entity.
operationId: createTroubleTicketSpecification
parameters:
- $ref: '#/components/parameters/Fields'
requestBody:
$ref: '#/components/requestBodies/TroubleTicketSpecification_FVO'
responses:
'201':
$ref: '#/components/responses/201TroubleTicketSpecification'
'202':
description: Accepted
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'409':
$ref: '#/components/responses/409'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'503':
$ref: '#/components/responses/503'
'/troubleTicketSpecification/{id}':
get:
tags:
- troubleTicketSpecification
summary: Retrieves a TroubleTicketSpecification by ID
description: >-
This operation retrieves a TroubleTicketSpecification entity. Attribute selection enabled
for all first level attributes.
operationId: retrieveTroubleTicketSpecification
parameters:
- $ref: '#/components/parameters/Id'
- $ref: '#/components/parameters/Fields'
responses:
'200':
$ref: '#/components/responses/200TroubleTicketSpecification_Get'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'503':
$ref: '#/components/responses/503'
patch:
tags:
- troubleTicketSpecification
summary: Updates partially a TroubleTicketSpecification
description: This operation updates partially a TroubleTicketSpecification entity.
operationId: patchTroubleTicketSpecification
parameters:
- $ref: '#/components/parameters/Id'
- $ref: '#/components/parameters/Fields'
requestBody:
$ref: '#/components/requestBodies/TroubleTicketSpecification_MVO'
responses:
'200':
$ref: '#/components/responses/200TroubleTicketSpecification_Patch'
'202':
description: Accepted
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'409':
$ref: '#/components/responses/409'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'503':
$ref: '#/components/responses/503'
delete:
tags:
- troubleTicketSpecification
summary: Deletes a TroubleTicketSpecification
description: This operation deletes a TroubleTicketSpecification entity.
operationId: deleteTroubleTicketSpecification
parameters:
- $ref: '#/components/parameters/Id'
responses:
'202':
$ref: '#/components/responses/202'
'204':
$ref: '#/components/responses/204'
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'405':
$ref: '#/components/responses/405'
'409':
$ref: '#/components/responses/409'
'500':
$ref: '#/components/responses/500'
'501':
$ref: '#/components/responses/501'
'503':
$ref: '#/components/responses/503'
/listener/troubleTicketSpecificationCreateEvent:
post:
tags:
- notification listener
summary: Client listener for entity TroubleTicketSpecificationCreateEvent
description: >-
Example of a client listener for receiving the notification
TroubleTicketSpecificationCreateEvent
operationId: troubleTicketSpecificationCreateEvent
requestBody:
$ref: '#/components/requestBodies/TroubleTicketSpecificationCreateEvent'
responses:
'204':
description: Notified
default:
$ref: '#/components/responses/Error'
/listener/troubleTicketSpecificationAttributeValueChangeEvent:
post:
tags:
- notification listener
summary: Client listener for entity TroubleTicketSpecificationAttributeValueChangeEvent
description: >-
Example of a client listener for receiving the notification
TroubleTicketSpecificationAttributeValueChangeEvent
operationId: troubleTicketSpecificationAttributeValueChangeEvent
requestBody:
$ref: '#/components/requestBodies/TroubleTicketSpecificationAttributeValueChangeEvent'
responses:
'204':
description: Notified
default:
$ref: '#/components/responses/Error'
/listener/troubleTicketSpecificationStatusChangeEvent:
post:
tags:
- notification listener
summary: Client listener for entity TroubleTicketSpecificationStatusChangeEvent
description: >-
Example of a client listener for receiving the notification
TroubleTicketSpecificationStatusChangeEvent
operationId: troubleTicketSpecificationStatusChangeEvent
requestBody:
$ref: '#/components/requestBodies/TroubleTicketSpecificationStatusChangeEvent'
responses:
'204':
description: Notified
default:
$ref: '#/components/responses/Error'
/listener/troubleTicketSpecificationDeleteEvent:
post:
tags:
- notification listener
summary: Client listener for entity TroubleTicketSpecificationDeleteEvent
description: >-
Example of a client listener for receiving the notification
TroubleTicketSpecificationDeleteEvent
operationId: troubleTicketSpecificationDeleteEvent
requestBody:
$ref: '#/components/requestBodies/TroubleTicketSpecificationDeleteEvent'
responses:
'204':
description: Notified
default:
$ref: '#/components/responses/Error'
/hub:
post:
operationId: createHub
summary: Create a subscription (hub) to receive Events
description: Sets the communication endpoint to receive Events.
tags:
- events subscription
requestBody:
$ref: '#/components/requestBodies/Hub_FVO'
responses:
'201':
$ref: '#/components/responses/Hub'
default:
$ref: '#/components/responses/Error'
'/hub/{id}':
delete:
operationId: hubDelete
summary: Remove a subscription (hub) to receive Events
description: ''
tags:
- events subscription
parameters:
- $ref: '#/components/parameters/Id'
responses:
'204':
description: Deleted
default:
$ref: '#/components/responses/Error'
components:
schemas:
Addressable:
type: object
description: Base schema for adressable entities
properties:
href:
type: string
description: Hyperlink reference
id:
type: string
description: unique identifier
Addressable_FVO:
type: object
description: Base schema for adressable entities
properties:
id:
type: string
description: unique identifier
Attachment:
allOf:
- $ref: '#/components/schemas/Entity'
- type: object
description: >-
Complements the description of an element (for instance a product) through video,
pictures...
properties:
name:
type: string
description: The name of the attachment
description:
type: string
description: A narrative text describing the content of the attachment
example: Photograph of the Product
url:
type: string
description: 'Uniform Resource Locator, is a web page address (a subset of URI)'
example: 'http://host/Content/4aafacbd-11ff-4dc8-b445-305f2215715f'
content:
type: string
format: base64
description: 'The actual contents of the attachment object, if embedded, encoded as base64'
size:
$ref: '#/components/schemas/Quantity'
validFor:
$ref: '#/components/schemas/TimePeriod'
attachmentType:
type: string
description: >-
a business characterization of the purpose of the attachment, for example logo,
instructionManual, contractCopy
mimeType:
type: string
description: a technical characterization of the attachment content format using IETF Mime Types
discriminator:
propertyName: '@type'
mapping:
Attachment: '#/components/schemas/Attachment'
AttachmentRef:
allOf:
- $ref: '#/components/schemas/EntityRef'
- type: object
description: >-
Attachment reference. An attachment complements the description of an element (for
instance a product) through video, pictures
properties:
description:
type: string
description: A narrative text describing the content of the attachment
url:
description: Link to the attachment media/content
type: string
discriminator:
propertyName: '@type'
mapping:
AttachmentRef: '#/components/schemas/AttachmentRef'
AttachmentRefOrValue:
type: object
description: >-
The polymorphic attributes @type, @schemaLocation & @referredType are related to the
Attachment entity and not the AttachmentRefOrValue class itself
oneOf:
- $ref: '#/components/schemas/Attachment'
- $ref: '#/components/schemas/AttachmentRef'
discriminator:
propertyName: '@type'
mapping:
Attachment: '#/components/schemas/Attachment'
AttachmentRef: '#/components/schemas/AttachmentRef'
AttachmentRefOrValue_FVO:
type: object
description: >-
The polymorphic attributes @type, @schemaLocation & @referredType are related to the
Attachment entity and not the AttachmentRefOrValue class itself
oneOf:
- $ref: '#/components/schemas/Attachment_FVO'
- $ref: '#/components/schemas/AttachmentRef_FVO'
discriminator:
propertyName: '@type'
mapping:
Attachment: '#/components/schemas/Attachment_FVO'
AttachmentRef: '#/components/schemas/AttachmentRef_FVO'
AttachmentRefOrValue_MVO:
type: object
description: >-
The polymorphic attributes @type, @schemaLocation & @referredType are related to the
Attachment entity and not the AttachmentRefOrValue class itself
oneOf:
- $ref: '#/components/schemas/Attachment_MVO'
- $ref: '#/components/schemas/AttachmentRef_MVO'
discriminator:
propertyName: '@type'
mapping:
Attachment: '#/components/schemas/Attachment_MVO'
AttachmentRef: '#/components/schemas/AttachmentRef_MVO'
AttachmentRef_FVO:
allOf:
- $ref: '#/components/schemas/EntityRef_FVO'
- type: object
description: >-
Attachment reference. An attachment complements the description of an element (for
instance a product) through video, pictures
properties:
description:
type: string
description: A narrative text describing the content of the attachment
url:
description: Link to the attachment media/content
type: string
discriminator:
propertyName: '@type'
mapping:
AttachmentRef: '#/components/schemas/AttachmentRef_FVO'
AttachmentRef_MVO:
allOf:
- $ref: '#/components/schemas/EntityRef'
- type: object
description: >-
Attachment reference. An attachment complements the description of an element (for
instance a product) through video, pictures
properties:
description:
type: string
description: A narrative text describing the content of the attachment
url:
description: Link to the attachment media/content
type: string
discriminator:
propertyName: '@type'
mapping:
AttachmentRef: '#/components/schemas/AttachmentRef_MVO'
Attachment_FVO:
allOf:
- $ref: '#/components/schemas/Entity_FVO'
- type: object
description: >-
Complements the description of an element (for instance a product) through video,
pictures...
properties:
name:
type: string
description: The name of the attachment
description:
type: string
description: A narrative text describing the content of the attachment
example: Photograph of the Product
url:
type: string
description: 'Uniform Resource Locator, is a web page address (a subset of URI)'
example: 'http://host/Content/4aafacbd-11ff-4dc8-b445-305f2215715f'
content:
type: string
format: base64
description: 'The actual contents of the attachment object, if embedded, encoded as base64'
size:
$ref: '#/components/schemas/Quantity'
validFor:
$ref: '#/components/schemas/TimePeriod'
attachmentType:
type: string
description: >-
a business characterization of the purpose of the attachment, for example logo,
instructionManual, contractCopy
mimeType:
type: string
description: a technical characterization of the attachment content format using IETF Mime Types
required:
- attachmentType
- mimeType
discriminator:
propertyName: '@type'
mapping:
Attachment: '#/components/schemas/Attachment_FVO'
Attachment_MVO:
allOf:
- $ref: '#/components/schemas/Entity_MVO'
- type: object
description: >-
Complements the description of an element (for instance a product) through video,
pictures...
properties:
name:
type: string
description: The name of the attachment
description:
type: string
description: A narrative text describing the content of the attachment
example: Photograph of the Product
url:
type: string
description: 'Uniform Resource Locator, is a web page address (a subset of URI)'
example: 'http://host/Content/4aafacbd-11ff-4dc8-b445-305f2215715f'
content:
type: string
format: base64
description: 'The actual contents of the attachment object, if embedded, encoded as base64'
size:
$ref: '#/components/schemas/Quantity'
validFor:
$ref: '#/components/schemas/TimePeriod'
attachmentType:
type: string
description: >-
a business characterization of the purpose of the attachment, for example logo,
instructionManual, contractCopy
mimeType:
type: string
description: a technical characterization of the attachment content format using IETF Mime Types
discriminator:
propertyName: '@type'
mapping:
Attachment: '#/components/schemas/Attachment_MVO'
BaseEvent:
allOf:
- $ref: '#/components/schemas/Entity'
- type: object
description: Base event with common attributes.
properties:
event:
type: object
eventId:
type: string
description: The identifier of the notification.
eventTime:
type: string
format: date-time
description: Time of the event occurrence.
eventType:
type: string
description: The type of the notification.
correlationId:
type: string
description: The correlation id for this event.
domain:
type: string
description: The domain of the event.
title:
type: string
description: The title of the event.
description:
type: string
description: An explanatory of the event.
priority:
type: string
description: A priority.
timeOcurred:
type: string
format: date-time
description: The time the event occured.
discriminator:
propertyName: '@type'
mapping:
BaseEvent: '#/components/schemas/BaseEvent'
BaseEvent_FVO:
allOf:
- $ref: '#/components/schemas/Entity_FVO'
- type: object
description: Base event with common attributes.
properties:
event:
type: object
eventId:
type: string
description: The identifier of the notification.
eventTime:
type: string
format: date-time
description: Time of the event occurrence.
eventType:
type: string
description: The type of the notification.
correlationId:
type: string
description: The correlation id for this event.
domain:
type: string
description: The domain of the event.
title:
type: string
description: The title of the event.
description:
type: string
description: An explanatory of the event.
priority:
type: string
description: A priority.
timeOcurred:
type: string
format: date-time
description: The time the event occured.
discriminator:
propertyName: '@type'
mapping:
BaseEvent: '#/components/schemas/BaseEvent_FVO'
BaseEvent_MVO:
allOf:
- $ref: '#/components/schemas/Entity_MVO'
- type: object
description: Base event with common attributes.
properties:
event:
type: object
eventId:
type: string
description: The identifier of the notification.
eventTime:
type: string
format: date-time
description: Time of the event occurrence.
eventType:
type: string
description: The type of the notification.
correlationId:
type: string
description: The correlation id for this event.
domain:
type: string
description: The domain of the event.
title:
type: string
description: The title of the event.
description:
type: string
description: An explanatory of the event.
priority:
type: string
description: A priority.
timeOcurred:
type: string
format: date-time
description: The time the event occured.
discriminator:
propertyName: '@type'
mapping:
BaseEvent: '#/components/schemas/BaseEvent_MVO'
BooleanArrayCharacteristic:
allOf:
- $ref: '#/components/schemas/Characteristic'
- type: object
description: A characteristic which value is an array of Boolean(s).
properties:
value:
type: array
items:
type: boolean
BooleanArrayCharacteristicValueSpecification:
allOf:
- $ref: '#/components/schemas/CharacteristicValueSpecification'
- type: object
description: A specification for a characteristic for which the value is an array booleans
properties:
value:
type: array
items:
type: boolean
BooleanArrayCharacteristicValueSpecification_FVO:
allOf:
- $ref: '#/components/schemas/CharacteristicValueSpecification_FVO'
- type: object
description: A specification for a characteristic for which the value is an array booleans
properties:
value:
type: array
items:
type: boolean
BooleanArrayCharacteristicValueSpecification_MVO:
allOf:
- $ref: '#/components/schemas/CharacteristicValueSpecification_MVO'
- type: object
description: A specification for a characteristic for which the value is an array booleans
properties:
value:
type: array
items:
type: boolean
BooleanArrayCharacteristic_FVO:
allOf:
- $ref: '#/components/schemas/Characteristic_FVO'
- type: object
description: A characteristic which value is an array of Boolean(s).
properties:
value:
type: array
items:
type: boolean
required:
- value
BooleanArrayCharacteristic_MVO:
allOf:
- $ref: '#/components/schemas/Characteristic_MVO'
- type: object
description: A characteristic which value is an array of Boolean(s).
properties:
value:
type: array
items:
type: boolean
required:
- value
BooleanCharacteristic:
allOf:
- $ref: '#/components/schemas/Characteristic'
- type: object
description: A characteristic which value is a Boolean.
properties:
value:
type: boolean
description: Value of the characteristic
BooleanCharacteristicValueSpecification:
allOf:
- $ref: '#/components/schemas/CharacteristicValueSpecification'
- type: object
description: A specification for a characteristic for which the value is a boolean
properties:
value:
type: boolean
description: Value of the characteristic
BooleanCharacteristicValueSpecification_FVO:
allOf:
- $ref: '#/components/schemas/CharacteristicValueSpecification_FVO'
- type: object
description: A specification for a characteristic for which the value is a boolean
properties:
value:
type: boolean
description: Value of the characteristic
BooleanCharacteristicValueSpecification_MVO:
allOf:
- $ref: '#/components/schemas/CharacteristicValueSpecification_MVO'
- type: object
description: A specification for a characteristic for which the value is a boolean
properties:
value:
type: boolean
description: Value of the characteristic
BooleanCharacteristic_FVO:
allOf:
- $ref: '#/components/schemas/Characteristic_FVO'
- type: object
description: A characteristic which value is a Boolean.
properties:
value:
type: boolean
description: Value of the characteristic
required:
- value
BooleanCharacteristic_MVO:
allOf:
- $ref: '#/components/schemas/Characteristic_MVO'
- type: object
description: A characteristic which value is a Boolean.
properties:
value:
type: boolean
description: Value of the characteristic
required:
- value
ChannelRef:
type: object
description: >-
The channel to which the resource reference to. e.g. channel for selling product offerings,
channel for opening a trouble ticket etc..
allOf:
- $ref: '#/components/schemas/EntityRef'
discriminator: