docs/consumedapis/consumedapis.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2 .. http://creativecommons.org/licenses/by/4.0
   3 .. Copyright 2018 ORANGE
   4
   5
   6 Consumed APIs
   7 =============
   8
   9
  10 NBI application is interacting with 3 ONAP APIs
  11
  12 ***************
  13 SDC API
  14 ***************
  15
  16 this API is used to provide Service Catalog information
  17 Information are retrieved in SDC (and in Tosca "service template" file) - Only GET operation is provided - this API DID NOT UPDATE SDC
  18
  19     SDC_ROOT_URL = "/sdc/v1/catalog/services/"
  20
  21     SDC_GET_PATH = "/metadata"
  22
  23     SDC_TOSCA_PATH = "/toscaModel"
  24
  25
  26 ***************
  27 AAI API
  28 ***************
  29
  30 this API is used to provide Service Inventory information
  31 This API retrieves service(s) in the AAI inventory. Only following attributes will be retrieve in service inventory: id, name and type (no state or startDate available )
  32
  33     AAI_GET_TENANTS_PATH = "/aai/v11/cloud-infrastructure/cloud-regions/cloud-region/$onap.cloudOwner/$onap.lcpCloudRegionId/tenants"
  34
  35     AAI_GET_CUSTOMER_PATH = "/aai/v11/business/customers/customer/"
  36
  37     AAI_GET_SERVICES_FOR_CUSTOMER_PATH = "/aai/v11/business/customers/customer/$customerId/service-subscriptions"
  38
  39     AAI_PUT_SERVICE_FOR_CUSTOMER_PATH = "/aai/v11/business/customers/customer/$customerId/service-subscriptions/service-subscription/
  40
  41     AAI_GET_SERVICE_FOR_CUSTOMER_PATH = "/aai/v11/business/customers/customer/$customerId/service-subscriptions/service-subscription/$serviceSpecName/service-instances/service-instance/$serviceId"
  42
  43     AAI_GET_SERVICE_INSTANCES_PATH = "/aai/v11/business/customers/customer/$customerId/service-subscriptions/service-subscription/$serviceSpecName/service-instances/"
  44
  45
  46
  47 ***************
  48 SO API
  49 ***************
  50
  51 this API is used to perform Service Order and thus instantiate a service
  52
  53
  54     MSO_CREATE_SERVICE_INSTANCE_PATH = "/ecomp/mso/infra/serviceInstance/v4"
  55
  56     MSO_GET_REQUEST_STATUS_PATH = "/ecomp/mso/infra/orchestrationRequests/v4/"
  57
  58     MSO_DELETE_REQUEST_STATUS_PATH = "/ecomp/mso/infra/serviceInstances/"
  59