API Designer Model: serviceCatalog Version: 4.0.1 Owner: ONAPNBI Generated on: 2019-03-12T17:02:42.013Z Generated by: Orange API Designer v2, model-v1 This class is used to describe error. for nbi Beijing release we do not manage additional error for serviceCatalog This class is used to describe error. for nbi Beijing release we do not manage additional error for serviceCatalog Application related code (as defined in the API or from a common list) Text that explains the reason for error. This can be shown to a client user. Text that provide more details and corrective actions related to the error. This can be shown to a client user http error code extension like 400-2 url pointing to documentation describing the error The class type of a REST resource. it provides a link to the schema describing a REST resource. A time period A time period Start date and time of the period End date and time of the period Party linked to the service catalog. in nbi we retrieve information about last updater of the service in SDC Party linked to the service catalog. in nbi we retrieve information about last updater of the service in SDC Unique identifier of the related party. Filled with lastUpdaterUserId Role payed by the related party Only role 'lastUpdater' is retrieved in Beijing release Name of the related party - Filled with lastUpdatedFullName 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. the service information are retrieved in SDC 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. the service information are retrieved in SDC Unique identifier of the service specification. Filled with SDC Service uuid Reference of the service specification- not mapped in Beijing Name of the service specification- Filled with SDC Service name A narrative that explains in detail what the service specification is - Filled with SDC Service description This attribute allows to dynamically extends TMF class. Valued with 'ONAPservice'. We used this features to add following attributes: invariantUUID toscaModelURL toscaResourceName category (1) subcategory (1) distributionStatus Not used for Beijing release Not used for Beijing release Additional attribute (not in the TMF API) - extended through @type - invariantUUID Additional attribute (not in the TMF API) - extended through @type - toscaModelURL Additional attribute (not in the TMF API) - extended through @type - toscaResourceName Additional attribute - extended through @type - category Please note that this attribute is managed in TMF - in future release we'll introduce category resource Additional attribute - extended through @type - category Please note that this attribute is managed in TMF - in future release we'll introduce category resourc Additional attribute - extended through @type - distributionStatus Service specification version - Filled with SDC Service version Service Current status in the catalog - Filled with SDC Service life cycle state Not used in Beijing release A list of attachments concerning the service specification - Used to retrieve service artifacts A list of parties linked to the service specification - Used to retrieve lastUpdater informative A list of resource specification usable to deliver this service - used to retrieve resource A list of characteristic features of the service specification A characteristic quality or distinctive feature of a ServiceSpecification. ServiceSpecCharacteristic are retrieved in the serviceTosca file in the topology_template section in the inputs section. A characteristic quality or distinctive feature of a ServiceSpecification. ServiceSpecCharacteristic are retrieved in the serviceTosca file in the topology_template section in the inputs section. Name of the characteristic - Filled with parameter_name A narrative that explains in detail what the characteristic is - Filled with parameter_description A kind of value that the characteristic can take on, such as numeric, text and so forth - Filled with parameter_type This attribute allows to dynamically extends TMF class. Valued with: 'ONAPserviceCharacteristic'. We do not used this features in nbi Beijing release. An url pointing to type description - we do not use it in nbi Beijing release A parameter to define if the characteristic is mandatory - Filled from parameter_required – if not fielded by default ‘true’ Status of the characteristic - filled with status_value Value that can be assigned to a characteristic An attachment is a file uses to describe the service. In nbi we use attachment to retrieve ONAP artifacts. An attachment is a file uses to describe the service. In nbi we use attachment to retrieve ONAP artifacts. Unique identifier of the attachment - filled with artifactUUID. Name of the attachment - filled with artifactName Description of the attachment - filled with artifactDescription This attribute allows to dynamically extends TMF class. Valued with 'ONAPartifact'. We used this features to add following attributes: artifactLabel artifactGroupType artifactTimeout artifactChecksum artifactVersion generatedFromUUID Additional attribute (not in the TMF API) - extended through @type - artifactLabel Additional attribute (not in the TMF API) - extended through @type - artifactGroupType Additional attribute (not in the TMF API) - extended through @type - artifactTimeout Additional attribute (not in the TMF API) - extended through @type - artifactChecksum Additional attribute (not in the TMF API) - extended through @type - artifactVersion Additional attribute (not in the TMF API) - extended through @type - generatedFromUUID Uniform Resource Locator, is a web page address - filled with artifactURL Filled with artifactType A number or text that can be assigned to a service specification characteristic. ServiceSpecCharacteristicValue are retrieved in the service Tosca file A number or text that can be assigned to a service specification characteristic. ServiceSpecCharacteristicValue are retrieved in the service Tosca file A kind of value that the characteristic can take on, such as numeric, text, and so forth Retrieved in the Tosca in the topology_template section in the inputs section - parameter_type. We do not manage parameter_type= list or map for Beijing release Information calculated from parameter default in the Tosca file A discrete value that the characteristic can take on A list of resourceSpec identified to deliver the service. for nbi we retrieve resource information available in service description (through SDC api) bu as well information retrieved in the TOSCA file. A list of resourceSpec identified to deliver the service. for nbi we retrieve resource information available in service description (through SDC api) bu as well information retrieved in the TOSCA file. Unique identifier of the resource specification - filled with resourceUUID Version for this resource specification - filled with resourceVersion Name of the resource specification - filled with resourceName This attribute allows to dynamically extends TMF class. Valued with: 'ONAPresource'. We used this features to add following attributes: resourceInstanceName resourceInvariantUUID resourceType modelCustomizationName modelCustomizationId Additional attribute (not in the TMF API) - extended through @type - resourceInstanceName Additional attribute (not in the TMF API) - extended through @type - resourceInvariantUUID Additional attribute (not in the TMF API) - extended through @type - resoucreType 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 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