5 "description": "Query information about instantiated services\n\nList of available subscription for serviceInventory notifications, see /hub resources for more information:\n\n- ServiceCreationNotification\n- ServiceAttributeValueChangeNotification\n- ServiceRemoveNotification\n\n",
7 "title": "API ServiceInventory",
9 "url": "/redoc/logo.png",
10 "backgroundColor": "#FFFFFF"
14 "host": "localhost:8080",
15 "basePath": "/nbi/api/v4",
20 "application/json;charset=utf-8"
26 "description": "Provided by NBI"
29 "name": "Notification",
30 "description": "provided by subscriber, which MUST has been registered by creating a Hub ressource on NBI"
40 "application/json;charset=utf-8"
42 "operationId": "serviceFind",
43 "summary": "List services",
44 "description": "This operation list service entities. \nAttribute selection is restricted. \nfields attribute may be used to filter retrieved attribute(s) for each service",
50 "name": "relatedParty.id",
58 "name": "serviceSpecification.id",
66 "name": "serviceSpecification.name",
96 "$ref": "#/definitions/ListService"
110 "application/json;charset=utf-8"
112 "operationId": "serviceGet",
113 "summary": "Retrieve a service",
114 "description": "This operation retrieves a service entity. \nAttribute selection is enabled for all first level attributes.",
130 "$ref": "#/definitions/Service"
143 "application/json;charset=utf-8"
146 "application/json;charset=utf-8"
148 "operationId": "notificationCreate",
149 "summary": "NBI will send notification to this operation provided by subscribers",
156 "name": "Notification",
161 "$ref": "#/definitions/Notification"
167 "description": "Created",
169 "$ref": "#/definitions/Notification"
184 "ServiceCreationNotification",
185 "ServiceAttributeValueChangeNotification",
186 "ServiceRemoveNotification"]
190 "ErrorRepresentation": {
191 "description": "This class is used to describe error.",
202 "description": "Application related code (as defined in the API or from a common list)",
207 "description": "Text that explains the reason for error. This can be shown to a client user.",
211 "description": "Text that provide more details and corrective actions related to the error. This can be shown to a client user.",
215 "description": "http error code extension like 400-2",
219 "description": "url pointing to documentation describing the error",
223 "description": "The class type of a REST resource.",
227 "description": "it provides a link to the schema describing a REST resource.",
235 "description": "Instantiated service (service_instance) in AAI",
241 "description": "Unique identifier of the service - Valued with service-instance-id",
245 "description": "Reference of the service\nNot managed in Beijing release",
249 "description": "Name of the service - Valued with service-instance-name",
253 "description": "Service type - valued with 'service-instance'",
257 "description": "State of the service.",
261 "description": "This attribute allows to dynamically extends TMF class. Not used in Beijing release.",
265 "description": "Not managed in Beijing release",
269 "description": "Not managed in Beijing release",
272 "serviceSpecification": {
274 "$ref": "#/definitions/ServiceSpecificationRef"
280 "$ref": "#/definitions/ServiceCharacteristic"
283 "supportingResource": {
287 "$ref": "#/definitions/SupportingResource"
294 "$ref": "#/definitions/RelatedPartyRef"
301 "ServiceSpecificationRef": {
302 "description": "Service specification reference: ServiceSpecification of this service (catalog information)",
308 "description": "Unique identifier of the service specification. valued to model-version-id",
312 "description": "Reference of the service specification.\nnot managed in Beijing release.",
316 "description": "Name of the required service specification",
320 "description": "Service specification version.\nNot managed in Beijing release",
324 "description": "This attribute allows to dynamically extends TMF class. Valued with 'ONAPservice'. We used this features to add following attribute: invariantUUID",
328 "description": "Not managed in Beijing release",
332 "description": "Additional attribute (not in the TMF API) - extended through @referredType - model-invariant-id",
339 "ServiceCharacteristic": {
340 "description": "A list of name value pairs that define the service characteristics\nNot managed in Beijing release.",
350 "description": "Name of the characteristic\nNot managed in Beijing release.",
354 "description": "Type of value for this characteristic.\nNot managed in Beijing release.",
359 "$ref": "#/definitions/Value"
365 "SupportingResource": {
366 "description": "Supporting resource - A supportingResource will be retrieved for each relationship of the relationship-list where related-link describe a vnf",
372 "description": "Unique identifier of the supporting resource - Valued to vnf-id",
376 "description": "Reference of the supporting resource",
380 "description": "Not managed in Beijing release.",
384 "description": "Name of the supporting resource - Valued with vnf_-name",
388 "description": "This attribute allows to dynamically extends TMF class. Valued with 'ONAP resource'. We used this features to add following attributes:\n status\t\n modelInvariantId\n modelVersionId\n modelCustomisationId",
392 "description": "Not managed in Beijing release.",
396 "description": "Additional attribute (not in the TMF API) - extended through @referredType - valued with prov-status",
399 "modelInvariantId": {
400 "description": "Additional attribute (not in the TMF API) - extended through @referredType - valued with model-invariant-id",
404 "description": "Additional attribute (not in the TMF API) - extended through @referredType - valued with model-verson-id",
407 "modelCustomisationId": {
408 "description": "Additional attribute (not in the TMF API) - extended through @referredType - valued with model-customisation-id",
416 "description": "RelatedParty reference. A related party defines party or party role linked to a specific entity.",
422 "description": "Unique identifier of a related party",
426 "description": "Reference of a related party.\nNot filled in Beijing release.",
430 "description": "Role played by the related party.\nFilled with 'ONAPcustomer'",
434 "description": "Not managed in the Beijing release.",
442 "description": "Structure used to describe characteristic value.\nNot managed in Beijing release.",
448 "description": "Not managed in Beijing release.",
452 "description": "Not managed in Beijing release.",
455 "serviceCharacteristicValue": {
456 "description": "Not managed in Beijing release.",
463 "ListRelatedPartyRef": {
464 "description": "This class is used to structure list of service(s) retrieved",
470 "description": "Unique identifier of a related party",
474 "description": "Role played by the related party - only role “ONAPcustomer” is managed in Beijing release.",
481 "ListServiceSpecificationRef": {
482 "description": "This class is used to structure list of service(s) retrieved",
488 "description": "Unique identifier of the service specification",
492 "description": "Name of the required service specification",
500 "description": "This class is used to structure list of service(s) retrieved",
506 "description": "Unique identifier of the service",
510 "description": "Name of the service",
513 "serviceSpecification": {
515 "$ref": "#/definitions/ListServiceSpecificationRef"
519 "$ref": "#/definitions/ListRelatedPartyRef"
525 "ServiceInventoryEvent": {
526 "description": "Structure for a service inventory event notification",
541 "description": "The Service Instance Id",
545 "description": "A reference to the service inventory",
549 "description": "The name of the Service Instance",
553 "description": "The type of event, service-instance",
557 "description": "The state of the service instance",
562 "$ref": "#/definitions/RelatedPartyRef"
569 "description": "Notification structure for a service notification",
588 "format": "date-time"
592 "$ref": "#/definitions/eventType"
596 "$ref": "#/definitions/ServiceInventoryEvent"