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