9 https://api-designer.sso.infra.ftgroup/swagger-ui/?url=https://api-designer.sso.infra.ftgroup/api/1.0/apis/XOmvoxNn9d/swagger.json[Swagger UI]
12 https://plantuml.rd.francetelecom.fr/proxy?fmt=svg&src=https://api-designer.sso.infra.ftgroup/api/1.0/apis/XOmvoxNn9d/plantuml&noCache=995303.0[plant UML UI]
14 serviceCatalog API designed for ONAP Beijing Release.
15 This API is build from TMF open API17.5.
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
33 * ServiceSpecification
38 * `application/json;charset=utf-8`
44 [[_servicespecification_resource]]
45 === ServiceSpecification
47 [[_servicespecificationfind]]
48 ==== List service specifications
50 GET /serviceSpecification
55 This operation returns service specifications from a catalog.
56 Only a predefined set of attribute is proposed : Based on SDC limitations, only attributes category and distributionStatus are available for serviceSpecification filtering
57 Fields attribute could be used to filter attributes retrieved
59 Specific business errors for current operation will be encapsulated in
61 HTTP Response 422 Unprocessable entity
66 [options="header", cols=".^2,.^3,.^9,.^4"]
68 |Type|Name|Description|Schema
69 |**Query**|**category** +
70 __optional__|Service Category (filter)|string
71 |**Query**|**distributionStatus** +
72 __optional__|Service distribution status (filter)|string
73 |**Query**|**fields** +
74 __optional__|Field selection - used to filtering the attributes to be retreived|string
80 [options="header", cols=".^2,.^14,.^4"]
82 |HTTP Code|Description|Schema
83 |**200**|Success|< <<_servicespecification,ServiceSpecification>> > array
86 List of supported error codes:
87 - 20: Invalid URL parameter value
90 - 23: Missing body field
91 - 24: Invalid body field
93 - 26: Invalid header value
94 - 27: Missing query-string parameter
95 - 28: Invalid query-string parameter value|<<_errorrepresentation,ErrorRepresentation>>
98 List of supported error codes:
99 - 40: Missing credentials
100 - 41: Invalid credentials
101 - 42: Expired credentials|<<_errorrepresentation,ErrorRepresentation>>
104 List of supported error codes:
106 - 51: Forbidden requester
108 - 53: Too many requests|<<_errorrepresentation,ErrorRepresentation>>
111 List of supported error codes:
112 - 60: Resource not found|<<_errorrepresentation,ErrorRepresentation>>
113 |**422**|Unprocessable entity
115 Functional error|<<_errorrepresentation,ErrorRepresentation>>
116 |**500**|Internal Server Error
118 List of supported error codes:
119 - 1: Internal error|<<_errorrepresentation,ErrorRepresentation>>
120 |**503**|Service Unavailable
122 List of supported error codes:
123 - 5: The service is temporarily unavailable
124 - 6: Orange API is over capacity, retry later !|<<_errorrepresentation,ErrorRepresentation>>
130 * `application/json;charset=utf-8`
133 [[_servicespecificationget]]
134 ==== Retrieve a service specification
136 GET /serviceSpecification/{id}
141 This operation returns a service specification by its id from a catalog. Attribute selection is enabled using the fields attribute.
143 Specific business errors for current operation will be encapsulated in
145 HTTP Response 422 Unprocessable entity
150 [options="header", cols=".^2,.^3,.^9,.^4"]
152 |Type|Name|Description|Schema
155 |**Query**|**fields** +
156 __optional__|Attribute selection|string
162 [options="header", cols=".^2,.^14,.^4"]
164 |HTTP Code|Description|Schema
165 |**200**|Success|<<_servicespecification,ServiceSpecification>>
168 List of supported error codes:
169 - 20: Invalid URL parameter value
172 - 23: Missing body field
173 - 24: Invalid body field
175 - 26: Invalid header value
176 - 27: Missing query-string parameter
177 - 28: Invalid query-string parameter value|<<_errorrepresentation,ErrorRepresentation>>
178 |**401**|Unauthorized
180 List of supported error codes:
181 - 40: Missing credentials
182 - 41: Invalid credentials
183 - 42: Expired credentials|<<_errorrepresentation,ErrorRepresentation>>
186 List of supported error codes:
188 - 51: Forbidden requester
190 - 53: Too many requests|<<_errorrepresentation,ErrorRepresentation>>
193 List of supported error codes:
194 - 60: Resource not found|<<_errorrepresentation,ErrorRepresentation>>
195 |**422**|Unprocessable entity
197 Functional error|<<_errorrepresentation,ErrorRepresentation>>
198 |**500**|Internal Server Error
200 List of supported error codes:
201 - 1: Internal error|<<_errorrepresentation,ErrorRepresentation>>
202 |**503**|Service Unavailable
204 List of supported error codes:
205 - 5: The service is temporarily unavailable
206 - 6: Orange API is over capacity, retry later !|<<_errorrepresentation,ErrorRepresentation>>
212 * `application/json;charset=utf-8`
220 An attachment is a file uses to describe the service.
221 In nbi we use attachment to retrieve ONAP artifacts.
224 [options="header", cols=".^3,.^11,.^4"]
226 |Name|Description|Schema
228 __optional__|This attribute allows to dynamically extends TMF class. Valued with 'ONAPartifact'. We used this features to add following attributes:
235 **Default** : `"ONAPartifact"`|string
236 |**artifactChecksum** +
237 __optional__|Additional attribute (not in the TMF API) - extended through @type - artifactChecksum|string
238 |**artifactGroupType** +
239 __optional__|Additional attribute (not in the TMF API) - extended through @type - artifactGroupType|string
241 __optional__|Additional attribute (not in the TMF API) - extended through @type - artifactLabel|string
242 |**artifactTimeout** +
243 __optional__|Additional attribute (not in the TMF API) - extended through @type - artifactTimeout|string
244 |**artifactVersion** +
245 __optional__|Additional attribute (not in the TMF API) - extended through @type - artifactVersion|string
247 __optional__|Description of the attachment - filled with artifactDescription|string
248 |**generatedFromUUID** +
249 __optional__|Additional attribute (not in the TMF API) - extended through @type - generatedFromUUID|string
251 __optional__|Unique identifier of the attachment - filled with artifactUUID.|string
253 __optional__|Filled with artifactType|string
255 __optional__|Name of the attachment - filled with artifactName|string
257 __optional__|Uniform Resource Locator, is a web page address - filled with artifactURL|string
261 [[_distributionstatus]]
262 === DistributionStatus
263 Service distribution status from ONAP.
265 __Type__ : enum (DISTRIBUTION_NOT_APPROVED, DISTRIBUTION_APPROVED, DISTRIBUTED, DISTRIBUTION_REJECTED)
268 [[_errorrepresentation]]
269 === ErrorRepresentation
270 This class is used to describe error.
271 for nbi Beijing release we do not manage additional error for serviceCatalog
274 [options="header", cols=".^3,.^11,.^4"]
276 |Name|Description|Schema
277 |**@schemaLocation** +
278 __optional__|it provides a link to the schema describing a REST resource.|string
280 __optional__|The class type of a REST resource.|string
282 __required__|Application related code (as defined in the API or from a common list)|integer (int32)
284 __optional__|Text that provide more details and corrective actions related to the error. This can be shown to a client user|string
286 __required__|Text that explains the reason for error. This can be shown to a client user.|string
287 |**referenceErrror** +
288 __optional__|url pointing to documentation describing the error|string
290 __optional__|http error code extension like 400-2|string
294 [[_lifecyclestatusvalues]]
295 === LifecycleStatusValues
296 Service lifecycle value from ONAP SDC
298 __Type__ : enum (NOT_CERTIFIED_CHECKOUT, NOT_CERTIFIED_CHECKIN, READY_FOR_CERTIFICATION, CERTIFICATION_IN_PROGRESS, CERTIFIED)
303 Party linked to the service catalog.
304 in nbi we retrieve information about last updater of the service in SDC
307 [options="header", cols=".^3,.^11,.^4"]
309 |Name|Description|Schema
311 __optional__|Unique identifier of the related party. Filled with lastUpdaterUserId|string
313 __optional__|Name of the related party - Filled with lastUpdatedFullName|string
315 __optional__|Role payed by the related party
316 Only role 'lastUpdater' is retrieved in Beijing release|string
320 [[_resourcespecificationref]]
321 === ResourceSpecificationRef
322 A list of resourceSpec identified to deliver the service.
323 for nbi we retrieve resource information available in service description (through SDC api) bu as well information retrieved in the TOSCA file.
326 [options="header", cols=".^3,.^11,.^4"]
328 |Name|Description|Schema
330 __optional__|This attribute allows to dynamically extends TMF class. Valued with: 'ONAPresource'. We used this features to add following attributes:
332 resourceInvariantUUID
334 modelCustomizationName
335 modelCustomizationId +
336 **Default** : `"ONAPresource"`|string
338 __optional__|Unique identifier of the resource specification - filled with resourceUUID|string
339 |**modelCustomizationId** +
340 __optional__|Additional attribute (not in the TMF API) - extended through @type - Retrieved in the TOSCA file : attribute customizationUUID in topology_template/node_template for the resource|string
341 |**modelCustomizationName** +
342 __optional__|Additional attribute (not in the TMF API) - extended through @type - Retrieved in the TOSCA file : attribute name in topology_template/node_template for the resource|string
344 __optional__|Name of the resource specification - filled with resourceName|string
345 |**resourceInstanceName** +
346 __optional__|Additional attribute (not in the TMF API) - extended through @type - resourceInstanceName|string
347 |**resourceInvariantUUID** +
348 __optional__|Additional attribute (not in the TMF API) - extended through @type - resourceInvariantUUID|string
350 __optional__|Additional attribute (not in the TMF API) - extended through @type - resoucreType|string
352 __optional__|Version for this resource specification - filled with resourceVersion|string
356 [[_servicespeccharacteristic]]
357 === ServiceSpecCharacteristic
358 A characteristic quality or distinctive feature of a ServiceSpecification.
359 ServiceSpecCharacteristic are retrieved in the serviceTosca file in the topology_template section in the inputs section.
362 [options="header", cols=".^3,.^11,.^4"]
364 |Name|Description|Schema
365 |**@schemaLocation** +
366 __optional__|An url pointing to type description - we do not use it in nbi Beijing release|string
368 __optional__|This attribute allows to dynamically extends TMF class. Valued with: 'ONAPserviceCharacteristic'. We do not used this features in nbi Beijing release.|string
370 __optional__|A narrative that explains in detail what the characteristic is - Filled with parameter_description|string
372 __optional__|Name of the characteristic - Filled with parameter_name|string
374 __optional__|A parameter to define if the characteristic is mandatory - Filled from parameter_required – if not fielded by default ‘true’ +
375 **Default** : `true`|boolean
376 |**serviceSpecCharacteristicValue** +
377 __optional__||< <<_servicespeccharacteristicvalue,ServiceSpecCharacteristicValue>> > array
379 __optional__|Status of the characteristic - filled with status_value|string
381 __optional__|A kind of value that the characteristic can take on, such as numeric, text and so forth - Filled with parameter_type|string
385 [[_servicespeccharacteristicvalue]]
386 === ServiceSpecCharacteristicValue
387 A number or text that can be assigned to a service specification characteristic.
388 ServiceSpecCharacteristicValue are retrieved in the service Tosca file
391 [options="header", cols=".^3,.^11,.^4"]
393 |Name|Description|Schema
395 __optional__|Information calculated from parameter default in the Tosca file|boolean
397 __optional__|A discrete value that the characteristic can take on|string
399 __optional__|A kind of value that the characteristic can take on, such as numeric, text, and so forth
400 Retrieved in the Tosca in the topology_template section in the inputs section - parameter_type.
401 We do not manage parameter_type= list or map for Beijing release|string
405 [[_servicespecification]]
406 === ServiceSpecification
407 ServiceSpecification is a class that offers characteristics to describe a type of service. Functionally, it acts as a template by which Services may be instantiated. By sharing the same specification, these services would therefore share the same set of characteristics.
408 the service information are retrieved in SDC
411 [options="header", cols=".^3,.^11,.^4"]
413 |Name|Description|Schema
415 __optional__|Not used for Beijing release|string
416 |**@schemaLocation** +
417 __optional__|Not used for Beijing release|string
419 __optional__|This attribute allows to dynamically extends TMF class. Valued with 'ONAPservice'. We used this features to add following attributes:
426 **Default** : `"ONAPservice"`|string
428 __optional__||< <<_attachment,Attachment>> > array
430 __optional__|Additional attribute - extended through @type - category
431 Please note that this attribute is managed in TMF - in future release we'll introduce category resource|string
433 __optional__|A narrative that explains in detail what the service specification is - Filled with SDC Service description|string
434 |**distributionStatus** +
435 __optional__||<<_distributionstatus,DistributionStatus>>
437 __optional__|Reference of the service specification- not mapped in Beijing|string
439 __optional__|Unique identifier of the service specification. Filled with SDC Service uuid|string
441 __required__|Additional attribute (not in the TMF API) - extended through @type - invariantUUID|string
442 |**lifecycleStatus** +
443 __optional__||<<_lifecyclestatusvalues,LifecycleStatusValues>>
445 __optional__|Name of the service specification- Filled with SDC Service name|string
447 __optional__||< <<_relatedpartyref,RelatedPartyRef>> > array
448 |**resourceSpecification** +
449 __optional__||< <<_resourcespecificationref,ResourceSpecificationRef>> > array
450 |**serviceSpecCharacteristic** +
451 __optional__||< <<_servicespeccharacteristic,ServiceSpecCharacteristic>> > array
453 __optional__|Additional attribute - extended through @type - category
454 Please note that this attribute is managed in TMF - in future release we'll introduce category resourc|string
455 |**targetServiceSchema** +
456 __optional__||<<_targetserviceschemaref,TargetServiceSchemaRef>>
458 __optional__|Additional attribute (not in the TMF API) - extended through @type - toscaModelURL|string
459 |**toscaResourceName** +
460 __optional__|Additional attribute (not in the TMF API) - extended through @type - toscaResourceName|string
462 __optional__|Service specification version - Filled with SDC Service version|string
466 [[_targetserviceschemaref]]
467 === TargetServiceSchemaRef
469 [options="header", cols=".^3,.^4"]
472 |**@schemaLocation** +
484 [options="header", cols=".^3,.^11,.^4"]
486 |Name|Description|Schema
488 __optional__|End date and time of the period|string (date-time)
490 __optional__|Start date and time of the period|string (date-time)