docs/consumedapis/consumedapis.rst

   1 .. This work is licensed under
   2 .. a Creative Commons Attribution 4.0 International License.
   3 .. http://creativecommons.org/licenses/by/4.0
   4 .. Copyright 2018 ORANGE
   5
   6
   7 Consumed APIs
   8 =============
   9
  10
  11 NBI application is interacting with 3 ONAP APIs
  12
  13 *******
  14 SDC API
  15 *******
  16
  17 This API is used to provide Service Catalog information
  18 Information are retrieved in SDC (and in TOSCA "service template" file)
  19 - Only GET operation is provided - this API DID NOT UPDATE SDC
  20
  21 ::
  22
  23     SDC_ROOT_URL = "/sdc/v1/catalog/services/"
  24
  25     SDC_GET_PATH = "/metadata"
  26
  27     SDC_TOSCA_PATH = "/toscaModel"
  28
  29
  30 *******
  31 AAI API
  32 *******
  33
  34 This API is used to provide Service Inventory information
  35 This API retrieves service(s) in the AAI inventory. Only following attributes
  36 will be retrieve in service inventory: id, name and type
  37 (no state or startDate available )
  38
  39 ::
  40
  41     AAI_GET_TENANTS_PATH = "/aai/v11/cloud-infrastructure/cloud-regions/cloud-region/$onap.cloudOwner/$onap.lcpCloudRegionId/tenants"
  42
  43     AAI_GET_CUSTOMER_PATH = "/aai/v11/business/customers/customer/"
  44
  45     AAI_GET_SERVICES_FOR_CUSTOMER_PATH = "/aai/v11/business/customers/customer/$customerId/service-subscriptions"
  46
  47     AAI_PUT_SERVICE_FOR_CUSTOMER_PATH = "/aai/v11/business/customers/customer/$customerId/service-subscriptions/service-subscription/
  48
  49     AAI_GET_SERVICE_FOR_CUSTOMER_PATH = "/aai/v11/business/customers/customer/$customerId/service-subscriptions/service-subscription/$serviceSpecName/service-instances/service-instance/$serviceId"
  50
  51     AAI_GET_SERVICE_INSTANCES_PATH = "/aai/v11/business/customers/customer/$customerId/service-subscriptions/service-subscription/$serviceSpecName/service-instances/"
  52
  53
  54
  55 ******
  56 SO API
  57 ******
  58
  59 This API is used to perform Service Order and thus instantiate a service.
  60 Distinct SO APIs are used for serviceInstance creation request depending on the serviceSpecification category (set in SDC).
  61 If service could be delivered end-to-end from one request category is set to 'E2E Service'.
  62 In this case NBI uses
  63
  64 ::
  65
  66     MSO_CREATE_E2ESERVICE_INSTANCE_PATH = "/ecomp/mso/infra/e2eServiceInstances/v3"
  67
  68     MSO_GET_REQUEST_STATUS_PATH = "/ecomp/mso/infra/orchestrationRequests/v6/"
  69
  70     MSO_DELETE_REQUEST_STATUS_PATH = "/ecomp/mso/infra/serviceInstances/v6/"
  71
  72
  73 else following API are used:
  74
  75 ::
  76
  77     MSO_CREATE_SERVICE_INSTANCE_PATH = "/ecomp/mso/infra/serviceInstance/v6"
  78
  79     MSO_GET_REQUEST_STATUS_PATH = "/ecomp/mso/infra/orchestrationRequests/v6/"
  80
  81     MSO_DELETE_REQUEST_STATUS_PATH = "/ecomp/mso/infra/serviceInstances/v6/"