Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
  • This document covers sample service order requests from UUI to EXT-API for service creation/activation/deactivation/termination.


SERVICE CREATION :

MethodURL
POST{nbiUrl}/nbi/api/v4/serviceOrder/


JSON Viewer
modeText
{
   "externalId":"CSMF_Portal_TrackindId1",
   "category":"CommunicationService",
   "description":"NBI_NS_1",
   "priority":"1",
   "relatedParty":[
      {
         "id":"5GCustomer",
         "role":"ONAPcustomer",
         "name":"5GCustomer",
         "@referredType":"Consumer"
      }
   ],
   "orderItem":[
      {
         "id":"1",
         "action":"add",
         "service":{
            "name":"NBI_NS_1",
            "serviceType":"5G",
            "serviceSpecification":{
               "id":"442bf07a-5067-4f7f-bbd8-b77918ac3baa"
            },
            "serviceCharacteristic":[
               {
                  "name":"expDataRateDL",
                  "value":{
                     "serviceCharacteristicValue":"10"
                  }
               },
               {
                  "name":"expDataRateUL",
                  "value":{
                     "serviceCharacteristicValue":"30"
                  }
               },
               {
                  "name":"latency",
                  "value":{
                     "serviceCharacteristicValue":"100"
                  }
               },
               {
                  "name":"maxNumberofUEs",
                  "value":{
                     "serviceCharacteristicValue":"100"
                  }
               },
               {
                  "name":"uEMobilityLevel",
                  "value":{
                     "serviceCharacteristicValue":"stationary"
                  }
               },
               {
                  "name":"resourceSharingLevel",
                  "value":{
                     "serviceCharacteristicValue":"non-shared"
                  }
               },
               {
                  "name":"coverageAreaList",
                  "value":{
                     "serviceCharacteristicValue":"area1|area2"
                  }
               },
               {
                  "name":"useInterval",
                  "value":{
                     "serviceCharacteristicValue":"3"
                  }
               }
            ]
         }
      }
   ]
}


SERVICE TERMINATION

MethodURL
POST{nbiUrl}/nbi/api/v4/serviceOrder/


JSON Viewer
modeText
{
   "externalId":"CSMF_Portal_TrackindId3584",
   "category":"CommunicationService",
   "description":"ServiceOrderfordeleteCS",
   "priority":"1",
   "relatedParty":[
      {
         "id":"5GCustomer",
         "role":"ONAPcustomer",
         "name":"5GCustomer",
         "@referredType":"Consumer"
      }
   ],
   "orderItem":[
      {
         "id":"1",
         "action":"delete",
         "service":{
            "id":"262b9cc7-b7d5-4934-9af2-de120df54fbf",
            "serviceType":"5G",
            "serviceSpecification":{
               "id":"442bf07a-5067-4f7f-bbd8-b77918ac3baa"
            }
         }
      }
   ]
}

...

SERVICE ACTIVATION/DEACTIVATION :

MethodURL
POST{nbiUrl}/nbi/api/v4/serviceOrder/


JSON Viewer
modeText
{
   "externalId":"CSMF_Portal_TrackindId3584",
   "category":"Communication Service",
   "description":"Service Order for a new CS",
   "priority":"1",
   "relatedParty":[
      {
         "id":"CustomerId1",
         "role":"ONAPcustomer",
         "name":"CustomerId1",
         "@referredType":"Consumer"
      }
   ],
   "orderItem":[
      {
         "id":"1",
         "action":"modify",
         "service":{
            "id":"5c3feee0-6e36-46c6-862c-236d9c626422",
            "serviceType":"5G",
            "serviceState":"active/inactive",
            "serviceSpecification":{
               "id":"1e3fddb0-9e36-46c6-862c-236d9c626400"
            }
         }
      }
   ]
}

...