@itentialopensource/adapter-tmf638_service_inventory_management 1.0.0 → 1.1.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 (41) hide show
  1. package/CALLS.md +11 -11
  2. package/CHANGELOG.md +8 -0
  3. package/CONTRIBUTING.md +1 -160
  4. package/ENHANCE.md +2 -2
  5. package/README.md +31 -22
  6. package/adapter.js +159 -330
  7. package/adapterBase.js +538 -873
  8. package/changelogs/changelog.md +16 -0
  9. package/metadata.json +49 -0
  10. package/package.json +22 -25
  11. package/pronghorn.json +474 -142
  12. package/propertiesSchema.json +453 -40
  13. package/refs?service=git-upload-pack +0 -0
  14. package/report/adapter-openapi.json +3065 -0
  15. package/report/adapter-openapi.yaml +2807 -0
  16. package/report/adapterInfo.json +8 -8
  17. package/report/updateReport1691508412248.json +120 -0
  18. package/report/updateReport1692202894289.json +120 -0
  19. package/report/updateReport1694465090893.json +120 -0
  20. package/report/updateReport1698421776983.json +120 -0
  21. package/sampleProperties.json +63 -2
  22. package/test/integration/adapterTestBasicGet.js +1 -1
  23. package/test/integration/adapterTestConnectivity.js +91 -42
  24. package/test/integration/adapterTestIntegration.js +130 -2
  25. package/test/unit/adapterBaseTestUnit.js +388 -313
  26. package/test/unit/adapterTestUnit.js +306 -109
  27. package/utils/adapterInfo.js +1 -1
  28. package/utils/addAuth.js +1 -1
  29. package/utils/artifactize.js +1 -1
  30. package/utils/checkMigrate.js +1 -1
  31. package/utils/entitiesToDB.js +1 -0
  32. package/utils/findPath.js +1 -1
  33. package/utils/methodDocumentor.js +71 -23
  34. package/utils/modify.js +13 -15
  35. package/utils/packModificationScript.js +1 -1
  36. package/utils/taskMover.js +309 -0
  37. package/utils/tbScript.js +3 -10
  38. package/utils/tbUtils.js +2 -3
  39. package/utils/testRunner.js +1 -1
  40. package/utils/troubleshootingAdapter.js +1 -3
  41. package/workflows/README.md +0 -3
@@ -0,0 +1,2807 @@
1
+ openapi: 3.0.0
2
+ info:
3
+ title: Service Inventory Management
4
+ description: "## TMF API Reference : TMF 638 - Service Inventory Management\n\n Version 4.0 \n\nThe intent of this API is to provide a consistent/standardized mechanism to query and manipulate the Service inventory.\n\nThe Service Inventory API can be used to query the service instances for a customer via Self Service Portal or the Call Centre operator can query the service instances on behalf of the customer while a customer may have a complaint or a query.\nNote: Only the CustomerFacingServices instances will be presented to the customer.\n\nThe Service Inventory API can be called by the Service Order Management to create a new service instance/ update an existing service instance in the Service Inventory.\n\n### Service resource\nService is an abstract base class for defining the Service hierarchy. All Services are characterized as either being possibly visible and usable by a Customer or not. This gives rise to the two subclasses of Service: CustomerFacingService and ResourceFacingService.\n\n### Service Inventory API performs the following operations on service :\n- Retrieve a service or a collection of services depending on filter criteria\n- Partial update of a service (including updating rules)\n- Create a service (including default values and creation rules and for administration users only)\n- Delete a service (for administration users only)\n- Notification of events on service\n\nCopyright (c)TM Forum 2019. All Rights Reserved."
5
+ contact: {}
6
+ version: '4.0.0'
7
+ servers:
8
+ - url: https://serverRoot/tmf-api/serviceInventory/v4
9
+ variables: {}
10
+ paths:
11
+ /service:
12
+ get:
13
+ tags:
14
+ - service
15
+ summary: listService
16
+ description: This operation list or find Service entities
17
+ operationId: listService
18
+ parameters:
19
+ - name: fields
20
+ in: query
21
+ description: Comma-separated properties to be provided in response
22
+ style: form
23
+ explode: true
24
+ schema:
25
+ type: string
26
+ - name: offset
27
+ in: query
28
+ description: Requested index for start of resources to be provided in response
29
+ style: form
30
+ explode: true
31
+ schema:
32
+ type: integer
33
+ format: int32
34
+ - name: limit
35
+ in: query
36
+ description: Requested number of resources to be provided in response
37
+ style: form
38
+ explode: true
39
+ schema:
40
+ type: integer
41
+ format: int32
42
+ responses:
43
+ '200':
44
+ description: Success
45
+ headers:
46
+ X-Result-Count:
47
+ description: Actual number of items returned in the response body
48
+ content:
49
+ text/plain:
50
+ schema:
51
+ type: string
52
+ description: Actual number of items returned in the response body
53
+ X-Total-Count:
54
+ description: Total number of items matching criteria
55
+ content:
56
+ text/plain:
57
+ schema:
58
+ type: string
59
+ description: Total number of items matching criteria
60
+ content:
61
+ application/json;charset=utf-8:
62
+ schema:
63
+ type: array
64
+ items:
65
+ $ref: '#/components/schemas/Service'
66
+ description: ''
67
+ '400':
68
+ description: Bad Request
69
+ headers: {}
70
+ content:
71
+ application/json;charset=utf-8:
72
+ schema:
73
+ allOf:
74
+ - $ref: '#/components/schemas/Error'
75
+ - description: Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
76
+ '401':
77
+ description: Unauthorized
78
+ headers: {}
79
+ content:
80
+ application/json;charset=utf-8:
81
+ schema:
82
+ allOf:
83
+ - $ref: '#/components/schemas/Error'
84
+ - description: Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
85
+ '403':
86
+ description: Forbidden
87
+ headers: {}
88
+ content:
89
+ application/json;charset=utf-8:
90
+ schema:
91
+ allOf:
92
+ - $ref: '#/components/schemas/Error'
93
+ - description: Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
94
+ '404':
95
+ description: Not Found
96
+ headers: {}
97
+ content:
98
+ application/json;charset=utf-8:
99
+ schema:
100
+ allOf:
101
+ - $ref: '#/components/schemas/Error'
102
+ - description: Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
103
+ '405':
104
+ description: Method Not allowed
105
+ headers: {}
106
+ content:
107
+ application/json;charset=utf-8:
108
+ schema:
109
+ allOf:
110
+ - $ref: '#/components/schemas/Error'
111
+ - description: Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
112
+ '409':
113
+ description: Conflict
114
+ headers: {}
115
+ content:
116
+ application/json;charset=utf-8:
117
+ schema:
118
+ allOf:
119
+ - $ref: '#/components/schemas/Error'
120
+ - description: Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
121
+ '500':
122
+ description: Internal Server Error
123
+ headers: {}
124
+ content:
125
+ application/json;charset=utf-8:
126
+ schema:
127
+ allOf:
128
+ - $ref: '#/components/schemas/Error'
129
+ - description: Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
130
+ deprecated: false
131
+ post:
132
+ tags:
133
+ - service
134
+ summary: createService
135
+ description: This operation creates a Service entity.
136
+ operationId: createService
137
+ parameters: []
138
+ requestBody:
139
+ description: The Service to be created
140
+ content:
141
+ application/json:
142
+ schema:
143
+ allOf:
144
+ - $ref: '#/components/schemas/ServiceRequest'
145
+ - description: The Service to be created
146
+ required: true
147
+ responses:
148
+ '201':
149
+ description: Created
150
+ headers: {}
151
+ content:
152
+ application/json;charset=utf-8:
153
+ schema:
154
+ allOf:
155
+ - $ref: '#/components/schemas/Service'
156
+ - description: 'Service is a base class for defining the Service hierarchy. All Services are characterized as either being possibly visible and usable by a Customer or not. This gives rise to the two subclasses of Service: CustomerFacingService and ResourceFacingService.'
157
+ '400':
158
+ description: Bad Request
159
+ headers: {}
160
+ content:
161
+ application/json;charset=utf-8:
162
+ schema:
163
+ allOf:
164
+ - $ref: '#/components/schemas/Error'
165
+ - description: Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
166
+ '401':
167
+ description: Unauthorized
168
+ headers: {}
169
+ content:
170
+ application/json;charset=utf-8:
171
+ schema:
172
+ allOf:
173
+ - $ref: '#/components/schemas/Error'
174
+ - description: Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
175
+ '403':
176
+ description: Forbidden
177
+ headers: {}
178
+ content:
179
+ application/json;charset=utf-8:
180
+ schema:
181
+ allOf:
182
+ - $ref: '#/components/schemas/Error'
183
+ - description: Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
184
+ '405':
185
+ description: Method Not allowed
186
+ headers: {}
187
+ content:
188
+ application/json;charset=utf-8:
189
+ schema:
190
+ allOf:
191
+ - $ref: '#/components/schemas/Error'
192
+ - description: Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
193
+ '409':
194
+ description: Conflict
195
+ headers: {}
196
+ content:
197
+ application/json;charset=utf-8:
198
+ schema:
199
+ allOf:
200
+ - $ref: '#/components/schemas/Error'
201
+ - description: Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
202
+ '500':
203
+ description: Internal Server Error
204
+ headers: {}
205
+ content:
206
+ application/json;charset=utf-8:
207
+ schema:
208
+ allOf:
209
+ - $ref: '#/components/schemas/Error'
210
+ - description: Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
211
+ deprecated: false
212
+ /service/{id}:
213
+ get:
214
+ tags:
215
+ - service
216
+ summary: retrieveService
217
+ description: This operation retrieves a Service entity. Attribute selection is enabled for all first level attributes.
218
+ operationId: retrieveService
219
+ parameters:
220
+ - name: id
221
+ in: path
222
+ description: Identifier of the Service
223
+ required: true
224
+ style: simple
225
+ schema:
226
+ type: string
227
+ - name: fields
228
+ in: query
229
+ description: Comma-separated properties to provide in response
230
+ style: form
231
+ explode: true
232
+ schema:
233
+ type: string
234
+ responses:
235
+ '200':
236
+ description: Success
237
+ headers: {}
238
+ content:
239
+ application/json;charset=utf-8:
240
+ schema:
241
+ allOf:
242
+ - $ref: '#/components/schemas/Service'
243
+ - description: 'Service is a base class for defining the Service hierarchy. All Services are characterized as either being possibly visible and usable by a Customer or not. This gives rise to the two subclasses of Service: CustomerFacingService and ResourceFacingService.'
244
+ '400':
245
+ description: Bad Request
246
+ headers: {}
247
+ content:
248
+ application/json;charset=utf-8:
249
+ schema:
250
+ allOf:
251
+ - $ref: '#/components/schemas/Error'
252
+ - description: Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
253
+ '401':
254
+ description: Unauthorized
255
+ headers: {}
256
+ content:
257
+ application/json;charset=utf-8:
258
+ schema:
259
+ allOf:
260
+ - $ref: '#/components/schemas/Error'
261
+ - description: Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
262
+ '403':
263
+ description: Forbidden
264
+ headers: {}
265
+ content:
266
+ application/json;charset=utf-8:
267
+ schema:
268
+ allOf:
269
+ - $ref: '#/components/schemas/Error'
270
+ - description: Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
271
+ '404':
272
+ description: Not Found
273
+ headers: {}
274
+ content:
275
+ application/json;charset=utf-8:
276
+ schema:
277
+ allOf:
278
+ - $ref: '#/components/schemas/Error'
279
+ - description: Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
280
+ '405':
281
+ description: Method Not allowed
282
+ headers: {}
283
+ content:
284
+ application/json;charset=utf-8:
285
+ schema:
286
+ allOf:
287
+ - $ref: '#/components/schemas/Error'
288
+ - description: Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
289
+ '409':
290
+ description: Conflict
291
+ headers: {}
292
+ content:
293
+ application/json;charset=utf-8:
294
+ schema:
295
+ allOf:
296
+ - $ref: '#/components/schemas/Error'
297
+ - description: Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
298
+ '500':
299
+ description: Internal Server Error
300
+ headers: {}
301
+ content:
302
+ application/json;charset=utf-8:
303
+ schema:
304
+ allOf:
305
+ - $ref: '#/components/schemas/Error'
306
+ - description: Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
307
+ deprecated: false
308
+ patch:
309
+ tags:
310
+ - service
311
+ summary: patchService
312
+ description: This operation updates partially a Service entity.
313
+ operationId: patchService
314
+ parameters:
315
+ - name: id
316
+ in: path
317
+ description: Identifier of the Service
318
+ required: true
319
+ style: simple
320
+ schema:
321
+ type: string
322
+ requestBody:
323
+ description: The Service to be updated
324
+ content:
325
+ application/json:
326
+ schema:
327
+ allOf:
328
+ - $ref: '#/components/schemas/ServiceRequest1'
329
+ - description: The Service to be updated
330
+ required: true
331
+ responses:
332
+ '200':
333
+ description: Updated
334
+ headers: {}
335
+ content:
336
+ application/json;charset=utf-8:
337
+ schema:
338
+ allOf:
339
+ - $ref: '#/components/schemas/Service'
340
+ - description: 'Service is a base class for defining the Service hierarchy. All Services are characterized as either being possibly visible and usable by a Customer or not. This gives rise to the two subclasses of Service: CustomerFacingService and ResourceFacingService.'
341
+ '400':
342
+ description: Bad Request
343
+ headers: {}
344
+ content:
345
+ application/json;charset=utf-8:
346
+ schema:
347
+ allOf:
348
+ - $ref: '#/components/schemas/Error'
349
+ - description: Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
350
+ '401':
351
+ description: Unauthorized
352
+ headers: {}
353
+ content:
354
+ application/json;charset=utf-8:
355
+ schema:
356
+ allOf:
357
+ - $ref: '#/components/schemas/Error'
358
+ - description: Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
359
+ '403':
360
+ description: Forbidden
361
+ headers: {}
362
+ content:
363
+ application/json;charset=utf-8:
364
+ schema:
365
+ allOf:
366
+ - $ref: '#/components/schemas/Error'
367
+ - description: Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
368
+ '404':
369
+ description: Not Found
370
+ headers: {}
371
+ content:
372
+ application/json;charset=utf-8:
373
+ schema:
374
+ allOf:
375
+ - $ref: '#/components/schemas/Error'
376
+ - description: Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
377
+ '405':
378
+ description: Method Not allowed
379
+ headers: {}
380
+ content:
381
+ application/json;charset=utf-8:
382
+ schema:
383
+ allOf:
384
+ - $ref: '#/components/schemas/Error'
385
+ - description: Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
386
+ '409':
387
+ description: Conflict
388
+ headers: {}
389
+ content:
390
+ application/json;charset=utf-8:
391
+ schema:
392
+ allOf:
393
+ - $ref: '#/components/schemas/Error'
394
+ - description: Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
395
+ '500':
396
+ description: Internal Server Error
397
+ headers: {}
398
+ content:
399
+ application/json;charset=utf-8:
400
+ schema:
401
+ allOf:
402
+ - $ref: '#/components/schemas/Error'
403
+ - description: Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
404
+ deprecated: false
405
+ delete:
406
+ tags:
407
+ - service
408
+ summary: deleteService
409
+ description: This operation deletes a Service entity.
410
+ operationId: deleteService
411
+ parameters:
412
+ - name: id
413
+ in: path
414
+ description: Identifier of the Service
415
+ required: true
416
+ style: simple
417
+ schema:
418
+ type: string
419
+ responses:
420
+ '204':
421
+ description: Deleted
422
+ headers: {}
423
+ content: {}
424
+ '400':
425
+ description: Bad Request
426
+ headers: {}
427
+ content:
428
+ application/json;charset=utf-8:
429
+ schema:
430
+ allOf:
431
+ - $ref: '#/components/schemas/Error'
432
+ - description: Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
433
+ '401':
434
+ description: Unauthorized
435
+ headers: {}
436
+ content:
437
+ application/json;charset=utf-8:
438
+ schema:
439
+ allOf:
440
+ - $ref: '#/components/schemas/Error'
441
+ - description: Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
442
+ '403':
443
+ description: Forbidden
444
+ headers: {}
445
+ content:
446
+ application/json;charset=utf-8:
447
+ schema:
448
+ allOf:
449
+ - $ref: '#/components/schemas/Error'
450
+ - description: Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
451
+ '404':
452
+ description: Not Found
453
+ headers: {}
454
+ content:
455
+ application/json;charset=utf-8:
456
+ schema:
457
+ allOf:
458
+ - $ref: '#/components/schemas/Error'
459
+ - description: Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
460
+ '405':
461
+ description: Method Not allowed
462
+ headers: {}
463
+ content:
464
+ application/json;charset=utf-8:
465
+ schema:
466
+ allOf:
467
+ - $ref: '#/components/schemas/Error'
468
+ - description: Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
469
+ '409':
470
+ description: Conflict
471
+ headers: {}
472
+ content:
473
+ application/json;charset=utf-8:
474
+ schema:
475
+ allOf:
476
+ - $ref: '#/components/schemas/Error'
477
+ - description: Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
478
+ '500':
479
+ description: Internal Server Error
480
+ headers: {}
481
+ content:
482
+ application/json;charset=utf-8:
483
+ schema:
484
+ allOf:
485
+ - $ref: '#/components/schemas/Error'
486
+ - description: Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
487
+ deprecated: false
488
+ /listener/serviceCreateEvent:
489
+ post:
490
+ tags:
491
+ - notification listeners (client side)
492
+ summary: listenToServiceCreateEvent
493
+ description: Example of a client listener for receiving the notification ServiceCreateEvent
494
+ operationId: listenToServiceCreateEvent
495
+ parameters: []
496
+ requestBody:
497
+ description: The event data
498
+ content:
499
+ application/json:
500
+ schema:
501
+ allOf:
502
+ - $ref: '#/components/schemas/ListenerServiceCreateEventRequest'
503
+ - description: The event data
504
+ required: true
505
+ responses:
506
+ '201':
507
+ description: Notified
508
+ headers: {}
509
+ content:
510
+ application/json;charset=utf-8:
511
+ schema:
512
+ allOf:
513
+ - $ref: '#/components/schemas/EventSubscription'
514
+ - description: Sets the communication endpoint address the service instance must use to deliver notification information
515
+ '400':
516
+ description: Bad Request
517
+ headers: {}
518
+ content:
519
+ application/json;charset=utf-8:
520
+ schema:
521
+ allOf:
522
+ - $ref: '#/components/schemas/Error'
523
+ - description: Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
524
+ '401':
525
+ description: Unauthorized
526
+ headers: {}
527
+ content:
528
+ application/json;charset=utf-8:
529
+ schema:
530
+ allOf:
531
+ - $ref: '#/components/schemas/Error'
532
+ - description: Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
533
+ '403':
534
+ description: Forbidden
535
+ headers: {}
536
+ content:
537
+ application/json;charset=utf-8:
538
+ schema:
539
+ allOf:
540
+ - $ref: '#/components/schemas/Error'
541
+ - description: Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
542
+ '404':
543
+ description: Not Found
544
+ headers: {}
545
+ content:
546
+ application/json;charset=utf-8:
547
+ schema:
548
+ allOf:
549
+ - $ref: '#/components/schemas/Error'
550
+ - description: Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
551
+ '405':
552
+ description: Method Not allowed
553
+ headers: {}
554
+ content:
555
+ application/json;charset=utf-8:
556
+ schema:
557
+ allOf:
558
+ - $ref: '#/components/schemas/Error'
559
+ - description: Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
560
+ '409':
561
+ description: Conflict
562
+ headers: {}
563
+ content:
564
+ application/json;charset=utf-8:
565
+ schema:
566
+ allOf:
567
+ - $ref: '#/components/schemas/Error'
568
+ - description: Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
569
+ '500':
570
+ description: Internal Server Error
571
+ headers: {}
572
+ content:
573
+ application/json;charset=utf-8:
574
+ schema:
575
+ allOf:
576
+ - $ref: '#/components/schemas/Error'
577
+ - description: Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
578
+ deprecated: false
579
+ /listener/serviceAttributeValueChangeEvent:
580
+ post:
581
+ tags:
582
+ - notification listeners (client side)
583
+ summary: listenToServiceAttributeValueChangeEvent
584
+ description: Example of a client listener for receiving the notification ServiceAttributeValueChangeEvent
585
+ operationId: listenToServiceAttributeValueChangeEvent
586
+ parameters: []
587
+ requestBody:
588
+ description: The event data
589
+ content:
590
+ application/json:
591
+ schema:
592
+ allOf:
593
+ - $ref: '#/components/schemas/ListenerServiceAttributeValueChangeEventRequest'
594
+ - description: The event data
595
+ required: true
596
+ responses:
597
+ '201':
598
+ description: Notified
599
+ headers: {}
600
+ content:
601
+ application/json;charset=utf-8:
602
+ schema:
603
+ allOf:
604
+ - $ref: '#/components/schemas/EventSubscription'
605
+ - description: Sets the communication endpoint address the service instance must use to deliver notification information
606
+ '400':
607
+ description: Bad Request
608
+ headers: {}
609
+ content:
610
+ application/json;charset=utf-8:
611
+ schema:
612
+ allOf:
613
+ - $ref: '#/components/schemas/Error'
614
+ - description: Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
615
+ '401':
616
+ description: Unauthorized
617
+ headers: {}
618
+ content:
619
+ application/json;charset=utf-8:
620
+ schema:
621
+ allOf:
622
+ - $ref: '#/components/schemas/Error'
623
+ - description: Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
624
+ '403':
625
+ description: Forbidden
626
+ headers: {}
627
+ content:
628
+ application/json;charset=utf-8:
629
+ schema:
630
+ allOf:
631
+ - $ref: '#/components/schemas/Error'
632
+ - description: Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
633
+ '404':
634
+ description: Not Found
635
+ headers: {}
636
+ content:
637
+ application/json;charset=utf-8:
638
+ schema:
639
+ allOf:
640
+ - $ref: '#/components/schemas/Error'
641
+ - description: Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
642
+ '405':
643
+ description: Method Not allowed
644
+ headers: {}
645
+ content:
646
+ application/json;charset=utf-8:
647
+ schema:
648
+ allOf:
649
+ - $ref: '#/components/schemas/Error'
650
+ - description: Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
651
+ '409':
652
+ description: Conflict
653
+ headers: {}
654
+ content:
655
+ application/json;charset=utf-8:
656
+ schema:
657
+ allOf:
658
+ - $ref: '#/components/schemas/Error'
659
+ - description: Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
660
+ '500':
661
+ description: Internal Server Error
662
+ headers: {}
663
+ content:
664
+ application/json;charset=utf-8:
665
+ schema:
666
+ allOf:
667
+ - $ref: '#/components/schemas/Error'
668
+ - description: Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
669
+ deprecated: false
670
+ /listener/serviceStateChangeEvent:
671
+ post:
672
+ tags:
673
+ - notification listeners (client side)
674
+ summary: listenToServiceStateChangeEvent
675
+ description: Example of a client listener for receiving the notification ServiceStateChangeEvent
676
+ operationId: listenToServiceStateChangeEvent
677
+ parameters: []
678
+ requestBody:
679
+ description: The event data
680
+ content:
681
+ application/json:
682
+ schema:
683
+ allOf:
684
+ - $ref: '#/components/schemas/ListenerServiceStateChangeEventRequest'
685
+ - description: The event data
686
+ required: true
687
+ responses:
688
+ '201':
689
+ description: Notified
690
+ headers: {}
691
+ content:
692
+ application/json;charset=utf-8:
693
+ schema:
694
+ allOf:
695
+ - $ref: '#/components/schemas/EventSubscription'
696
+ - description: Sets the communication endpoint address the service instance must use to deliver notification information
697
+ '400':
698
+ description: Bad Request
699
+ headers: {}
700
+ content:
701
+ application/json;charset=utf-8:
702
+ schema:
703
+ allOf:
704
+ - $ref: '#/components/schemas/Error'
705
+ - description: Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
706
+ '401':
707
+ description: Unauthorized
708
+ headers: {}
709
+ content:
710
+ application/json;charset=utf-8:
711
+ schema:
712
+ allOf:
713
+ - $ref: '#/components/schemas/Error'
714
+ - description: Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
715
+ '403':
716
+ description: Forbidden
717
+ headers: {}
718
+ content:
719
+ application/json;charset=utf-8:
720
+ schema:
721
+ allOf:
722
+ - $ref: '#/components/schemas/Error'
723
+ - description: Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
724
+ '404':
725
+ description: Not Found
726
+ headers: {}
727
+ content:
728
+ application/json;charset=utf-8:
729
+ schema:
730
+ allOf:
731
+ - $ref: '#/components/schemas/Error'
732
+ - description: Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
733
+ '405':
734
+ description: Method Not allowed
735
+ headers: {}
736
+ content:
737
+ application/json;charset=utf-8:
738
+ schema:
739
+ allOf:
740
+ - $ref: '#/components/schemas/Error'
741
+ - description: Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
742
+ '409':
743
+ description: Conflict
744
+ headers: {}
745
+ content:
746
+ application/json;charset=utf-8:
747
+ schema:
748
+ allOf:
749
+ - $ref: '#/components/schemas/Error'
750
+ - description: Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
751
+ '500':
752
+ description: Internal Server Error
753
+ headers: {}
754
+ content:
755
+ application/json;charset=utf-8:
756
+ schema:
757
+ allOf:
758
+ - $ref: '#/components/schemas/Error'
759
+ - description: Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
760
+ deprecated: false
761
+ /listener/serviceDeleteEvent:
762
+ post:
763
+ tags:
764
+ - notification listeners (client side)
765
+ summary: listenToServiceDeleteEvent
766
+ description: Example of a client listener for receiving the notification ServiceDeleteEvent
767
+ operationId: listenToServiceDeleteEvent
768
+ parameters: []
769
+ requestBody:
770
+ description: The event data
771
+ content:
772
+ application/json:
773
+ schema:
774
+ allOf:
775
+ - $ref: '#/components/schemas/ListenerServiceDeleteEventRequest'
776
+ - description: The event data
777
+ required: true
778
+ responses:
779
+ '201':
780
+ description: Notified
781
+ headers: {}
782
+ content:
783
+ application/json;charset=utf-8:
784
+ schema:
785
+ allOf:
786
+ - $ref: '#/components/schemas/EventSubscription'
787
+ - description: Sets the communication endpoint address the service instance must use to deliver notification information
788
+ '400':
789
+ description: Bad Request
790
+ headers: {}
791
+ content:
792
+ application/json;charset=utf-8:
793
+ schema:
794
+ allOf:
795
+ - $ref: '#/components/schemas/Error'
796
+ - description: Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
797
+ '401':
798
+ description: Unauthorized
799
+ headers: {}
800
+ content:
801
+ application/json;charset=utf-8:
802
+ schema:
803
+ allOf:
804
+ - $ref: '#/components/schemas/Error'
805
+ - description: Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
806
+ '403':
807
+ description: Forbidden
808
+ headers: {}
809
+ content:
810
+ application/json;charset=utf-8:
811
+ schema:
812
+ allOf:
813
+ - $ref: '#/components/schemas/Error'
814
+ - description: Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
815
+ '404':
816
+ description: Not Found
817
+ headers: {}
818
+ content:
819
+ application/json;charset=utf-8:
820
+ schema:
821
+ allOf:
822
+ - $ref: '#/components/schemas/Error'
823
+ - description: Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
824
+ '405':
825
+ description: Method Not allowed
826
+ headers: {}
827
+ content:
828
+ application/json;charset=utf-8:
829
+ schema:
830
+ allOf:
831
+ - $ref: '#/components/schemas/Error'
832
+ - description: Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
833
+ '409':
834
+ description: Conflict
835
+ headers: {}
836
+ content:
837
+ application/json;charset=utf-8:
838
+ schema:
839
+ allOf:
840
+ - $ref: '#/components/schemas/Error'
841
+ - description: Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
842
+ '500':
843
+ description: Internal Server Error
844
+ headers: {}
845
+ content:
846
+ application/json;charset=utf-8:
847
+ schema:
848
+ allOf:
849
+ - $ref: '#/components/schemas/Error'
850
+ - description: Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
851
+ deprecated: false
852
+ /hub:
853
+ post:
854
+ tags:
855
+ - events subscription
856
+ summary: registerListener
857
+ description: Sets the communication endpoint address the service instance must use to deliver information about its health state, execution state, failures and metrics.
858
+ operationId: registerListener
859
+ parameters: []
860
+ requestBody:
861
+ description: Data containing the callback endpoint to deliver the information
862
+ content:
863
+ application/json:
864
+ schema:
865
+ allOf:
866
+ - $ref: '#/components/schemas/HubRequest'
867
+ - description: Data containing the callback endpoint to deliver the information
868
+ required: true
869
+ responses:
870
+ '201':
871
+ description: Subscribed
872
+ headers: {}
873
+ content:
874
+ application/json;charset=utf-8:
875
+ schema:
876
+ allOf:
877
+ - $ref: '#/components/schemas/EventSubscription'
878
+ - description: Sets the communication endpoint address the service instance must use to deliver notification information
879
+ '400':
880
+ description: Bad Request
881
+ headers: {}
882
+ content:
883
+ application/json;charset=utf-8:
884
+ schema:
885
+ allOf:
886
+ - $ref: '#/components/schemas/Error'
887
+ - description: Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
888
+ '401':
889
+ description: Unauthorized
890
+ headers: {}
891
+ content:
892
+ application/json;charset=utf-8:
893
+ schema:
894
+ allOf:
895
+ - $ref: '#/components/schemas/Error'
896
+ - description: Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
897
+ '403':
898
+ description: Forbidden
899
+ headers: {}
900
+ content:
901
+ application/json;charset=utf-8:
902
+ schema:
903
+ allOf:
904
+ - $ref: '#/components/schemas/Error'
905
+ - description: Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
906
+ '404':
907
+ description: Not Found
908
+ headers: {}
909
+ content:
910
+ application/json;charset=utf-8:
911
+ schema:
912
+ allOf:
913
+ - $ref: '#/components/schemas/Error'
914
+ - description: Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
915
+ '405':
916
+ description: Method Not allowed
917
+ headers: {}
918
+ content:
919
+ application/json;charset=utf-8:
920
+ schema:
921
+ allOf:
922
+ - $ref: '#/components/schemas/Error'
923
+ - description: Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
924
+ '409':
925
+ description: Conflict
926
+ headers: {}
927
+ content:
928
+ application/json;charset=utf-8:
929
+ schema:
930
+ allOf:
931
+ - $ref: '#/components/schemas/Error'
932
+ - description: Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
933
+ '500':
934
+ description: Internal Server Error
935
+ headers: {}
936
+ content:
937
+ application/json;charset=utf-8:
938
+ schema:
939
+ allOf:
940
+ - $ref: '#/components/schemas/Error'
941
+ - description: Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
942
+ deprecated: false
943
+ /hub/{id}:
944
+ delete:
945
+ tags:
946
+ - events subscription
947
+ summary: unregisterListener
948
+ description: Resets the communication endpoint address the service instance must use to deliver information about its health state, execution state, failures and metrics.
949
+ operationId: unregisterListener
950
+ parameters:
951
+ - name: id
952
+ in: path
953
+ description: The id of the registered listener
954
+ required: true
955
+ style: simple
956
+ schema:
957
+ type: string
958
+ responses:
959
+ '204':
960
+ description: Deleted
961
+ headers: {}
962
+ content: {}
963
+ '400':
964
+ description: Bad request
965
+ headers: {}
966
+ content:
967
+ application/json;charset=utf-8:
968
+ schema:
969
+ allOf:
970
+ - $ref: '#/components/schemas/Error'
971
+ - description: Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
972
+ '401':
973
+ description: Unauthorized
974
+ headers: {}
975
+ content:
976
+ application/json;charset=utf-8:
977
+ schema:
978
+ allOf:
979
+ - $ref: '#/components/schemas/Error'
980
+ - description: Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
981
+ '403':
982
+ description: Forbidden
983
+ headers: {}
984
+ content:
985
+ application/json;charset=utf-8:
986
+ schema:
987
+ allOf:
988
+ - $ref: '#/components/schemas/Error'
989
+ - description: Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
990
+ '404':
991
+ description: Not Found
992
+ headers: {}
993
+ content:
994
+ application/json;charset=utf-8:
995
+ schema:
996
+ allOf:
997
+ - $ref: '#/components/schemas/Error'
998
+ - description: Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
999
+ '405':
1000
+ description: Method not allowed
1001
+ headers: {}
1002
+ content:
1003
+ application/json;charset=utf-8:
1004
+ schema:
1005
+ allOf:
1006
+ - $ref: '#/components/schemas/Error'
1007
+ - description: Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
1008
+ '500':
1009
+ description: Internal Server Error
1010
+ headers: {}
1011
+ content:
1012
+ application/json;charset=utf-8:
1013
+ schema:
1014
+ allOf:
1015
+ - $ref: '#/components/schemas/Error'
1016
+ - description: Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
1017
+ deprecated: false
1018
+ components:
1019
+ schemas:
1020
+ Addressable:
1021
+ title: Addressable
1022
+ type: object
1023
+ properties:
1024
+ id:
1025
+ type: string
1026
+ description: unique identifier
1027
+ href:
1028
+ type: string
1029
+ description: Hyperlink reference
1030
+ description: Base schema for adressable entities
1031
+ Characteristic:
1032
+ title: Characteristic
1033
+ required:
1034
+ - name
1035
+ - value
1036
+ type: object
1037
+ properties:
1038
+ id:
1039
+ type: string
1040
+ description: Unique identifier of the characteristic
1041
+ name:
1042
+ type: string
1043
+ description: Name of the characteristic
1044
+ valueType:
1045
+ type: string
1046
+ description: Data type of the value of the characteristic
1047
+ characteristicRelationship:
1048
+ type: array
1049
+ items:
1050
+ $ref: '#/components/schemas/CharacteristicRelationship'
1051
+ description: ''
1052
+ value: {}
1053
+ '@baseType':
1054
+ type: string
1055
+ description: When sub-classing, this defines the super-class
1056
+ '@schemaLocation':
1057
+ type: string
1058
+ description: A URI to a JSON-Schema file that defines additional attributes and relationships
1059
+ '@type':
1060
+ type: string
1061
+ description: When sub-classing, this defines the sub-class Extensible name
1062
+ description: Describes a given characteristic of an object or entity through a name/value pair.
1063
+ CharacteristicRelationship:
1064
+ title: CharacteristicRelationship
1065
+ type: object
1066
+ properties:
1067
+ id:
1068
+ type: string
1069
+ description: Unique identifier of the characteristic
1070
+ relationshipType:
1071
+ type: string
1072
+ description: The type of relationship
1073
+ description: Another Characteristic that is related to the current Characteristic;
1074
+ ConstraintRef:
1075
+ title: ConstraintRef
1076
+ required:
1077
+ - id
1078
+ type: object
1079
+ properties:
1080
+ id:
1081
+ type: string
1082
+ description: reference id to the target constraint
1083
+ href:
1084
+ type: string
1085
+ description: Hyperlink reference to the target constraint
1086
+ name:
1087
+ type: string
1088
+ description: Name given to the constraint
1089
+ version:
1090
+ type: string
1091
+ description: constraint version
1092
+ '@baseType':
1093
+ type: string
1094
+ description: When sub-classing, this defines the super-class
1095
+ '@schemaLocation':
1096
+ type: string
1097
+ description: A URI to a JSON-Schema file that defines additional attributes and relationships
1098
+ '@type':
1099
+ type: string
1100
+ description: When sub-classing, this defines the sub-class Extensible name
1101
+ '@referredType':
1102
+ type: string
1103
+ description: The (class) type of the referred constraint
1104
+ description: Constraint reference. The Constraint resource represents a policy/rule applied to an entity or entity spec.
1105
+ EntityRef:
1106
+ title: EntityRef
1107
+ required:
1108
+ - id
1109
+ type: object
1110
+ properties:
1111
+ id:
1112
+ type: string
1113
+ description: unique identifier
1114
+ href:
1115
+ type: string
1116
+ description: Hyperlink reference
1117
+ name:
1118
+ type: string
1119
+ description: Name of the related entity.
1120
+ '@baseType':
1121
+ type: string
1122
+ description: When sub-classing, this defines the super-class
1123
+ '@schemaLocation':
1124
+ type: string
1125
+ description: A URI to a JSON-Schema file that defines additional attributes and relationships
1126
+ '@type':
1127
+ type: string
1128
+ description: When sub-classing, this defines the sub-class Extensible name
1129
+ '@referredType':
1130
+ type: string
1131
+ description: The actual type of the target instance when needed for disambiguation.
1132
+ description: Entity reference schema to be use for all entityRef class.
1133
+ EntityValue:
1134
+ title: EntityValue
1135
+ type: object
1136
+ properties:
1137
+ id:
1138
+ type: string
1139
+ description: Unique identifier of a related entity.
1140
+ href:
1141
+ type: string
1142
+ description: Reference of the related entity.
1143
+ description: Base entity value schema for use in TMForum Open-APIs
1144
+ Extensible:
1145
+ title: Extensible
1146
+ type: object
1147
+ properties:
1148
+ '@baseType':
1149
+ type: string
1150
+ description: When sub-classing, this defines the super-class
1151
+ '@schemaLocation':
1152
+ type: string
1153
+ description: A URI to a JSON-Schema file that defines additional attributes and relationships
1154
+ '@type':
1155
+ type: string
1156
+ description: When sub-classing, this defines the sub-class Extensible name
1157
+ description: Base Extensible schema for use in TMForum Open-APIs
1158
+ Feature:
1159
+ title: Feature
1160
+ required:
1161
+ - id
1162
+ - name
1163
+ - featureCharacteristic
1164
+ type: object
1165
+ properties:
1166
+ id:
1167
+ type: string
1168
+ description: Unique identifier of the feature.
1169
+ isBundle:
1170
+ type: boolean
1171
+ description: True if this is a feature group. Default is false.
1172
+ isEnabled:
1173
+ type: boolean
1174
+ description: True if this feature is enabled. Default is true.
1175
+ name:
1176
+ type: string
1177
+ description: This is the name for the feature.
1178
+ constraint:
1179
+ type: array
1180
+ items:
1181
+ $ref: '#/components/schemas/ConstraintRef'
1182
+ description: This is a list of feature constraints.
1183
+ featureCharacteristic:
1184
+ minItems: 1
1185
+ type: array
1186
+ items:
1187
+ $ref: '#/components/schemas/Characteristic'
1188
+ description: This is a list of Characteristics for a particular feature.
1189
+ featureRelationship:
1190
+ type: array
1191
+ items:
1192
+ $ref: '#/components/schemas/FeatureRelationship'
1193
+ description: ''
1194
+ description: Configuration feature.
1195
+ FeatureRelationship:
1196
+ title: FeatureRelationship
1197
+ required:
1198
+ - name
1199
+ - relationshipType
1200
+ type: object
1201
+ properties:
1202
+ id:
1203
+ type: string
1204
+ description: Unique identifier of the target feature.
1205
+ name:
1206
+ type: string
1207
+ description: This is the name of the target feature.
1208
+ relationshipType:
1209
+ type: string
1210
+ description: This is the type of the feature relationship.
1211
+ validFor:
1212
+ $ref: '#/components/schemas/ValidFor'
1213
+ description: Configuration feature
1214
+ Note:
1215
+ title: Note
1216
+ required:
1217
+ - author
1218
+ - date
1219
+ - text
1220
+ type: object
1221
+ properties:
1222
+ id:
1223
+ type: string
1224
+ description: Identifier of the note within its containing entity (may or may not be globally unique, depending on provider implementation)
1225
+ author:
1226
+ type: string
1227
+ description: Author of the note
1228
+ date:
1229
+ type: string
1230
+ description: Date of the note
1231
+ format: date-time
1232
+ text:
1233
+ type: string
1234
+ description: Text of the note
1235
+ description: Extra information about a given entity
1236
+ OrderItemActionType:
1237
+ title: OrderItemActionType
1238
+ enum:
1239
+ - add
1240
+ - modify
1241
+ - delete
1242
+ - noChange
1243
+ type: string
1244
+ description: action to be performed on the product
1245
+ Place:
1246
+ title: Place
1247
+ type: object
1248
+ properties:
1249
+ id:
1250
+ type: string
1251
+ description: Unique identifier of the place
1252
+ href:
1253
+ type: string
1254
+ description: Unique reference of the place
1255
+ name:
1256
+ type: string
1257
+ description: A user-friendly name for the place, such as [Paris Store], [London Store], [Main Home]
1258
+ description: Place reference. Place defines the places where the products are sold or delivered.
1259
+ PlaceRef:
1260
+ title: PlaceRef
1261
+ required:
1262
+ - id
1263
+ type: object
1264
+ properties:
1265
+ id:
1266
+ type: string
1267
+ description: unique identifier
1268
+ href:
1269
+ type: string
1270
+ description: Hyperlink reference
1271
+ name:
1272
+ type: string
1273
+ description: Name of the related entity.
1274
+ '@baseType':
1275
+ type: string
1276
+ description: When sub-classing, this defines the super-class
1277
+ '@schemaLocation':
1278
+ type: string
1279
+ description: A URI to a JSON-Schema file that defines additional attributes and relationships
1280
+ '@type':
1281
+ type: string
1282
+ description: When sub-classing, this defines the sub-class Extensible name
1283
+ '@referredType':
1284
+ type: string
1285
+ description: The actual type of the target instance when needed for disambiguation.
1286
+ description: Place reference. PlaceRef defines the placeRefs where the products are sold or delivered.
1287
+ RelatedEntityRefOrValue:
1288
+ title: RelatedEntityRefOrValue
1289
+ required:
1290
+ - role
1291
+ type: object
1292
+ properties:
1293
+ id:
1294
+ type: string
1295
+ description: Unique identifier of a related entity.
1296
+ href:
1297
+ type: string
1298
+ description: Reference of the related entity.
1299
+ name:
1300
+ type: string
1301
+ description: Name of the related entity.
1302
+ role:
1303
+ type: string
1304
+ '@baseType':
1305
+ type: string
1306
+ description: When sub-classing, this defines the super-class
1307
+ '@schemaLocation':
1308
+ type: string
1309
+ description: A URI to a JSON-Schema file that defines additional attributes and relationships
1310
+ '@type':
1311
+ type: string
1312
+ description: When sub-classing, this defines the sub-class Extensible name
1313
+ '@referredType':
1314
+ type: string
1315
+ description: The actual type of the target instance when needed for disambiguation.
1316
+ description: A reference to an entity, where the type of the entity is not known in advance. A related entity defines a entity described by reference or by value linked to a specific entity. The polymorphic attributes @type, @schemaLocation & @referredType are related to the Entity and not the RelatedEntityRefOrValue class itself
1317
+ RelatedParty:
1318
+ title: RelatedParty
1319
+ required:
1320
+ - id
1321
+ - '@referredType'
1322
+ type: object
1323
+ properties:
1324
+ id:
1325
+ type: string
1326
+ description: unique identifier
1327
+ href:
1328
+ type: string
1329
+ description: Hyperlink reference
1330
+ name:
1331
+ type: string
1332
+ description: Name of the related entity.
1333
+ role:
1334
+ type: string
1335
+ description: Role played by the related party
1336
+ '@baseType':
1337
+ type: string
1338
+ description: When sub-classing, this defines the super-class
1339
+ '@schemaLocation':
1340
+ type: string
1341
+ description: A URI to a JSON-Schema file that defines additional attributes and relationships
1342
+ '@type':
1343
+ type: string
1344
+ description: When sub-classing, this defines the sub-class Extensible name
1345
+ '@referredType':
1346
+ type: string
1347
+ description: The actual type of the target instance when needed for disambiguation.
1348
+ description: Related Entity reference. A related party defines party or party role linked to a specific entity.
1349
+ RelatedPlaceRefOrValue:
1350
+ title: RelatedPlaceRefOrValue
1351
+ required:
1352
+ - role
1353
+ type: object
1354
+ properties:
1355
+ id:
1356
+ type: string
1357
+ description: Unique identifier of the place
1358
+ href:
1359
+ type: string
1360
+ description: Unique reference of the place
1361
+ name:
1362
+ type: string
1363
+ description: A user-friendly name for the place, such as [Paris Store], [London Store], [Main Home]
1364
+ role:
1365
+ type: string
1366
+ '@baseType':
1367
+ type: string
1368
+ description: When sub-classing, this defines the super-class
1369
+ '@schemaLocation':
1370
+ type: string
1371
+ description: A URI to a JSON-Schema file that defines additional attributes and relationships
1372
+ '@type':
1373
+ type: string
1374
+ description: When sub-classing, this defines the sub-class Extensible name
1375
+ '@referredType':
1376
+ type: string
1377
+ description: The actual type of the target instance when needed for disambiguation.
1378
+ 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
1379
+ RelatedServiceOrderItem:
1380
+ title: RelatedServiceOrderItem
1381
+ required:
1382
+ - itemId
1383
+ - serviceOrderId
1384
+ type: object
1385
+ properties:
1386
+ itemId:
1387
+ type: string
1388
+ description: Identifier of the order item where the service was managed
1389
+ role:
1390
+ type: string
1391
+ description: role of the service order item for this service
1392
+ serviceOrderHref:
1393
+ type: string
1394
+ description: Reference of the related entity.
1395
+ serviceOrderId:
1396
+ type: string
1397
+ description: Unique identifier of a related entity.
1398
+ itemAction:
1399
+ $ref: '#/components/schemas/OrderItemActionType'
1400
+ '@referredType':
1401
+ type: string
1402
+ description: The actual type of the target instance when needed for disambiguation.
1403
+ description: RelatedServiceOrderItem (a ServiceOrder item) .The service order item which triggered service creation/change/termination.
1404
+ ResourceRef:
1405
+ title: ResourceRef
1406
+ required:
1407
+ - id
1408
+ type: object
1409
+ properties:
1410
+ id:
1411
+ type: string
1412
+ description: unique identifier
1413
+ href:
1414
+ type: string
1415
+ description: Hyperlink reference
1416
+ name:
1417
+ type: string
1418
+ description: Name of the related entity.
1419
+ '@baseType':
1420
+ type: string
1421
+ description: When sub-classing, this defines the super-class
1422
+ '@schemaLocation':
1423
+ type: string
1424
+ description: A URI to a JSON-Schema file that defines additional attributes and relationships
1425
+ '@type':
1426
+ type: string
1427
+ description: When sub-classing, this defines the sub-class Extensible name
1428
+ '@referredType':
1429
+ type: string
1430
+ description: The actual type of the target instance when needed for disambiguation.
1431
+ Service:
1432
+ title: Service
1433
+ type: object
1434
+ properties:
1435
+ id:
1436
+ type: string
1437
+ description: Unique identifier of the service
1438
+ href:
1439
+ type: string
1440
+ description: Reference of the service
1441
+ category:
1442
+ type: string
1443
+ description: Is it a customer facing or resource facing service
1444
+ description:
1445
+ type: string
1446
+ description: Free-text description of the service
1447
+ endDate:
1448
+ type: string
1449
+ description: Date when the service ends
1450
+ format: date-time
1451
+ hasStarted:
1452
+ type: boolean
1453
+ description: If TRUE, this Service has already been started
1454
+ isBundle:
1455
+ type: boolean
1456
+ description: If true, the service is a ServiceBundle which regroup a service hierachy. If false, the service is a 'atomic' service (hierachy leaf).
1457
+ isServiceEnabled:
1458
+ type: boolean
1459
+ description: If FALSE and hasStarted is FALSE, this particular Service has NOT been enabled for use - if FALSE and hasStarted is TRUE then the service has failed
1460
+ isStateful:
1461
+ type: boolean
1462
+ description: If TRUE, this Service can be changed without affecting any other services
1463
+ name:
1464
+ type: string
1465
+ description: Name of the service
1466
+ serviceDate:
1467
+ type: string
1468
+ description: Date when the service was created (whatever its status).
1469
+ serviceType:
1470
+ type: string
1471
+ description: Business type of the service
1472
+ startDate:
1473
+ type: string
1474
+ description: Date when the service starts
1475
+ format: date-time
1476
+ startMode:
1477
+ type: string
1478
+ description: 'This attribute is an enumerated integer that indicates how the Service is started, such as: 0: Unknown; 1: Automatically by the managed environment; 2: Automatically by the owning device; 3: Manually by the Provider of the Service; 4: Manually by a Customer of the Provider; 5: Any of the above'
1479
+ feature:
1480
+ type: array
1481
+ items:
1482
+ $ref: '#/components/schemas/Feature'
1483
+ description: A list of feature associated with this service
1484
+ note:
1485
+ type: array
1486
+ items:
1487
+ $ref: '#/components/schemas/Note'
1488
+ description: A list of notes made on this service
1489
+ place:
1490
+ type: array
1491
+ items:
1492
+ $ref: '#/components/schemas/RelatedPlaceRefOrValue'
1493
+ description: A list of places (Place [*]). Used to define a place useful for the service (for example a geographical place whre the service is installed)
1494
+ relatedEntity:
1495
+ type: array
1496
+ items:
1497
+ $ref: '#/components/schemas/RelatedEntityRefOrValue'
1498
+ description: A list of related entity in relationship with this service
1499
+ relatedParty:
1500
+ type: array
1501
+ items:
1502
+ $ref: '#/components/schemas/RelatedParty'
1503
+ description: A list of related party references (RelatedParty [*]). A related party defines party or party role linked to a specific entity
1504
+ serviceCharacteristic:
1505
+ type: array
1506
+ items:
1507
+ $ref: '#/components/schemas/Characteristic'
1508
+ description: A list of characteristics that characterize this service (ServiceCharacteristic [*])
1509
+ serviceOrderItem:
1510
+ type: array
1511
+ items:
1512
+ $ref: '#/components/schemas/RelatedServiceOrderItem'
1513
+ description: A list of service order items related to this service
1514
+ serviceRelationship:
1515
+ type: array
1516
+ items:
1517
+ $ref: '#/components/schemas/ServiceRelationship'
1518
+ description: A list of service relationships (ServiceRelationship [*]). Describes links with other service(s) in the inventory.
1519
+ serviceSpecification:
1520
+ $ref: '#/components/schemas/ServiceSpecification'
1521
+ state:
1522
+ $ref: '#/components/schemas/ServiceStateType'
1523
+ supportingResource:
1524
+ type: array
1525
+ items:
1526
+ $ref: '#/components/schemas/ResourceRef'
1527
+ description: 'A list of supporting resources (SupportingResource [*]).Note: only Service of type RFS can be associated with Resources'
1528
+ supportingService:
1529
+ type: array
1530
+ items:
1531
+ $ref: '#/components/schemas/ServiceRefOrValue'
1532
+ description: A list of supporting services (SupportingService [*]). A collection of services that support this service (bundling, link CFS to RFS)
1533
+ description: 'Service is a base class for defining the Service hierarchy. All Services are characterized as either being possibly visible and usable by a Customer or not. This gives rise to the two subclasses of Service: CustomerFacingService and ResourceFacingService.'
1534
+ Service_Create:
1535
+ title: Service_Create
1536
+ required:
1537
+ - serviceSpecification
1538
+ - state
1539
+ type: object
1540
+ properties:
1541
+ category:
1542
+ type: string
1543
+ description: Is it a customer facing or resource facing service
1544
+ description:
1545
+ type: string
1546
+ description: Free-text description of the service
1547
+ endDate:
1548
+ type: string
1549
+ description: Date when the service ends
1550
+ format: date-time
1551
+ hasStarted:
1552
+ type: boolean
1553
+ description: If TRUE, this Service has already been started
1554
+ isBundle:
1555
+ type: boolean
1556
+ description: If true, the service is a ServiceBundle which regroup a service hierachy. If false, the service is a 'atomic' service (hierachy leaf).
1557
+ isServiceEnabled:
1558
+ type: boolean
1559
+ description: If FALSE and hasStarted is FALSE, this particular Service has NOT been enabled for use - if FALSE and hasStarted is TRUE then the service has failed
1560
+ isStateful:
1561
+ type: boolean
1562
+ description: If TRUE, this Service can be changed without affecting any other services
1563
+ name:
1564
+ type: string
1565
+ description: Name of the service
1566
+ serviceDate:
1567
+ type: string
1568
+ description: Date when the service was created (whatever its status).
1569
+ serviceType:
1570
+ type: string
1571
+ description: Business type of the service
1572
+ startDate:
1573
+ type: string
1574
+ description: Date when the service starts
1575
+ format: date-time
1576
+ startMode:
1577
+ type: string
1578
+ description: 'This attribute is an enumerated integer that indicates how the Service is started, such as: 0: Unknown; 1: Automatically by the managed environment; 2: Automatically by the owning device; 3: Manually by the Provider of the Service; 4: Manually by a Customer of the Provider; 5: Any of the above'
1579
+ feature:
1580
+ type: array
1581
+ items:
1582
+ $ref: '#/components/schemas/Feature'
1583
+ description: A list of feature associated with this service
1584
+ note:
1585
+ type: array
1586
+ items:
1587
+ $ref: '#/components/schemas/Note'
1588
+ description: A list of notes made on this service
1589
+ place:
1590
+ type: array
1591
+ items:
1592
+ $ref: '#/components/schemas/RelatedPlaceRefOrValue'
1593
+ description: A list of places (Place [*]). Used to define a place useful for the service (for example a geographical place whre the service is installed)
1594
+ relatedEntity:
1595
+ type: array
1596
+ items:
1597
+ $ref: '#/components/schemas/RelatedEntityRefOrValue'
1598
+ description: A list of related entity in relationship with this service
1599
+ relatedParty:
1600
+ type: array
1601
+ items:
1602
+ $ref: '#/components/schemas/RelatedParty'
1603
+ description: A list of related party references (RelatedParty [*]). A related party defines party or party role linked to a specific entity
1604
+ serviceCharacteristic:
1605
+ type: array
1606
+ items:
1607
+ $ref: '#/components/schemas/Characteristic'
1608
+ description: A list of characteristics that characterize this service (ServiceCharacteristic [*])
1609
+ serviceOrderItem:
1610
+ type: array
1611
+ items:
1612
+ $ref: '#/components/schemas/RelatedServiceOrderItem'
1613
+ description: A list of service order items related to this service
1614
+ serviceRelationship:
1615
+ type: array
1616
+ items:
1617
+ $ref: '#/components/schemas/ServiceRelationship'
1618
+ description: A list of service relationships (ServiceRelationship [*]). Describes links with other service(s) in the inventory.
1619
+ serviceSpecification:
1620
+ $ref: '#/components/schemas/ServiceSpecification'
1621
+ state:
1622
+ $ref: '#/components/schemas/ServiceStateType'
1623
+ supportingResource:
1624
+ type: array
1625
+ items:
1626
+ $ref: '#/components/schemas/ResourceRef'
1627
+ description: 'A list of supporting resources (SupportingResource [*]).Note: only Service of type RFS can be associated with Resources'
1628
+ supportingService:
1629
+ type: array
1630
+ items:
1631
+ $ref: '#/components/schemas/ServiceRefOrValue'
1632
+ description: A list of supporting services (SupportingService [*]). A collection of services that support this service (bundling, link CFS to RFS)
1633
+ description: >-
1634
+ Service is a base class for defining the Service hierarchy. All Services are characterized as either being possibly visible and usable by a Customer or not. This gives rise to the two subclasses of Service: CustomerFacingService and ResourceFacingService.
1635
+
1636
+ Skipped properties: id,href
1637
+ Service_Update:
1638
+ title: Service_Update
1639
+ type: object
1640
+ properties:
1641
+ category:
1642
+ type: string
1643
+ description: Is it a customer facing or resource facing service
1644
+ description:
1645
+ type: string
1646
+ description: Free-text description of the service
1647
+ endDate:
1648
+ type: string
1649
+ description: Date when the service ends
1650
+ format: date-time
1651
+ hasStarted:
1652
+ type: boolean
1653
+ description: If TRUE, this Service has already been started
1654
+ isBundle:
1655
+ type: boolean
1656
+ description: If true, the service is a ServiceBundle which regroup a service hierachy. If false, the service is a 'atomic' service (hierachy leaf).
1657
+ isServiceEnabled:
1658
+ type: boolean
1659
+ description: If FALSE and hasStarted is FALSE, this particular Service has NOT been enabled for use - if FALSE and hasStarted is TRUE then the service has failed
1660
+ isStateful:
1661
+ type: boolean
1662
+ description: If TRUE, this Service can be changed without affecting any other services
1663
+ name:
1664
+ type: string
1665
+ description: Name of the service
1666
+ serviceType:
1667
+ type: string
1668
+ description: Business type of the service
1669
+ startDate:
1670
+ type: string
1671
+ description: Date when the service starts
1672
+ format: date-time
1673
+ startMode:
1674
+ type: string
1675
+ description: 'This attribute is an enumerated integer that indicates how the Service is started, such as: 0: Unknown; 1: Automatically by the managed environment; 2: Automatically by the owning device; 3: Manually by the Provider of the Service; 4: Manually by a Customer of the Provider; 5: Any of the above'
1676
+ feature:
1677
+ type: array
1678
+ items:
1679
+ $ref: '#/components/schemas/Feature'
1680
+ description: A list of feature associated with this service
1681
+ note:
1682
+ type: array
1683
+ items:
1684
+ $ref: '#/components/schemas/Note'
1685
+ description: A list of notes made on this service
1686
+ place:
1687
+ type: array
1688
+ items:
1689
+ $ref: '#/components/schemas/RelatedPlaceRefOrValue'
1690
+ description: A list of places (Place [*]). Used to define a place useful for the service (for example a geographical place whre the service is installed)
1691
+ relatedEntity:
1692
+ type: array
1693
+ items:
1694
+ $ref: '#/components/schemas/RelatedEntityRefOrValue'
1695
+ description: A list of related entity in relationship with this service
1696
+ relatedParty:
1697
+ type: array
1698
+ items:
1699
+ $ref: '#/components/schemas/RelatedParty'
1700
+ description: A list of related party references (RelatedParty [*]). A related party defines party or party role linked to a specific entity
1701
+ serviceCharacteristic:
1702
+ type: array
1703
+ items:
1704
+ $ref: '#/components/schemas/Characteristic'
1705
+ description: A list of characteristics that characterize this service (ServiceCharacteristic [*])
1706
+ serviceOrderItem:
1707
+ type: array
1708
+ items:
1709
+ $ref: '#/components/schemas/RelatedServiceOrderItem'
1710
+ description: A list of service order items related to this service
1711
+ serviceRelationship:
1712
+ type: array
1713
+ items:
1714
+ $ref: '#/components/schemas/ServiceRelationship'
1715
+ description: A list of service relationships (ServiceRelationship [*]). Describes links with other service(s) in the inventory.
1716
+ serviceSpecification:
1717
+ $ref: '#/components/schemas/ServiceSpecification'
1718
+ state:
1719
+ $ref: '#/components/schemas/ServiceStateType'
1720
+ supportingResource:
1721
+ type: array
1722
+ items:
1723
+ $ref: '#/components/schemas/ResourceRef'
1724
+ description: 'A list of supporting resources (SupportingResource [*]).Note: only Service of type RFS can be associated with Resources'
1725
+ supportingService:
1726
+ type: array
1727
+ items:
1728
+ $ref: '#/components/schemas/ServiceRefOrValue'
1729
+ description: A list of supporting services (SupportingService [*]). A collection of services that support this service (bundling, link CFS to RFS)
1730
+ description: >-
1731
+ Service is a base class for defining the Service hierarchy. All Services are characterized as either being possibly visible and usable by a Customer or not. This gives rise to the two subclasses of Service: CustomerFacingService and ResourceFacingService.
1732
+
1733
+ Skipped properties: id,href,serviceDate
1734
+ ServiceRef:
1735
+ title: ServiceRef
1736
+ required:
1737
+ - id
1738
+ type: object
1739
+ properties:
1740
+ id:
1741
+ type: string
1742
+ description: unique identifier
1743
+ href:
1744
+ type: string
1745
+ description: Hyperlink reference
1746
+ name:
1747
+ type: string
1748
+ description: Name of the related entity.
1749
+ '@baseType':
1750
+ type: string
1751
+ description: When sub-classing, this defines the super-class
1752
+ '@schemaLocation':
1753
+ type: string
1754
+ description: A URI to a JSON-Schema file that defines additional attributes and relationships
1755
+ '@type':
1756
+ type: string
1757
+ description: When sub-classing, this defines the sub-class Extensible name
1758
+ '@referredType':
1759
+ type: string
1760
+ description: The actual type of the target instance when needed for disambiguation.
1761
+ description: Service reference, for when Service is used by other entities
1762
+ ServiceRefOrValue:
1763
+ title: ServiceRefOrValue
1764
+ required:
1765
+ - id
1766
+ type: object
1767
+ properties:
1768
+ id:
1769
+ type: string
1770
+ description: Unique identifier of the service
1771
+ href:
1772
+ type: string
1773
+ description: Reference of the service
1774
+ category:
1775
+ type: string
1776
+ description: Is it a customer facing or resource facing service
1777
+ description:
1778
+ type: string
1779
+ description: Free-text description of the service
1780
+ endDate:
1781
+ type: string
1782
+ description: Date when the service ends
1783
+ format: date-time
1784
+ hasStarted:
1785
+ type: boolean
1786
+ description: If TRUE, this Service has already been started
1787
+ isBundle:
1788
+ type: boolean
1789
+ description: If true, the service is a ServiceBundle which regroup a service hierachy. If false, the service is a 'atomic' service (hierachy leaf).
1790
+ isServiceEnabled:
1791
+ type: boolean
1792
+ description: If FALSE and hasStarted is FALSE, this particular Service has NOT been enabled for use - if FALSE and hasStarted is TRUE then the service has failed
1793
+ isStateful:
1794
+ type: boolean
1795
+ description: If TRUE, this Service can be changed without affecting any other services
1796
+ name:
1797
+ type: string
1798
+ description: Name of the service
1799
+ serviceDate:
1800
+ type: string
1801
+ description: Date when the service was created (whatever its status).
1802
+ serviceType:
1803
+ type: string
1804
+ description: Business type of the service
1805
+ startDate:
1806
+ type: string
1807
+ description: Date when the service starts
1808
+ format: date-time
1809
+ startMode:
1810
+ type: string
1811
+ description: 'This attribute is an enumerated integer that indicates how the Service is started, such as: 0: Unknown; 1: Automatically by the managed environment; 2: Automatically by the owning device; 3: Manually by the Provider of the Service; 4: Manually by a Customer of the Provider; 5: Any of the above'
1812
+ feature:
1813
+ type: array
1814
+ items:
1815
+ $ref: '#/components/schemas/Feature'
1816
+ description: A list of feature associated with this service
1817
+ note:
1818
+ type: array
1819
+ items:
1820
+ $ref: '#/components/schemas/Note'
1821
+ description: A list of notes made on this service
1822
+ place:
1823
+ type: array
1824
+ items:
1825
+ $ref: '#/components/schemas/RelatedPlaceRefOrValue'
1826
+ description: A list of places (Place [*]). Used to define a place useful for the service (for example a geographical place whre the service is installed)
1827
+ relatedEntity:
1828
+ type: array
1829
+ items:
1830
+ $ref: '#/components/schemas/RelatedEntityRefOrValue'
1831
+ description: A list of related entity in relationship with this service
1832
+ relatedParty:
1833
+ type: array
1834
+ items:
1835
+ $ref: '#/components/schemas/RelatedParty'
1836
+ description: A list of related party references (RelatedParty [*]). A related party defines party or party role linked to a specific entity
1837
+ serviceCharacteristic:
1838
+ type: array
1839
+ items:
1840
+ $ref: '#/components/schemas/Characteristic'
1841
+ description: A list of characteristics that characterize this service (ServiceCharacteristic [*])
1842
+ serviceOrderItem:
1843
+ type: array
1844
+ items:
1845
+ $ref: '#/components/schemas/RelatedServiceOrderItem'
1846
+ description: A list of service order items related to this service
1847
+ serviceRelationship:
1848
+ type: array
1849
+ items:
1850
+ $ref: '#/components/schemas/ServiceRelationship'
1851
+ description: A list of service relationships (ServiceRelationship [*]). Describes links with other service(s) in the inventory.
1852
+ serviceSpecification:
1853
+ $ref: '#/components/schemas/ServiceSpecification'
1854
+ state:
1855
+ $ref: '#/components/schemas/ServiceStateType'
1856
+ supportingResource:
1857
+ type: array
1858
+ items:
1859
+ $ref: '#/components/schemas/ResourceRef'
1860
+ description: 'A list of supporting resources (SupportingResource [*]).Note: only Service of type RFS can be associated with Resources'
1861
+ supportingService:
1862
+ type: array
1863
+ items:
1864
+ $ref: '#/components/schemas/ServiceRefOrValue'
1865
+ description: A list of supporting services (SupportingService [*]). A collection of services that support this service (bundling, link CFS to RFS)
1866
+ '@baseType':
1867
+ type: string
1868
+ description: When sub-classing, this defines the super-class
1869
+ '@schemaLocation':
1870
+ type: string
1871
+ description: A URI to a JSON-Schema file that defines additional attributes and relationships
1872
+ '@type':
1873
+ type: string
1874
+ description: When sub-classing, this defines the sub-class Extensible name
1875
+ '@referredType':
1876
+ type: string
1877
+ description: The actual type of the target instance when needed for disambiguation.
1878
+ description: A Service to be created defined by value or existing defined by reference. The polymorphic attributes @type, @schemaLocation & @referredType are related to the Service entity and not the RelatedServiceRefOrValue class itself
1879
+ ServiceRelationship:
1880
+ title: ServiceRelationship
1881
+ required:
1882
+ - relationshipType
1883
+ - service
1884
+ type: object
1885
+ properties:
1886
+ relationshipType:
1887
+ type: string
1888
+ service:
1889
+ $ref: '#/components/schemas/Service1'
1890
+ serviceRelationshipCharacteristic:
1891
+ type: array
1892
+ items:
1893
+ $ref: '#/components/schemas/Characteristic'
1894
+ description: ''
1895
+ ServiceSpecificationRef:
1896
+ title: ServiceSpecificationRef
1897
+ required:
1898
+ - id
1899
+ type: object
1900
+ properties:
1901
+ id:
1902
+ type: string
1903
+ description: unique identifier
1904
+ href:
1905
+ type: string
1906
+ description: Hyperlink reference
1907
+ name:
1908
+ type: string
1909
+ description: Name of the related entity.
1910
+ version:
1911
+ type: string
1912
+ description: Service specification version
1913
+ '@baseType':
1914
+ type: string
1915
+ description: When sub-classing, this defines the super-class
1916
+ '@schemaLocation':
1917
+ type: string
1918
+ description: A URI to a JSON-Schema file that defines additional attributes and relationships
1919
+ '@type':
1920
+ type: string
1921
+ description: When sub-classing, this defines the sub-class Extensible name
1922
+ '@referredType':
1923
+ type: string
1924
+ description: The actual type of the target instance when needed for disambiguation.
1925
+ description: 'Service specification reference: ServiceSpecification(s) required to realize a ProductSpecification.'
1926
+ ServiceStateType:
1927
+ title: ServiceStateType
1928
+ enum:
1929
+ - feasibilityChecked
1930
+ - designed
1931
+ - reserved
1932
+ - inactive
1933
+ - active
1934
+ - terminated
1935
+ type: string
1936
+ description: Valid values for the lifecycle state of the service
1937
+ TimePeriod:
1938
+ title: TimePeriod
1939
+ type: object
1940
+ properties:
1941
+ endDateTime:
1942
+ type: string
1943
+ description: End of the time period, using IETC-RFC-3339 format
1944
+ format: date-time
1945
+ example: 1985-04-12T23:20:50.52Z
1946
+ startDateTime:
1947
+ type: string
1948
+ description: Start of the time period, using IETC-RFC-3339 format
1949
+ format: date-time
1950
+ example: 1985-04-12T23:20:50.52Z
1951
+ description: A period of time, either as a deadline (endDateTime only) a startDateTime only, or both
1952
+ EventSubscription:
1953
+ title: EventSubscription
1954
+ required:
1955
+ - id
1956
+ - callback
1957
+ type: object
1958
+ properties:
1959
+ id:
1960
+ type: string
1961
+ description: Id of the listener
1962
+ callback:
1963
+ type: string
1964
+ description: The callback being registered.
1965
+ query:
1966
+ type: string
1967
+ description: additional data to be passed
1968
+ description: Sets the communication endpoint address the service instance must use to deliver notification information
1969
+ EventSubscriptionInput:
1970
+ title: EventSubscriptionInput
1971
+ required:
1972
+ - callback
1973
+ type: object
1974
+ properties:
1975
+ callback:
1976
+ type: string
1977
+ description: The callback being registered.
1978
+ query:
1979
+ type: string
1980
+ description: additional data to be passed
1981
+ description: Sets the communication endpoint address the service instance must use to deliver notification information
1982
+ ServiceCreateEvent:
1983
+ title: ServiceCreateEvent
1984
+ type: object
1985
+ properties:
1986
+ event:
1987
+ $ref: '#/components/schemas/Event'
1988
+ eventId:
1989
+ type: string
1990
+ description: The identifier of the notification.
1991
+ eventTime:
1992
+ type: string
1993
+ description: Time of the event occurrence.
1994
+ format: date-time
1995
+ eventType:
1996
+ type: string
1997
+ description: The type of the notification.
1998
+ correlationId:
1999
+ type: string
2000
+ description: The correlation id for this event.
2001
+ domain:
2002
+ type: string
2003
+ description: The domain of the event.
2004
+ title:
2005
+ type: string
2006
+ description: The title of the event.
2007
+ description:
2008
+ type: string
2009
+ description: An explnatory of the event.
2010
+ priority:
2011
+ type: string
2012
+ description: A priority.
2013
+ timeOcurred:
2014
+ type: string
2015
+ description: The time the event occured.
2016
+ format: date-time
2017
+ description: The notification data structure
2018
+ ServiceCreateEventPayload:
2019
+ title: ServiceCreateEventPayload
2020
+ type: object
2021
+ properties:
2022
+ service:
2023
+ $ref: '#/components/schemas/Service2'
2024
+ description: The event data structure
2025
+ ServiceAttributeValueChangeEvent:
2026
+ title: ServiceAttributeValueChangeEvent
2027
+ type: object
2028
+ properties:
2029
+ eventId:
2030
+ type: string
2031
+ description: The identifier of the notification.
2032
+ eventTime:
2033
+ type: string
2034
+ description: Time of the event occurrence.
2035
+ format: date-time
2036
+ eventType:
2037
+ type: string
2038
+ description: The type of the notification.
2039
+ correlationId:
2040
+ type: string
2041
+ description: The correlation id for this event.
2042
+ domain:
2043
+ type: string
2044
+ description: The domain of the event.
2045
+ title:
2046
+ type: string
2047
+ description: The title of the event.
2048
+ description:
2049
+ type: string
2050
+ description: An explnatory of the event.
2051
+ priority:
2052
+ type: string
2053
+ description: A priority.
2054
+ timeOcurred:
2055
+ type: string
2056
+ description: The time the event occured.
2057
+ format: date-time
2058
+ fieldPath:
2059
+ type: string
2060
+ description: The path identifying the object field concerned by this notification.
2061
+ event:
2062
+ $ref: '#/components/schemas/Event'
2063
+ description: The notification data structure
2064
+ ServiceAttributeValueChangeEventPayload:
2065
+ title: ServiceAttributeValueChangeEventPayload
2066
+ type: object
2067
+ properties:
2068
+ service:
2069
+ $ref: '#/components/schemas/Service2'
2070
+ description: The event data structure
2071
+ ServiceStateChangeEvent:
2072
+ title: ServiceStateChangeEvent
2073
+ type: object
2074
+ properties:
2075
+ event:
2076
+ $ref: '#/components/schemas/Event'
2077
+ eventId:
2078
+ type: string
2079
+ description: The identifier of the notification.
2080
+ eventTime:
2081
+ type: string
2082
+ description: Time of the event occurrence.
2083
+ format: date-time
2084
+ eventType:
2085
+ type: string
2086
+ description: The type of the notification.
2087
+ correlationId:
2088
+ type: string
2089
+ description: The correlation id for this event.
2090
+ domain:
2091
+ type: string
2092
+ description: The domain of the event.
2093
+ title:
2094
+ type: string
2095
+ description: The title of the event.
2096
+ description:
2097
+ type: string
2098
+ description: An explnatory of the event.
2099
+ priority:
2100
+ type: string
2101
+ description: A priority.
2102
+ timeOcurred:
2103
+ type: string
2104
+ description: The time the event occured.
2105
+ format: date-time
2106
+ description: The notification data structure
2107
+ ServiceStateChangeEventPayload:
2108
+ title: ServiceStateChangeEventPayload
2109
+ type: object
2110
+ properties:
2111
+ service:
2112
+ $ref: '#/components/schemas/Service2'
2113
+ description: The event data structure
2114
+ ServiceDeleteEvent:
2115
+ title: ServiceDeleteEvent
2116
+ type: object
2117
+ properties:
2118
+ event:
2119
+ $ref: '#/components/schemas/Event'
2120
+ eventId:
2121
+ type: string
2122
+ description: The identifier of the notification.
2123
+ eventTime:
2124
+ type: string
2125
+ description: Time of the event occurrence.
2126
+ format: date-time
2127
+ eventType:
2128
+ type: string
2129
+ description: The type of the notification.
2130
+ correlationId:
2131
+ type: string
2132
+ description: The correlation id for this event.
2133
+ domain:
2134
+ type: string
2135
+ description: The domain of the event.
2136
+ title:
2137
+ type: string
2138
+ description: The title of the event.
2139
+ description:
2140
+ type: string
2141
+ description: An explnatory of the event.
2142
+ priority:
2143
+ type: string
2144
+ description: A priority.
2145
+ timeOcurred:
2146
+ type: string
2147
+ description: The time the event occured.
2148
+ format: date-time
2149
+ description: The notification data structure
2150
+ ServiceDeleteEventPayload:
2151
+ title: ServiceDeleteEventPayload
2152
+ type: object
2153
+ properties:
2154
+ service:
2155
+ $ref: '#/components/schemas/Service2'
2156
+ description: The event data structure
2157
+ Error:
2158
+ title: Error
2159
+ required:
2160
+ - code
2161
+ - reason
2162
+ type: object
2163
+ properties:
2164
+ code:
2165
+ type: string
2166
+ description: Application relevant detail, defined in the API or a common list.
2167
+ reason:
2168
+ type: string
2169
+ description: Explanation of the reason for the error which can be shown to a client user.
2170
+ message:
2171
+ type: string
2172
+ description: More details and corrective actions related to the error which can be shown to a client user.
2173
+ status:
2174
+ type: string
2175
+ description: HTTP Error code extension
2176
+ referenceError:
2177
+ type: string
2178
+ description: URI of documentation describing the error.
2179
+ '@baseType':
2180
+ type: string
2181
+ description: When sub-classing, this defines the super-class.
2182
+ '@schemaLocation':
2183
+ type: string
2184
+ description: A URI to a JSON-Schema file that defines additional attributes and relationships
2185
+ '@type':
2186
+ type: string
2187
+ description: When sub-classing, this defines the sub-class entity name.
2188
+ description: Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
2189
+ Event:
2190
+ title: Event
2191
+ type: object
2192
+ properties:
2193
+ service:
2194
+ $ref: '#/components/schemas/Service2'
2195
+ HubRequest:
2196
+ title: HubRequest
2197
+ required:
2198
+ - callback
2199
+ type: object
2200
+ properties:
2201
+ callback:
2202
+ type: string
2203
+ description: The callback being registered.
2204
+ query:
2205
+ type: string
2206
+ description: additional data to be passed
2207
+ ListenerServiceAttributeValueChangeEventRequest:
2208
+ title: ListenerServiceAttributeValueChangeEventRequest
2209
+ type: object
2210
+ properties:
2211
+ eventId:
2212
+ type: string
2213
+ description: The identifier of the notification.
2214
+ eventTime:
2215
+ type: string
2216
+ description: Time of the event occurrence.
2217
+ format: date-time
2218
+ eventType:
2219
+ type: string
2220
+ description: The type of the notification.
2221
+ correlationId:
2222
+ type: string
2223
+ description: The correlation id for this event.
2224
+ domain:
2225
+ type: string
2226
+ description: The domain of the event.
2227
+ title:
2228
+ type: string
2229
+ description: The title of the event.
2230
+ description:
2231
+ type: string
2232
+ description: An explnatory of the event.
2233
+ priority:
2234
+ type: string
2235
+ description: A priority.
2236
+ timeOcurred:
2237
+ type: string
2238
+ description: The time the event occured.
2239
+ format: date-time
2240
+ fieldPath:
2241
+ type: string
2242
+ description: The path identifying the object field concerned by this notification.
2243
+ event:
2244
+ $ref: '#/components/schemas/Event'
2245
+ ListenerServiceCreateEventRequest:
2246
+ title: ListenerServiceCreateEventRequest
2247
+ type: object
2248
+ properties:
2249
+ event:
2250
+ $ref: '#/components/schemas/Event'
2251
+ eventId:
2252
+ type: string
2253
+ description: The identifier of the notification.
2254
+ eventTime:
2255
+ type: string
2256
+ description: Time of the event occurrence.
2257
+ format: date-time
2258
+ eventType:
2259
+ type: string
2260
+ description: The type of the notification.
2261
+ correlationId:
2262
+ type: string
2263
+ description: The correlation id for this event.
2264
+ domain:
2265
+ type: string
2266
+ description: The domain of the event.
2267
+ title:
2268
+ type: string
2269
+ description: The title of the event.
2270
+ description:
2271
+ type: string
2272
+ description: An explnatory of the event.
2273
+ priority:
2274
+ type: string
2275
+ description: A priority.
2276
+ timeOcurred:
2277
+ type: string
2278
+ description: The time the event occured.
2279
+ format: date-time
2280
+ ListenerServiceDeleteEventRequest:
2281
+ title: ListenerServiceDeleteEventRequest
2282
+ type: object
2283
+ properties:
2284
+ event:
2285
+ $ref: '#/components/schemas/Event'
2286
+ eventId:
2287
+ type: string
2288
+ description: The identifier of the notification.
2289
+ eventTime:
2290
+ type: string
2291
+ description: Time of the event occurrence.
2292
+ format: date-time
2293
+ eventType:
2294
+ type: string
2295
+ description: The type of the notification.
2296
+ correlationId:
2297
+ type: string
2298
+ description: The correlation id for this event.
2299
+ domain:
2300
+ type: string
2301
+ description: The domain of the event.
2302
+ title:
2303
+ type: string
2304
+ description: The title of the event.
2305
+ description:
2306
+ type: string
2307
+ description: An explnatory of the event.
2308
+ priority:
2309
+ type: string
2310
+ description: A priority.
2311
+ timeOcurred:
2312
+ type: string
2313
+ description: The time the event occured.
2314
+ format: date-time
2315
+ ListenerServiceStateChangeEventRequest:
2316
+ title: ListenerServiceStateChangeEventRequest
2317
+ type: object
2318
+ properties:
2319
+ event:
2320
+ $ref: '#/components/schemas/Event'
2321
+ eventId:
2322
+ type: string
2323
+ description: The identifier of the notification.
2324
+ eventTime:
2325
+ type: string
2326
+ description: Time of the event occurrence.
2327
+ format: date-time
2328
+ eventType:
2329
+ type: string
2330
+ description: The type of the notification.
2331
+ correlationId:
2332
+ type: string
2333
+ description: The correlation id for this event.
2334
+ domain:
2335
+ type: string
2336
+ description: The domain of the event.
2337
+ title:
2338
+ type: string
2339
+ description: The title of the event.
2340
+ description:
2341
+ type: string
2342
+ description: An explnatory of the event.
2343
+ priority:
2344
+ type: string
2345
+ description: A priority.
2346
+ timeOcurred:
2347
+ type: string
2348
+ description: The time the event occured.
2349
+ format: date-time
2350
+ ServiceRequest:
2351
+ title: ServiceRequest
2352
+ required:
2353
+ - serviceSpecification
2354
+ - state
2355
+ type: object
2356
+ properties:
2357
+ category:
2358
+ type: string
2359
+ description: Is it a customer facing or resource facing service
2360
+ description:
2361
+ type: string
2362
+ description: Free-text description of the service
2363
+ endDate:
2364
+ type: string
2365
+ description: Date when the service ends
2366
+ format: date-time
2367
+ hasStarted:
2368
+ type: boolean
2369
+ description: If TRUE, this Service has already been started
2370
+ isBundle:
2371
+ type: boolean
2372
+ description: If true, the service is a ServiceBundle which regroup a service hierachy. If false, the service is a 'atomic' service (hierachy leaf).
2373
+ isServiceEnabled:
2374
+ type: boolean
2375
+ description: If FALSE and hasStarted is FALSE, this particular Service has NOT been enabled for use - if FALSE and hasStarted is TRUE then the service has failed
2376
+ isStateful:
2377
+ type: boolean
2378
+ description: If TRUE, this Service can be changed without affecting any other services
2379
+ name:
2380
+ type: string
2381
+ description: Name of the service
2382
+ serviceDate:
2383
+ type: string
2384
+ description: Date when the service was created (whatever its status).
2385
+ serviceType:
2386
+ type: string
2387
+ description: Business type of the service
2388
+ startDate:
2389
+ type: string
2390
+ description: Date when the service starts
2391
+ format: date-time
2392
+ startMode:
2393
+ type: string
2394
+ description: 'This attribute is an enumerated integer that indicates how the Service is started, such as: 0: Unknown; 1: Automatically by the managed environment; 2: Automatically by the owning device; 3: Manually by the Provider of the Service; 4: Manually by a Customer of the Provider; 5: Any of the above'
2395
+ feature:
2396
+ type: array
2397
+ items:
2398
+ $ref: '#/components/schemas/Feature'
2399
+ description: A list of feature associated with this service
2400
+ note:
2401
+ type: array
2402
+ items:
2403
+ $ref: '#/components/schemas/Note'
2404
+ description: A list of notes made on this service
2405
+ place:
2406
+ type: array
2407
+ items:
2408
+ $ref: '#/components/schemas/RelatedPlaceRefOrValue'
2409
+ description: A list of places (Place [*]). Used to define a place useful for the service (for example a geographical place whre the service is installed)
2410
+ relatedEntity:
2411
+ type: array
2412
+ items:
2413
+ $ref: '#/components/schemas/RelatedEntityRefOrValue'
2414
+ description: A list of related entity in relationship with this service
2415
+ relatedParty:
2416
+ type: array
2417
+ items:
2418
+ $ref: '#/components/schemas/RelatedParty'
2419
+ description: A list of related party references (RelatedParty [*]). A related party defines party or party role linked to a specific entity
2420
+ serviceCharacteristic:
2421
+ type: array
2422
+ items:
2423
+ $ref: '#/components/schemas/Characteristic'
2424
+ description: A list of characteristics that characterize this service (ServiceCharacteristic [*])
2425
+ serviceOrderItem:
2426
+ type: array
2427
+ items:
2428
+ $ref: '#/components/schemas/RelatedServiceOrderItem'
2429
+ description: A list of service order items related to this service
2430
+ serviceRelationship:
2431
+ type: array
2432
+ items:
2433
+ $ref: '#/components/schemas/ServiceRelationship'
2434
+ description: A list of service relationships (ServiceRelationship [*]). Describes links with other service(s) in the inventory.
2435
+ serviceSpecification:
2436
+ $ref: '#/components/schemas/ServiceSpecification'
2437
+ state:
2438
+ $ref: '#/components/schemas/ServiceStateType'
2439
+ supportingResource:
2440
+ type: array
2441
+ items:
2442
+ $ref: '#/components/schemas/ResourceRef'
2443
+ description: 'A list of supporting resources (SupportingResource [*]).Note: only Service of type RFS can be associated with Resources'
2444
+ supportingService:
2445
+ type: array
2446
+ items:
2447
+ $ref: '#/components/schemas/ServiceRefOrValue'
2448
+ description: A list of supporting services (SupportingService [*]). A collection of services that support this service (bundling, link CFS to RFS)
2449
+ ServiceRequest1:
2450
+ title: ServiceRequest1
2451
+ type: object
2452
+ properties:
2453
+ category:
2454
+ type: string
2455
+ description: Is it a customer facing or resource facing service
2456
+ description:
2457
+ type: string
2458
+ description: Free-text description of the service
2459
+ endDate:
2460
+ type: string
2461
+ description: Date when the service ends
2462
+ format: date-time
2463
+ hasStarted:
2464
+ type: boolean
2465
+ description: If TRUE, this Service has already been started
2466
+ isBundle:
2467
+ type: boolean
2468
+ description: If true, the service is a ServiceBundle which regroup a service hierachy. If false, the service is a 'atomic' service (hierachy leaf).
2469
+ isServiceEnabled:
2470
+ type: boolean
2471
+ description: If FALSE and hasStarted is FALSE, this particular Service has NOT been enabled for use - if FALSE and hasStarted is TRUE then the service has failed
2472
+ isStateful:
2473
+ type: boolean
2474
+ description: If TRUE, this Service can be changed without affecting any other services
2475
+ name:
2476
+ type: string
2477
+ description: Name of the service
2478
+ serviceType:
2479
+ type: string
2480
+ description: Business type of the service
2481
+ startDate:
2482
+ type: string
2483
+ description: Date when the service starts
2484
+ format: date-time
2485
+ startMode:
2486
+ type: string
2487
+ description: 'This attribute is an enumerated integer that indicates how the Service is started, such as: 0: Unknown; 1: Automatically by the managed environment; 2: Automatically by the owning device; 3: Manually by the Provider of the Service; 4: Manually by a Customer of the Provider; 5: Any of the above'
2488
+ feature:
2489
+ type: array
2490
+ items:
2491
+ $ref: '#/components/schemas/Feature'
2492
+ description: A list of feature associated with this service
2493
+ note:
2494
+ type: array
2495
+ items:
2496
+ $ref: '#/components/schemas/Note'
2497
+ description: A list of notes made on this service
2498
+ place:
2499
+ type: array
2500
+ items:
2501
+ $ref: '#/components/schemas/RelatedPlaceRefOrValue'
2502
+ description: A list of places (Place [*]). Used to define a place useful for the service (for example a geographical place whre the service is installed)
2503
+ relatedEntity:
2504
+ type: array
2505
+ items:
2506
+ $ref: '#/components/schemas/RelatedEntityRefOrValue'
2507
+ description: A list of related entity in relationship with this service
2508
+ relatedParty:
2509
+ type: array
2510
+ items:
2511
+ $ref: '#/components/schemas/RelatedParty'
2512
+ description: A list of related party references (RelatedParty [*]). A related party defines party or party role linked to a specific entity
2513
+ serviceCharacteristic:
2514
+ type: array
2515
+ items:
2516
+ $ref: '#/components/schemas/Characteristic'
2517
+ description: A list of characteristics that characterize this service (ServiceCharacteristic [*])
2518
+ serviceOrderItem:
2519
+ type: array
2520
+ items:
2521
+ $ref: '#/components/schemas/RelatedServiceOrderItem'
2522
+ description: A list of service order items related to this service
2523
+ serviceRelationship:
2524
+ type: array
2525
+ items:
2526
+ $ref: '#/components/schemas/ServiceRelationship'
2527
+ description: A list of service relationships (ServiceRelationship [*]). Describes links with other service(s) in the inventory.
2528
+ serviceSpecification:
2529
+ $ref: '#/components/schemas/ServiceSpecification'
2530
+ state:
2531
+ $ref: '#/components/schemas/ServiceStateType'
2532
+ supportingResource:
2533
+ type: array
2534
+ items:
2535
+ $ref: '#/components/schemas/ResourceRef'
2536
+ description: 'A list of supporting resources (SupportingResource [*]).Note: only Service of type RFS can be associated with Resources'
2537
+ supportingService:
2538
+ type: array
2539
+ items:
2540
+ $ref: '#/components/schemas/ServiceRefOrValue'
2541
+ description: A list of supporting services (SupportingService [*]). A collection of services that support this service (bundling, link CFS to RFS)
2542
+ Service1:
2543
+ title: Service1
2544
+ required:
2545
+ - id
2546
+ type: object
2547
+ properties:
2548
+ id:
2549
+ type: string
2550
+ description: Unique identifier of the service
2551
+ href:
2552
+ type: string
2553
+ description: Reference of the service
2554
+ category:
2555
+ type: string
2556
+ description: Is it a customer facing or resource facing service
2557
+ description:
2558
+ type: string
2559
+ description: Free-text description of the service
2560
+ endDate:
2561
+ type: string
2562
+ description: Date when the service ends
2563
+ format: date-time
2564
+ hasStarted:
2565
+ type: boolean
2566
+ description: If TRUE, this Service has already been started
2567
+ isBundle:
2568
+ type: boolean
2569
+ description: If true, the service is a ServiceBundle which regroup a service hierachy. If false, the service is a 'atomic' service (hierachy leaf).
2570
+ isServiceEnabled:
2571
+ type: boolean
2572
+ description: If FALSE and hasStarted is FALSE, this particular Service has NOT been enabled for use - if FALSE and hasStarted is TRUE then the service has failed
2573
+ isStateful:
2574
+ type: boolean
2575
+ description: If TRUE, this Service can be changed without affecting any other services
2576
+ name:
2577
+ type: string
2578
+ description: Name of the service
2579
+ serviceDate:
2580
+ type: string
2581
+ description: Date when the service was created (whatever its status).
2582
+ serviceType:
2583
+ type: string
2584
+ description: Business type of the service
2585
+ startDate:
2586
+ type: string
2587
+ description: Date when the service starts
2588
+ format: date-time
2589
+ startMode:
2590
+ type: string
2591
+ description: 'This attribute is an enumerated integer that indicates how the Service is started, such as: 0: Unknown; 1: Automatically by the managed environment; 2: Automatically by the owning device; 3: Manually by the Provider of the Service; 4: Manually by a Customer of the Provider; 5: Any of the above'
2592
+ feature:
2593
+ type: array
2594
+ items:
2595
+ $ref: '#/components/schemas/Feature'
2596
+ description: A list of feature associated with this service
2597
+ note:
2598
+ type: array
2599
+ items:
2600
+ $ref: '#/components/schemas/Note'
2601
+ description: A list of notes made on this service
2602
+ place:
2603
+ type: array
2604
+ items:
2605
+ $ref: '#/components/schemas/RelatedPlaceRefOrValue'
2606
+ description: A list of places (Place [*]). Used to define a place useful for the service (for example a geographical place whre the service is installed)
2607
+ relatedEntity:
2608
+ type: array
2609
+ items:
2610
+ $ref: '#/components/schemas/RelatedEntityRefOrValue'
2611
+ description: A list of related entity in relationship with this service
2612
+ relatedParty:
2613
+ type: array
2614
+ items:
2615
+ $ref: '#/components/schemas/RelatedParty'
2616
+ description: A list of related party references (RelatedParty [*]). A related party defines party or party role linked to a specific entity
2617
+ serviceCharacteristic:
2618
+ type: array
2619
+ items:
2620
+ $ref: '#/components/schemas/Characteristic'
2621
+ description: A list of characteristics that characterize this service (ServiceCharacteristic [*])
2622
+ serviceOrderItem:
2623
+ type: array
2624
+ items:
2625
+ $ref: '#/components/schemas/RelatedServiceOrderItem'
2626
+ description: A list of service order items related to this service
2627
+ serviceRelationship:
2628
+ type: array
2629
+ items:
2630
+ $ref: '#/components/schemas/ServiceRelationship'
2631
+ description: A list of service relationships (ServiceRelationship [*]). Describes links with other service(s) in the inventory.
2632
+ serviceSpecification:
2633
+ $ref: '#/components/schemas/ServiceSpecification'
2634
+ state:
2635
+ $ref: '#/components/schemas/ServiceStateType'
2636
+ supportingResource:
2637
+ type: array
2638
+ items:
2639
+ $ref: '#/components/schemas/ResourceRef'
2640
+ description: 'A list of supporting resources (SupportingResource [*]).Note: only Service of type RFS can be associated with Resources'
2641
+ supportingService:
2642
+ type: array
2643
+ items:
2644
+ $ref: '#/components/schemas/ServiceRefOrValue'
2645
+ description: A list of supporting services (SupportingService [*]). A collection of services that support this service (bundling, link CFS to RFS)
2646
+ '@baseType':
2647
+ type: string
2648
+ description: When sub-classing, this defines the super-class
2649
+ '@schemaLocation':
2650
+ type: string
2651
+ description: A URI to a JSON-Schema file that defines additional attributes and relationships
2652
+ '@type':
2653
+ type: string
2654
+ description: When sub-classing, this defines the sub-class Extensible name
2655
+ '@referredType':
2656
+ type: string
2657
+ description: The actual type of the target instance when needed for disambiguation.
2658
+ Service2:
2659
+ title: Service2
2660
+ type: object
2661
+ properties:
2662
+ id:
2663
+ type: string
2664
+ description: Unique identifier of the service
2665
+ href:
2666
+ type: string
2667
+ description: Reference of the service
2668
+ category:
2669
+ type: string
2670
+ description: Is it a customer facing or resource facing service
2671
+ description:
2672
+ type: string
2673
+ description: Free-text description of the service
2674
+ endDate:
2675
+ type: string
2676
+ description: Date when the service ends
2677
+ format: date-time
2678
+ hasStarted:
2679
+ type: boolean
2680
+ description: If TRUE, this Service has already been started
2681
+ isBundle:
2682
+ type: boolean
2683
+ description: If true, the service is a ServiceBundle which regroup a service hierachy. If false, the service is a 'atomic' service (hierachy leaf).
2684
+ isServiceEnabled:
2685
+ type: boolean
2686
+ description: If FALSE and hasStarted is FALSE, this particular Service has NOT been enabled for use - if FALSE and hasStarted is TRUE then the service has failed
2687
+ isStateful:
2688
+ type: boolean
2689
+ description: If TRUE, this Service can be changed without affecting any other services
2690
+ name:
2691
+ type: string
2692
+ description: Name of the service
2693
+ serviceDate:
2694
+ type: string
2695
+ description: Date when the service was created (whatever its status).
2696
+ serviceType:
2697
+ type: string
2698
+ description: Business type of the service
2699
+ startDate:
2700
+ type: string
2701
+ description: Date when the service starts
2702
+ format: date-time
2703
+ startMode:
2704
+ type: string
2705
+ description: 'This attribute is an enumerated integer that indicates how the Service is started, such as: 0: Unknown; 1: Automatically by the managed environment; 2: Automatically by the owning device; 3: Manually by the Provider of the Service; 4: Manually by a Customer of the Provider; 5: Any of the above'
2706
+ feature:
2707
+ type: array
2708
+ items:
2709
+ $ref: '#/components/schemas/Feature'
2710
+ description: A list of feature associated with this service
2711
+ note:
2712
+ type: array
2713
+ items:
2714
+ $ref: '#/components/schemas/Note'
2715
+ description: A list of notes made on this service
2716
+ place:
2717
+ type: array
2718
+ items:
2719
+ $ref: '#/components/schemas/RelatedPlaceRefOrValue'
2720
+ description: A list of places (Place [*]). Used to define a place useful for the service (for example a geographical place whre the service is installed)
2721
+ relatedEntity:
2722
+ type: array
2723
+ items:
2724
+ $ref: '#/components/schemas/RelatedEntityRefOrValue'
2725
+ description: A list of related entity in relationship with this service
2726
+ relatedParty:
2727
+ type: array
2728
+ items:
2729
+ $ref: '#/components/schemas/RelatedParty'
2730
+ description: A list of related party references (RelatedParty [*]). A related party defines party or party role linked to a specific entity
2731
+ serviceCharacteristic:
2732
+ type: array
2733
+ items:
2734
+ $ref: '#/components/schemas/Characteristic'
2735
+ description: A list of characteristics that characterize this service (ServiceCharacteristic [*])
2736
+ serviceOrderItem:
2737
+ type: array
2738
+ items:
2739
+ $ref: '#/components/schemas/RelatedServiceOrderItem'
2740
+ description: A list of service order items related to this service
2741
+ serviceRelationship:
2742
+ type: array
2743
+ items:
2744
+ $ref: '#/components/schemas/ServiceRelationship'
2745
+ description: A list of service relationships (ServiceRelationship [*]). Describes links with other service(s) in the inventory.
2746
+ serviceSpecification:
2747
+ $ref: '#/components/schemas/ServiceSpecification'
2748
+ state:
2749
+ $ref: '#/components/schemas/ServiceStateType'
2750
+ supportingResource:
2751
+ type: array
2752
+ items:
2753
+ $ref: '#/components/schemas/ResourceRef'
2754
+ description: 'A list of supporting resources (SupportingResource [*]).Note: only Service of type RFS can be associated with Resources'
2755
+ supportingService:
2756
+ type: array
2757
+ items:
2758
+ $ref: '#/components/schemas/ServiceRefOrValue'
2759
+ description: A list of supporting services (SupportingService [*]). A collection of services that support this service (bundling, link CFS to RFS)
2760
+ ServiceSpecification:
2761
+ title: ServiceSpecification
2762
+ required:
2763
+ - id
2764
+ type: object
2765
+ properties:
2766
+ id:
2767
+ type: string
2768
+ description: unique identifier
2769
+ href:
2770
+ type: string
2771
+ description: Hyperlink reference
2772
+ name:
2773
+ type: string
2774
+ description: Name of the related entity.
2775
+ version:
2776
+ type: string
2777
+ description: Service specification version
2778
+ '@baseType':
2779
+ type: string
2780
+ description: When sub-classing, this defines the super-class
2781
+ '@schemaLocation':
2782
+ type: string
2783
+ description: A URI to a JSON-Schema file that defines additional attributes and relationships
2784
+ '@type':
2785
+ type: string
2786
+ description: When sub-classing, this defines the sub-class Extensible name
2787
+ '@referredType':
2788
+ type: string
2789
+ description: The actual type of the target instance when needed for disambiguation.
2790
+ ValidFor:
2791
+ title: ValidFor
2792
+ type: object
2793
+ properties:
2794
+ endDateTime:
2795
+ type: string
2796
+ description: End of the time period, using IETC-RFC-3339 format
2797
+ format: date-time
2798
+ example: 1985-04-12T23:20:50.52Z
2799
+ startDateTime:
2800
+ type: string
2801
+ description: Start of the time period, using IETC-RFC-3339 format
2802
+ format: date-time
2803
+ example: 1985-04-12T23:20:50.52Z
2804
+ tags:
2805
+ - name: service
2806
+ - name: notification listeners (client side)
2807
+ - name: events subscription