3 description: "Query information about instantiated services\n\nList of available\
4 \ subscription for serviceInventory notifications, see /hub resources for more\
5 \ information:\n\n- ServiceCreationNotification\n- ServiceAttributeValueChangeNotification\n\
6 - ServiceRemoveNotification\n\n"
7 version: "4.0.0_inProgress"
8 title: "API ServiceInventory"
10 url: "/redoc/logo.png"
11 backgroundColor: "#FFFFFF"
12 host: "localhost:8080"
13 basePath: "/nbi/api/v4"
17 - "application/json;charset=utf-8"
20 description: "Provided by NBI"
21 - name: "Notification"
22 description: "provided by subscriber, which MUST has been registered by creating\
23 \ a Hub ressource on NBI"
30 - "application/json;charset=utf-8"
31 operationId: "serviceFind"
32 summary: "List services"
33 description: "This operation list service entities. \nAttribute selection is\
34 \ restricted. \nfields attribute may be used to filter retrieved attribute(s)\
38 - name: "relatedParty.id"
43 - name: "serviceSpecification.id"
48 - name: "serviceSpecification.name"
69 $ref: "#/definitions/ListService"
75 - "application/json;charset=utf-8"
76 operationId: "serviceGet"
77 summary: "Retrieve a service"
78 description: "This operation retrieves a service entity. \nAttribute selection\
79 \ is enabled for all first level attributes."
90 $ref: "#/definitions/Service"
96 - "application/json;charset=utf-8"
98 - "application/json;charset=utf-8"
99 operationId: "notificationCreate"
100 summary: "NBI will send notification to this operation provided by subscribers"
104 - name: "Notification"
109 $ref: "#/definitions/Notification"
112 description: "Created"
114 $ref: "#/definitions/Notification"
120 - "ServiceCreationNotification"
121 - "ServiceAttributeValueChangeNotification"
122 - "ServiceRemoveNotification"
124 description: "This class is used to describe error."
131 description: "Application related code (as defined in the API or from a common\
136 description: "Text that explains the reason for error. This can be shown to\
140 description: "Text that provide more details and corrective actions related\
141 \ to the error. This can be shown to a client user."
144 description: "http error code extension like 400-2"
147 description: "url pointing to documentation describing the error"
150 description: "The class type of a REST resource."
153 description: "it provides a link to the schema describing a REST resource."
156 description: "Instantiated service (service_instance) in AAI"
160 description: "Unique identifier of the service - Valued with service-instance-id"
163 description: "Reference of the service\nNot managed in Beijing release"
166 description: "Name of the service - Valued with service-instance-name"
169 description: "Service type - valued with 'service-instance'"
172 description: "State of the service."
175 description: "This attribute allows to dynamically extends TMF class. Not\
176 \ used in Beijing release."
179 description: "Not managed in Beijing release"
182 description: "Not managed in Beijing release"
184 serviceSpecification:
185 $ref: "#/definitions/ServiceSpecificationRef"
189 $ref: "#/definitions/ServiceCharacteristic"
193 $ref: "#/definitions/SupportingResource"
197 $ref: "#/definitions/RelatedPartyRef"
198 ServiceSpecificationRef:
199 description: "Service specification reference: ServiceSpecification of this service\
200 \ (catalog information)"
204 description: "Unique identifier of the service specification. valued to model-version-id"
207 description: "Reference of the service specification.\nnot managed in Beijing\
211 description: "Name of the required service specification"
214 description: "Service specification version.\nNot managed in Beijing release"
217 description: "This attribute allows to dynamically extends TMF class. Valued\
218 \ with 'ONAPservice'. We used this features to add following attribute:\
222 description: "Not managed in Beijing release"
225 description: "Additional attribute (not in the TMF API) - extended through\
226 \ @referredType - model-invariant-id"
228 ServiceCharacteristic:
229 description: "A list of name value pairs that define the service characteristics\n\
230 Not managed in Beijing release."
236 description: "Name of the characteristic\nNot managed in Beijing release."
239 description: "Type of value for this characteristic.\nNot managed in Beijing\
243 $ref: "#/definitions/Value"
245 description: "Supporting resource - A supportingResource will be retrieved for\
246 \ each relationship of the relationship-list where related-link describe a vnf"
250 description: "Unique identifier of the supporting resource - Valued to vnf-id"
253 description: "Reference of the supporting resource"
256 description: "Not managed in Beijing release."
259 description: "Name of the supporting resource - Valued with vnf_-name"
262 description: "This attribute allows to dynamically extends TMF class. Valued\
263 \ with 'ONAP resource'. We used this features to add following attributes:\n\
264 \ status\t\n modelInvariantId\n modelVersionId\n modelCustomisationId"
267 description: "Not managed in Beijing release."
270 description: "Additional attribute (not in the TMF API) - extended through\
271 \ @referredType - valued with prov-status"
274 description: "Additional attribute (not in the TMF API) - extended through\
275 \ @referredType - valued with model-invariant-id"
278 description: "Additional attribute (not in the TMF API) - extended through\
279 \ @referredType - valued with model-verson-id"
281 modelCustomisationId:
282 description: "Additional attribute (not in the TMF API) - extended through\
283 \ @referredType - valued with model-customisation-id"
286 description: "RelatedParty reference. A related party defines party or party role\
287 \ linked to a specific entity."
291 description: "Unique identifier of a related party"
294 description: "Reference of a related party.\nNot filled in Beijing release."
297 description: "Role played by the related party.\nFilled with 'ONAPcustomer'"
300 description: "Not managed in the Beijing release."
303 description: "Structure used to describe characteristic value.\nNot managed in\
308 description: "Not managed in Beijing release."
311 description: "Not managed in Beijing release."
313 serviceCharacteristicValue:
314 description: "Not managed in Beijing release."
317 description: "This class is used to structure list of service(s) retrieved"
321 description: "Unique identifier of a related party"
324 description: "Role played by the related party - only role “ONAPcustomer”\
325 \ is managed in Beijing release."
327 ListServiceSpecificationRef:
328 description: "This class is used to structure list of service(s) retrieved"
332 description: "Unique identifier of the service specification"
335 description: "Name of the required service specification"
338 description: "This class is used to structure list of service(s) retrieved"
342 description: "Unique identifier of the service"
345 description: "Name of the service"
347 serviceSpecification:
348 $ref: "#/definitions/ListServiceSpecificationRef"
350 $ref: "#/definitions/ListRelatedPartyRef"
351 ServiceInventoryEvent:
352 description: "Structure for a service inventory event notification"
363 description: "The Service Instance Id"
366 description: "A reference to the service inventory"
369 description: "The name of the Service Instance"
372 description: "The type of event, service-instance"
375 description: "The state of the service instance"
378 $ref: "#/definitions/RelatedPartyRef"
380 description: "Notification structure for a service notification"
396 $ref: "#/definitions/eventType"
398 $ref: "#/definitions/ServiceInventoryEvent"