blob: fa63c9e75a606097fbb5510a7d1791f1d94ab696 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
|
<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xmime="http://www.w3.org/2005/05/xmlmime"
xmlns="http://orange.com/ONAPNBI/api/serviceInventory/v4/model"
xmlns:xs="http://www.w3.org/2001/XMLSchema"
attributeFormDefault="unqualified"
elementFormDefault="qualified"
targetNamespace="http://orange.com/ONAPNBI/api/serviceInventory/v4/model">
<xs:annotation id="signature">
<xs:appinfo>API Designer</xs:appinfo>
<xs:documentation>Model: serviceInventory
Version: 4.0.1
Owner: ONAPNBI
Generated on: 2019-03-12T16:45:37.288Z
Generated by: Orange API Designer v2, model-v1</xs:documentation>
</xs:annotation>
<xs:simpleType name="eventType">
<xs:restriction base="xs:string">
<xs:enumeration value="ServiceCreationNotification"/>
<xs:enumeration value="ServiceAttributeValueChangeNotification"/>
<xs:enumeration value="ServiceRemoveNotification"/>
</xs:restriction>
</xs:simpleType>
<xs:element name="ErrorRepresentation" type="ErrorRepresentation">
<xs:annotation>
<xs:documentation source="public">This class is used to describe error.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:complexType name="ErrorRepresentation">
<xs:annotation>
<xs:documentation source="public">This class is used to describe error.</xs:documentation>
</xs:annotation>
<xs:sequence minOccurs="1" maxOccurs="1">
<xs:element name="code" type="xs:int" minOccurs="1">
<xs:annotation>
<xs:documentation source="public">Application related code (as defined in the API or from a common list)</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="reason" type="xs:string" minOccurs="1">
<xs:annotation>
<xs:documentation source="public">Text that explains the reason for error. This can be shown to a client user.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="message" type="xs:string" minOccurs="0">
<xs:annotation>
<xs:documentation source="public">Text that provide more details and corrective actions related to the error. This can be shown to a client user.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="status" type="xs:string" minOccurs="0">
<xs:annotation>
<xs:documentation source="public">http error code extension like 400-2</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="referenceError" type="xs:string" minOccurs="0">
<xs:annotation>
<xs:documentation source="public">url pointing to documentation describing the error</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="@type" type="xs:string" minOccurs="0">
<xs:annotation>
<xs:documentation source="public">The class type of a REST resource.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="@schemaLocation" type="xs:string" minOccurs="0">
<xs:annotation>
<xs:documentation source="public">it provides a link to the schema describing a REST resource.</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>
<xs:element name="Service" type="Service">
<xs:annotation>
<xs:documentation source="public">Instantiated service (service_instance) in AAI</xs:documentation>
</xs:annotation>
</xs:element>
<xs:complexType name="Service">
<xs:annotation>
<xs:documentation source="public">Instantiated service (service_instance) in AAI</xs:documentation>
</xs:annotation>
<xs:sequence minOccurs="1" maxOccurs="1">
<xs:element name="id" type="xs:string" minOccurs="0">
<xs:annotation>
<xs:documentation source="public">Unique identifier of the service - Valued with service-instance-id</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="href" type="xs:string" minOccurs="0">
<xs:annotation>
<xs:documentation source="public">Reference of the service
Not managed in Beijing release</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="name" type="xs:string" minOccurs="0">
<xs:annotation>
<xs:documentation source="public">Name of the service - Valued with service-instance-name</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="type" type="xs:string" minOccurs="0">
<xs:annotation>
<xs:documentation source="public">Service type - valued with 'service-instance'</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="state" type="xs:string" minOccurs="0">
<xs:annotation>
<xs:documentation source="public">State of the service.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="@type" type="xs:string" minOccurs="0">
<xs:annotation>
<xs:documentation source="public">This attribute allows to dynamically extends TMF class. Not used in Beijing release.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="@baseType" type="xs:string" minOccurs="0">
<xs:annotation>
<xs:documentation source="public">Not managed in Beijing release</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="@schemaLocation" type="xs:string" minOccurs="0">
<xs:annotation>
<xs:documentation source="public">Not managed in Beijing release</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="serviceSpecification"
type="ServiceSpecificationRef"
minOccurs="0">
<xs:annotation>
<xs:documentation source="public">A service specification reference required to realize a ProductSpecification</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="characteristic"
type="ServiceCharacteristic"
minOccurs="0"
maxOccurs="unbounded">
<xs:annotation>
<xs:documentation source="public">A list of service characteristics i.e. name/value pairs that define the service characteristics</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="supportingResource"
type="SupportingResource"
minOccurs="0"
maxOccurs="unbounded">
<xs:annotation>
<xs:documentation source="public">A list of supporting resources
A supportingResource will be retrieved for each relationship of the relationship-list where related-link describe a vnf</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="relatedParty"
type="RelatedPartyRef"
minOccurs="0"
maxOccurs="unbounded">
<xs:annotation>
<xs:documentation source="public">A list of related party references . A related party defines party or party role linked to a specific entity.</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>
<xs:element name="ServiceSpecificationRef" type="ServiceSpecificationRef">
<xs:annotation>
<xs:documentation source="public">Service specification reference: ServiceSpecification of this service (catalog information)</xs:documentation>
</xs:annotation>
</xs:element>
<xs:complexType name="ServiceSpecificationRef">
<xs:annotation>
<xs:documentation source="public">Service specification reference: ServiceSpecification of this service (catalog information)</xs:documentation>
</xs:annotation>
<xs:sequence minOccurs="1" maxOccurs="1">
<xs:element name="id" type="xs:string" minOccurs="0">
<xs:annotation>
<xs:documentation source="public">Unique identifier of the service specification. valued to model-version-id</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="href" type="xs:string" minOccurs="0">
<xs:annotation>
<xs:documentation source="public">Reference of the service specification.
not managed in Beijing release.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="name" type="xs:string" minOccurs="0">
<xs:annotation>
<xs:documentation source="public">Name of the required service specification</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="version" type="xs:string" minOccurs="0">
<xs:annotation>
<xs:documentation source="public">Service specification version.
Not managed in Beijing release</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="@referredType" type="xs:string" minOccurs="0">
<xs:annotation>
<xs:documentation source="public">This attribute allows to dynamically extends TMF class. Valued with 'ONAPservice'. We used this features to add following attribute: invariantUUID</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="@schemaLocation" type="xs:string" minOccurs="0">
<xs:annotation>
<xs:documentation source="public">Not managed in Beijing release</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="invariantUUID" type="xs:string" minOccurs="0">
<xs:annotation>
<xs:documentation source="public">Additional attribute (not in the TMF API) - extended through @referredType - model-invariant-id</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>
<xs:element name="ServiceCharacteristic" type="ServiceCharacteristic">
<xs:annotation>
<xs:documentation source="public">A list of name value pairs that define the service characteristics
Not managed in Beijing release.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:complexType name="ServiceCharacteristic">
<xs:annotation>
<xs:documentation source="public">A list of name value pairs that define the service characteristics
Not managed in Beijing release.</xs:documentation>
</xs:annotation>
<xs:sequence minOccurs="1" maxOccurs="1">
<xs:element name="name" type="xs:string" minOccurs="1">
<xs:annotation>
<xs:documentation source="public">Name of the characteristic
Not managed in Beijing release.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="valueType" type="xs:string" minOccurs="0">
<xs:annotation>
<xs:documentation source="public">Type of value for this characteristic.
Not managed in Beijing release.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="value" type="Value" minOccurs="0">
<xs:annotation>
<xs:documentation source="public">Value of the characteristic
Not managed in Beijing release.</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>
<xs:element name="SupportingResource" type="SupportingResource">
<xs:annotation>
<xs:documentation source="public">Supporting resource - A supportingResource will be retrieved for each relationship of the relationship-list where related-link describe a vnf</xs:documentation>
</xs:annotation>
</xs:element>
<xs:complexType name="SupportingResource">
<xs:annotation>
<xs:documentation source="public">Supporting resource - A supportingResource will be retrieved for each relationship of the relationship-list where related-link describe a vnf</xs:documentation>
</xs:annotation>
<xs:sequence minOccurs="1" maxOccurs="1">
<xs:element name="id" type="xs:string" minOccurs="0">
<xs:annotation>
<xs:documentation source="public">Unique identifier of the supporting resource - Valued to vnf-id</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="href" type="xs:string" minOccurs="0">
<xs:annotation>
<xs:documentation source="public">Reference of the supporting resource</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="role" type="xs:string" minOccurs="0">
<xs:annotation>
<xs:documentation source="public">Not managed in Beijing release.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="name" type="xs:string" minOccurs="0">
<xs:annotation>
<xs:documentation source="public">Name of the supporting resource - Valued with vnf_-name</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="@referredType" type="xs:string" minOccurs="0">
<xs:annotation>
<xs:documentation source="public">This attribute allows to dynamically extends TMF class. Valued with 'ONAP resource'. We used this features to add following attributes:
status
modelInvariantId
modelVersionId
modelCustomisationId</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="@schemaLocation" type="xs:string" minOccurs="0">
<xs:annotation>
<xs:documentation source="public">Not managed in Beijing release.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="status" type="xs:string" minOccurs="0">
<xs:annotation>
<xs:documentation source="public">Additional attribute (not in the TMF API) - extended through @referredType - valued with prov-status</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="modelInvariantId" type="xs:string" minOccurs="0">
<xs:annotation>
<xs:documentation source="public">Additional attribute (not in the TMF API) - extended through @referredType - valued with model-invariant-id</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="modelVersionId" type="xs:string" minOccurs="0">
<xs:annotation>
<xs:documentation source="public">Additional attribute (not in the TMF API) - extended through @referredType - valued with model-verson-id</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="modelCustomisationId" type="xs:string" minOccurs="0">
<xs:annotation>
<xs:documentation source="public">Additional attribute (not in the TMF API) - extended through @referredType - valued with model-customisation-id</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>
<xs:element name="RelatedPartyRef" type="RelatedPartyRef">
<xs:annotation>
<xs:documentation source="public">RelatedParty reference. A related party defines party or party role linked to a specific entity.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:complexType name="RelatedPartyRef">
<xs:annotation>
<xs:documentation source="public">RelatedParty reference. A related party defines party or party role linked to a specific entity.</xs:documentation>
</xs:annotation>
<xs:sequence minOccurs="1" maxOccurs="1">
<xs:element name="id" type="xs:string" minOccurs="0">
<xs:annotation>
<xs:documentation source="public">Unique identifier of a related party</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="href" type="xs:string" minOccurs="0">
<xs:annotation>
<xs:documentation source="public">Reference of a related party.
Not filled in Beijing release.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="role" type="xs:string" minOccurs="0">
<xs:annotation>
<xs:documentation source="public">Role played by the related party.
Filled with 'ONAPcustomer'</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="@referredType" type="xs:string" minOccurs="0">
<xs:annotation>
<xs:documentation source="public">Not managed in the Beijing release.</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>
<xs:element name="Value" type="Value">
<xs:annotation>
<xs:documentation source="public">Structure used to describe characteristic value.
Not managed in Beijing release.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:complexType name="Value">
<xs:annotation>
<xs:documentation source="public">Structure used to describe characteristic value.
Not managed in Beijing release.</xs:documentation>
</xs:annotation>
<xs:sequence minOccurs="1" maxOccurs="1">
<xs:element name="@type" type="xs:string" minOccurs="0">
<xs:annotation>
<xs:documentation source="public">Not managed in Beijing release.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="@schemaLocation" type="xs:string" minOccurs="0">
<xs:annotation>
<xs:documentation source="public">Not managed in Beijing release.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="serviceCharacteristicValue" type="xs:string" minOccurs="0">
<xs:annotation>
<xs:documentation source="public">Not managed in Beijing release.</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>
<xs:element name="ListRelatedPartyRef" type="ListRelatedPartyRef">
<xs:annotation>
<xs:documentation source="public">This class is used to structure list of service(s) retrieved</xs:documentation>
</xs:annotation>
</xs:element>
<xs:complexType name="ListRelatedPartyRef">
<xs:annotation>
<xs:documentation source="public">This class is used to structure list of service(s) retrieved</xs:documentation>
</xs:annotation>
<xs:sequence minOccurs="1" maxOccurs="1">
<xs:element name="id" type="xs:string" minOccurs="0">
<xs:annotation>
<xs:documentation source="public">Unique identifier of a related party</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="role" type="xs:string" minOccurs="0">
<xs:annotation>
<xs:documentation source="public">Role played by the related party - only role “ONAPcustomer” is managed in Beijing release.</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>
<xs:element name="ListServiceSpecificationRef" type="ListServiceSpecificationRef">
<xs:annotation>
<xs:documentation source="public">This class is used to structure list of service(s) retrieved</xs:documentation>
</xs:annotation>
</xs:element>
<xs:complexType name="ListServiceSpecificationRef">
<xs:annotation>
<xs:documentation source="public">This class is used to structure list of service(s) retrieved</xs:documentation>
</xs:annotation>
<xs:sequence minOccurs="1" maxOccurs="1">
<xs:element name="id" type="xs:string" minOccurs="0">
<xs:annotation>
<xs:documentation source="public">Unique identifier of the service specification</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="name" type="xs:string" minOccurs="0">
<xs:annotation>
<xs:documentation source="public">Name of the required service specification</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>
<xs:element name="ListService" type="ListService">
<xs:annotation>
<xs:documentation source="public">This class is used to structure list of service(s) retrieved</xs:documentation>
</xs:annotation>
</xs:element>
<xs:complexType name="ListService">
<xs:annotation>
<xs:documentation source="public">This class is used to structure list of service(s) retrieved</xs:documentation>
</xs:annotation>
<xs:sequence minOccurs="1" maxOccurs="1">
<xs:element name="id" type="xs:string" minOccurs="0">
<xs:annotation>
<xs:documentation source="public">Unique identifier of the service</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="name" type="xs:string" minOccurs="0">
<xs:annotation>
<xs:documentation source="public">Name of the service</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="serviceSpecification"
type="ListServiceSpecificationRef"
minOccurs="0">
<xs:annotation>
<xs:documentation source="public">A service specification reference required to realize a ProductSpecification</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="relatedParty" type="ListRelatedPartyRef" minOccurs="0">
<xs:annotation>
<xs:documentation source="public">Related Party to the service (only ONAP customer is managed)</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>
<xs:element name="ServiceInventoryEvent" type="ServiceInventoryEvent">
<xs:annotation>
<xs:documentation source="public">Structure for a service inventory event notification</xs:documentation>
</xs:annotation>
</xs:element>
<xs:complexType name="ServiceInventoryEvent">
<xs:annotation>
<xs:documentation source="public">Structure for a service inventory event notification</xs:documentation>
</xs:annotation>
<xs:sequence minOccurs="1" maxOccurs="1">
<xs:element name="id" type="xs:string" minOccurs="1">
<xs:annotation>
<xs:documentation source="public">The Service Instance Id</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="href" type="xs:string" minOccurs="1">
<xs:annotation>
<xs:documentation source="public">A reference to the service inventory</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="name" type="xs:string" minOccurs="1">
<xs:annotation>
<xs:documentation source="public">The name of the Service Instance</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="type" type="xs:string" minOccurs="1">
<xs:annotation>
<xs:documentation source="public">The type of event, service-instance</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="state" type="xs:string" minOccurs="1">
<xs:annotation>
<xs:documentation source="public">The state of the service instance</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="relatedParty" type="RelatedPartyRef" minOccurs="1"/>
</xs:sequence>
</xs:complexType>
<xs:element name="Notification" type="Notification">
<xs:annotation>
<xs:documentation source="public">Notification structure for a service notification</xs:documentation>
</xs:annotation>
</xs:element>
<xs:complexType name="Notification">
<xs:annotation>
<xs:documentation source="public">Notification structure for a service notification</xs:documentation>
</xs:annotation>
<xs:sequence minOccurs="1" maxOccurs="1">
<xs:element name="eventId" type="xs:string" minOccurs="1"/>
<xs:element name="eventDate" type="xs:dateTime" minOccurs="1"/>
<xs:element name="eventType" type="eventType" minOccurs="1"/>
<xs:element name="event" type="ServiceInventoryEvent" minOccurs="1"/>
</xs:sequence>
</xs:complexType>
</xs:schema>
|
