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 ::
  20
  21     SDC_ROOT_URL = "/sdc/v1/catalog/services/"
  22
  23     SDC_GET_PATH = "/metadata"
  24
  25     SDC_TOSCA_PATH = "/toscaModel"
  26
  27
  28 *******
  29 AAI API
  30 *******
  31
  32 This API is used to provide Service Inventory information
  33 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 )
  34
  35 ::
  36
  37     AAI_GET_TENANTS_PATH = "/aai/v11/cloud-infrastructure/cloud-regions/cloud-region/$onap.cloudOwner/$onap.lcpCloudRegionId/tenants"
  38
  39     AAI_GET_CUSTOMER_PATH = "/aai/v11/business/customers/customer/"
  40
  41     AAI_GET_SERVICES_FOR_CUSTOMER_PATH = "/aai/v11/business/customers/customer/$customerId/service-subscriptions"
  42
  43     AAI_PUT_SERVICE_FOR_CUSTOMER_PATH = "/aai/v11/business/customers/customer/$customerId/service-subscriptions/service-subscription/
  44
  45     AAI_GET_SERVICE_FOR_CUSTOMER_PATH = "/aai/v11/business/customers/customer/$customerId/service-subscriptions/service-subscription/$serviceSpecName/service-instances/service-instance/$serviceId"
  46
  47     AAI_GET_SERVICE_INSTANCES_PATH = "/aai/v11/business/customers/customer/$customerId/service-subscriptions/service-subscription/$serviceSpecName/service-instances/"
  48
  49
  50
  51 ******
  52 SO API
  53 ******
  54
  55 This API is used to perform Service Order and thus instantiate a service
  56
  57
  58 ::
  59
  60     MSO_CREATE_SERVICE_INSTANCE_PATH = "/ecomp/mso/infra/serviceInstance/v4"
  61
  62     MSO_GET_REQUEST_STATUS_PATH = "/ecomp/mso/infra/orchestrationRequests/v4/"
  63
  64     MSO_DELETE_REQUEST_STATUS_PATH = "/ecomp/mso/infra/serviceInstances/"
  65