blob: c7e9dd49b60f4ab04c4c08851de4b2857539ed18 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
|
.. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. http://creativecommons.org/licenses/by/4.0
.. Copyright 2021 Wipro Ltd.
onap3gppServiceInstances API
============================
Create a 3GPP service instance
++++++++++++++++++++++++++++++
+--------------------+------------------------------------------------------------+
|Interface Definition|Description |
+====================+============================================================+
|URI |/onap/so/infra/3gppservices/v1/allocate |
+--------------------+------------------------------------------------------------+
|Operation Type |POST |
+--------------------+------------------------------------------------------------+
|Content-Type |application/json |
+--------------------+------------------------------------------------------------+
Request Body:
+---------------------+---------+-----------+----------------------------+-----------------------------------------+
|Attribute |Qualifier|Cardinality|Content |Description |
+=====================+=========+===========+============================+=========================================+
|allocate3gppService |M |1 |allocate3gppService Object |Content of allocate3gppService object |
+---------------------+---------+-----------+----------------------------+-----------------------------------------+
Allocate3gppService Object
+------------------------------+-----------------+-------------------------------------------------------------------+
|Attribute |Content |Description |
+==============================+=================+===================================================================+
|name |String |Name of the service to allocate |
+------------------------------+-----------------+-------------------------------------------------------------------+
|modelInvariantUuid |String |Model Invariant UUID |
+------------------------------+-----------------+-------------------------------------------------------------------+
|modelUuid |String |Model UUID |
+------------------------------+-----------------+-------------------------------------------------------------------+
|gloabalSubscriberId |String |Customer Id |
+------------------------------+-----------------+-------------------------------------------------------------------+
|subscriptionServiceType |String |service Type for subscription |
+------------------------------+-----------------+-------------------------------------------------------------------+
|networkType |String |Network Type |
+------------------------------+-----------------+-------------------------------------------------------------------+
|additionalProperties |Object |Map of additional properties required for service allocation |
+------------------------------+-----------------+-------------------------------------------------------------------+
Response:
+--------------------+---------+-----------+-------+------------------------------------------------------------------------+
|Attribute |Qualifier|Cardinality|Content|Description |
+--------------------+---------+-----------+-------+------------------------------------------------------------------------+
|jobId |M |1 |String |Job ID to be used to identify the status of the job |
+--------------------+---------+-----------+-------+------------------------------------------------------------------------+
|status |M |1 |String |Status of the job |
+--------------------+---------+-----------+-------+------------------------------------------------------------------------+
|statusDescription |M |1 |Object |Description on status in case of erroneous response |
+--------------------+---------+-----------+-------+------------------------------------------------------------------------+
Terminate/Deallocate a 3GPP service instance
++++++++++++++++++++++++++++++++++++++++++++
+--------------------+------------------------------------------------------------+
|Interface Definition|Description |
+====================+============================================================+
|URI |/onap/so/infra/3gppservices/v1/deAllocate |
+--------------------+------------------------------------------------------------+
|Operation Type |DELETE |
+--------------------+------------------------------------------------------------+
|Content-Type |application/json |
+--------------------+------------------------------------------------------------+
Request Body:
+-----------------------+---------+-----------+------------------------------+-------------------------------------------+
|Attribute |Qualifier|Cardinality|Content |Description |
+=======================+=========+===========+==============================+===========================================+
|deAllocate3gppService |M |1 |deAllocate3gppService Object |Content of deAllocate3gppService object |
+-----------------------+---------+-----------+------------------------------+-------------------------------------------+
DeAllocate3gppService Object
+------------------------------+-----------------+---------------------------------------------------------------------+
|Attribute |Content |Description |
+==============================+=================+=====================================================================+
|serviceInstanceID |String |ID of the service to terminate |
+------------------------------+-----------------+---------------------------------------------------------------------+
|gloabalSubscriberId |String |Customer Id |
+------------------------------+-----------------+---------------------------------------------------------------------+
|subscriptionServiceType |String |service Type for subscription |
+------------------------------+-----------------+---------------------------------------------------------------------+
|networkType |String |Network Type |
+------------------------------+-----------------+---------------------------------------------------------------------+
|additionalProperties |Object |Map of additional properties required for service deallocation |
+------------------------------+-----------------+---------------------------------------------------------------------+
Response:
+--------------------+---------+-----------+-------+------------------------------------------------------------------------+
|Attribute |Qualifier|Cardinality|Content|Description |
+--------------------+---------+-----------+-------+------------------------------------------------------------------------+
|jobId |M |1 |String |Job ID to be used to identify the status of the job |
+--------------------+---------+-----------+-------+------------------------------------------------------------------------+
|status |M |1 |String |Status of the job |
+--------------------+---------+-----------+-------+------------------------------------------------------------------------+
|statusDescription |M |1 |Object |Description on status in case of erroneous response |
+--------------------+---------+-----------+-------+------------------------------------------------------------------------+
Modify a 3GPP service instance
++++++++++++++++++++++++++++++
+--------------------+------------------------------------------------------------+
|Interface Definition|Description |
+====================+============================================================+
|URI |/onap/so/infra/3gppservices/v1/modify |
+--------------------+------------------------------------------------------------+
|Operation Type |PUT |
+--------------------+------------------------------------------------------------+
|Content-Type |application/json |
+--------------------+------------------------------------------------------------+
Request Body:
+---------------------+---------+-----------+----------------------------+-----------------------------------------+
|Attribute |Qualifier|Cardinality|Content |Description |
+=====================+=========+===========+============================+=========================================+
|modify3gppService |M |1 |modify3gppService Object |Content of modify3gppService object |
+---------------------+---------+-----------+----------------------------+-----------------------------------------+
Modify3gppService Object
+------------------------------+-----------------+-------------------------------------------------------------------+
|Attribute |Content |Description |
+==============================+=================+===================================================================+
|name |String |Name of the service to modify |
+------------------------------+-----------------+-------------------------------------------------------------------+
|serviceInstanceID |String |ID of the service to modify |
+------------------------------+-----------------+-------------------------------------------------------------------+
|gloabalSubscriberId |String |Customer Id |
+------------------------------+-----------------+-------------------------------------------------------------------+
|subscriptionServiceType |String |service Type for subscription |
+------------------------------+-----------------+-------------------------------------------------------------------+
|networkType |String |Network Type |
+------------------------------+-----------------+-------------------------------------------------------------------+
|additionalProperties |Object |Map of additional properties required for service modification |
+------------------------------+-----------------+-------------------------------------------------------------------+
Response:
+--------------------+---------+-----------+-------+------------------------------------------------------------------------+
|Attribute |Qualifier|Cardinality|Content|Description |
+--------------------+---------+-----------+-------+------------------------------------------------------------------------+
|jobId |M |1 |String |Job ID to be used to identify the status of the job |
+--------------------+---------+-----------+-------+------------------------------------------------------------------------+
|status |M |1 |String |Status of the job |
+--------------------+---------+-----------+-------+------------------------------------------------------------------------+
|statusDescription |M |1 |Object |Description on status in case of erroneous response |
+--------------------+---------+-----------+-------+------------------------------------------------------------------------+
Activate a 3GPP service instance
++++++++++++++++++++++++++++++++
+--------------------+------------------------------------------------------------+
|Interface Definition|Description |
+====================+============================================================+
|URI |/onap/so/infra/3gppservices/v1/activate |
+--------------------+------------------------------------------------------------+
|Operation Type |POST |
+--------------------+------------------------------------------------------------+
|Content-Type |application/json |
+--------------------+------------------------------------------------------------+
Request Body:
+---------------------+---------+-----------+----------------------------+-----------------------------------------+
|Attribute |Qualifier|Cardinality|Content |Description |
+=====================+=========+===========+============================+=========================================+
|activate3gppService |M |1 |activate3gppService Object |Content of activate3gppService object |
+---------------------+---------+-----------+----------------------------+-----------------------------------------+
Activate3gppService Object
+------------------------------+-----------------+-------------------------------------------------------------------+
|Attribute |Content |Description |
+==============================+=================+===================================================================+
|serviceInstanceID |String |ID of the service to be activated |
+------------------------------+-----------------+-------------------------------------------------------------------+
|gloabalSubscriberId |String |Customer Id |
+------------------------------+-----------------+-------------------------------------------------------------------+
|subscriptionServiceType |String |service Type for subscription |
+------------------------------+-----------------+-------------------------------------------------------------------+
|networkType |String |Network Type |
+------------------------------+-----------------+-------------------------------------------------------------------+
|additionalProperties |Object |Map of additional properties required for service activation |
+------------------------------+-----------------+-------------------------------------------------------------------+
Response:
+--------------------+---------+-----------+-------+------------------------------------------------------------------------+
|Attribute |Qualifier|Cardinality|Content|Description |
+--------------------+---------+-----------+-------+------------------------------------------------------------------------+
|jobId |M |1 |String |Job ID to be used to identify the status of the job |
+--------------------+---------+-----------+-------+------------------------------------------------------------------------+
|status |M |1 |String |Status of the job |
+--------------------+---------+-----------+-------+------------------------------------------------------------------------+
|statusDescription |M |1 |Object |Description on status in case of erroneous response |
+--------------------+---------+-----------+-------+------------------------------------------------------------------------+
Deactivate a 3GPP service instance
++++++++++++++++++++++++++++++++++
+--------------------+------------------------------------------------------------+
|Interface Definition|Description |
+====================+============================================================+
|URI |/onap/so/infra/3gppservices/v1/deActivate |
+--------------------+------------------------------------------------------------+
|Operation Type |POST |
+--------------------+------------------------------------------------------------+
|Content-Type |application/json |
+--------------------+------------------------------------------------------------+
Request Body:
+-----------------------+---------+-----------+------------------------------+-------------------------------------------+
|Attribute |Qualifier|Cardinality|Content |Description |
+=======================+=========+===========+==============================+===========================================+
|deActivate3gppService |M |1 |deActivate3gppService Object |Content of deActivate3gppService object |
+-----------------------+---------+-----------+------------------------------+-------------------------------------------+
DeActivate3gppService Object
+------------------------------+-----------------+-------------------------------------------------------------------+
|Attribute |Content |Description |
+==============================+=================+===================================================================+
|serviceInstanceID |String |ID of the service to be deactivated |
+------------------------------+-----------------+-------------------------------------------------------------------+
|gloabalSubscriberId |String |Customer Id |
+------------------------------+-----------------+-------------------------------------------------------------------+
|subscriptionServiceType |String |service Type for subscription |
+------------------------------+-----------------+-------------------------------------------------------------------+
|networkType |String |Network Type |
+------------------------------+-----------------+-------------------------------------------------------------------+
|additionalProperties |Object |Map of additional properties required for service deactivation |
+------------------------------+-----------------+-------------------------------------------------------------------+
Response:
+--------------------+---------+-----------+-------+------------------------------------------------------------------------+
|Attribute |Qualifier|Cardinality|Content|Description |
+--------------------+---------+-----------+-------+------------------------------------------------------------------------+
|jobId |M |1 |String |Job ID to be used to identify the status of the job |
+--------------------+---------+-----------+-------+------------------------------------------------------------------------+
|status |M |1 |String |Status of the job |
+--------------------+---------+-----------+-------+------------------------------------------------------------------------+
|statusDescription |M |1 |Object |Description on status in case of erroneous response |
+--------------------+---------+-----------+-------+------------------------------------------------------------------------+
Query subnet capability based on subnet types
+++++++++++++++++++++++++++++++++++++++++++++
+--------------------+------------------------------------------------------------+
|Interface Definition|Description |
+====================+============================================================+
|URI |/onap/so/infra/3gppservices/v1/subnetCapabilityQuery |
+--------------------+------------------------------------------------------------+
|Operation Type |GET |
+--------------------+------------------------------------------------------------+
|Content-Type |application/json |
+--------------------+------------------------------------------------------------+
Request Body:
+-------------------------+---------+-----------+-------------------------------+-----------------------------------------+
|Attribute |Qualifier|Cardinality|Content |Description |
+=========================+=========+===========+===============================+=========================================+
|querySubnetCapability |M |1 |QuerySubnetCapability Object |Content of querySubnetCapability object |
+-------------------------+---------+-----------+-------------------------------+-----------------------------------------+
QuerySubnetCapability Object
+------------------------------+-----------------+-----------------------------------------+
|Attribute |Content |Description |
+==============================+=================+=========================================+
|SubnetTypes |List of object |This describes the subnet types info |
+------------------------------+-----------------+-----------------------------------------+
SubnetTypes Object
+------------------------------+-----------------+------------------------------------------------------------------------+
|Attribute |Content |Description |
+==============================+=================+========================================================================+
|SubnetTypes |enum |This describes the subnet types i.e., AN,AN_NF,CN,TN_FH,TN_MH,TN_BH |
+------------------------------+-----------------+------------------------------------------------------------------------+
Response:
+------------------+---------+-----------+-------+------------------------------------------------------------------------+
|Attribute |Qualifier|Cardinality|Content|Description |
+------------------+---------+-----------+-------+------------------------------------------------------------------------+
|ResponseDetails |M |1 |Object |Successful operation with capabilities for the queried subnetTypes |
+------------------+---------+-----------+-------+------------------------------------------------------------------------+
|
