docs/api/apis/ManagedObject3gppServiceInstances.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 2023 DTAG
   4
   5 ManagedObject3gppServiceInstances API
   6 =====================================
   7
   8 Create a ManagedObject3gppServiceInstances
   9 ++++++++++++++++++++++++++++++++++++++++++
  10
  11 +--------------------+------------------------------------------------------------+
  12 |Interface Definition|Description                                                 |
  13 +====================+============================================================+
  14 |URI                 |onap/so/infra/moi/api/rest/v1/NetworkSliceSubnet/$NSSID     |
  15 +--------------------+------------------------------------------------------------+
  16 |Operation Type      |PUT                                                         |
  17 +--------------------+------------------------------------------------------------+
  18 |Content-Type        |application/json                                            |
  19 +--------------------+------------------------------------------------------------+
  20
  21 Request Body:
  22
  23 +-----------------------------------+---------+-----------+--------------+---------------------------------------+
  24 |Attribute                          |Qualifier|Cardinality|Content       |Description                            |
  25 +===================================+=========+===========+==============+=======================================+
  26 |ManagedObject3gppServiceInstances  |M        |1          |allocateMOI   |Content of allocate3gppMOI object      |
  27 +-----------------------------------+---------+-----------+--------------+---------------------------------------+
  28
  29 ManagedObject3gppServiceInstances Object
  30
  31 +------------------------------+-----------------+-------------------------------------------------------------------+
  32 |Attribute                     |Content          |Description                                                        |
  33 +==============================+=================+===================================================================+
  34 |attributes                    |List             |List of Slice Profile Attribute                                    |
  35 +------------------------------+-----------------+-------------------------------------------------------------------+
  36
  37
  38 SliceProfileList Object
  39
  40 +------------------------------+-----------------+-------------------------------------------------------------------+
  41 |Attribute                     |Content          |Description                                                        |
  42 +==============================+=================+===================================================================+
  43 |plmnInfoList                  |List             |Contains plmnInfoList                                              |
  44 +------------------------------+-----------------+-------------------------------------------------------------------+
  45 |RANSliceSubnetProfile         |Object           |Contains RAN Attributes Object                                     |
  46 +------------------------------+-----------------+-------------------------------------------------------------------+
  47
  48
  49 plmnInfoList Object
  50
  51 +------------------------------+-----------------+-------------------------------------------------------------------+
  52 |Attribute                     |Content          |Description                                                        |
  53 +==============================+=================+===================================================================+
  54 |plmnId                        |Object           |Contains plmnData                                                  |
  55 +------------------------------+-----------------+-------------------------------------------------------------------+
  56 |snssai                        |Object           |Contains snssai data                                               |
  57 +------------------------------+-----------------+-------------------------------------------------------------------+
  58
  59 plmnId Object
  60
  61 +------------------------------+-----------------+-------------------------------------------------------------------+
  62 |Attribute                     |Content          |Description                                                        |
  63 +==============================+=================+===================================================================+
  64 |mcc                           |integer          |Contains mcc value                                                 |
  65 +------------------------------+-----------------+-------------------------------------------------------------------+
  66 |mnc                           |integer          |Contains mcc value                                                 |
  67 +------------------------------+-----------------+-------------------------------------------------------------------+
  68
  69 snssai Object
  70
  71 +------------------------------+-----------------+-------------------------------------------------------------------+
  72 |Attribute                     |Content          |Description                                                        |
  73 +==============================+=================+===================================================================+
  74 |sst                           |string           |Contains sst                                                       |
  75 +------------------------------+-----------------+-------------------------------------------------------------------+
  76 |sd                            |string           |Contains sd                                                        |
  77 +------------------------------+-----------------+-------------------------------------------------------------------+
  78
  79 RAN Attribute Object
  80
  81 +------------------------------+-----------------+-------------------------------------------------------------------+
  82 |Attribute                     |Content          |Description                                                        |
  83 +==============================+=================+===================================================================+
  84 |coverageAreaTAList            |integer          |Contains coverageAreaTAList                                        |
  85 +------------------------------+-----------------+-------------------------------------------------------------------+
  86 |latency                       |integer          |desired latency of slice                                           |
  87 +------------------------------+-----------------+-------------------------------------------------------------------+
  88 |areaTrafficCapDL              |integer          |Contains areaTrafficCapDL                                          |
  89 +------------------------------+-----------------+-------------------------------------------------------------------+
  90 |resourceSharingLevel          |string           |describes slice sharing level                                      |
  91 +------------------------------+-----------------+-------------------------------------------------------------------+
  92 |serviceType                   |string           |describes serviceType                                              |
  93 +------------------------------+-----------------+-------------------------------------------------------------------+
  94 |maxNumberofUEs                |integer          |describes maxNumberofUEs                                           |
  95 +------------------------------+-----------------+-------------------------------------------------------------------+
  96
  97
  98 Response:
  99
 100 +-------------------------+---------+-----------+-----------------+-------------------------------------------+
 101 |Attribute                |Qualifier|Cardinality|Content          |Description                                |
 102 +=========================+=========+===========+=================+===========================================+
 103 |requestReferences        |M        |1          |Response Object  |Content of Response object.                |
 104 +----------------+--------+---------+-----------+-----------------+-------------------------------------------+
 105
 106 Response Object
 107
 108 +-------------------+---------+-----------+--------------------------+-------------------------------------------+
 109 |Attribute          |Qualifier|Cardinality|Content                   |Description                                |
 110 +===================+=========+===========+==========================+===========================================+
 111 |requestId          |M        |1          |String                    |Request Id.                                |
 112 +-------------------+---------+-----------+--------------------------+-------------------------------------------+
 113 |requestDetails     |M        |1          |requestDetails Object     |Type of the request.                       |
 114 +-------------------+---------+-----------+--------------------------+-------------------------------------------+
 115 |instanceId         |M        |1          |requestStatus Object      |Type of the request.                       |
 116 +-------------------+---------+-----------+--------------------------+-------------------------------------------+
 117
 118
 119
 120 Terminate/Deallocate a MOI
 121 ++++++++++++++++++++++++++
 122
 123 +--------------------+------------------------------------------------------------+
 124 |Interface Definition|Description                                                 |
 125 +====================+============================================================+
 126 |URI                 |onap/so/infra/moi/api/rest/v1/NetworkSliceSubnet/$NSSID     |
 127 +--------------------+------------------------------------------------------------+
 128 |Operation Type      |DELETE                                                      |
 129 +--------------------+------------------------------------------------------------+
 130 |Content-Type        |application/json                                            |
 131 +--------------------+------------------------------------------------------------+
 132
 133
 134 Request Body:
 135
 136 +-----------------------------------+---------+-----------+--------------+---------------------------------------+
 137 |Attribute                          |Qualifier|Cardinality|Content       |Description                            |
 138 +===================================+=========+===========+==============+=======================================+
 139 |ManagedObject3gppServiceInstances  |M        |1          |deleteMOI     |Content of deleteMOI object            |
 140 +-----------------------------------+---------+-----------+--------------+---------------------------------------+
 141
 142 ManagedObject3gppServiceInstances Object
 143
 144 +------------------------------+-----------------+-------------------------------------------------------------------+
 145 |Attribute                     |Content          |Description                                                        |
 146 +==============================+=================+===================================================================+
 147 |attributes                    |List             |List of Slice Profile Attribute                                    |
 148 +------------------------------+-----------------+-------------------------------------------------------------------+
 149
 150
 151 SliceProfileList Object
 152
 153 +------------------------------+-----------------+-------------------------------------------------------------------+
 154 |Attribute                     |Content          |Description                                                        |
 155 +==============================+=================+===================================================================+
 156 |sliceProfileId                |string           |slice profile id to be deleted                                     |
 157 +------------------------------+-----------------+-------------------------------------------------------------------+
 158
 159
 160 Response
 161
 162 +-------------------------+---------+-----------+-----------------+-------------------------------------------+
 163 |Attribute                |Qualifier|Cardinality|Content          |Description                                |
 164 +=========================+=========+===========+=================+===========================================+
 165 |requestReferences        |M        |1          |Response Object  |Content of Response object.                |
 166 +-------------------------+---------+-----------+-----------------+-------------------------------------------+
 167
 168 Response Object
 169
 170 +-------------------+---------+-----------+--------------------------+-------------------------------------------+
 171 |Attribute          |Qualifier|Cardinality|Content                   |Description                                |
 172 +===================+=========+===========+==========================+===========================================+
 173 |requestId          |M        |1          |String                    |Request Id.                                |
 174 +-------------------+---------+-----------+--------------------------+-------------------------------------------+
 175 |requestDetails     |M        |1          |requestDetails Object     |Type of the request.                       |
 176 +-------------------+---------+-----------+--------------------------+-------------------------------------------+
 177 |instanceId         |M        |1          |requestStatus Object      |Type of the request.                       |
 178 +-------------------+---------+-----------+--------------------------+-------------------------------------------+
 179
 180
 181
 182
 183 Modify a 3GPP service instance
 184 ++++++++++++++++++++++++++++++
 185 +--------------------+------------------------------------------------------------+
 186 |Interface Definition|Description                                                 |
 187 +====================+============================================================+
 188 |URI                 |onap/so/infra/moi/api/rest/v1/NetworkSliceSubnet/$NSSID     |
 189 +--------------------+------------------------------------------------------------+
 190 |Operation Type      |PATCH                                                       |
 191 +--------------------+------------------------------------------------------------+
 192 |Content-Type        |application/json                                            |
 193 +--------------------+------------------------------------------------------------+
 194
 195
 196 Request Body:
 197
 198 +-----------------------------------+---------+-----------+--------------+---------------------------------------+
 199 |Attribute                          |Qualifier|Cardinality|Content       |Description                            |
 200 +===================================+=========+===========+==============+=======================================+
 201 |ManagedObject3gppServiceInstances  |M        |1          |modifyMOI     |Content of modifyMOI object            |
 202 +-----------------------------------+---------+-----------+--------------+---------------------------------------+
 203
 204
 205 ManagedObject3gppServiceInstances Object
 206
 207 +------------------------------+-----------------+-------------------------------------------------------------------+
 208 |Attribute                     |Content          |Description                                                        |
 209 +==============================+=================+===================================================================+
 210 |attributes                    |List             |List of Slice Profile Attribute                                    |
 211 +------------------------------+-----------------+-------------------------------------------------------------------+
 212
 213
 214 SliceProfileList Object
 215
 216 +------------------------------+-----------------+-------------------------------------------------------------------+
 217 |Attribute                     |Content          |Description                                                        |
 218 +==============================+=================+===================================================================+
 219 |sliceProfileId                |string           |slice profile id to be modify                                      |
 220 +------------------------------+-----------------+-------------------------------------------------------------------+
 221 |RANSliceSubnetProfile         |Object           |Contains RAN Attributes Object                                     |
 222 +------------------------------+-----------------+-------------------------------------------------------------------+
 223
 224
 225 RAN Attribute Object
 226
 227 +------------------------------+-----------------+-------------------------------------------------------------------+
 228 |Attribute                     |Content          |Description                                                        |
 229 +==============================+=================+===================================================================+
 230 |coverageAreaTAList            |integer          |Contains coverageAreaTAList                                        |
 231 +------------------------------+-----------------+-------------------------------------------------------------------+
 232 |latency                       |integer          |desired latency of slice                                           |
 233 +------------------------------+-----------------+-------------------------------------------------------------------+
 234 |areaTrafficCapDL              |integer          |Contains areaTrafficCapDL                                          |
 235 +------------------------------+-----------------+-------------------------------------------------------------------+
 236 |resourceSharingLevel          |string           |describes slice sharing level                                      |
 237 +------------------------------+-----------------+-------------------------------------------------------------------+
 238 |serviceType                   |string           |describes serviceType                                              |
 239 +------------------------------+-----------------+-------------------------------------------------------------------+
 240 |maxNumberofUEs                |integer          |describes maxNumberofUEs                                           |
 241 +------------------------------+-----------------+-------------------------------------------------------------------+
 242
 243
 244 Response:
 245
 246 +-------------------------+---------+-----------+-----------------+-------------------------------------------+
 247 |Attribute                |Qualifier|Cardinality|Content          |Description                                |
 248 +=========================+=========+===========+=================+===========================================+
 249 |requestReferences        |M        |1          |Response Object  |Content of Response object.                |
 250 +-------------------------+---------+-----------+-----------------+-------------------------------------------+
 251
 252 Response Object
 253
 254 +-------------------+---------+-----------+--------------------------+-------------------------------------------+
 255 |Attribute          |Qualifier|Cardinality|Content                   |Description                                |
 256 +===================+=========+===========+==========================+===========================================+
 257 |requestId          |M        |1          |String                    |Request Id.                                |
 258 +-------------------+---------+-----------+--------------------------+-------------------------------------------+
 259 |requestDetails     |M        |1          |requestDetails Object     |Type of the request.                       |
 260 +-------------------+---------+-----------+--------------------------+-------------------------------------------+
 261 |instanceId         |M        |1          |requestStatus Object      |Type of the request.                       |
 262 +-------------------+---------+-----------+--------------------------+-------------------------------------------+