9 https://api-designer.sso.infra.ftgroup/swagger-ui/?url=https://api-designer.sso.infra.ftgroup/api/1.0/apis/5ymwb6l1dR/swagger.json[Swagger UI]
12 https://plantuml.rd.francetelecom.fr/proxy?fmt=svg&src=https://api-designer.sso.infra.ftgroup/api/1.0/apis/5ymwb6l1dR/plantuml&noCache=137264.0[plant UML UI]
14 serviceInventory API designed for ONAP Beijing Release.
15 This API is build from TMF open API18.0 (applying TMF Guideline 3.0)
16 only operation GET (by id & byList) for resource serviceSpecification is available
19 === Version information
21 __Version__ : 3.0.0_inProgress
27 __BasePath__ : /nbi/api/v3
38 * `application/json;charset=utf-8`
55 This operation list service entities.
56 Attribute selection is restricted.
57 fields attribute may be used to filter retrieved attribute(s) for each service
59 Specific business errors for current operation will be encapsulated in
61 HTTP Response 422 Unprocessable entity
66 [options="header", cols=".^2,.^3,.^4"]
69 |**Query**|**fields** +
73 |**Query**|**relatedParty.id** +
75 |**Query**|**serviceSpecification.id** +
77 |**Query**|**serviceSpecification.name** +
84 [options="header", cols=".^2,.^14,.^4"]
86 |HTTP Code|Description|Schema
87 |**200**|Success|< <<_listservice,ListService>> > array
90 List of supported error codes:
91 - 20: Invalid URL parameter value
94 - 23: Missing body field
95 - 24: Invalid body field
97 - 26: Invalid header value
98 - 27: Missing query-string parameter
99 - 28: Invalid query-string parameter value|<<_errorrepresentation,ErrorRepresentation>>
100 |**401**|Unauthorized
102 List of supported error codes:
103 - 40: Missing credentials
104 - 41: Invalid credentials
105 - 42: Expired credentials|<<_errorrepresentation,ErrorRepresentation>>
108 List of supported error codes:
110 - 51: Forbidden requester
112 - 53: Too many requests|<<_errorrepresentation,ErrorRepresentation>>
115 List of supported error codes:
116 - 60: Resource not found|<<_errorrepresentation,ErrorRepresentation>>
117 |**422**|Unprocessable entity
119 Functional error|<<_errorrepresentation,ErrorRepresentation>>
120 |**500**|Internal Server Error
122 List of supported error codes:
123 - 1: Internal error|<<_errorrepresentation,ErrorRepresentation>>
124 |**503**|Service Unavailable
126 List of supported error codes:
127 - 5: The service is temporarily unavailable
128 - 6: Orange API is over capacity, retry later !|<<_errorrepresentation,ErrorRepresentation>>
134 * `application/json;charset=utf-8`
138 ==== Retrieve a service
145 This operation retrieves a service entity.
146 Attribute selection is enabled for all first level attributes.
148 Specific business errors for current operation will be encapsulated in
150 HTTP Response 422 Unprocessable entity
155 [options="header", cols=".^2,.^3,.^4"]
160 |**Query**|**relatedParty.id** +
162 |**Query**|**serviceSpecification.id** +
164 |**Query**|**serviceSpecification.name** +
171 [options="header", cols=".^2,.^14,.^4"]
173 |HTTP Code|Description|Schema
174 |**200**|Success|<<_service,Service>>
177 List of supported error codes:
178 - 20: Invalid URL parameter value
181 - 23: Missing body field
182 - 24: Invalid body field
184 - 26: Invalid header value
185 - 27: Missing query-string parameter
186 - 28: Invalid query-string parameter value|<<_errorrepresentation,ErrorRepresentation>>
187 |**401**|Unauthorized
189 List of supported error codes:
190 - 40: Missing credentials
191 - 41: Invalid credentials
192 - 42: Expired credentials|<<_errorrepresentation,ErrorRepresentation>>
195 List of supported error codes:
197 - 51: Forbidden requester
199 - 53: Too many requests|<<_errorrepresentation,ErrorRepresentation>>
202 List of supported error codes:
203 - 60: Resource not found|<<_errorrepresentation,ErrorRepresentation>>
204 |**422**|Unprocessable entity
206 Functional error|<<_errorrepresentation,ErrorRepresentation>>
207 |**500**|Internal Server Error
209 List of supported error codes:
210 - 1: Internal error|<<_errorrepresentation,ErrorRepresentation>>
211 |**503**|Service Unavailable
213 List of supported error codes:
214 - 5: The service is temporarily unavailable
215 - 6: Orange API is over capacity, retry later !|<<_errorrepresentation,ErrorRepresentation>>
221 * `application/json;charset=utf-8`
227 [[_errorrepresentation]]
228 === ErrorRepresentation
229 This class is used to describe error.
230 for nbi Beijing release we do not manage additional error for serviceCatalog
233 [options="header", cols=".^3,.^11,.^4"]
235 |Name|Description|Schema
236 |**@schemaLocation** +
237 __optional__|it provides a link to the schema describing a REST resource.|string
239 __optional__|The class type of a REST resource.|string
241 __required__|Application related code (as defined in the API or from a common list)|integer (int32)
243 __optional__|Text that provide more details and corrective actions related to the error. This can be shown to a client user.|string
245 __required__|Text that explains the reason for error. This can be shown to a client user.|string
246 |**referenceError** +
247 __optional__|url pointing to documentation describing the error|string
249 __optional__|http error code extension like 400-2|string
253 [[_listrelatedpartyref]]
254 === ListRelatedPartyRef
255 This class is used to structure list of service(s) retrieved
258 [options="header", cols=".^3,.^11,.^4"]
260 |Name|Description|Schema
262 __optional__|Unique identifier of a related party|string
264 __optional__|Role played by the related party - only role “ONAPcustomer” is managed in Beijing release.|string
270 This class is used to structure list of service(s) retrieved
273 [options="header", cols=".^3,.^11,.^4"]
275 |Name|Description|Schema
277 __optional__|Unique identifier of the service|string
279 __optional__|Name of the service|string
281 __optional__||<<_listrelatedpartyref,ListRelatedPartyRef>>
282 |**serviceSpecification** +
283 __optional__||<<_listservicespecificationref,ListServiceSpecificationRef>>
287 [[_listservicespecificationref]]
288 === ListServiceSpecificationRef
289 This class is used to structure list of service(s) retrieved
292 [options="header", cols=".^3,.^11,.^4"]
294 |Name|Description|Schema
296 __optional__|Unique identifier of the service specification|string
298 __optional__|Name of the required service specification|string
304 RelatedParty reference. A related party defines party or party role linked to a specific entity.
305 Only ONAP Customer is managed in Beijing release.
308 [options="header", cols=".^3,.^11,.^4"]
310 |Name|Description|Schema
312 __optional__|Not managed in the Beijing release.|string
314 __optional__|Reference of a related party.
315 Not filled in Beijing release.|string
317 __optional__|Unique identifier of a related party|string
319 __optional__|Role played by the related party.
320 Filled with 'ONAPcustomer'|string
326 Instantiated service (service_instance) in AAI
329 [options="header", cols=".^3,.^11,.^4"]
331 |Name|Description|Schema
333 __optional__|Not managed in Beijing release|string
334 |**@schemaLocation** +
335 __optional__|Not managed in Beijing release|string
337 __optional__|This attribute allows to dynamically extends TMF class. Not used in Beijing release.|string
338 |**characteristic** +
339 __optional__||< <<_servicecharacteristic,ServiceCharacteristic>> > array
341 __optional__|This is a Boolean attribute that, if TRUE, signifies that this Service has already been started. If the value of this attribute is FALSE, then this signifies that this Service has NOT been Started
342 Not managed in Beijing release|boolean
344 __optional__|Reference of the service
345 Not managed in Beijing release|string
347 __optional__|Unique identifier of the service - Valued with service-instance-id|string
349 __optional__|Name of the service - Valued with service-instance-name|string
351 __optional__||< <<_relatedpartyref,RelatedPartyRef>> > array
352 |**serviceSpecification** +
353 __optional__||<<_servicespecificationref,ServiceSpecificationRef>>
355 __optional__|State of the service. Not managed in Beijing release|string
356 |**supportingResource** +
357 __optional__||< <<_supportingresource,SupportingResource>> > array
359 __optional__|Service type - valued with 'service-instance'|string
363 [[_servicecharacteristic]]
364 === ServiceCharacteristic
365 A list of name value pairs that define the service characteristics
366 Not managed in Beijing release.
369 [options="header", cols=".^3,.^11,.^4"]
371 |Name|Description|Schema
373 __required__|Name of the characteristic
374 Not managed in Beijing release.|string
376 __optional__||<<_value,Value>>
378 __optional__|Type of value for this characteristic.
379 Not managed in Beijing release.|string
383 [[_servicespecificationref]]
384 === ServiceSpecificationRef
385 Service specification reference: ServiceSpecification of this service (catalog information)
388 [options="header", cols=".^3,.^11,.^4"]
390 |Name|Description|Schema
392 __optional__|This attribute allows to dynamically extends TMF class. Valued with 'ONAPservice'. We used this features to add following attribute: invariantUUID|string
393 |**@schemaLocation** +
394 __optional__|Not managed in Beijing release|string
396 __optional__|Reference of the service specification.
397 not managed in Beijing release.|string
399 __optional__|Unique identifier of the service specification. valued to model-version-id|string
401 __optional__|Additional attribute (not in the TMF API) - extended through @referredType - model-invariant-id|string
403 __optional__|Name of the required service specification|string
405 __optional__|Service specification version.
406 Not managed in Beijing release|string
410 [[_supportingresource]]
411 === SupportingResource
412 Supporting resource - A supportingResource will be retrieved for each relationship of the relationship-list where related-link describe a vnf
415 [options="header", cols=".^3,.^11,.^4"]
417 |Name|Description|Schema
419 __optional__|This attribute allows to dynamically extends TMF class. Valued with 'ONAP resource'. We used this features to add following attributes:
423 modelCustomisationId|string
424 |**@schemaLocation** +
425 __optional__|Not managed in Beijing release.|string
427 __optional__|Reference of the supporting resource|string
429 __optional__|Unique identifier of the supporting resource - Valued to vnf-id|string
430 |**modelCustomisationId** +
431 __optional__|Additional attribute (not in the TMF API) - extended through @referredType - valued with model-customisation-id|string
432 |**modelInvariantId** +
433 __optional__|Additional attribute (not in the TMF API) - extended through @referredType - valued with model-invariant-id|string
434 |**modelVersionId** +
435 __optional__|Additional attribute (not in the TMF API) - extended through @referredType - valued with model-verson-id|string
437 __optional__|Name of the supporting resource - Valued with vnf_-name|string
439 __optional__|Not managed in Beijing release.|string
441 __optional__|Additional attribute (not in the TMF API) - extended through @referredType - valued with prov-status|string
447 Structure used to describe characteristic value.
448 Not managed in Beijing release.
451 [options="header", cols=".^3,.^11,.^4"]
453 |Name|Description|Schema
454 |**@schemaLocation** +
455 __optional__|Not managed in Beijing release.|string
457 __optional__|Not managed in Beijing release.|string
458 |**serviceCharacteristicValue** +
459 __optional__|Not managed in Beijing release.|string