@itentialopensource/adapter-tmf639_resource_inventory_management 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (73) hide show
  1. package/.eslintignore +5 -0
  2. package/.eslintrc.js +18 -0
  3. package/.jshintrc +3 -0
  4. package/AUTH.md +39 -0
  5. package/BROKER.md +199 -0
  6. package/CALLS.md +326 -0
  7. package/CHANGELOG.md +16 -0
  8. package/CODE_OF_CONDUCT.md +43 -0
  9. package/CONTRIBUTING.md +172 -0
  10. package/ENHANCE.md +69 -0
  11. package/LICENSE +201 -0
  12. package/PROPERTIES.md +641 -0
  13. package/README.md +337 -0
  14. package/SUMMARY.md +9 -0
  15. package/SYSTEMINFO.md +11 -0
  16. package/TROUBLESHOOT.md +47 -0
  17. package/adapter.js +2995 -0
  18. package/adapterBase.js +1787 -0
  19. package/entities/.generic/action.json +214 -0
  20. package/entities/.generic/schema.json +28 -0
  21. package/entities/.system/action.json +50 -0
  22. package/entities/.system/mockdatafiles/getToken-default.json +3 -0
  23. package/entities/.system/mockdatafiles/healthcheck-default.json +3 -0
  24. package/entities/.system/schema.json +19 -0
  25. package/entities/.system/schemaTokenReq.json +53 -0
  26. package/entities/.system/schemaTokenResp.json +53 -0
  27. package/entities/EventsSubscription/action.json +44 -0
  28. package/entities/EventsSubscription/schema.json +20 -0
  29. package/entities/LogicalResource/action.json +126 -0
  30. package/entities/LogicalResource/mockdatafiles/listLogicalResource-default.json +3235 -0
  31. package/entities/LogicalResource/schema.json +24 -0
  32. package/entities/NotificationListenersClientSide/action.json +164 -0
  33. package/entities/NotificationListenersClientSide/schema.json +26 -0
  34. package/entities/PhysicalResource/action.json +106 -0
  35. package/entities/PhysicalResource/mockdatafiles/listPhysicalResource-default.json +2033 -0
  36. package/entities/PhysicalResource/schema.json +23 -0
  37. package/entities/Resource/action.json +106 -0
  38. package/entities/Resource/mockdatafiles/listResource-default.json +9505 -0
  39. package/entities/Resource/schema.json +23 -0
  40. package/error.json +190 -0
  41. package/package.json +86 -0
  42. package/pronghorn.json +11338 -0
  43. package/propertiesDecorators.json +14 -0
  44. package/propertiesSchema.json +1248 -0
  45. package/refs?service=git-upload-pack +0 -0
  46. package/report/TMF639-ResourceInventory-v4.0.0.swagger.json +4172 -0
  47. package/report/adapterInfo.json +10 -0
  48. package/report/creationReport.json +385 -0
  49. package/sampleProperties.json +195 -0
  50. package/test/integration/adapterTestBasicGet.js +83 -0
  51. package/test/integration/adapterTestConnectivity.js +93 -0
  52. package/test/integration/adapterTestIntegration.js +2895 -0
  53. package/test/unit/adapterBaseTestUnit.js +949 -0
  54. package/test/unit/adapterTestUnit.js +2082 -0
  55. package/utils/adapterInfo.js +206 -0
  56. package/utils/addAuth.js +94 -0
  57. package/utils/artifactize.js +146 -0
  58. package/utils/basicGet.js +50 -0
  59. package/utils/checkMigrate.js +63 -0
  60. package/utils/entitiesToDB.js +178 -0
  61. package/utils/findPath.js +74 -0
  62. package/utils/methodDocumentor.js +225 -0
  63. package/utils/modify.js +154 -0
  64. package/utils/packModificationScript.js +35 -0
  65. package/utils/patches2bundledDeps.js +90 -0
  66. package/utils/pre-commit.sh +32 -0
  67. package/utils/removeHooks.js +20 -0
  68. package/utils/setup.js +33 -0
  69. package/utils/tbScript.js +246 -0
  70. package/utils/tbUtils.js +490 -0
  71. package/utils/testRunner.js +298 -0
  72. package/utils/troubleshootingAdapter.js +195 -0
  73. package/workflows/README.md +3 -0
@@ -0,0 +1,4172 @@
1
+ {
2
+ "swagger": "2.0",
3
+ "info": {
4
+ "title": "Resource Inventory Management",
5
+ "description": "This is Swagger UI environment generated for the TMF Resource Inventory Management specification",
6
+ "version": "4.0.0"
7
+ },
8
+ "host": "serverRoot",
9
+ "basePath": "/tmf-api/resourceInventoryManagement/v4/",
10
+ "schemes": [
11
+ "https"
12
+ ],
13
+ "consumes": [
14
+ "application/json;charset=utf-8"
15
+ ],
16
+ "produces": [
17
+ "application/json;charset=utf-8"
18
+ ],
19
+ "tags": [
20
+ {
21
+ "name": "resource"
22
+ },
23
+ {
24
+ "name": "physicalResource"
25
+ },
26
+ {
27
+ "name": "logicalResource"
28
+ },
29
+ {
30
+ "name": "notification listeners (client side)"
31
+ },
32
+ {
33
+ "name": "events subscription"
34
+ }
35
+ ],
36
+ "paths": {
37
+ "/resource": {
38
+ "get": {
39
+ "operationId": "listResource",
40
+ "summary": "List or find Resource objects",
41
+ "description": "This operation list or find Resource entities",
42
+ "tags": [
43
+ "resource"
44
+ ],
45
+ "parameters": [
46
+ {
47
+ "name": "fields",
48
+ "description": "Comma-separated properties to be provided in response",
49
+ "required": false,
50
+ "in": "query",
51
+ "type": "string"
52
+ },
53
+ {
54
+ "name": "offset",
55
+ "description": "Requested index for start of resources to be provided in response",
56
+ "required": false,
57
+ "in": "query",
58
+ "type": "integer"
59
+ },
60
+ {
61
+ "name": "limit",
62
+ "description": "Requested number of resources to be provided in response",
63
+ "required": false,
64
+ "in": "query",
65
+ "type": "integer"
66
+ }
67
+ ],
68
+ "responses": {
69
+ "200": {
70
+ "description": "Success",
71
+ "headers": {
72
+ "X-Result-Count": {
73
+ "description": "Actual number of items returned in the response body",
74
+ "type": "integer"
75
+ },
76
+ "X-Total-Count": {
77
+ "description": "Total number of items matching criteria",
78
+ "type": "integer"
79
+ }
80
+ },
81
+ "schema": {
82
+ "type": "array",
83
+ "items": {
84
+ "$ref": "#/definitions/Resource"
85
+ }
86
+ }
87
+ },
88
+ "400": {
89
+ "description": "Bad Request",
90
+ "schema": {
91
+ "$ref": "#/definitions/Error"
92
+ }
93
+ },
94
+ "401": {
95
+ "description": "Unauthorized",
96
+ "schema": {
97
+ "$ref": "#/definitions/Error"
98
+ }
99
+ },
100
+ "403": {
101
+ "description": "Forbidden",
102
+ "schema": {
103
+ "$ref": "#/definitions/Error"
104
+ }
105
+ },
106
+ "404": {
107
+ "description": "Not Found",
108
+ "schema": {
109
+ "$ref": "#/definitions/Error"
110
+ }
111
+ },
112
+ "405": {
113
+ "description": "Method Not allowed",
114
+ "schema": {
115
+ "$ref": "#/definitions/Error"
116
+ }
117
+ },
118
+ "409": {
119
+ "description": "Conflict",
120
+ "schema": {
121
+ "$ref": "#/definitions/Error"
122
+ }
123
+ },
124
+ "500": {
125
+ "description": "Internal Server Error",
126
+ "schema": {
127
+ "$ref": "#/definitions/Error"
128
+ }
129
+ }
130
+ }
131
+ },
132
+ "post": {
133
+ "operationId": "createResource",
134
+ "summary": "Creates a Resource",
135
+ "description": "This operation creates a Resource entity.",
136
+ "tags": [
137
+ "resource"
138
+ ],
139
+ "parameters": [
140
+ {
141
+ "name": "resource",
142
+ "description": "The Resource to be created",
143
+ "required": true,
144
+ "schema": {
145
+ "$ref": "#/definitions/Resource_Create"
146
+ },
147
+ "in": "body"
148
+ }
149
+ ],
150
+ "responses": {
151
+ "201": {
152
+ "description": "Created",
153
+ "schema": {
154
+ "$ref": "#/definitions/Resource"
155
+ }
156
+ },
157
+ "400": {
158
+ "description": "Bad Request",
159
+ "schema": {
160
+ "$ref": "#/definitions/Error"
161
+ }
162
+ },
163
+ "401": {
164
+ "description": "Unauthorized",
165
+ "schema": {
166
+ "$ref": "#/definitions/Error"
167
+ }
168
+ },
169
+ "403": {
170
+ "description": "Forbidden",
171
+ "schema": {
172
+ "$ref": "#/definitions/Error"
173
+ }
174
+ },
175
+ "405": {
176
+ "description": "Method Not allowed",
177
+ "schema": {
178
+ "$ref": "#/definitions/Error"
179
+ }
180
+ },
181
+ "409": {
182
+ "description": "Conflict",
183
+ "schema": {
184
+ "$ref": "#/definitions/Error"
185
+ }
186
+ },
187
+ "500": {
188
+ "description": "Internal Server Error",
189
+ "schema": {
190
+ "$ref": "#/definitions/Error"
191
+ }
192
+ }
193
+ }
194
+ }
195
+ },
196
+ "/resource/{id}": {
197
+ "get": {
198
+ "operationId": "retrieveResource",
199
+ "summary": "Retrieves a Resource by ID",
200
+ "description": "This operation retrieves a Resource entity. Attribute selection is enabled for all first level attributes.",
201
+ "tags": [
202
+ "resource"
203
+ ],
204
+ "parameters": [
205
+ {
206
+ "name": "id",
207
+ "description": "Identifier of the Resource",
208
+ "required": true,
209
+ "type": "string",
210
+ "in": "path"
211
+ },
212
+ {
213
+ "name": "fields",
214
+ "description": "Comma-separated properties to provide in response",
215
+ "required": false,
216
+ "type": "string",
217
+ "in": "query"
218
+ }
219
+ ],
220
+ "responses": {
221
+ "200": {
222
+ "description": "Success",
223
+ "schema": {
224
+ "$ref": "#/definitions/Resource"
225
+ }
226
+ },
227
+ "400": {
228
+ "description": "Bad Request",
229
+ "schema": {
230
+ "$ref": "#/definitions/Error"
231
+ }
232
+ },
233
+ "401": {
234
+ "description": "Unauthorized",
235
+ "schema": {
236
+ "$ref": "#/definitions/Error"
237
+ }
238
+ },
239
+ "403": {
240
+ "description": "Forbidden",
241
+ "schema": {
242
+ "$ref": "#/definitions/Error"
243
+ }
244
+ },
245
+ "404": {
246
+ "description": "Not Found",
247
+ "schema": {
248
+ "$ref": "#/definitions/Error"
249
+ }
250
+ },
251
+ "405": {
252
+ "description": "Method Not allowed",
253
+ "schema": {
254
+ "$ref": "#/definitions/Error"
255
+ }
256
+ },
257
+ "409": {
258
+ "description": "Conflict",
259
+ "schema": {
260
+ "$ref": "#/definitions/Error"
261
+ }
262
+ },
263
+ "500": {
264
+ "description": "Internal Server Error",
265
+ "schema": {
266
+ "$ref": "#/definitions/Error"
267
+ }
268
+ }
269
+ }
270
+ },
271
+ "patch": {
272
+ "operationId": "patchResource",
273
+ "summary": "Updates partially a Resource",
274
+ "description": "This operation updates partially a Resource entity.",
275
+ "tags": [
276
+ "resource"
277
+ ],
278
+ "parameters": [
279
+ {
280
+ "name": "id",
281
+ "description": "Identifier of the Resource",
282
+ "required": true,
283
+ "type": "string",
284
+ "in": "path"
285
+ },
286
+ {
287
+ "name": "resource",
288
+ "description": "The Resource to be updated",
289
+ "required": true,
290
+ "schema": {
291
+ "$ref": "#/definitions/Resource_Update"
292
+ },
293
+ "in": "body"
294
+ }
295
+ ],
296
+ "responses": {
297
+ "200": {
298
+ "description": "Updated",
299
+ "schema": {
300
+ "$ref": "#/definitions/Resource"
301
+ }
302
+ },
303
+ "400": {
304
+ "description": "Bad Request",
305
+ "schema": {
306
+ "$ref": "#/definitions/Error"
307
+ }
308
+ },
309
+ "401": {
310
+ "description": "Unauthorized",
311
+ "schema": {
312
+ "$ref": "#/definitions/Error"
313
+ }
314
+ },
315
+ "403": {
316
+ "description": "Forbidden",
317
+ "schema": {
318
+ "$ref": "#/definitions/Error"
319
+ }
320
+ },
321
+ "404": {
322
+ "description": "Not Found",
323
+ "schema": {
324
+ "$ref": "#/definitions/Error"
325
+ }
326
+ },
327
+ "405": {
328
+ "description": "Method Not allowed",
329
+ "schema": {
330
+ "$ref": "#/definitions/Error"
331
+ }
332
+ },
333
+ "409": {
334
+ "description": "Conflict",
335
+ "schema": {
336
+ "$ref": "#/definitions/Error"
337
+ }
338
+ },
339
+ "500": {
340
+ "description": "Internal Server Error",
341
+ "schema": {
342
+ "$ref": "#/definitions/Error"
343
+ }
344
+ }
345
+ }
346
+ },
347
+ "delete": {
348
+ "operationId": "deleteResource",
349
+ "summary": "Deletes a Resource",
350
+ "description": "This operation deletes a Resource entity.",
351
+ "tags": [
352
+ "resource"
353
+ ],
354
+ "parameters": [
355
+ {
356
+ "name": "id",
357
+ "description": "Identifier of the Resource",
358
+ "required": true,
359
+ "type": "string",
360
+ "in": "path"
361
+ }
362
+ ],
363
+ "responses": {
364
+ "204": {
365
+ "description": "Deleted"
366
+ },
367
+ "400": {
368
+ "description": "Bad Request",
369
+ "schema": {
370
+ "$ref": "#/definitions/Error"
371
+ }
372
+ },
373
+ "401": {
374
+ "description": "Unauthorized",
375
+ "schema": {
376
+ "$ref": "#/definitions/Error"
377
+ }
378
+ },
379
+ "403": {
380
+ "description": "Forbidden",
381
+ "schema": {
382
+ "$ref": "#/definitions/Error"
383
+ }
384
+ },
385
+ "404": {
386
+ "description": "Not Found",
387
+ "schema": {
388
+ "$ref": "#/definitions/Error"
389
+ }
390
+ },
391
+ "405": {
392
+ "description": "Method Not allowed",
393
+ "schema": {
394
+ "$ref": "#/definitions/Error"
395
+ }
396
+ },
397
+ "409": {
398
+ "description": "Conflict",
399
+ "schema": {
400
+ "$ref": "#/definitions/Error"
401
+ }
402
+ },
403
+ "500": {
404
+ "description": "Internal Server Error",
405
+ "schema": {
406
+ "$ref": "#/definitions/Error"
407
+ }
408
+ }
409
+ }
410
+ }
411
+ },
412
+ "/physicalResource": {
413
+ "get": {
414
+ "operationId": "listPhysicalResource",
415
+ "summary": "List or find PhysicalResource objects",
416
+ "description": "This operation list or find PhysicalResource entities",
417
+ "tags": [
418
+ "physicalResource"
419
+ ],
420
+ "parameters": [
421
+ {
422
+ "name": "fields",
423
+ "description": "Comma-separated properties to be provided in response",
424
+ "required": false,
425
+ "in": "query",
426
+ "type": "string"
427
+ },
428
+ {
429
+ "name": "offset",
430
+ "description": "Requested index for start of resources to be provided in response",
431
+ "required": false,
432
+ "in": "query",
433
+ "type": "integer"
434
+ },
435
+ {
436
+ "name": "limit",
437
+ "description": "Requested number of resources to be provided in response",
438
+ "required": false,
439
+ "in": "query",
440
+ "type": "integer"
441
+ }
442
+ ],
443
+ "responses": {
444
+ "200": {
445
+ "description": "Success",
446
+ "headers": {
447
+ "X-Result-Count": {
448
+ "description": "Actual number of items returned in the response body",
449
+ "type": "integer"
450
+ },
451
+ "X-Total-Count": {
452
+ "description": "Total number of items matching criteria",
453
+ "type": "integer"
454
+ }
455
+ },
456
+ "schema": {
457
+ "type": "array",
458
+ "items": {
459
+ "$ref": "#/definitions/PhysicalResource"
460
+ }
461
+ }
462
+ },
463
+ "400": {
464
+ "description": "Bad Request",
465
+ "schema": {
466
+ "$ref": "#/definitions/Error"
467
+ }
468
+ },
469
+ "401": {
470
+ "description": "Unauthorized",
471
+ "schema": {
472
+ "$ref": "#/definitions/Error"
473
+ }
474
+ },
475
+ "403": {
476
+ "description": "Forbidden",
477
+ "schema": {
478
+ "$ref": "#/definitions/Error"
479
+ }
480
+ },
481
+ "404": {
482
+ "description": "Not Found",
483
+ "schema": {
484
+ "$ref": "#/definitions/Error"
485
+ }
486
+ },
487
+ "405": {
488
+ "description": "Method Not allowed",
489
+ "schema": {
490
+ "$ref": "#/definitions/Error"
491
+ }
492
+ },
493
+ "409": {
494
+ "description": "Conflict",
495
+ "schema": {
496
+ "$ref": "#/definitions/Error"
497
+ }
498
+ },
499
+ "500": {
500
+ "description": "Internal Server Error",
501
+ "schema": {
502
+ "$ref": "#/definitions/Error"
503
+ }
504
+ }
505
+ }
506
+ },
507
+ "post": {
508
+ "operationId": "createPhysicalResource",
509
+ "summary": "Creates a PhysicalResource",
510
+ "description": "This operation creates a PhysicalResource entity.",
511
+ "tags": [
512
+ "physicalResource"
513
+ ],
514
+ "parameters": [
515
+ {
516
+ "name": "physicalResource",
517
+ "description": "The PhysicalResource to be created",
518
+ "required": true,
519
+ "schema": {
520
+ "$ref": "#/definitions/PhysicalResource_Create"
521
+ },
522
+ "in": "body"
523
+ }
524
+ ],
525
+ "responses": {
526
+ "201": {
527
+ "description": "Created",
528
+ "schema": {
529
+ "$ref": "#/definitions/PhysicalResource"
530
+ }
531
+ },
532
+ "400": {
533
+ "description": "Bad Request",
534
+ "schema": {
535
+ "$ref": "#/definitions/Error"
536
+ }
537
+ },
538
+ "401": {
539
+ "description": "Unauthorized",
540
+ "schema": {
541
+ "$ref": "#/definitions/Error"
542
+ }
543
+ },
544
+ "403": {
545
+ "description": "Forbidden",
546
+ "schema": {
547
+ "$ref": "#/definitions/Error"
548
+ }
549
+ },
550
+ "405": {
551
+ "description": "Method Not allowed",
552
+ "schema": {
553
+ "$ref": "#/definitions/Error"
554
+ }
555
+ },
556
+ "409": {
557
+ "description": "Conflict",
558
+ "schema": {
559
+ "$ref": "#/definitions/Error"
560
+ }
561
+ },
562
+ "500": {
563
+ "description": "Internal Server Error",
564
+ "schema": {
565
+ "$ref": "#/definitions/Error"
566
+ }
567
+ }
568
+ }
569
+ }
570
+ },
571
+ "/physicalResource/{id}": {
572
+ "get": {
573
+ "operationId": "retrievePhysicalResource",
574
+ "summary": "Retrieves a PhysicalResource by ID",
575
+ "description": "This operation retrieves a PhysicalResource entity. Attribute selection is enabled for all first level attributes.",
576
+ "tags": [
577
+ "physicalResource"
578
+ ],
579
+ "parameters": [
580
+ {
581
+ "name": "id",
582
+ "description": "Identifier of the PhysicalResource",
583
+ "required": true,
584
+ "type": "string",
585
+ "in": "path"
586
+ },
587
+ {
588
+ "name": "fields",
589
+ "description": "Comma-separated properties to provide in response",
590
+ "required": false,
591
+ "type": "string",
592
+ "in": "query"
593
+ }
594
+ ],
595
+ "responses": {
596
+ "200": {
597
+ "description": "Success",
598
+ "schema": {
599
+ "$ref": "#/definitions/PhysicalResource"
600
+ }
601
+ },
602
+ "400": {
603
+ "description": "Bad Request",
604
+ "schema": {
605
+ "$ref": "#/definitions/Error"
606
+ }
607
+ },
608
+ "401": {
609
+ "description": "Unauthorized",
610
+ "schema": {
611
+ "$ref": "#/definitions/Error"
612
+ }
613
+ },
614
+ "403": {
615
+ "description": "Forbidden",
616
+ "schema": {
617
+ "$ref": "#/definitions/Error"
618
+ }
619
+ },
620
+ "404": {
621
+ "description": "Not Found",
622
+ "schema": {
623
+ "$ref": "#/definitions/Error"
624
+ }
625
+ },
626
+ "405": {
627
+ "description": "Method Not allowed",
628
+ "schema": {
629
+ "$ref": "#/definitions/Error"
630
+ }
631
+ },
632
+ "409": {
633
+ "description": "Conflict",
634
+ "schema": {
635
+ "$ref": "#/definitions/Error"
636
+ }
637
+ },
638
+ "500": {
639
+ "description": "Internal Server Error",
640
+ "schema": {
641
+ "$ref": "#/definitions/Error"
642
+ }
643
+ }
644
+ }
645
+ },
646
+ "patch": {
647
+ "operationId": "patchPhysicalResource",
648
+ "summary": "Updates partially a PhysicalResource",
649
+ "description": "This operation updates partially a PhysicalResource entity.",
650
+ "tags": [
651
+ "physicalResource"
652
+ ],
653
+ "parameters": [
654
+ {
655
+ "name": "id",
656
+ "description": "Identifier of the PhysicalResource",
657
+ "required": true,
658
+ "type": "string",
659
+ "in": "path"
660
+ },
661
+ {
662
+ "name": "physicalResource",
663
+ "description": "The PhysicalResource to be updated",
664
+ "required": true,
665
+ "schema": {
666
+ "$ref": "#/definitions/PhysicalResource_Update"
667
+ },
668
+ "in": "body"
669
+ }
670
+ ],
671
+ "responses": {
672
+ "200": {
673
+ "description": "Updated",
674
+ "schema": {
675
+ "$ref": "#/definitions/PhysicalResource"
676
+ }
677
+ },
678
+ "400": {
679
+ "description": "Bad Request",
680
+ "schema": {
681
+ "$ref": "#/definitions/Error"
682
+ }
683
+ },
684
+ "401": {
685
+ "description": "Unauthorized",
686
+ "schema": {
687
+ "$ref": "#/definitions/Error"
688
+ }
689
+ },
690
+ "403": {
691
+ "description": "Forbidden",
692
+ "schema": {
693
+ "$ref": "#/definitions/Error"
694
+ }
695
+ },
696
+ "404": {
697
+ "description": "Not Found",
698
+ "schema": {
699
+ "$ref": "#/definitions/Error"
700
+ }
701
+ },
702
+ "405": {
703
+ "description": "Method Not allowed",
704
+ "schema": {
705
+ "$ref": "#/definitions/Error"
706
+ }
707
+ },
708
+ "409": {
709
+ "description": "Conflict",
710
+ "schema": {
711
+ "$ref": "#/definitions/Error"
712
+ }
713
+ },
714
+ "500": {
715
+ "description": "Internal Server Error",
716
+ "schema": {
717
+ "$ref": "#/definitions/Error"
718
+ }
719
+ }
720
+ }
721
+ },
722
+ "delete": {
723
+ "operationId": "deletePhysicalResource",
724
+ "summary": "Deletes a PhysicalResource",
725
+ "description": "This operation deletes a PhysicalResource entity.",
726
+ "tags": [
727
+ "physicalResource"
728
+ ],
729
+ "parameters": [
730
+ {
731
+ "name": "id",
732
+ "description": "Identifier of the PhysicalResource",
733
+ "required": true,
734
+ "type": "string",
735
+ "in": "path"
736
+ }
737
+ ],
738
+ "responses": {
739
+ "204": {
740
+ "description": "Deleted"
741
+ },
742
+ "400": {
743
+ "description": "Bad Request",
744
+ "schema": {
745
+ "$ref": "#/definitions/Error"
746
+ }
747
+ },
748
+ "401": {
749
+ "description": "Unauthorized",
750
+ "schema": {
751
+ "$ref": "#/definitions/Error"
752
+ }
753
+ },
754
+ "403": {
755
+ "description": "Forbidden",
756
+ "schema": {
757
+ "$ref": "#/definitions/Error"
758
+ }
759
+ },
760
+ "404": {
761
+ "description": "Not Found",
762
+ "schema": {
763
+ "$ref": "#/definitions/Error"
764
+ }
765
+ },
766
+ "405": {
767
+ "description": "Method Not allowed",
768
+ "schema": {
769
+ "$ref": "#/definitions/Error"
770
+ }
771
+ },
772
+ "409": {
773
+ "description": "Conflict",
774
+ "schema": {
775
+ "$ref": "#/definitions/Error"
776
+ }
777
+ },
778
+ "500": {
779
+ "description": "Internal Server Error",
780
+ "schema": {
781
+ "$ref": "#/definitions/Error"
782
+ }
783
+ }
784
+ }
785
+ }
786
+ },
787
+ "/logicalResource": {
788
+ "get": {
789
+ "operationId": "listLogicalResource",
790
+ "summary": "List or find LogicalResource objects",
791
+ "description": "This operation list or find LogicalResource entities",
792
+ "tags": [
793
+ "logicalResource"
794
+ ],
795
+ "parameters": [
796
+ {
797
+ "name": "fields",
798
+ "description": "Comma-separated properties to be provided in response",
799
+ "required": false,
800
+ "in": "query",
801
+ "type": "string"
802
+ },
803
+ {
804
+ "name": "offset",
805
+ "description": "Requested index for start of resources to be provided in response",
806
+ "required": false,
807
+ "in": "query",
808
+ "type": "integer"
809
+ },
810
+ {
811
+ "name": "limit",
812
+ "description": "Requested number of resources to be provided in response",
813
+ "required": false,
814
+ "in": "query",
815
+ "type": "integer"
816
+ }
817
+ ],
818
+ "responses": {
819
+ "200": {
820
+ "description": "Success",
821
+ "headers": {
822
+ "X-Result-Count": {
823
+ "description": "Actual number of items returned in the response body",
824
+ "type": "integer"
825
+ },
826
+ "X-Total-Count": {
827
+ "description": "Total number of items matching criteria",
828
+ "type": "integer"
829
+ }
830
+ },
831
+ "schema": {
832
+ "type": "array",
833
+ "items": {
834
+ "$ref": "#/definitions/LogicalResource"
835
+ }
836
+ }
837
+ },
838
+ "400": {
839
+ "description": "Bad Request",
840
+ "schema": {
841
+ "$ref": "#/definitions/Error"
842
+ }
843
+ },
844
+ "401": {
845
+ "description": "Unauthorized",
846
+ "schema": {
847
+ "$ref": "#/definitions/Error"
848
+ }
849
+ },
850
+ "403": {
851
+ "description": "Forbidden",
852
+ "schema": {
853
+ "$ref": "#/definitions/Error"
854
+ }
855
+ },
856
+ "404": {
857
+ "description": "Not Found",
858
+ "schema": {
859
+ "$ref": "#/definitions/Error"
860
+ }
861
+ },
862
+ "405": {
863
+ "description": "Method Not allowed",
864
+ "schema": {
865
+ "$ref": "#/definitions/Error"
866
+ }
867
+ },
868
+ "409": {
869
+ "description": "Conflict",
870
+ "schema": {
871
+ "$ref": "#/definitions/Error"
872
+ }
873
+ },
874
+ "500": {
875
+ "description": "Internal Server Error",
876
+ "schema": {
877
+ "$ref": "#/definitions/Error"
878
+ }
879
+ }
880
+ }
881
+ },
882
+ "post": {
883
+ "operationId": "createLogicalResource",
884
+ "summary": "Creates a LogicalResource",
885
+ "description": "This operation creates a LogicalResource entity.",
886
+ "tags": [
887
+ "logicalResource"
888
+ ],
889
+ "parameters": [
890
+ {
891
+ "name": "logicalResource",
892
+ "description": "The LogicalResource to be created",
893
+ "required": true,
894
+ "schema": {
895
+ "$ref": "#/definitions/LogicalResource_Create"
896
+ },
897
+ "in": "body"
898
+ }
899
+ ],
900
+ "responses": {
901
+ "201": {
902
+ "description": "Created",
903
+ "schema": {
904
+ "$ref": "#/definitions/LogicalResource"
905
+ }
906
+ },
907
+ "400": {
908
+ "description": "Bad Request",
909
+ "schema": {
910
+ "$ref": "#/definitions/Error"
911
+ }
912
+ },
913
+ "401": {
914
+ "description": "Unauthorized",
915
+ "schema": {
916
+ "$ref": "#/definitions/Error"
917
+ }
918
+ },
919
+ "403": {
920
+ "description": "Forbidden",
921
+ "schema": {
922
+ "$ref": "#/definitions/Error"
923
+ }
924
+ },
925
+ "405": {
926
+ "description": "Method Not allowed",
927
+ "schema": {
928
+ "$ref": "#/definitions/Error"
929
+ }
930
+ },
931
+ "409": {
932
+ "description": "Conflict",
933
+ "schema": {
934
+ "$ref": "#/definitions/Error"
935
+ }
936
+ },
937
+ "500": {
938
+ "description": "Internal Server Error",
939
+ "schema": {
940
+ "$ref": "#/definitions/Error"
941
+ }
942
+ }
943
+ }
944
+ }
945
+ },
946
+ "/logicalResource/{id}": {
947
+ "get": {
948
+ "operationId": "retrieveLogicalResource",
949
+ "summary": "Retrieves a LogicalResource by ID",
950
+ "description": "This operation retrieves a LogicalResource entity. Attribute selection is enabled for all first level attributes.",
951
+ "tags": [
952
+ "logicalResource"
953
+ ],
954
+ "parameters": [
955
+ {
956
+ "name": "id",
957
+ "description": "Identifier of the LogicalResource",
958
+ "required": true,
959
+ "type": "string",
960
+ "in": "path"
961
+ },
962
+ {
963
+ "name": "fields",
964
+ "description": "Comma-separated properties to provide in response",
965
+ "required": false,
966
+ "type": "string",
967
+ "in": "query"
968
+ }
969
+ ],
970
+ "responses": {
971
+ "200": {
972
+ "description": "Success",
973
+ "schema": {
974
+ "$ref": "#/definitions/LogicalResource"
975
+ }
976
+ },
977
+ "400": {
978
+ "description": "Bad Request",
979
+ "schema": {
980
+ "$ref": "#/definitions/Error"
981
+ }
982
+ },
983
+ "401": {
984
+ "description": "Unauthorized",
985
+ "schema": {
986
+ "$ref": "#/definitions/Error"
987
+ }
988
+ },
989
+ "403": {
990
+ "description": "Forbidden",
991
+ "schema": {
992
+ "$ref": "#/definitions/Error"
993
+ }
994
+ },
995
+ "404": {
996
+ "description": "Not Found",
997
+ "schema": {
998
+ "$ref": "#/definitions/Error"
999
+ }
1000
+ },
1001
+ "405": {
1002
+ "description": "Method Not allowed",
1003
+ "schema": {
1004
+ "$ref": "#/definitions/Error"
1005
+ }
1006
+ },
1007
+ "409": {
1008
+ "description": "Conflict",
1009
+ "schema": {
1010
+ "$ref": "#/definitions/Error"
1011
+ }
1012
+ },
1013
+ "500": {
1014
+ "description": "Internal Server Error",
1015
+ "schema": {
1016
+ "$ref": "#/definitions/Error"
1017
+ }
1018
+ }
1019
+ }
1020
+ },
1021
+ "put": {
1022
+ "operationId": "updateLogicalResource",
1023
+ "summary": "Updates a LogicalResource",
1024
+ "description": "This operation updates a LogicalResource entity.",
1025
+ "tags": [
1026
+ "logicalResource"
1027
+ ],
1028
+ "parameters": [
1029
+ {
1030
+ "name": "id",
1031
+ "description": "Identifier of the LogicalResource",
1032
+ "required": true,
1033
+ "type": "string",
1034
+ "in": "path"
1035
+ },
1036
+ {
1037
+ "name": "logicalResource",
1038
+ "description": "The LogicalResource to be updated",
1039
+ "required": true,
1040
+ "schema": {
1041
+ "$ref": "#/definitions/LogicalResource_Update"
1042
+ },
1043
+ "in": "body"
1044
+ }
1045
+ ],
1046
+ "responses": {
1047
+ "200": {
1048
+ "description": "Updated",
1049
+ "schema": {
1050
+ "$ref": "#/definitions/LogicalResource"
1051
+ }
1052
+ },
1053
+ "400": {
1054
+ "description": "Bad Request",
1055
+ "schema": {
1056
+ "$ref": "#/definitions/Error"
1057
+ }
1058
+ },
1059
+ "401": {
1060
+ "description": "Unauthorized",
1061
+ "schema": {
1062
+ "$ref": "#/definitions/Error"
1063
+ }
1064
+ },
1065
+ "403": {
1066
+ "description": "Forbidden",
1067
+ "schema": {
1068
+ "$ref": "#/definitions/Error"
1069
+ }
1070
+ },
1071
+ "404": {
1072
+ "description": "Not Found",
1073
+ "schema": {
1074
+ "$ref": "#/definitions/Error"
1075
+ }
1076
+ },
1077
+ "405": {
1078
+ "description": "Method Not allowed",
1079
+ "schema": {
1080
+ "$ref": "#/definitions/Error"
1081
+ }
1082
+ },
1083
+ "409": {
1084
+ "description": "Conflict",
1085
+ "schema": {
1086
+ "$ref": "#/definitions/Error"
1087
+ }
1088
+ },
1089
+ "500": {
1090
+ "description": "Internal Server Error",
1091
+ "schema": {
1092
+ "$ref": "#/definitions/Error"
1093
+ }
1094
+ }
1095
+ }
1096
+ },
1097
+ "patch": {
1098
+ "operationId": "patchLogicalResource",
1099
+ "summary": "Updates partially a LogicalResource",
1100
+ "description": "This operation updates partially a LogicalResource entity.",
1101
+ "tags": [
1102
+ "logicalResource"
1103
+ ],
1104
+ "parameters": [
1105
+ {
1106
+ "name": "id",
1107
+ "description": "Identifier of the LogicalResource",
1108
+ "required": true,
1109
+ "type": "string",
1110
+ "in": "path"
1111
+ },
1112
+ {
1113
+ "name": "logicalResource",
1114
+ "description": "The LogicalResource to be updated",
1115
+ "required": true,
1116
+ "schema": {
1117
+ "$ref": "#/definitions/LogicalResource_Update"
1118
+ },
1119
+ "in": "body"
1120
+ }
1121
+ ],
1122
+ "responses": {
1123
+ "200": {
1124
+ "description": "Updated",
1125
+ "schema": {
1126
+ "$ref": "#/definitions/LogicalResource"
1127
+ }
1128
+ },
1129
+ "400": {
1130
+ "description": "Bad Request",
1131
+ "schema": {
1132
+ "$ref": "#/definitions/Error"
1133
+ }
1134
+ },
1135
+ "401": {
1136
+ "description": "Unauthorized",
1137
+ "schema": {
1138
+ "$ref": "#/definitions/Error"
1139
+ }
1140
+ },
1141
+ "403": {
1142
+ "description": "Forbidden",
1143
+ "schema": {
1144
+ "$ref": "#/definitions/Error"
1145
+ }
1146
+ },
1147
+ "404": {
1148
+ "description": "Not Found",
1149
+ "schema": {
1150
+ "$ref": "#/definitions/Error"
1151
+ }
1152
+ },
1153
+ "405": {
1154
+ "description": "Method Not allowed",
1155
+ "schema": {
1156
+ "$ref": "#/definitions/Error"
1157
+ }
1158
+ },
1159
+ "409": {
1160
+ "description": "Conflict",
1161
+ "schema": {
1162
+ "$ref": "#/definitions/Error"
1163
+ }
1164
+ },
1165
+ "500": {
1166
+ "description": "Internal Server Error",
1167
+ "schema": {
1168
+ "$ref": "#/definitions/Error"
1169
+ }
1170
+ }
1171
+ }
1172
+ },
1173
+ "delete": {
1174
+ "operationId": "deleteLogicalResource",
1175
+ "summary": "Deletes a LogicalResource",
1176
+ "description": "This operation deletes a LogicalResource entity.",
1177
+ "tags": [
1178
+ "logicalResource"
1179
+ ],
1180
+ "parameters": [
1181
+ {
1182
+ "name": "id",
1183
+ "description": "Identifier of the LogicalResource",
1184
+ "required": true,
1185
+ "type": "string",
1186
+ "in": "path"
1187
+ }
1188
+ ],
1189
+ "responses": {
1190
+ "204": {
1191
+ "description": "Deleted"
1192
+ },
1193
+ "400": {
1194
+ "description": "Bad Request",
1195
+ "schema": {
1196
+ "$ref": "#/definitions/Error"
1197
+ }
1198
+ },
1199
+ "401": {
1200
+ "description": "Unauthorized",
1201
+ "schema": {
1202
+ "$ref": "#/definitions/Error"
1203
+ }
1204
+ },
1205
+ "403": {
1206
+ "description": "Forbidden",
1207
+ "schema": {
1208
+ "$ref": "#/definitions/Error"
1209
+ }
1210
+ },
1211
+ "404": {
1212
+ "description": "Not Found",
1213
+ "schema": {
1214
+ "$ref": "#/definitions/Error"
1215
+ }
1216
+ },
1217
+ "405": {
1218
+ "description": "Method Not allowed",
1219
+ "schema": {
1220
+ "$ref": "#/definitions/Error"
1221
+ }
1222
+ },
1223
+ "409": {
1224
+ "description": "Conflict",
1225
+ "schema": {
1226
+ "$ref": "#/definitions/Error"
1227
+ }
1228
+ },
1229
+ "500": {
1230
+ "description": "Internal Server Error",
1231
+ "schema": {
1232
+ "$ref": "#/definitions/Error"
1233
+ }
1234
+ }
1235
+ }
1236
+ }
1237
+ },
1238
+ "/hub": {
1239
+ "post": {
1240
+ "operationId": "registerListener",
1241
+ "summary": "Register a listener",
1242
+ "description": "Sets the communication endpoint address the service instance must use to deliver information about its health state, execution state, failures and metrics.",
1243
+ "tags": [
1244
+ "events subscription"
1245
+ ],
1246
+ "parameters": [
1247
+ {
1248
+ "name": "data",
1249
+ "schema": {
1250
+ "$ref": "#/definitions/EventSubscriptionInput"
1251
+ },
1252
+ "required": true,
1253
+ "in": "body",
1254
+ "description": "Data containing the callback endpoint to deliver the information"
1255
+ }
1256
+ ],
1257
+ "responses": {
1258
+ "201": {
1259
+ "description": "Subscribed",
1260
+ "schema": {
1261
+ "$ref": "#/definitions/EventSubscription"
1262
+ }
1263
+ },
1264
+ "400": {
1265
+ "description": "Bad Request",
1266
+ "schema": {
1267
+ "$ref": "#/definitions/Error"
1268
+ }
1269
+ },
1270
+ "401": {
1271
+ "description": "Unauthorized",
1272
+ "schema": {
1273
+ "$ref": "#/definitions/Error"
1274
+ }
1275
+ },
1276
+ "403": {
1277
+ "description": "Forbidden",
1278
+ "schema": {
1279
+ "$ref": "#/definitions/Error"
1280
+ }
1281
+ },
1282
+ "404": {
1283
+ "description": "Not Found",
1284
+ "schema": {
1285
+ "$ref": "#/definitions/Error"
1286
+ }
1287
+ },
1288
+ "405": {
1289
+ "description": "Method Not allowed",
1290
+ "schema": {
1291
+ "$ref": "#/definitions/Error"
1292
+ }
1293
+ },
1294
+ "409": {
1295
+ "description": "Conflict",
1296
+ "schema": {
1297
+ "$ref": "#/definitions/Error"
1298
+ }
1299
+ },
1300
+ "500": {
1301
+ "description": "Internal Server Error",
1302
+ "schema": {
1303
+ "$ref": "#/definitions/Error"
1304
+ }
1305
+ }
1306
+ }
1307
+ }
1308
+ },
1309
+ "/hub/{id}": {
1310
+ "delete": {
1311
+ "operationId": "unregisterListener",
1312
+ "summary": "Unregister a listener",
1313
+ "description": "Resets the communication endpoint address the service instance must use to deliver information about its health state, execution state, failures and metrics.",
1314
+ "tags": [
1315
+ "events subscription"
1316
+ ],
1317
+ "parameters": [
1318
+ {
1319
+ "name": "id",
1320
+ "type": "string",
1321
+ "required": true,
1322
+ "in": "path",
1323
+ "description": "The id of the registered listener"
1324
+ }
1325
+ ],
1326
+ "responses": {
1327
+ "204": {
1328
+ "description": "Deleted"
1329
+ },
1330
+ "400": {
1331
+ "description": "Bad request",
1332
+ "schema": {
1333
+ "$ref": "#/definitions/Error"
1334
+ }
1335
+ },
1336
+ "401": {
1337
+ "description": "Unauthorized",
1338
+ "schema": {
1339
+ "$ref": "#/definitions/Error"
1340
+ }
1341
+ },
1342
+ "403": {
1343
+ "description": "Forbidden",
1344
+ "schema": {
1345
+ "$ref": "#/definitions/Error"
1346
+ }
1347
+ },
1348
+ "404": {
1349
+ "description": "Not Found",
1350
+ "schema": {
1351
+ "$ref": "#/definitions/Error"
1352
+ }
1353
+ },
1354
+ "405": {
1355
+ "description": "Method not allowed",
1356
+ "schema": {
1357
+ "$ref": "#/definitions/Error"
1358
+ }
1359
+ },
1360
+ "500": {
1361
+ "description": "Internal Server Error",
1362
+ "schema": {
1363
+ "$ref": "#/definitions/Error"
1364
+ }
1365
+ }
1366
+ }
1367
+ }
1368
+ },
1369
+ "/listener/resourceCreateEvent": {
1370
+ "post": {
1371
+ "operationId": "listenToResourceCreateEvent",
1372
+ "summary": "Client listener for entity ResourceCreateEvent",
1373
+ "description": "Example of a client listener for receiving the notification ResourceCreateEvent",
1374
+ "tags": [
1375
+ "notification listeners (client side)"
1376
+ ],
1377
+ "parameters": [
1378
+ {
1379
+ "name": "data",
1380
+ "required": true,
1381
+ "in": "body",
1382
+ "description": "The event data",
1383
+ "schema": {
1384
+ "$ref": "#/definitions/ResourceCreateEvent"
1385
+ }
1386
+ }
1387
+ ],
1388
+ "responses": {
1389
+ "201": {
1390
+ "description": "Notified",
1391
+ "schema": {
1392
+ "$ref": "#/definitions/EventSubscription"
1393
+ }
1394
+ },
1395
+ "400": {
1396
+ "description": "Bad Request",
1397
+ "schema": {
1398
+ "$ref": "#/definitions/Error"
1399
+ }
1400
+ },
1401
+ "401": {
1402
+ "description": "Unauthorized",
1403
+ "schema": {
1404
+ "$ref": "#/definitions/Error"
1405
+ }
1406
+ },
1407
+ "403": {
1408
+ "description": "Forbidden",
1409
+ "schema": {
1410
+ "$ref": "#/definitions/Error"
1411
+ }
1412
+ },
1413
+ "404": {
1414
+ "description": "Not Found",
1415
+ "schema": {
1416
+ "$ref": "#/definitions/Error"
1417
+ }
1418
+ },
1419
+ "405": {
1420
+ "description": "Method Not allowed",
1421
+ "schema": {
1422
+ "$ref": "#/definitions/Error"
1423
+ }
1424
+ },
1425
+ "409": {
1426
+ "description": "Conflict",
1427
+ "schema": {
1428
+ "$ref": "#/definitions/Error"
1429
+ }
1430
+ },
1431
+ "500": {
1432
+ "description": "Internal Server Error",
1433
+ "schema": {
1434
+ "$ref": "#/definitions/Error"
1435
+ }
1436
+ }
1437
+ }
1438
+ }
1439
+ },
1440
+ "/listener/resourceAttributeValueChangeEvent": {
1441
+ "post": {
1442
+ "operationId": "listenToResourceAttributeValueChangeEvent",
1443
+ "summary": "Client listener for entity ResourceAttributeValueChangeEvent",
1444
+ "description": "Example of a client listener for receiving the notification ResourceAttributeValueChangeEvent",
1445
+ "tags": [
1446
+ "notification listeners (client side)"
1447
+ ],
1448
+ "parameters": [
1449
+ {
1450
+ "name": "data",
1451
+ "required": true,
1452
+ "in": "body",
1453
+ "description": "The event data",
1454
+ "schema": {
1455
+ "$ref": "#/definitions/ResourceAttributeValueChangeEvent"
1456
+ }
1457
+ }
1458
+ ],
1459
+ "responses": {
1460
+ "201": {
1461
+ "description": "Notified",
1462
+ "schema": {
1463
+ "$ref": "#/definitions/EventSubscription"
1464
+ }
1465
+ },
1466
+ "400": {
1467
+ "description": "Bad Request",
1468
+ "schema": {
1469
+ "$ref": "#/definitions/Error"
1470
+ }
1471
+ },
1472
+ "401": {
1473
+ "description": "Unauthorized",
1474
+ "schema": {
1475
+ "$ref": "#/definitions/Error"
1476
+ }
1477
+ },
1478
+ "403": {
1479
+ "description": "Forbidden",
1480
+ "schema": {
1481
+ "$ref": "#/definitions/Error"
1482
+ }
1483
+ },
1484
+ "404": {
1485
+ "description": "Not Found",
1486
+ "schema": {
1487
+ "$ref": "#/definitions/Error"
1488
+ }
1489
+ },
1490
+ "405": {
1491
+ "description": "Method Not allowed",
1492
+ "schema": {
1493
+ "$ref": "#/definitions/Error"
1494
+ }
1495
+ },
1496
+ "409": {
1497
+ "description": "Conflict",
1498
+ "schema": {
1499
+ "$ref": "#/definitions/Error"
1500
+ }
1501
+ },
1502
+ "500": {
1503
+ "description": "Internal Server Error",
1504
+ "schema": {
1505
+ "$ref": "#/definitions/Error"
1506
+ }
1507
+ }
1508
+ }
1509
+ }
1510
+ },
1511
+ "/listener/resourceStateChangeEvent": {
1512
+ "post": {
1513
+ "operationId": "listenToResourceStateChangeEvent",
1514
+ "summary": "Client listener for entity ResourceStateChangeEvent",
1515
+ "description": "Example of a client listener for receiving the notification ResourceStateChangeEvent",
1516
+ "tags": [
1517
+ "notification listeners (client side)"
1518
+ ],
1519
+ "parameters": [
1520
+ {
1521
+ "name": "data",
1522
+ "required": true,
1523
+ "in": "body",
1524
+ "description": "The event data",
1525
+ "schema": {
1526
+ "$ref": "#/definitions/ResourceStateChangeEvent"
1527
+ }
1528
+ }
1529
+ ],
1530
+ "responses": {
1531
+ "201": {
1532
+ "description": "Notified",
1533
+ "schema": {
1534
+ "$ref": "#/definitions/EventSubscription"
1535
+ }
1536
+ },
1537
+ "400": {
1538
+ "description": "Bad Request",
1539
+ "schema": {
1540
+ "$ref": "#/definitions/Error"
1541
+ }
1542
+ },
1543
+ "401": {
1544
+ "description": "Unauthorized",
1545
+ "schema": {
1546
+ "$ref": "#/definitions/Error"
1547
+ }
1548
+ },
1549
+ "403": {
1550
+ "description": "Forbidden",
1551
+ "schema": {
1552
+ "$ref": "#/definitions/Error"
1553
+ }
1554
+ },
1555
+ "404": {
1556
+ "description": "Not Found",
1557
+ "schema": {
1558
+ "$ref": "#/definitions/Error"
1559
+ }
1560
+ },
1561
+ "405": {
1562
+ "description": "Method Not allowed",
1563
+ "schema": {
1564
+ "$ref": "#/definitions/Error"
1565
+ }
1566
+ },
1567
+ "409": {
1568
+ "description": "Conflict",
1569
+ "schema": {
1570
+ "$ref": "#/definitions/Error"
1571
+ }
1572
+ },
1573
+ "500": {
1574
+ "description": "Internal Server Error",
1575
+ "schema": {
1576
+ "$ref": "#/definitions/Error"
1577
+ }
1578
+ }
1579
+ }
1580
+ }
1581
+ },
1582
+ "/listener/resourceDeleteEvent": {
1583
+ "post": {
1584
+ "operationId": "listenToResourceDeleteEvent",
1585
+ "summary": "Client listener for entity ResourceDeleteEvent",
1586
+ "description": "Example of a client listener for receiving the notification ResourceDeleteEvent",
1587
+ "tags": [
1588
+ "notification listeners (client side)"
1589
+ ],
1590
+ "parameters": [
1591
+ {
1592
+ "name": "data",
1593
+ "required": true,
1594
+ "in": "body",
1595
+ "description": "The event data",
1596
+ "schema": {
1597
+ "$ref": "#/definitions/ResourceDeleteEvent"
1598
+ }
1599
+ }
1600
+ ],
1601
+ "responses": {
1602
+ "201": {
1603
+ "description": "Notified",
1604
+ "schema": {
1605
+ "$ref": "#/definitions/EventSubscription"
1606
+ }
1607
+ },
1608
+ "400": {
1609
+ "description": "Bad Request",
1610
+ "schema": {
1611
+ "$ref": "#/definitions/Error"
1612
+ }
1613
+ },
1614
+ "401": {
1615
+ "description": "Unauthorized",
1616
+ "schema": {
1617
+ "$ref": "#/definitions/Error"
1618
+ }
1619
+ },
1620
+ "403": {
1621
+ "description": "Forbidden",
1622
+ "schema": {
1623
+ "$ref": "#/definitions/Error"
1624
+ }
1625
+ },
1626
+ "404": {
1627
+ "description": "Not Found",
1628
+ "schema": {
1629
+ "$ref": "#/definitions/Error"
1630
+ }
1631
+ },
1632
+ "405": {
1633
+ "description": "Method Not allowed",
1634
+ "schema": {
1635
+ "$ref": "#/definitions/Error"
1636
+ }
1637
+ },
1638
+ "409": {
1639
+ "description": "Conflict",
1640
+ "schema": {
1641
+ "$ref": "#/definitions/Error"
1642
+ }
1643
+ },
1644
+ "500": {
1645
+ "description": "Internal Server Error",
1646
+ "schema": {
1647
+ "$ref": "#/definitions/Error"
1648
+ }
1649
+ }
1650
+ }
1651
+ }
1652
+ },
1653
+ "/listener/physicalResourceCreateEvent": {
1654
+ "post": {
1655
+ "operationId": "listenToPhysicalResourceCreateEvent",
1656
+ "summary": "Client listener for entity PhysicalResourceCreateEvent",
1657
+ "description": "Example of a client listener for receiving the notification PhysicalResourceCreateEvent",
1658
+ "tags": [
1659
+ "notification listeners (client side)"
1660
+ ],
1661
+ "parameters": [
1662
+ {
1663
+ "name": "data",
1664
+ "required": true,
1665
+ "in": "body",
1666
+ "description": "The event data",
1667
+ "schema": {
1668
+ "$ref": "#/definitions/PhysicalResourceCreateEvent"
1669
+ }
1670
+ }
1671
+ ],
1672
+ "responses": {
1673
+ "201": {
1674
+ "description": "Notified",
1675
+ "schema": {
1676
+ "$ref": "#/definitions/EventSubscription"
1677
+ }
1678
+ },
1679
+ "400": {
1680
+ "description": "Bad Request",
1681
+ "schema": {
1682
+ "$ref": "#/definitions/Error"
1683
+ }
1684
+ },
1685
+ "401": {
1686
+ "description": "Unauthorized",
1687
+ "schema": {
1688
+ "$ref": "#/definitions/Error"
1689
+ }
1690
+ },
1691
+ "403": {
1692
+ "description": "Forbidden",
1693
+ "schema": {
1694
+ "$ref": "#/definitions/Error"
1695
+ }
1696
+ },
1697
+ "404": {
1698
+ "description": "Not Found",
1699
+ "schema": {
1700
+ "$ref": "#/definitions/Error"
1701
+ }
1702
+ },
1703
+ "405": {
1704
+ "description": "Method Not allowed",
1705
+ "schema": {
1706
+ "$ref": "#/definitions/Error"
1707
+ }
1708
+ },
1709
+ "409": {
1710
+ "description": "Conflict",
1711
+ "schema": {
1712
+ "$ref": "#/definitions/Error"
1713
+ }
1714
+ },
1715
+ "500": {
1716
+ "description": "Internal Server Error",
1717
+ "schema": {
1718
+ "$ref": "#/definitions/Error"
1719
+ }
1720
+ }
1721
+ }
1722
+ }
1723
+ },
1724
+ "/listener/physicalResourceAttributeValueChangeEvent": {
1725
+ "post": {
1726
+ "operationId": "listenToPhysicalResourceAttributeValueChangeEvent",
1727
+ "summary": "Client listener for entity PhysicalResourceAttributeValueChangeEvent",
1728
+ "description": "Example of a client listener for receiving the notification PhysicalResourceAttributeValueChangeEvent",
1729
+ "tags": [
1730
+ "notification listeners (client side)"
1731
+ ],
1732
+ "parameters": [
1733
+ {
1734
+ "name": "data",
1735
+ "required": true,
1736
+ "in": "body",
1737
+ "description": "The event data",
1738
+ "schema": {
1739
+ "$ref": "#/definitions/PhysicalResourceAttributeValueChangeEvent"
1740
+ }
1741
+ }
1742
+ ],
1743
+ "responses": {
1744
+ "201": {
1745
+ "description": "Notified",
1746
+ "schema": {
1747
+ "$ref": "#/definitions/EventSubscription"
1748
+ }
1749
+ },
1750
+ "400": {
1751
+ "description": "Bad Request",
1752
+ "schema": {
1753
+ "$ref": "#/definitions/Error"
1754
+ }
1755
+ },
1756
+ "401": {
1757
+ "description": "Unauthorized",
1758
+ "schema": {
1759
+ "$ref": "#/definitions/Error"
1760
+ }
1761
+ },
1762
+ "403": {
1763
+ "description": "Forbidden",
1764
+ "schema": {
1765
+ "$ref": "#/definitions/Error"
1766
+ }
1767
+ },
1768
+ "404": {
1769
+ "description": "Not Found",
1770
+ "schema": {
1771
+ "$ref": "#/definitions/Error"
1772
+ }
1773
+ },
1774
+ "405": {
1775
+ "description": "Method Not allowed",
1776
+ "schema": {
1777
+ "$ref": "#/definitions/Error"
1778
+ }
1779
+ },
1780
+ "409": {
1781
+ "description": "Conflict",
1782
+ "schema": {
1783
+ "$ref": "#/definitions/Error"
1784
+ }
1785
+ },
1786
+ "500": {
1787
+ "description": "Internal Server Error",
1788
+ "schema": {
1789
+ "$ref": "#/definitions/Error"
1790
+ }
1791
+ }
1792
+ }
1793
+ }
1794
+ },
1795
+ "/listener/physicalResourceStateChangeEvent": {
1796
+ "post": {
1797
+ "operationId": "listenToPhysicalResourceStateChangeEvent",
1798
+ "summary": "Client listener for entity PhysicalResourceStateChangeEvent",
1799
+ "description": "Example of a client listener for receiving the notification PhysicalResourceStateChangeEvent",
1800
+ "tags": [
1801
+ "notification listeners (client side)"
1802
+ ],
1803
+ "parameters": [
1804
+ {
1805
+ "name": "data",
1806
+ "required": true,
1807
+ "in": "body",
1808
+ "description": "The event data",
1809
+ "schema": {
1810
+ "$ref": "#/definitions/PhysicalResourceStateChangeEvent"
1811
+ }
1812
+ }
1813
+ ],
1814
+ "responses": {
1815
+ "201": {
1816
+ "description": "Notified",
1817
+ "schema": {
1818
+ "$ref": "#/definitions/EventSubscription"
1819
+ }
1820
+ },
1821
+ "400": {
1822
+ "description": "Bad Request",
1823
+ "schema": {
1824
+ "$ref": "#/definitions/Error"
1825
+ }
1826
+ },
1827
+ "401": {
1828
+ "description": "Unauthorized",
1829
+ "schema": {
1830
+ "$ref": "#/definitions/Error"
1831
+ }
1832
+ },
1833
+ "403": {
1834
+ "description": "Forbidden",
1835
+ "schema": {
1836
+ "$ref": "#/definitions/Error"
1837
+ }
1838
+ },
1839
+ "404": {
1840
+ "description": "Not Found",
1841
+ "schema": {
1842
+ "$ref": "#/definitions/Error"
1843
+ }
1844
+ },
1845
+ "405": {
1846
+ "description": "Method Not allowed",
1847
+ "schema": {
1848
+ "$ref": "#/definitions/Error"
1849
+ }
1850
+ },
1851
+ "409": {
1852
+ "description": "Conflict",
1853
+ "schema": {
1854
+ "$ref": "#/definitions/Error"
1855
+ }
1856
+ },
1857
+ "500": {
1858
+ "description": "Internal Server Error",
1859
+ "schema": {
1860
+ "$ref": "#/definitions/Error"
1861
+ }
1862
+ }
1863
+ }
1864
+ }
1865
+ },
1866
+ "/listener/physicalResourceDeleteEvent": {
1867
+ "post": {
1868
+ "operationId": "listenToPhysicalResourceDeleteEvent",
1869
+ "summary": "Client listener for entity PhysicalResourceDeleteEvent",
1870
+ "description": "Example of a client listener for receiving the notification PhysicalResourceDeleteEvent",
1871
+ "tags": [
1872
+ "notification listeners (client side)"
1873
+ ],
1874
+ "parameters": [
1875
+ {
1876
+ "name": "data",
1877
+ "required": true,
1878
+ "in": "body",
1879
+ "description": "The event data",
1880
+ "schema": {
1881
+ "$ref": "#/definitions/PhysicalResourceDeleteEvent"
1882
+ }
1883
+ }
1884
+ ],
1885
+ "responses": {
1886
+ "201": {
1887
+ "description": "Notified",
1888
+ "schema": {
1889
+ "$ref": "#/definitions/EventSubscription"
1890
+ }
1891
+ },
1892
+ "400": {
1893
+ "description": "Bad Request",
1894
+ "schema": {
1895
+ "$ref": "#/definitions/Error"
1896
+ }
1897
+ },
1898
+ "401": {
1899
+ "description": "Unauthorized",
1900
+ "schema": {
1901
+ "$ref": "#/definitions/Error"
1902
+ }
1903
+ },
1904
+ "403": {
1905
+ "description": "Forbidden",
1906
+ "schema": {
1907
+ "$ref": "#/definitions/Error"
1908
+ }
1909
+ },
1910
+ "404": {
1911
+ "description": "Not Found",
1912
+ "schema": {
1913
+ "$ref": "#/definitions/Error"
1914
+ }
1915
+ },
1916
+ "405": {
1917
+ "description": "Method Not allowed",
1918
+ "schema": {
1919
+ "$ref": "#/definitions/Error"
1920
+ }
1921
+ },
1922
+ "409": {
1923
+ "description": "Conflict",
1924
+ "schema": {
1925
+ "$ref": "#/definitions/Error"
1926
+ }
1927
+ },
1928
+ "500": {
1929
+ "description": "Internal Server Error",
1930
+ "schema": {
1931
+ "$ref": "#/definitions/Error"
1932
+ }
1933
+ }
1934
+ }
1935
+ }
1936
+ }
1937
+ },
1938
+ "definitions": {
1939
+ "Any": {},
1940
+ "Attachment": {
1941
+ "type": "object",
1942
+ "description": "Complements the description of an element (for instance a product) through video, pictures...",
1943
+ "properties": {
1944
+ "id": {
1945
+ "type": "string",
1946
+ "description": "Unique identifier for this particular attachment"
1947
+ },
1948
+ "href": {
1949
+ "type": "string",
1950
+ "description": "URI for this Attachment"
1951
+ },
1952
+ "attachmentType": {
1953
+ "type": "string",
1954
+ "description": "Attachment type such as video, picture"
1955
+ },
1956
+ "content": {
1957
+ "type": "string",
1958
+ "description": "The actual contents of the attachment object, if embedded, encoded as base64"
1959
+ },
1960
+ "description": {
1961
+ "type": "string",
1962
+ "description": "A narrative text describing the content of the attachment"
1963
+ },
1964
+ "mimeType": {
1965
+ "type": "string",
1966
+ "description": "Attachment mime type such as extension file for video, picture and document"
1967
+ },
1968
+ "name": {
1969
+ "type": "string",
1970
+ "description": "The name of the attachment"
1971
+ },
1972
+ "url": {
1973
+ "type": "string",
1974
+ "description": "Uniform Resource Locator, is a web page address (a subset of URI)"
1975
+ },
1976
+ "size": {
1977
+ "$ref": "#/definitions/Quantity",
1978
+ "description": "The size of the attachment."
1979
+ },
1980
+ "validFor": {
1981
+ "$ref": "#/definitions/TimePeriod",
1982
+ "description": "The period of time for which the attachment is valid"
1983
+ },
1984
+ "@baseType": {
1985
+ "type": "string",
1986
+ "description": "When sub-classing, this defines the super-class"
1987
+ },
1988
+ "@schemaLocation": {
1989
+ "type": "string",
1990
+ "format": "uri",
1991
+ "description": "A URI to a JSON-Schema file that defines additional attributes and relationships"
1992
+ },
1993
+ "@type": {
1994
+ "type": "string",
1995
+ "description": "When sub-classing, this defines the sub-class entity name"
1996
+ }
1997
+ }
1998
+ },
1999
+ "AttachmentRef": {
2000
+ "type": "object",
2001
+ "description": "Attachment reference. An attachment complements the description of an element (for instance a product) through video, pictures",
2002
+ "properties": {
2003
+ "id": {
2004
+ "type": "string",
2005
+ "description": "Unique-Identifier for this attachment"
2006
+ },
2007
+ "href": {
2008
+ "type": "string",
2009
+ "description": "URL serving as reference for the attachment resource"
2010
+ },
2011
+ "description": {
2012
+ "type": "string",
2013
+ "description": "A narrative text describing the content of the attachment"
2014
+ },
2015
+ "name": {
2016
+ "type": "string",
2017
+ "description": "Name of the related entity."
2018
+ },
2019
+ "url": {
2020
+ "type": "string",
2021
+ "description": "Link to the attachment media/content"
2022
+ },
2023
+ "@baseType": {
2024
+ "type": "string",
2025
+ "description": "When sub-classing, this defines the super-class"
2026
+ },
2027
+ "@schemaLocation": {
2028
+ "type": "string",
2029
+ "format": "uri",
2030
+ "description": "A URI to a JSON-Schema file that defines additional attributes and relationships"
2031
+ },
2032
+ "@type": {
2033
+ "type": "string",
2034
+ "description": "When sub-classing, this defines the sub-class entity name"
2035
+ },
2036
+ "@referredType": {
2037
+ "type": "string",
2038
+ "description": "The actual type of the target instance when needed for disambiguation."
2039
+ }
2040
+ },
2041
+ "required": [
2042
+ "id"
2043
+ ]
2044
+ },
2045
+ "AttachmentRefOrValue": {
2046
+ "type": "object",
2047
+ "description": "An attachment by value or by reference. For AttachmentRefOrValue, the attribute type,schemaLocation and referredType are related to the contained entity and not to AttchmentRefOrValue itself",
2048
+ "properties": {
2049
+ "id": {
2050
+ "type": "string",
2051
+ "description": "Unique identifier for this particular attachment"
2052
+ },
2053
+ "href": {
2054
+ "type": "string",
2055
+ "description": "URI for this Attachment"
2056
+ },
2057
+ "attachmentType": {
2058
+ "type": "string",
2059
+ "description": "Attachment type such as video, picture"
2060
+ },
2061
+ "content": {
2062
+ "type": "string",
2063
+ "description": "The actual contents of the attachment object, if embedded, encoded as base64"
2064
+ },
2065
+ "description": {
2066
+ "type": "string",
2067
+ "description": "A narrative text describing the content of the attachment"
2068
+ },
2069
+ "mimeType": {
2070
+ "type": "string",
2071
+ "description": "Attachment mime type such as extension file for video, picture and document"
2072
+ },
2073
+ "name": {
2074
+ "type": "string",
2075
+ "description": "The name of the attachment"
2076
+ },
2077
+ "url": {
2078
+ "type": "string",
2079
+ "description": "Uniform Resource Locator, is a web page address (a subset of URI)"
2080
+ },
2081
+ "size": {
2082
+ "$ref": "#/definitions/Quantity",
2083
+ "description": "The size of the attachment."
2084
+ },
2085
+ "validFor": {
2086
+ "$ref": "#/definitions/TimePeriod",
2087
+ "description": "The period of time for which the attachment is valid"
2088
+ },
2089
+ "@baseType": {
2090
+ "type": "string",
2091
+ "description": "When sub-classing, this defines the super-class"
2092
+ },
2093
+ "@schemaLocation": {
2094
+ "type": "string",
2095
+ "format": "uri",
2096
+ "description": "A URI to a JSON-Schema file that defines additional attributes and relationships"
2097
+ },
2098
+ "@type": {
2099
+ "type": "string",
2100
+ "description": "When sub-classing, this defines the sub-class entity name"
2101
+ },
2102
+ "@referredType": {
2103
+ "type": "string",
2104
+ "description": "The actual type of the target instance when needed for disambiguation."
2105
+ }
2106
+ }
2107
+ },
2108
+ "Characteristic": {
2109
+ "type": "object",
2110
+ "description": "Describes a given characteristic of an object or entity through a name/value pair.",
2111
+ "required": [
2112
+ "name",
2113
+ "value"
2114
+ ],
2115
+ "properties": {
2116
+ "id": {
2117
+ "type": "string",
2118
+ "description": "Unique identifier of the characteristic"
2119
+ },
2120
+ "name": {
2121
+ "type": "string",
2122
+ "description": "Name of the characteristic"
2123
+ },
2124
+ "valueType": {
2125
+ "type": "string",
2126
+ "description": "Data type of the value of the characteristic"
2127
+ },
2128
+ "characteristicRelationship": {
2129
+ "type": "array",
2130
+ "items": {
2131
+ "$ref": "#/definitions/CharacteristicRelationship"
2132
+ }
2133
+ },
2134
+ "value": {
2135
+ "$ref": "#/definitions/Any",
2136
+ "description": "The value of the characteristic"
2137
+ },
2138
+ "@baseType": {
2139
+ "type": "string",
2140
+ "description": "When sub-classing, this defines the super-class"
2141
+ },
2142
+ "@schemaLocation": {
2143
+ "type": "string",
2144
+ "format": "uri",
2145
+ "description": "A URI to a JSON-Schema file that defines additional attributes and relationships"
2146
+ },
2147
+ "@type": {
2148
+ "type": "string",
2149
+ "description": "When sub-classing, this defines the sub-class entity name"
2150
+ }
2151
+ }
2152
+ },
2153
+ "CharacteristicRelationship": {
2154
+ "type": "object",
2155
+ "description": "Another Characteristic that is related to the current Characteristic;",
2156
+ "properties": {
2157
+ "id": {
2158
+ "type": "string",
2159
+ "description": "Unique identifier of the characteristic"
2160
+ },
2161
+ "relationshipType": {
2162
+ "type": "string",
2163
+ "description": "The type of relationship"
2164
+ },
2165
+ "@baseType": {
2166
+ "type": "string",
2167
+ "description": "When sub-classing, this defines the super-class"
2168
+ },
2169
+ "@schemaLocation": {
2170
+ "type": "string",
2171
+ "format": "uri",
2172
+ "description": "A URI to a JSON-Schema file that defines additional attributes and relationships"
2173
+ },
2174
+ "@type": {
2175
+ "type": "string",
2176
+ "description": "When sub-classing, this defines the sub-class entity name"
2177
+ }
2178
+ }
2179
+ },
2180
+ "EntityRef": {
2181
+ "type": "object",
2182
+ "description": "Entity reference schema to be use for all entityRef class.",
2183
+ "properties": {
2184
+ "id": {
2185
+ "type": "string",
2186
+ "description": "Unique identifier of a related entity."
2187
+ },
2188
+ "href": {
2189
+ "type": "string",
2190
+ "description": "Reference of the related entity."
2191
+ },
2192
+ "name": {
2193
+ "type": "string",
2194
+ "description": "Name of the related entity."
2195
+ },
2196
+ "@baseType": {
2197
+ "type": "string",
2198
+ "description": "When sub-classing, this defines the super-class"
2199
+ },
2200
+ "@schemaLocation": {
2201
+ "type": "string",
2202
+ "format": "uri",
2203
+ "description": "A URI to a JSON-Schema file that defines additional attributes and relationships"
2204
+ },
2205
+ "@type": {
2206
+ "type": "string",
2207
+ "description": "When sub-classing, this defines the sub-class entity name"
2208
+ },
2209
+ "@referredType": {
2210
+ "type": "string",
2211
+ "description": "The actual type of the target instance when needed for disambiguation."
2212
+ }
2213
+ },
2214
+ "required": [
2215
+ "id"
2216
+ ]
2217
+ },
2218
+ "LogicalResource": {
2219
+ "type": "object",
2220
+ "description": "Logic resource is a type of resource that describes the common set of attributes shared by all concrete logical resources (e.g. TPE, MSISDN, IP Addresses) in the inventory.",
2221
+ "required": [
2222
+ "href",
2223
+ "id"
2224
+ ],
2225
+ "properties": {
2226
+ "id": {
2227
+ "type": "string",
2228
+ "description": "Identifier of an instance of the resource. Required to be unique within the resource type. Used in URIs as the identifier for specific instances of a type."
2229
+ },
2230
+ "href": {
2231
+ "type": "string",
2232
+ "description": "The URI for the object itself."
2233
+ },
2234
+ "category": {
2235
+ "type": "string",
2236
+ "description": "Category of the concrete resource. e.g Gold, Silver for MSISDN concrete resource"
2237
+ },
2238
+ "description": {
2239
+ "type": "string",
2240
+ "description": "free-text description of the resource"
2241
+ },
2242
+ "endOperatingDate": {
2243
+ "type": "string",
2244
+ "format": "date-time",
2245
+ "description": "A date time( DateTime). The date till the resource is operating"
2246
+ },
2247
+ "name": {
2248
+ "type": "string",
2249
+ "description": "A string used to give a name to the resource"
2250
+ },
2251
+ "resourceVersion": {
2252
+ "type": "string",
2253
+ "description": "A field that identifies the specific version of an instance of a resource."
2254
+ },
2255
+ "startOperatingDate": {
2256
+ "type": "string",
2257
+ "format": "date-time",
2258
+ "description": "A date time( DateTime). The date from which the resource is operating"
2259
+ },
2260
+ "value": {
2261
+ "type": "string",
2262
+ "description": "the value of the logical resource. E.g '0746712345' for MSISDN's"
2263
+ },
2264
+ "administrativeState": {
2265
+ "$ref": "#/definitions/ResourceAdministrativeStateType",
2266
+ "description": "Tracks the lifecycle status of the resource, such as planning, installing, opereating, retiring and so on."
2267
+ },
2268
+ "attachment": {
2269
+ "type": "array",
2270
+ "items": {
2271
+ "$ref": "#/definitions/AttachmentRefOrValue"
2272
+ }
2273
+ },
2274
+ "note": {
2275
+ "type": "array",
2276
+ "items": {
2277
+ "$ref": "#/definitions/Note"
2278
+ }
2279
+ },
2280
+ "operationalState": {
2281
+ "$ref": "#/definitions/ResourceOperationalStateType",
2282
+ "description": "Tracks the lifecycle status of the resource, such as planning, installing, opereating, retiring and so on."
2283
+ },
2284
+ "place": {
2285
+ "$ref": "#/definitions/RelatedPlaceRefOrValue"
2286
+ },
2287
+ "relatedParty": {
2288
+ "type": "array",
2289
+ "items": {
2290
+ "$ref": "#/definitions/RelatedParty"
2291
+ }
2292
+ },
2293
+ "resourceCharacteristic": {
2294
+ "type": "array",
2295
+ "items": {
2296
+ "$ref": "#/definitions/Characteristic"
2297
+ }
2298
+ },
2299
+ "resourceRelationship": {
2300
+ "type": "array",
2301
+ "items": {
2302
+ "$ref": "#/definitions/ResourceRelationship"
2303
+ }
2304
+ },
2305
+ "resourceSpecification": {
2306
+ "$ref": "#/definitions/ResourceSpecificationRef"
2307
+ },
2308
+ "resourceStatus": {
2309
+ "$ref": "#/definitions/ResourceStatusType",
2310
+ "description": "Tracks the lifecycle status of the resource, such as planning, installing, opereating, retiring and so on."
2311
+ },
2312
+ "usageState": {
2313
+ "$ref": "#/definitions/ResourceUsageStateType",
2314
+ "description": "Tracks the lifecycle status of the resource, such as planning, installing, opereating, retiring and so on."
2315
+ },
2316
+ "@baseType": {
2317
+ "type": "string",
2318
+ "description": "When sub-classing, this defines the super-class"
2319
+ },
2320
+ "@schemaLocation": {
2321
+ "type": "string",
2322
+ "format": "uri",
2323
+ "description": "A URI to a JSON-Schema file that defines additional attributes and relationships"
2324
+ },
2325
+ "@type": {
2326
+ "type": "string",
2327
+ "description": "When sub-classing, this defines the sub-class entity name"
2328
+ },
2329
+ "@referredType": {
2330
+ "type": "string",
2331
+ "description": "The actual type of the target instance when needed for disambiguation."
2332
+ }
2333
+ }
2334
+ },
2335
+ "LogicalResource_Create": {
2336
+ "type": "object",
2337
+ "description": "Logic resource is a type of resource that describes the common set of attributes shared by all concrete logical resources (e.g. TPE, MSISDN, IP Addresses) in the inventory.\nSkipped properties: id,href",
2338
+ "properties": {
2339
+ "category": {
2340
+ "type": "string",
2341
+ "description": "Category of the concrete resource. e.g Gold, Silver for MSISDN concrete resource"
2342
+ },
2343
+ "description": {
2344
+ "type": "string",
2345
+ "description": "free-text description of the resource"
2346
+ },
2347
+ "endOperatingDate": {
2348
+ "type": "string",
2349
+ "format": "date-time",
2350
+ "description": "A date time( DateTime). The date till the resource is operating"
2351
+ },
2352
+ "name": {
2353
+ "type": "string",
2354
+ "description": "A string used to give a name to the resource"
2355
+ },
2356
+ "resourceVersion": {
2357
+ "type": "string",
2358
+ "description": "A field that identifies the specific version of an instance of a resource."
2359
+ },
2360
+ "startOperatingDate": {
2361
+ "type": "string",
2362
+ "format": "date-time",
2363
+ "description": "A date time( DateTime). The date from which the resource is operating"
2364
+ },
2365
+ "value": {
2366
+ "type": "string",
2367
+ "description": "the value of the logical resource. E.g '0746712345' for MSISDN's"
2368
+ },
2369
+ "administrativeState": {
2370
+ "$ref": "#/definitions/ResourceAdministrativeStateType",
2371
+ "description": "Tracks the lifecycle status of the resource, such as planning, installing, opereating, retiring and so on."
2372
+ },
2373
+ "attachment": {
2374
+ "type": "array",
2375
+ "items": {
2376
+ "$ref": "#/definitions/AttachmentRefOrValue"
2377
+ }
2378
+ },
2379
+ "note": {
2380
+ "type": "array",
2381
+ "items": {
2382
+ "$ref": "#/definitions/Note"
2383
+ }
2384
+ },
2385
+ "operationalState": {
2386
+ "$ref": "#/definitions/ResourceOperationalStateType",
2387
+ "description": "Tracks the lifecycle status of the resource, such as planning, installing, opereating, retiring and so on."
2388
+ },
2389
+ "place": {
2390
+ "$ref": "#/definitions/RelatedPlaceRefOrValue"
2391
+ },
2392
+ "relatedParty": {
2393
+ "type": "array",
2394
+ "items": {
2395
+ "$ref": "#/definitions/RelatedParty"
2396
+ }
2397
+ },
2398
+ "resourceCharacteristic": {
2399
+ "type": "array",
2400
+ "items": {
2401
+ "$ref": "#/definitions/Characteristic"
2402
+ }
2403
+ },
2404
+ "resourceRelationship": {
2405
+ "type": "array",
2406
+ "items": {
2407
+ "$ref": "#/definitions/ResourceRelationship"
2408
+ }
2409
+ },
2410
+ "resourceSpecification": {
2411
+ "$ref": "#/definitions/ResourceSpecificationRef"
2412
+ },
2413
+ "resourceStatus": {
2414
+ "$ref": "#/definitions/ResourceStatusType",
2415
+ "description": "Tracks the lifecycle status of the resource, such as planning, installing, opereating, retiring and so on."
2416
+ },
2417
+ "usageState": {
2418
+ "$ref": "#/definitions/ResourceUsageStateType",
2419
+ "description": "Tracks the lifecycle status of the resource, such as planning, installing, opereating, retiring and so on."
2420
+ },
2421
+ "@baseType": {
2422
+ "type": "string",
2423
+ "description": "When sub-classing, this defines the super-class"
2424
+ },
2425
+ "@schemaLocation": {
2426
+ "type": "string",
2427
+ "format": "uri",
2428
+ "description": "A URI to a JSON-Schema file that defines additional attributes and relationships"
2429
+ },
2430
+ "@type": {
2431
+ "type": "string",
2432
+ "description": "When sub-classing, this defines the sub-class entity name"
2433
+ },
2434
+ "@referredType": {
2435
+ "type": "string",
2436
+ "description": "The actual type of the target instance when needed for disambiguation."
2437
+ }
2438
+ }
2439
+ },
2440
+ "LogicalResource_Update": {
2441
+ "type": "object",
2442
+ "description": "Logic resource is a type of resource that describes the common set of attributes shared by all concrete logical resources (e.g. TPE, MSISDN, IP Addresses) in the inventory.\nSkipped properties: id,href",
2443
+ "properties": {
2444
+ "category": {
2445
+ "type": "string",
2446
+ "description": "Category of the concrete resource. e.g Gold, Silver for MSISDN concrete resource"
2447
+ },
2448
+ "description": {
2449
+ "type": "string",
2450
+ "description": "free-text description of the resource"
2451
+ },
2452
+ "endOperatingDate": {
2453
+ "type": "string",
2454
+ "format": "date-time",
2455
+ "description": "A date time( DateTime). The date till the resource is operating"
2456
+ },
2457
+ "name": {
2458
+ "type": "string",
2459
+ "description": "A string used to give a name to the resource"
2460
+ },
2461
+ "resourceVersion": {
2462
+ "type": "string",
2463
+ "description": "A field that identifies the specific version of an instance of a resource."
2464
+ },
2465
+ "startOperatingDate": {
2466
+ "type": "string",
2467
+ "format": "date-time",
2468
+ "description": "A date time( DateTime). The date from which the resource is operating"
2469
+ },
2470
+ "value": {
2471
+ "type": "string",
2472
+ "description": "the value of the logical resource. E.g '0746712345' for MSISDN's"
2473
+ },
2474
+ "administrativeState": {
2475
+ "$ref": "#/definitions/ResourceAdministrativeStateType",
2476
+ "description": "Tracks the lifecycle status of the resource, such as planning, installing, opereating, retiring and so on."
2477
+ },
2478
+ "attachment": {
2479
+ "type": "array",
2480
+ "items": {
2481
+ "$ref": "#/definitions/AttachmentRefOrValue"
2482
+ }
2483
+ },
2484
+ "note": {
2485
+ "type": "array",
2486
+ "items": {
2487
+ "$ref": "#/definitions/Note"
2488
+ }
2489
+ },
2490
+ "operationalState": {
2491
+ "$ref": "#/definitions/ResourceOperationalStateType",
2492
+ "description": "Tracks the lifecycle status of the resource, such as planning, installing, opereating, retiring and so on."
2493
+ },
2494
+ "place": {
2495
+ "$ref": "#/definitions/RelatedPlaceRefOrValue"
2496
+ },
2497
+ "relatedParty": {
2498
+ "type": "array",
2499
+ "items": {
2500
+ "$ref": "#/definitions/RelatedParty"
2501
+ }
2502
+ },
2503
+ "resourceCharacteristic": {
2504
+ "type": "array",
2505
+ "items": {
2506
+ "$ref": "#/definitions/Characteristic"
2507
+ }
2508
+ },
2509
+ "resourceRelationship": {
2510
+ "type": "array",
2511
+ "items": {
2512
+ "$ref": "#/definitions/ResourceRelationship"
2513
+ }
2514
+ },
2515
+ "resourceSpecification": {
2516
+ "$ref": "#/definitions/ResourceSpecificationRef"
2517
+ },
2518
+ "resourceStatus": {
2519
+ "$ref": "#/definitions/ResourceStatusType",
2520
+ "description": "Tracks the lifecycle status of the resource, such as planning, installing, opereating, retiring and so on."
2521
+ },
2522
+ "usageState": {
2523
+ "$ref": "#/definitions/ResourceUsageStateType",
2524
+ "description": "Tracks the lifecycle status of the resource, such as planning, installing, opereating, retiring and so on."
2525
+ },
2526
+ "@baseType": {
2527
+ "type": "string",
2528
+ "description": "When sub-classing, this defines the super-class"
2529
+ },
2530
+ "@schemaLocation": {
2531
+ "type": "string",
2532
+ "format": "uri",
2533
+ "description": "A URI to a JSON-Schema file that defines additional attributes and relationships"
2534
+ },
2535
+ "@type": {
2536
+ "type": "string",
2537
+ "description": "When sub-classing, this defines the sub-class entity name"
2538
+ },
2539
+ "@referredType": {
2540
+ "type": "string",
2541
+ "description": "The actual type of the target instance when needed for disambiguation."
2542
+ }
2543
+ }
2544
+ },
2545
+ "Note": {
2546
+ "type": "object",
2547
+ "description": "Extra information about a given entity",
2548
+ "properties": {
2549
+ "id": {
2550
+ "type": "string",
2551
+ "description": "Identifier of the note within its containing entity (may or may not be globally unique, depending on provider implementation)"
2552
+ },
2553
+ "author": {
2554
+ "type": "string",
2555
+ "description": "Author of the note"
2556
+ },
2557
+ "date": {
2558
+ "type": "string",
2559
+ "format": "date-time",
2560
+ "description": "Date of the note"
2561
+ },
2562
+ "text": {
2563
+ "type": "string",
2564
+ "description": "Text of the note"
2565
+ },
2566
+ "@baseType": {
2567
+ "type": "string",
2568
+ "description": "When sub-classing, this defines the super-class"
2569
+ },
2570
+ "@schemaLocation": {
2571
+ "type": "string",
2572
+ "format": "uri",
2573
+ "description": "A URI to a JSON-Schema file that defines additional attributes and relationships"
2574
+ },
2575
+ "@type": {
2576
+ "type": "string",
2577
+ "description": "When sub-classing, this defines the sub-class entity name"
2578
+ }
2579
+ }
2580
+ },
2581
+ "PhysicalResource": {
2582
+ "type": "object",
2583
+ "description": "Physical resource is a type of resource that describes the common set of attributes shared by all concrete physical resources (e.g. EQUIPMENT) in the inventory.",
2584
+ "required": [
2585
+ "href",
2586
+ "id"
2587
+ ],
2588
+ "properties": {
2589
+ "id": {
2590
+ "type": "string",
2591
+ "description": "Identifier of an instance of the resource. Required to be unique within the resource type. Used in URIs as the identifier for specific instances of a type."
2592
+ },
2593
+ "href": {
2594
+ "type": "string",
2595
+ "description": "The URI for the object itself."
2596
+ },
2597
+ "category": {
2598
+ "type": "string",
2599
+ "description": "Category of the concrete resource. e.g Gold, Silver for MSISDN concrete resource"
2600
+ },
2601
+ "description": {
2602
+ "type": "string",
2603
+ "description": "free-text description of the resource"
2604
+ },
2605
+ "endOperatingDate": {
2606
+ "type": "string",
2607
+ "format": "date-time",
2608
+ "description": "A date time( DateTime). The date till the resource is operating"
2609
+ },
2610
+ "manufactureDate": {
2611
+ "type": "string",
2612
+ "format": "date-time",
2613
+ "description": "This is a string attribute that defines the date of manufacture of this item in the fixed format \"dd/mm/yyyy\". This is an optional attribute."
2614
+ },
2615
+ "name": {
2616
+ "type": "string",
2617
+ "description": "A string used to give a name to the resource"
2618
+ },
2619
+ "powerState": {
2620
+ "type": "string",
2621
+ "description": "This defines the current power status of the hardware item. Values include:\n\n 0: Unknown\n 1: Not Applicable\n 2: No Power Applied\n 3: Full Power Applied\n 4: Power Save - Normal\n 5: Power Save - Degraded\n 6: Power Save - Standby\n 7: Power Save - Critical\n 8: Power Save - Low Power Mode\n 9: Power Save - Unknown\n 10: Power Cycle\n 11: Power Warning\n 12: Power Off"
2622
+ },
2623
+ "resourceVersion": {
2624
+ "type": "string",
2625
+ "description": "A field that identifies the specific version of an instance of a resource."
2626
+ },
2627
+ "serialNumber": {
2628
+ "type": "string",
2629
+ "description": "This is a string that represents a manufacturer-allocated number used to identify different instances of the same hardware item. The ModelNumber and PartNumber attributes are used to identify different types of hardware items. This is a REQUIRED attribute."
2630
+ },
2631
+ "startOperatingDate": {
2632
+ "type": "string",
2633
+ "format": "date-time",
2634
+ "description": "A date time( DateTime). The date from which the resource is operating"
2635
+ },
2636
+ "versionNumber": {
2637
+ "type": "string",
2638
+ "description": "This is a string that identifies the version of this physical resource. This is an optional attribute."
2639
+ },
2640
+ "administrativeState": {
2641
+ "$ref": "#/definitions/ResourceAdministrativeStateType",
2642
+ "description": "Tracks the lifecycle status of the resource, such as planning, installing, opereating, retiring and so on."
2643
+ },
2644
+ "attachment": {
2645
+ "type": "array",
2646
+ "items": {
2647
+ "$ref": "#/definitions/AttachmentRefOrValue"
2648
+ }
2649
+ },
2650
+ "note": {
2651
+ "type": "array",
2652
+ "items": {
2653
+ "$ref": "#/definitions/Note"
2654
+ }
2655
+ },
2656
+ "operationalState": {
2657
+ "$ref": "#/definitions/ResourceOperationalStateType",
2658
+ "description": "Tracks the lifecycle status of the resource, such as planning, installing, opereating, retiring and so on."
2659
+ },
2660
+ "place": {
2661
+ "$ref": "#/definitions/RelatedPlaceRefOrValue"
2662
+ },
2663
+ "relatedParty": {
2664
+ "type": "array",
2665
+ "items": {
2666
+ "$ref": "#/definitions/RelatedParty"
2667
+ }
2668
+ },
2669
+ "resourceCharacteristic": {
2670
+ "type": "array",
2671
+ "items": {
2672
+ "$ref": "#/definitions/Characteristic"
2673
+ }
2674
+ },
2675
+ "resourceRelationship": {
2676
+ "type": "array",
2677
+ "items": {
2678
+ "$ref": "#/definitions/ResourceRelationship"
2679
+ }
2680
+ },
2681
+ "resourceSpecification": {
2682
+ "$ref": "#/definitions/ResourceSpecificationRef"
2683
+ },
2684
+ "resourceStatus": {
2685
+ "$ref": "#/definitions/ResourceStatusType",
2686
+ "description": "Tracks the lifecycle status of the resource, such as planning, installing, opereating, retiring and so on."
2687
+ },
2688
+ "usageState": {
2689
+ "$ref": "#/definitions/ResourceUsageStateType",
2690
+ "description": "Tracks the lifecycle status of the resource, such as planning, installing, opereating, retiring and so on."
2691
+ },
2692
+ "@baseType": {
2693
+ "type": "string",
2694
+ "description": "When sub-classing, this defines the super-class"
2695
+ },
2696
+ "@schemaLocation": {
2697
+ "type": "string",
2698
+ "format": "uri",
2699
+ "description": "A URI to a JSON-Schema file that defines additional attributes and relationships"
2700
+ },
2701
+ "@type": {
2702
+ "type": "string",
2703
+ "description": "When sub-classing, this defines the sub-class entity name"
2704
+ },
2705
+ "@referredType": {
2706
+ "type": "string",
2707
+ "description": "The actual type of the target instance when needed for disambiguation."
2708
+ }
2709
+ }
2710
+ },
2711
+ "PhysicalResource_Create": {
2712
+ "type": "object",
2713
+ "description": "Physical resource is a type of resource that describes the common set of attributes shared by all concrete physical resources (e.g. EQUIPMENT) in the inventory.\nSkipped properties: id,href",
2714
+ "required": [
2715
+ "name"
2716
+ ],
2717
+ "properties": {
2718
+ "category": {
2719
+ "type": "string",
2720
+ "description": "Category of the concrete resource. e.g Gold, Silver for MSISDN concrete resource"
2721
+ },
2722
+ "description": {
2723
+ "type": "string",
2724
+ "description": "free-text description of the resource"
2725
+ },
2726
+ "endOperatingDate": {
2727
+ "type": "string",
2728
+ "format": "date-time",
2729
+ "description": "A date time( DateTime). The date till the resource is operating"
2730
+ },
2731
+ "manufactureDate": {
2732
+ "type": "string",
2733
+ "format": "date-time",
2734
+ "description": "This is a string attribute that defines the date of manufacture of this item in the fixed format \"dd/mm/yyyy\". This is an optional attribute."
2735
+ },
2736
+ "name": {
2737
+ "type": "string",
2738
+ "description": "A string used to give a name to the resource"
2739
+ },
2740
+ "powerState": {
2741
+ "type": "string",
2742
+ "description": "This defines the current power status of the hardware item. Values include:\n\n 0: Unknown\n 1: Not Applicable\n 2: No Power Applied\n 3: Full Power Applied\n 4: Power Save - Normal\n 5: Power Save - Degraded\n 6: Power Save - Standby\n 7: Power Save - Critical\n 8: Power Save - Low Power Mode\n 9: Power Save - Unknown\n 10: Power Cycle\n 11: Power Warning\n 12: Power Off"
2743
+ },
2744
+ "resourceVersion": {
2745
+ "type": "string",
2746
+ "description": "A field that identifies the specific version of an instance of a resource."
2747
+ },
2748
+ "serialNumber": {
2749
+ "type": "string",
2750
+ "description": "This is a string that represents a manufacturer-allocated number used to identify different instances of the same hardware item. The ModelNumber and PartNumber attributes are used to identify different types of hardware items. This is a REQUIRED attribute."
2751
+ },
2752
+ "startOperatingDate": {
2753
+ "type": "string",
2754
+ "format": "date-time",
2755
+ "description": "A date time( DateTime). The date from which the resource is operating"
2756
+ },
2757
+ "versionNumber": {
2758
+ "type": "string",
2759
+ "description": "This is a string that identifies the version of this physical resource. This is an optional attribute."
2760
+ },
2761
+ "administrativeState": {
2762
+ "$ref": "#/definitions/ResourceAdministrativeStateType",
2763
+ "description": "Tracks the lifecycle status of the resource, such as planning, installing, opereating, retiring and so on."
2764
+ },
2765
+ "attachment": {
2766
+ "type": "array",
2767
+ "items": {
2768
+ "$ref": "#/definitions/AttachmentRefOrValue"
2769
+ }
2770
+ },
2771
+ "note": {
2772
+ "type": "array",
2773
+ "items": {
2774
+ "$ref": "#/definitions/Note"
2775
+ }
2776
+ },
2777
+ "operationalState": {
2778
+ "$ref": "#/definitions/ResourceOperationalStateType",
2779
+ "description": "Tracks the lifecycle status of the resource, such as planning, installing, opereating, retiring and so on."
2780
+ },
2781
+ "place": {
2782
+ "$ref": "#/definitions/RelatedPlaceRefOrValue"
2783
+ },
2784
+ "relatedParty": {
2785
+ "type": "array",
2786
+ "items": {
2787
+ "$ref": "#/definitions/RelatedParty"
2788
+ }
2789
+ },
2790
+ "resourceCharacteristic": {
2791
+ "type": "array",
2792
+ "items": {
2793
+ "$ref": "#/definitions/Characteristic"
2794
+ }
2795
+ },
2796
+ "resourceRelationship": {
2797
+ "type": "array",
2798
+ "items": {
2799
+ "$ref": "#/definitions/ResourceRelationship"
2800
+ }
2801
+ },
2802
+ "resourceSpecification": {
2803
+ "$ref": "#/definitions/ResourceSpecificationRef"
2804
+ },
2805
+ "resourceStatus": {
2806
+ "$ref": "#/definitions/ResourceStatusType",
2807
+ "description": "Tracks the lifecycle status of the resource, such as planning, installing, opereating, retiring and so on."
2808
+ },
2809
+ "usageState": {
2810
+ "$ref": "#/definitions/ResourceUsageStateType",
2811
+ "description": "Tracks the lifecycle status of the resource, such as planning, installing, opereating, retiring and so on."
2812
+ },
2813
+ "@baseType": {
2814
+ "type": "string",
2815
+ "description": "When sub-classing, this defines the super-class"
2816
+ },
2817
+ "@schemaLocation": {
2818
+ "type": "string",
2819
+ "format": "uri",
2820
+ "description": "A URI to a JSON-Schema file that defines additional attributes and relationships"
2821
+ },
2822
+ "@type": {
2823
+ "type": "string",
2824
+ "description": "When sub-classing, this defines the sub-class entity name"
2825
+ },
2826
+ "@referredType": {
2827
+ "type": "string",
2828
+ "description": "The actual type of the target instance when needed for disambiguation."
2829
+ }
2830
+ }
2831
+ },
2832
+ "PhysicalResource_Update": {
2833
+ "type": "object",
2834
+ "description": "Physical resource is a type of resource that describes the common set of attributes shared by all concrete physical resources (e.g. EQUIPMENT) in the inventory.\nSkipped properties: id,href",
2835
+ "properties": {
2836
+ "category": {
2837
+ "type": "string",
2838
+ "description": "Category of the concrete resource. e.g Gold, Silver for MSISDN concrete resource"
2839
+ },
2840
+ "description": {
2841
+ "type": "string",
2842
+ "description": "free-text description of the resource"
2843
+ },
2844
+ "endOperatingDate": {
2845
+ "type": "string",
2846
+ "format": "date-time",
2847
+ "description": "A date time( DateTime). The date till the resource is operating"
2848
+ },
2849
+ "manufactureDate": {
2850
+ "type": "string",
2851
+ "format": "date-time",
2852
+ "description": "This is a string attribute that defines the date of manufacture of this item in the fixed format \"dd/mm/yyyy\". This is an optional attribute."
2853
+ },
2854
+ "name": {
2855
+ "type": "string",
2856
+ "description": "A string used to give a name to the resource"
2857
+ },
2858
+ "powerState": {
2859
+ "type": "string",
2860
+ "description": "This defines the current power status of the hardware item. Values include:\n\n 0: Unknown\n 1: Not Applicable\n 2: No Power Applied\n 3: Full Power Applied\n 4: Power Save - Normal\n 5: Power Save - Degraded\n 6: Power Save - Standby\n 7: Power Save - Critical\n 8: Power Save - Low Power Mode\n 9: Power Save - Unknown\n 10: Power Cycle\n 11: Power Warning\n 12: Power Off"
2861
+ },
2862
+ "resourceVersion": {
2863
+ "type": "string",
2864
+ "description": "A field that identifies the specific version of an instance of a resource."
2865
+ },
2866
+ "serialNumber": {
2867
+ "type": "string",
2868
+ "description": "This is a string that represents a manufacturer-allocated number used to identify different instances of the same hardware item. The ModelNumber and PartNumber attributes are used to identify different types of hardware items. This is a REQUIRED attribute."
2869
+ },
2870
+ "startOperatingDate": {
2871
+ "type": "string",
2872
+ "format": "date-time",
2873
+ "description": "A date time( DateTime). The date from which the resource is operating"
2874
+ },
2875
+ "versionNumber": {
2876
+ "type": "string",
2877
+ "description": "This is a string that identifies the version of this physical resource. This is an optional attribute."
2878
+ },
2879
+ "administrativeState": {
2880
+ "$ref": "#/definitions/ResourceAdministrativeStateType",
2881
+ "description": "Tracks the lifecycle status of the resource, such as planning, installing, opereating, retiring and so on."
2882
+ },
2883
+ "attachment": {
2884
+ "type": "array",
2885
+ "items": {
2886
+ "$ref": "#/definitions/AttachmentRefOrValue"
2887
+ }
2888
+ },
2889
+ "note": {
2890
+ "type": "array",
2891
+ "items": {
2892
+ "$ref": "#/definitions/Note"
2893
+ }
2894
+ },
2895
+ "operationalState": {
2896
+ "$ref": "#/definitions/ResourceOperationalStateType",
2897
+ "description": "Tracks the lifecycle status of the resource, such as planning, installing, opereating, retiring and so on."
2898
+ },
2899
+ "place": {
2900
+ "$ref": "#/definitions/RelatedPlaceRefOrValue"
2901
+ },
2902
+ "relatedParty": {
2903
+ "type": "array",
2904
+ "items": {
2905
+ "$ref": "#/definitions/RelatedParty"
2906
+ }
2907
+ },
2908
+ "resourceCharacteristic": {
2909
+ "type": "array",
2910
+ "items": {
2911
+ "$ref": "#/definitions/Characteristic"
2912
+ }
2913
+ },
2914
+ "resourceRelationship": {
2915
+ "type": "array",
2916
+ "items": {
2917
+ "$ref": "#/definitions/ResourceRelationship"
2918
+ }
2919
+ },
2920
+ "resourceSpecification": {
2921
+ "$ref": "#/definitions/ResourceSpecificationRef"
2922
+ },
2923
+ "resourceStatus": {
2924
+ "$ref": "#/definitions/ResourceStatusType",
2925
+ "description": "Tracks the lifecycle status of the resource, such as planning, installing, opereating, retiring and so on."
2926
+ },
2927
+ "usageState": {
2928
+ "$ref": "#/definitions/ResourceUsageStateType",
2929
+ "description": "Tracks the lifecycle status of the resource, such as planning, installing, opereating, retiring and so on."
2930
+ },
2931
+ "@baseType": {
2932
+ "type": "string",
2933
+ "description": "When sub-classing, this defines the super-class"
2934
+ },
2935
+ "@schemaLocation": {
2936
+ "type": "string",
2937
+ "format": "uri",
2938
+ "description": "A URI to a JSON-Schema file that defines additional attributes and relationships"
2939
+ },
2940
+ "@type": {
2941
+ "type": "string",
2942
+ "description": "When sub-classing, this defines the sub-class entity name"
2943
+ },
2944
+ "@referredType": {
2945
+ "type": "string",
2946
+ "description": "The actual type of the target instance when needed for disambiguation."
2947
+ }
2948
+ }
2949
+ },
2950
+ "Place": {
2951
+ "type": "object",
2952
+ "description": "Place reference. Place defines the places where the products are sold or delivered.",
2953
+ "required": [
2954
+ "href",
2955
+ "id",
2956
+ "role"
2957
+ ],
2958
+ "properties": {
2959
+ "id": {
2960
+ "type": "string",
2961
+ "description": "Unique identifier of the place"
2962
+ },
2963
+ "href": {
2964
+ "type": "string",
2965
+ "description": "Unique reference of the place"
2966
+ },
2967
+ "name": {
2968
+ "type": "string",
2969
+ "description": "A user-friendly name for the place, such as \"Paris Store\", \"London Store\", \"Main Home\""
2970
+ },
2971
+ "role": {
2972
+ "type": "string",
2973
+ "description": "Role of the place (for instance: 'home delivery', 'shop retrieval')"
2974
+ },
2975
+ "@baseType": {
2976
+ "type": "string",
2977
+ "description": "When sub-classing, this defines the super-class"
2978
+ },
2979
+ "@schemaLocation": {
2980
+ "type": "string",
2981
+ "format": "uri",
2982
+ "description": "A URI to a JSON-Schema file that defines additional attributes and relationships"
2983
+ },
2984
+ "@type": {
2985
+ "type": "string",
2986
+ "description": "When sub-classing, this defines the sub-class entity name"
2987
+ }
2988
+ }
2989
+ },
2990
+ "PlaceRef": {
2991
+ "type": "object",
2992
+ "description": "Place reference. PlaceRef defines the placeRefs where the products are sold or delivered.",
2993
+ "properties": {
2994
+ "id": {
2995
+ "type": "string",
2996
+ "description": "Unique identifier of a related entity."
2997
+ },
2998
+ "href": {
2999
+ "type": "string",
3000
+ "description": "Reference of the related entity."
3001
+ },
3002
+ "name": {
3003
+ "type": "string",
3004
+ "description": "Name of the related entity."
3005
+ },
3006
+ "@baseType": {
3007
+ "type": "string",
3008
+ "description": "When sub-classing, this defines the super-class"
3009
+ },
3010
+ "@schemaLocation": {
3011
+ "type": "string",
3012
+ "format": "uri",
3013
+ "description": "A URI to a JSON-Schema file that defines additional attributes and relationships"
3014
+ },
3015
+ "@type": {
3016
+ "type": "string",
3017
+ "description": "When sub-classing, this defines the sub-class entity name"
3018
+ },
3019
+ "@referredType": {
3020
+ "type": "string",
3021
+ "description": "The actual type of the target instance when needed for disambiguation."
3022
+ }
3023
+ },
3024
+ "required": [
3025
+ "id"
3026
+ ]
3027
+ },
3028
+ "Quantity": {
3029
+ "type": "object",
3030
+ "description": "An amount in a given unit",
3031
+ "properties": {
3032
+ "amount": {
3033
+ "default": 1,
3034
+ "type": "number",
3035
+ "format": "float",
3036
+ "description": "Numeric value in a given unit"
3037
+ },
3038
+ "units": {
3039
+ "type": "string",
3040
+ "description": "Unit"
3041
+ }
3042
+ }
3043
+ },
3044
+ "RelatedParty": {
3045
+ "type": "object",
3046
+ "description": "Related Entity reference. A related party defines party or party role linked to a specific entity.",
3047
+ "required": [
3048
+ "@referredType",
3049
+ "id"
3050
+ ],
3051
+ "properties": {
3052
+ "id": {
3053
+ "type": "string",
3054
+ "description": "Unique identifier of a related entity."
3055
+ },
3056
+ "href": {
3057
+ "type": "string",
3058
+ "description": "Reference of the related entity."
3059
+ },
3060
+ "name": {
3061
+ "type": "string",
3062
+ "description": "Name of the related entity."
3063
+ },
3064
+ "role": {
3065
+ "type": "string",
3066
+ "description": "Role played by the related party"
3067
+ },
3068
+ "@baseType": {
3069
+ "type": "string",
3070
+ "description": "When sub-classing, this defines the super-class"
3071
+ },
3072
+ "@schemaLocation": {
3073
+ "type": "string",
3074
+ "format": "uri",
3075
+ "description": "A URI to a JSON-Schema file that defines additional attributes and relationships"
3076
+ },
3077
+ "@type": {
3078
+ "type": "string",
3079
+ "description": "When sub-classing, this defines the sub-class entity name"
3080
+ },
3081
+ "@referredType": {
3082
+ "type": "string",
3083
+ "description": "The actual type of the target instance when needed for disambiguation."
3084
+ }
3085
+ }
3086
+ },
3087
+ "RelatedPlaceRefOrValue": {
3088
+ "type": "object",
3089
+ "description": "Related Entity reference. A related place defines a place described by reference or by value linked to a specific entity. The polymorphic attributes @type, @schemaLocation & @referredType are related to the place entity and not the RelatedPlaceRefOrValue class itself",
3090
+ "required": [
3091
+ "href",
3092
+ "id",
3093
+ "role"
3094
+ ],
3095
+ "properties": {
3096
+ "id": {
3097
+ "type": "string",
3098
+ "description": "Unique identifier of the place"
3099
+ },
3100
+ "href": {
3101
+ "type": "string",
3102
+ "description": "Unique reference of the place"
3103
+ },
3104
+ "name": {
3105
+ "type": "string",
3106
+ "description": "A user-friendly name for the place, such as \"Paris Store\", \"London Store\", \"Main Home\""
3107
+ },
3108
+ "role": {
3109
+ "type": "string"
3110
+ },
3111
+ "@baseType": {
3112
+ "type": "string",
3113
+ "description": "When sub-classing, this defines the super-class"
3114
+ },
3115
+ "@schemaLocation": {
3116
+ "type": "string",
3117
+ "format": "uri",
3118
+ "description": "A URI to a JSON-Schema file that defines additional attributes and relationships"
3119
+ },
3120
+ "@type": {
3121
+ "type": "string",
3122
+ "description": "When sub-classing, this defines the sub-class entity name"
3123
+ },
3124
+ "@referredType": {
3125
+ "type": "string",
3126
+ "description": "The actual type of the target instance when needed for disambiguation."
3127
+ }
3128
+ }
3129
+ },
3130
+ "Resource": {
3131
+ "type": "object",
3132
+ "description": "Resource is an abstract entity that describes the common set of attributes shared by all concrete resources (e.g. TPE, EQUIPMENT) in the inventory.",
3133
+ "required": [
3134
+ "href",
3135
+ "id"
3136
+ ],
3137
+ "properties": {
3138
+ "id": {
3139
+ "type": "string",
3140
+ "description": "Identifier of an instance of the resource. Required to be unique within the resource type. Used in URIs as the identifier for specific instances of a type."
3141
+ },
3142
+ "href": {
3143
+ "type": "string",
3144
+ "description": "The URI for the object itself."
3145
+ },
3146
+ "category": {
3147
+ "type": "string",
3148
+ "description": "Category of the concrete resource. e.g Gold, Silver for MSISDN concrete resource"
3149
+ },
3150
+ "description": {
3151
+ "type": "string",
3152
+ "description": "free-text description of the resource"
3153
+ },
3154
+ "endOperatingDate": {
3155
+ "type": "string",
3156
+ "format": "date-time",
3157
+ "description": "A date time( DateTime). The date till the resource is operating"
3158
+ },
3159
+ "name": {
3160
+ "type": "string",
3161
+ "description": "A string used to give a name to the resource"
3162
+ },
3163
+ "resourceVersion": {
3164
+ "type": "string",
3165
+ "description": "A field that identifies the specific version of an instance of a resource."
3166
+ },
3167
+ "startOperatingDate": {
3168
+ "type": "string",
3169
+ "format": "date-time",
3170
+ "description": "A date time( DateTime). The date from which the resource is operating"
3171
+ },
3172
+ "administrativeState": {
3173
+ "$ref": "#/definitions/ResourceAdministrativeStateType",
3174
+ "description": "Tracks the lifecycle status of the resource, such as planning, installing, opereating, retiring and so on."
3175
+ },
3176
+ "attachment": {
3177
+ "type": "array",
3178
+ "items": {
3179
+ "$ref": "#/definitions/AttachmentRefOrValue"
3180
+ }
3181
+ },
3182
+ "note": {
3183
+ "type": "array",
3184
+ "items": {
3185
+ "$ref": "#/definitions/Note"
3186
+ }
3187
+ },
3188
+ "operationalState": {
3189
+ "$ref": "#/definitions/ResourceOperationalStateType",
3190
+ "description": "Tracks the lifecycle status of the resource, such as planning, installing, opereating, retiring and so on."
3191
+ },
3192
+ "place": {
3193
+ "$ref": "#/definitions/RelatedPlaceRefOrValue"
3194
+ },
3195
+ "relatedParty": {
3196
+ "type": "array",
3197
+ "items": {
3198
+ "$ref": "#/definitions/RelatedParty"
3199
+ }
3200
+ },
3201
+ "resourceCharacteristic": {
3202
+ "type": "array",
3203
+ "items": {
3204
+ "$ref": "#/definitions/Characteristic"
3205
+ }
3206
+ },
3207
+ "resourceRelationship": {
3208
+ "type": "array",
3209
+ "items": {
3210
+ "$ref": "#/definitions/ResourceRelationship"
3211
+ }
3212
+ },
3213
+ "resourceSpecification": {
3214
+ "$ref": "#/definitions/ResourceSpecificationRef"
3215
+ },
3216
+ "resourceStatus": {
3217
+ "$ref": "#/definitions/ResourceStatusType",
3218
+ "description": "Tracks the lifecycle status of the resource, such as planning, installing, opereating, retiring and so on."
3219
+ },
3220
+ "usageState": {
3221
+ "$ref": "#/definitions/ResourceUsageStateType",
3222
+ "description": "Tracks the lifecycle status of the resource, such as planning, installing, opereating, retiring and so on."
3223
+ },
3224
+ "@baseType": {
3225
+ "type": "string",
3226
+ "description": "When sub-classing, this defines the super-class"
3227
+ },
3228
+ "@schemaLocation": {
3229
+ "type": "string",
3230
+ "format": "uri",
3231
+ "description": "A URI to a JSON-Schema file that defines additional attributes and relationships"
3232
+ },
3233
+ "@type": {
3234
+ "type": "string",
3235
+ "description": "When sub-classing, this defines the sub-class entity name"
3236
+ }
3237
+ }
3238
+ },
3239
+ "Resource_Create": {
3240
+ "type": "object",
3241
+ "description": "Resource is an abstract entity that describes the common set of attributes shared by all concrete resources (e.g. TPE, EQUIPMENT) in the inventory.\nSkipped properties: id,href",
3242
+ "required": [
3243
+ "name"
3244
+ ],
3245
+ "properties": {
3246
+ "category": {
3247
+ "type": "string",
3248
+ "description": "Category of the concrete resource. e.g Gold, Silver for MSISDN concrete resource"
3249
+ },
3250
+ "description": {
3251
+ "type": "string",
3252
+ "description": "free-text description of the resource"
3253
+ },
3254
+ "endOperatingDate": {
3255
+ "type": "string",
3256
+ "format": "date-time",
3257
+ "description": "A date time( DateTime). The date till the resource is operating"
3258
+ },
3259
+ "name": {
3260
+ "type": "string",
3261
+ "description": "A string used to give a name to the resource"
3262
+ },
3263
+ "resourceVersion": {
3264
+ "type": "string",
3265
+ "description": "A field that identifies the specific version of an instance of a resource."
3266
+ },
3267
+ "startOperatingDate": {
3268
+ "type": "string",
3269
+ "format": "date-time",
3270
+ "description": "A date time( DateTime). The date from which the resource is operating"
3271
+ },
3272
+ "administrativeState": {
3273
+ "$ref": "#/definitions/ResourceAdministrativeStateType",
3274
+ "description": "Tracks the lifecycle status of the resource, such as planning, installing, opereating, retiring and so on."
3275
+ },
3276
+ "attachment": {
3277
+ "type": "array",
3278
+ "items": {
3279
+ "$ref": "#/definitions/AttachmentRefOrValue"
3280
+ }
3281
+ },
3282
+ "note": {
3283
+ "type": "array",
3284
+ "items": {
3285
+ "$ref": "#/definitions/Note"
3286
+ }
3287
+ },
3288
+ "operationalState": {
3289
+ "$ref": "#/definitions/ResourceOperationalStateType",
3290
+ "description": "Tracks the lifecycle status of the resource, such as planning, installing, opereating, retiring and so on."
3291
+ },
3292
+ "place": {
3293
+ "$ref": "#/definitions/RelatedPlaceRefOrValue"
3294
+ },
3295
+ "relatedParty": {
3296
+ "type": "array",
3297
+ "items": {
3298
+ "$ref": "#/definitions/RelatedParty"
3299
+ }
3300
+ },
3301
+ "resourceCharacteristic": {
3302
+ "type": "array",
3303
+ "items": {
3304
+ "$ref": "#/definitions/Characteristic"
3305
+ }
3306
+ },
3307
+ "resourceRelationship": {
3308
+ "type": "array",
3309
+ "items": {
3310
+ "$ref": "#/definitions/ResourceRelationship"
3311
+ }
3312
+ },
3313
+ "resourceSpecification": {
3314
+ "$ref": "#/definitions/ResourceSpecificationRef"
3315
+ },
3316
+ "resourceStatus": {
3317
+ "$ref": "#/definitions/ResourceStatusType",
3318
+ "description": "Tracks the lifecycle status of the resource, such as planning, installing, opereating, retiring and so on."
3319
+ },
3320
+ "usageState": {
3321
+ "$ref": "#/definitions/ResourceUsageStateType",
3322
+ "description": "Tracks the lifecycle status of the resource, such as planning, installing, opereating, retiring and so on."
3323
+ },
3324
+ "@baseType": {
3325
+ "type": "string",
3326
+ "description": "When sub-classing, this defines the super-class"
3327
+ },
3328
+ "@schemaLocation": {
3329
+ "type": "string",
3330
+ "format": "uri",
3331
+ "description": "A URI to a JSON-Schema file that defines additional attributes and relationships"
3332
+ },
3333
+ "@type": {
3334
+ "type": "string",
3335
+ "description": "When sub-classing, this defines the sub-class entity name"
3336
+ }
3337
+ }
3338
+ },
3339
+ "Resource_Update": {
3340
+ "type": "object",
3341
+ "description": "Resource is an abstract entity that describes the common set of attributes shared by all concrete resources (e.g. TPE, EQUIPMENT) in the inventory.\nSkipped properties: id,href",
3342
+ "properties": {
3343
+ "category": {
3344
+ "type": "string",
3345
+ "description": "Category of the concrete resource. e.g Gold, Silver for MSISDN concrete resource"
3346
+ },
3347
+ "description": {
3348
+ "type": "string",
3349
+ "description": "free-text description of the resource"
3350
+ },
3351
+ "endOperatingDate": {
3352
+ "type": "string",
3353
+ "format": "date-time",
3354
+ "description": "A date time( DateTime). The date till the resource is operating"
3355
+ },
3356
+ "name": {
3357
+ "type": "string",
3358
+ "description": "A string used to give a name to the resource"
3359
+ },
3360
+ "resourceVersion": {
3361
+ "type": "string",
3362
+ "description": "A field that identifies the specific version of an instance of a resource."
3363
+ },
3364
+ "startOperatingDate": {
3365
+ "type": "string",
3366
+ "format": "date-time",
3367
+ "description": "A date time( DateTime). The date from which the resource is operating"
3368
+ },
3369
+ "administrativeState": {
3370
+ "$ref": "#/definitions/ResourceAdministrativeStateType",
3371
+ "description": "Tracks the lifecycle status of the resource, such as planning, installing, opereating, retiring and so on."
3372
+ },
3373
+ "attachment": {
3374
+ "type": "array",
3375
+ "items": {
3376
+ "$ref": "#/definitions/AttachmentRefOrValue"
3377
+ }
3378
+ },
3379
+ "note": {
3380
+ "type": "array",
3381
+ "items": {
3382
+ "$ref": "#/definitions/Note"
3383
+ }
3384
+ },
3385
+ "operationalState": {
3386
+ "$ref": "#/definitions/ResourceOperationalStateType",
3387
+ "description": "Tracks the lifecycle status of the resource, such as planning, installing, opereating, retiring and so on."
3388
+ },
3389
+ "place": {
3390
+ "$ref": "#/definitions/RelatedPlaceRefOrValue"
3391
+ },
3392
+ "relatedParty": {
3393
+ "type": "array",
3394
+ "items": {
3395
+ "$ref": "#/definitions/RelatedParty"
3396
+ }
3397
+ },
3398
+ "resourceCharacteristic": {
3399
+ "type": "array",
3400
+ "items": {
3401
+ "$ref": "#/definitions/Characteristic"
3402
+ }
3403
+ },
3404
+ "resourceRelationship": {
3405
+ "type": "array",
3406
+ "items": {
3407
+ "$ref": "#/definitions/ResourceRelationship"
3408
+ }
3409
+ },
3410
+ "resourceSpecification": {
3411
+ "$ref": "#/definitions/ResourceSpecificationRef"
3412
+ },
3413
+ "resourceStatus": {
3414
+ "$ref": "#/definitions/ResourceStatusType",
3415
+ "description": "Tracks the lifecycle status of the resource, such as planning, installing, opereating, retiring and so on."
3416
+ },
3417
+ "usageState": {
3418
+ "$ref": "#/definitions/ResourceUsageStateType",
3419
+ "description": "Tracks the lifecycle status of the resource, such as planning, installing, opereating, retiring and so on."
3420
+ },
3421
+ "@baseType": {
3422
+ "type": "string",
3423
+ "description": "When sub-classing, this defines the super-class"
3424
+ },
3425
+ "@schemaLocation": {
3426
+ "type": "string",
3427
+ "format": "uri",
3428
+ "description": "A URI to a JSON-Schema file that defines additional attributes and relationships"
3429
+ },
3430
+ "@type": {
3431
+ "type": "string",
3432
+ "description": "When sub-classing, this defines the sub-class entity name"
3433
+ }
3434
+ }
3435
+ },
3436
+ "ResourceAdministrativeStateType": {
3437
+ "type": "string",
3438
+ "description": "ResourceAdministrativeStateType enumerations",
3439
+ "enum": [
3440
+ "locked",
3441
+ "unlocked",
3442
+ "shutdown"
3443
+ ]
3444
+ },
3445
+ "ResourceOperationalStateType": {
3446
+ "type": "string",
3447
+ "description": "ResourceOperationalStateType enumerations",
3448
+ "enum": [
3449
+ "enable",
3450
+ "disable"
3451
+ ]
3452
+ },
3453
+ "ResourceRelationship": {
3454
+ "type": "object",
3455
+ "properties": {
3456
+ "id": {
3457
+ "type": "string",
3458
+ "description": "id of the related resource."
3459
+ },
3460
+ "href": {
3461
+ "type": "string",
3462
+ "description": "href of the related resource."
3463
+ },
3464
+ "relationshipType": {
3465
+ "type": "string"
3466
+ },
3467
+ "resourceRelationshipCharacteristic": {
3468
+ "type": "array",
3469
+ "items": {
3470
+ "$ref": "#/definitions/Characteristic"
3471
+ }
3472
+ },
3473
+ "@baseType": {
3474
+ "type": "string",
3475
+ "description": "When sub-classing, this defines the super-class"
3476
+ },
3477
+ "@schemaLocation": {
3478
+ "type": "string",
3479
+ "format": "uri",
3480
+ "description": "A URI to a JSON-Schema file that defines additional attributes and relationships"
3481
+ },
3482
+ "@type": {
3483
+ "type": "string",
3484
+ "description": "When sub-classing, this defines the sub-class entity name"
3485
+ }
3486
+ }
3487
+ },
3488
+ "ResourceSpecificationRef": {
3489
+ "type": "object",
3490
+ "description": "Resource Specification reference: The ResourceSpecification is required to realize a ProductSpecification.",
3491
+ "required": [
3492
+ "href",
3493
+ "id"
3494
+ ],
3495
+ "properties": {
3496
+ "id": {
3497
+ "type": "string",
3498
+ "description": "Unique identifier of the resource specification"
3499
+ },
3500
+ "href": {
3501
+ "type": "string",
3502
+ "description": "Reference of the resource specification"
3503
+ },
3504
+ "name": {
3505
+ "type": "string",
3506
+ "description": "Name of the requiredResourceSpecification"
3507
+ },
3508
+ "version": {
3509
+ "type": "string",
3510
+ "description": "Resource specification version"
3511
+ },
3512
+ "@baseType": {
3513
+ "type": "string",
3514
+ "description": "When sub-classing, this defines the super-class"
3515
+ },
3516
+ "@schemaLocation": {
3517
+ "type": "string",
3518
+ "format": "uri",
3519
+ "description": "A URI to a JSON-Schema file that defines additional attributes and relationships"
3520
+ },
3521
+ "@type": {
3522
+ "type": "string",
3523
+ "description": "When sub-classing, this defines the sub-class entity name"
3524
+ },
3525
+ "@referredType": {
3526
+ "type": "string",
3527
+ "description": "The actual type of the target instance when needed for disambiguation."
3528
+ }
3529
+ }
3530
+ },
3531
+ "ResourceStatusType": {
3532
+ "type": "string",
3533
+ "description": "ResourceStatusType enumerations",
3534
+ "enum": [
3535
+ "standby",
3536
+ "alarm",
3537
+ "available",
3538
+ "reserved",
3539
+ "unknown",
3540
+ "suspended"
3541
+ ]
3542
+ },
3543
+ "ResourceUsageStateType": {
3544
+ "type": "string",
3545
+ "description": "ResourceUsageStateType enumerations",
3546
+ "enum": [
3547
+ "idle",
3548
+ "active",
3549
+ "busy"
3550
+ ]
3551
+ },
3552
+ "TimePeriod": {
3553
+ "type": "object",
3554
+ "description": "A period of time, either as a deadline (endDateTime only) a startDateTime only, or both",
3555
+ "properties": {
3556
+ "endDateTime": {
3557
+ "type": "string",
3558
+ "format": "date-time",
3559
+ "description": "End of the time period, using IETC-RFC-3339 format"
3560
+ },
3561
+ "startDateTime": {
3562
+ "type": "string",
3563
+ "format": "date-time",
3564
+ "description": "Start of the time period, using IETC-RFC-3339 format. If you define a start, you must also define an end"
3565
+ }
3566
+ }
3567
+ },
3568
+ "EventSubscription": {
3569
+ "type": "object",
3570
+ "description": "Sets the communication endpoint address the service instance must use to deliver notification information",
3571
+ "required": [
3572
+ "id",
3573
+ "callback"
3574
+ ],
3575
+ "properties": {
3576
+ "id": {
3577
+ "type": "string",
3578
+ "description": "Id of the listener"
3579
+ },
3580
+ "callback": {
3581
+ "type": "string",
3582
+ "description": "The callback being registered."
3583
+ },
3584
+ "query": {
3585
+ "type": "string",
3586
+ "description": "additional data to be passed"
3587
+ }
3588
+ }
3589
+ },
3590
+ "EventSubscriptionInput": {
3591
+ "type": "object",
3592
+ "description": "Sets the communication endpoint address the service instance must use to deliver notification information",
3593
+ "required": [
3594
+ "callback"
3595
+ ],
3596
+ "properties": {
3597
+ "callback": {
3598
+ "type": "string",
3599
+ "description": "The callback being registered."
3600
+ },
3601
+ "query": {
3602
+ "type": "string",
3603
+ "description": "additional data to be passed"
3604
+ }
3605
+ }
3606
+ },
3607
+ "ResourceCreateEvent": {
3608
+ "type": "object",
3609
+ "description": "The notification data structure",
3610
+ "properties": {
3611
+ "id": {
3612
+ "type": "string",
3613
+ "description": "Identifier of the Process flow"
3614
+ },
3615
+ "href": {
3616
+ "type": "string",
3617
+ "description": "Reference of the ProcessFlow"
3618
+ },
3619
+ "eventId": {
3620
+ "type": "string",
3621
+ "description": "The identifier of the notification."
3622
+ },
3623
+ "eventTime": {
3624
+ "type": "string",
3625
+ "format": "date-time",
3626
+ "description": "Time of the event occurrence."
3627
+ },
3628
+ "eventType": {
3629
+ "type": "string",
3630
+ "description": "The type of the notification."
3631
+ },
3632
+ "correlationId": {
3633
+ "type": "string",
3634
+ "description": "The correlation id for this event."
3635
+ },
3636
+ "domain": {
3637
+ "type": "string",
3638
+ "description": "The domain of the event."
3639
+ },
3640
+ "title": {
3641
+ "type": "string",
3642
+ "description": "The title of the event."
3643
+ },
3644
+ "description": {
3645
+ "type": "string",
3646
+ "description": "An explnatory of the event."
3647
+ },
3648
+ "priority": {
3649
+ "type": "string",
3650
+ "description": "A priority."
3651
+ },
3652
+ "timeOcurred": {
3653
+ "type": "string",
3654
+ "format": "date-time",
3655
+ "description": "The time the event occured."
3656
+ },
3657
+ "event": {
3658
+ "description": "The event payload linked to the involved resource object",
3659
+ "$ref": "#/definitions/ResourceCreateEventPayload"
3660
+ }
3661
+ }
3662
+ },
3663
+ "ResourceCreateEventPayload": {
3664
+ "type": "object",
3665
+ "description": "The event data structure",
3666
+ "properties": {
3667
+ "resource": {
3668
+ "description": "The involved resource data for the event",
3669
+ "$ref": "#/definitions/Resource"
3670
+ }
3671
+ }
3672
+ },
3673
+ "ResourceAttributeValueChangeEvent": {
3674
+ "type": "object",
3675
+ "description": "The notification data structure",
3676
+ "properties": {
3677
+ "eventId": {
3678
+ "type": "string",
3679
+ "description": "The identifier of the notification."
3680
+ },
3681
+ "eventTime": {
3682
+ "type": "string",
3683
+ "format": "date-time",
3684
+ "description": "Time of the event occurrence."
3685
+ },
3686
+ "eventType": {
3687
+ "type": "string",
3688
+ "description": "The type of the notification."
3689
+ },
3690
+ "correlationId": {
3691
+ "type": "string",
3692
+ "description": "The correlation id for this event."
3693
+ },
3694
+ "domain": {
3695
+ "type": "string",
3696
+ "description": "The domain of the event."
3697
+ },
3698
+ "title": {
3699
+ "type": "string",
3700
+ "description": "The title of the event."
3701
+ },
3702
+ "description": {
3703
+ "type": "string",
3704
+ "description": "An explnatory of the event."
3705
+ },
3706
+ "priority": {
3707
+ "type": "string",
3708
+ "description": "A priority."
3709
+ },
3710
+ "timeOcurred": {
3711
+ "type": "string",
3712
+ "format": "date-time",
3713
+ "description": "The time the event occured."
3714
+ },
3715
+ "fieldPath": {
3716
+ "type": "string",
3717
+ "description": "The path identifying the object field concerned by this notification."
3718
+ },
3719
+ "event": {
3720
+ "description": "The event payload linked to the involved resource object",
3721
+ "$ref": "#/definitions/ResourceAttributeValueChangeEventPayload"
3722
+ }
3723
+ }
3724
+ },
3725
+ "ResourceAttributeValueChangeEventPayload": {
3726
+ "type": "object",
3727
+ "description": "The event data structure",
3728
+ "properties": {
3729
+ "resource": {
3730
+ "description": "The involved resource data for the event",
3731
+ "$ref": "#/definitions/Resource"
3732
+ }
3733
+ }
3734
+ },
3735
+ "ResourceStateChangeEvent": {
3736
+ "type": "object",
3737
+ "description": "The notification data structure",
3738
+ "properties": {
3739
+ "id": {
3740
+ "type": "string",
3741
+ "description": "Identifier of the Process flow"
3742
+ },
3743
+ "href": {
3744
+ "type": "string",
3745
+ "description": "Reference of the ProcessFlow"
3746
+ },
3747
+ "eventId": {
3748
+ "type": "string",
3749
+ "description": "The identifier of the notification."
3750
+ },
3751
+ "eventTime": {
3752
+ "type": "string",
3753
+ "format": "date-time",
3754
+ "description": "Time of the event occurrence."
3755
+ },
3756
+ "eventType": {
3757
+ "type": "string",
3758
+ "description": "The type of the notification."
3759
+ },
3760
+ "correlationId": {
3761
+ "type": "string",
3762
+ "description": "The correlation id for this event."
3763
+ },
3764
+ "domain": {
3765
+ "type": "string",
3766
+ "description": "The domain of the event."
3767
+ },
3768
+ "title": {
3769
+ "type": "string",
3770
+ "description": "The title of the event."
3771
+ },
3772
+ "description": {
3773
+ "type": "string",
3774
+ "description": "An explnatory of the event."
3775
+ },
3776
+ "priority": {
3777
+ "type": "string",
3778
+ "description": "A priority."
3779
+ },
3780
+ "timeOcurred": {
3781
+ "type": "string",
3782
+ "format": "date-time",
3783
+ "description": "The time the event occured."
3784
+ },
3785
+ "event": {
3786
+ "description": "The event payload linked to the involved resource object",
3787
+ "$ref": "#/definitions/ResourceStateChangeEventPayload"
3788
+ }
3789
+ }
3790
+ },
3791
+ "ResourceStateChangeEventPayload": {
3792
+ "type": "object",
3793
+ "description": "The event data structure",
3794
+ "properties": {
3795
+ "resource": {
3796
+ "description": "The involved resource data for the event",
3797
+ "$ref": "#/definitions/Resource"
3798
+ }
3799
+ }
3800
+ },
3801
+ "ResourceDeleteEvent": {
3802
+ "type": "object",
3803
+ "description": "The notification data structure",
3804
+ "properties": {
3805
+ "id": {
3806
+ "type": "string",
3807
+ "description": "Identifier of the Process flow"
3808
+ },
3809
+ "href": {
3810
+ "type": "string",
3811
+ "description": "Reference of the ProcessFlow"
3812
+ },
3813
+ "eventId": {
3814
+ "type": "string",
3815
+ "description": "The identifier of the notification."
3816
+ },
3817
+ "eventTime": {
3818
+ "type": "string",
3819
+ "format": "date-time",
3820
+ "description": "Time of the event occurrence."
3821
+ },
3822
+ "eventType": {
3823
+ "type": "string",
3824
+ "description": "The type of the notification."
3825
+ },
3826
+ "correlationId": {
3827
+ "type": "string",
3828
+ "description": "The correlation id for this event."
3829
+ },
3830
+ "domain": {
3831
+ "type": "string",
3832
+ "description": "The domain of the event."
3833
+ },
3834
+ "title": {
3835
+ "type": "string",
3836
+ "description": "The title of the event."
3837
+ },
3838
+ "description": {
3839
+ "type": "string",
3840
+ "description": "An explnatory of the event."
3841
+ },
3842
+ "priority": {
3843
+ "type": "string",
3844
+ "description": "A priority."
3845
+ },
3846
+ "timeOcurred": {
3847
+ "type": "string",
3848
+ "format": "date-time",
3849
+ "description": "The time the event occured."
3850
+ },
3851
+ "event": {
3852
+ "description": "The event payload linked to the involved resource object",
3853
+ "$ref": "#/definitions/ResourceDeleteEventPayload"
3854
+ }
3855
+ }
3856
+ },
3857
+ "ResourceDeleteEventPayload": {
3858
+ "type": "object",
3859
+ "description": "The event data structure",
3860
+ "properties": {
3861
+ "resource": {
3862
+ "description": "The involved resource data for the event",
3863
+ "$ref": "#/definitions/Resource"
3864
+ }
3865
+ }
3866
+ },
3867
+ "PhysicalResourceCreateEvent": {
3868
+ "type": "object",
3869
+ "description": "The notification data structure",
3870
+ "properties": {
3871
+ "id": {
3872
+ "type": "string",
3873
+ "description": "Identifier of the Process flow"
3874
+ },
3875
+ "href": {
3876
+ "type": "string",
3877
+ "description": "Reference of the ProcessFlow"
3878
+ },
3879
+ "eventId": {
3880
+ "type": "string",
3881
+ "description": "The identifier of the notification."
3882
+ },
3883
+ "eventTime": {
3884
+ "type": "string",
3885
+ "format": "date-time",
3886
+ "description": "Time of the event occurrence."
3887
+ },
3888
+ "eventType": {
3889
+ "type": "string",
3890
+ "description": "The type of the notification."
3891
+ },
3892
+ "correlationId": {
3893
+ "type": "string",
3894
+ "description": "The correlation id for this event."
3895
+ },
3896
+ "domain": {
3897
+ "type": "string",
3898
+ "description": "The domain of the event."
3899
+ },
3900
+ "title": {
3901
+ "type": "string",
3902
+ "description": "The title of the event."
3903
+ },
3904
+ "description": {
3905
+ "type": "string",
3906
+ "description": "An explnatory of the event."
3907
+ },
3908
+ "priority": {
3909
+ "type": "string",
3910
+ "description": "A priority."
3911
+ },
3912
+ "timeOcurred": {
3913
+ "type": "string",
3914
+ "format": "date-time",
3915
+ "description": "The time the event occured."
3916
+ },
3917
+ "event": {
3918
+ "description": "The event payload linked to the involved resource object",
3919
+ "$ref": "#/definitions/PhysicalResourceCreateEventPayload"
3920
+ }
3921
+ }
3922
+ },
3923
+ "PhysicalResourceCreateEventPayload": {
3924
+ "type": "object",
3925
+ "description": "The event data structure",
3926
+ "properties": {
3927
+ "physicalResource": {
3928
+ "description": "The involved resource data for the event",
3929
+ "$ref": "#/definitions/PhysicalResource"
3930
+ }
3931
+ }
3932
+ },
3933
+ "PhysicalResourceAttributeValueChangeEvent": {
3934
+ "type": "object",
3935
+ "description": "The notification data structure",
3936
+ "properties": {
3937
+ "eventId": {
3938
+ "type": "string",
3939
+ "description": "The identifier of the notification."
3940
+ },
3941
+ "eventTime": {
3942
+ "type": "string",
3943
+ "format": "date-time",
3944
+ "description": "Time of the event occurrence."
3945
+ },
3946
+ "eventType": {
3947
+ "type": "string",
3948
+ "description": "The type of the notification."
3949
+ },
3950
+ "correlationId": {
3951
+ "type": "string",
3952
+ "description": "The correlation id for this event."
3953
+ },
3954
+ "domain": {
3955
+ "type": "string",
3956
+ "description": "The domain of the event."
3957
+ },
3958
+ "title": {
3959
+ "type": "string",
3960
+ "description": "The title of the event."
3961
+ },
3962
+ "description": {
3963
+ "type": "string",
3964
+ "description": "An explnatory of the event."
3965
+ },
3966
+ "priority": {
3967
+ "type": "string",
3968
+ "description": "A priority."
3969
+ },
3970
+ "timeOcurred": {
3971
+ "type": "string",
3972
+ "format": "date-time",
3973
+ "description": "The time the event occured."
3974
+ },
3975
+ "fieldPath": {
3976
+ "type": "string",
3977
+ "description": "The path identifying the object field concerned by this notification."
3978
+ },
3979
+ "event": {
3980
+ "description": "The event payload linked to the involved resource object",
3981
+ "$ref": "#/definitions/PhysicalResourceAttributeValueChangeEventPayload"
3982
+ }
3983
+ }
3984
+ },
3985
+ "PhysicalResourceAttributeValueChangeEventPayload": {
3986
+ "type": "object",
3987
+ "description": "The event data structure",
3988
+ "properties": {
3989
+ "physicalResource": {
3990
+ "description": "The involved resource data for the event",
3991
+ "$ref": "#/definitions/PhysicalResource"
3992
+ }
3993
+ }
3994
+ },
3995
+ "PhysicalResourceStateChangeEvent": {
3996
+ "type": "object",
3997
+ "description": "The notification data structure",
3998
+ "properties": {
3999
+ "id": {
4000
+ "type": "string",
4001
+ "description": "Identifier of the Process flow"
4002
+ },
4003
+ "href": {
4004
+ "type": "string",
4005
+ "description": "Reference of the ProcessFlow"
4006
+ },
4007
+ "eventId": {
4008
+ "type": "string",
4009
+ "description": "The identifier of the notification."
4010
+ },
4011
+ "eventTime": {
4012
+ "type": "string",
4013
+ "format": "date-time",
4014
+ "description": "Time of the event occurrence."
4015
+ },
4016
+ "eventType": {
4017
+ "type": "string",
4018
+ "description": "The type of the notification."
4019
+ },
4020
+ "correlationId": {
4021
+ "type": "string",
4022
+ "description": "The correlation id for this event."
4023
+ },
4024
+ "domain": {
4025
+ "type": "string",
4026
+ "description": "The domain of the event."
4027
+ },
4028
+ "title": {
4029
+ "type": "string",
4030
+ "description": "The title of the event."
4031
+ },
4032
+ "description": {
4033
+ "type": "string",
4034
+ "description": "An explnatory of the event."
4035
+ },
4036
+ "priority": {
4037
+ "type": "string",
4038
+ "description": "A priority."
4039
+ },
4040
+ "timeOcurred": {
4041
+ "type": "string",
4042
+ "format": "date-time",
4043
+ "description": "The time the event occured."
4044
+ },
4045
+ "event": {
4046
+ "description": "The event payload linked to the involved resource object",
4047
+ "$ref": "#/definitions/PhysicalResourceStateChangeEventPayload"
4048
+ }
4049
+ }
4050
+ },
4051
+ "PhysicalResourceStateChangeEventPayload": {
4052
+ "type": "object",
4053
+ "description": "The event data structure",
4054
+ "properties": {
4055
+ "physicalResource": {
4056
+ "description": "The involved resource data for the event",
4057
+ "$ref": "#/definitions/PhysicalResource"
4058
+ }
4059
+ }
4060
+ },
4061
+ "PhysicalResourceDeleteEvent": {
4062
+ "type": "object",
4063
+ "description": "The notification data structure",
4064
+ "properties": {
4065
+ "id": {
4066
+ "type": "string",
4067
+ "description": "Identifier of the Process flow"
4068
+ },
4069
+ "href": {
4070
+ "type": "string",
4071
+ "description": "Reference of the ProcessFlow"
4072
+ },
4073
+ "eventId": {
4074
+ "type": "string",
4075
+ "description": "The identifier of the notification."
4076
+ },
4077
+ "eventTime": {
4078
+ "type": "string",
4079
+ "format": "date-time",
4080
+ "description": "Time of the event occurrence."
4081
+ },
4082
+ "eventType": {
4083
+ "type": "string",
4084
+ "description": "The type of the notification."
4085
+ },
4086
+ "correlationId": {
4087
+ "type": "string",
4088
+ "description": "The correlation id for this event."
4089
+ },
4090
+ "domain": {
4091
+ "type": "string",
4092
+ "description": "The domain of the event."
4093
+ },
4094
+ "title": {
4095
+ "type": "string",
4096
+ "description": "The title of the event."
4097
+ },
4098
+ "description": {
4099
+ "type": "string",
4100
+ "description": "An explnatory of the event."
4101
+ },
4102
+ "priority": {
4103
+ "type": "string",
4104
+ "description": "A priority."
4105
+ },
4106
+ "timeOcurred": {
4107
+ "type": "string",
4108
+ "format": "date-time",
4109
+ "description": "The time the event occured."
4110
+ },
4111
+ "event": {
4112
+ "description": "The event payload linked to the involved resource object",
4113
+ "$ref": "#/definitions/PhysicalResourceDeleteEventPayload"
4114
+ }
4115
+ }
4116
+ },
4117
+ "PhysicalResourceDeleteEventPayload": {
4118
+ "type": "object",
4119
+ "description": "The event data structure",
4120
+ "properties": {
4121
+ "physicalResource": {
4122
+ "description": "The involved resource data for the event",
4123
+ "$ref": "#/definitions/PhysicalResource"
4124
+ }
4125
+ }
4126
+ },
4127
+ "Error": {
4128
+ "description": "Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)",
4129
+ "type": "object",
4130
+ "required": [
4131
+ "code",
4132
+ "reason"
4133
+ ],
4134
+ "properties": {
4135
+ "code": {
4136
+ "type": "string",
4137
+ "description": "Application relevant detail, defined in the API or a common list."
4138
+ },
4139
+ "reason": {
4140
+ "type": "string",
4141
+ "description": "Explanation of the reason for the error which can be shown to a client user."
4142
+ },
4143
+ "message": {
4144
+ "type": "string",
4145
+ "description": "More details and corrective actions related to the error which can be shown to a client user."
4146
+ },
4147
+ "status": {
4148
+ "type": "string",
4149
+ "description": "HTTP Error code extension"
4150
+ },
4151
+ "referenceError": {
4152
+ "type": "string",
4153
+ "format": "uri",
4154
+ "description": "URI of documentation describing the error."
4155
+ },
4156
+ "@baseType": {
4157
+ "type": "string",
4158
+ "description": "When sub-classing, this defines the super-class."
4159
+ },
4160
+ "@schemaLocation": {
4161
+ "type": "string",
4162
+ "format": "uri",
4163
+ "description": "A URI to a JSON-Schema file that defines additional attributes and relationships"
4164
+ },
4165
+ "@type": {
4166
+ "type": "string",
4167
+ "description": "When sub-classing, this defines the sub-class entity name."
4168
+ }
4169
+ }
4170
+ }
4171
+ }
4172
+ }