diff options
Diffstat (limited to 'docs/api')
| -rw-r--r-- | docs/api/apis/onap3gppServiceInstances-api.rst | 302 |
1 files changed, 302 insertions, 0 deletions
diff --git a/docs/api/apis/onap3gppServiceInstances-api.rst b/docs/api/apis/onap3gppServiceInstances-api.rst new file mode 100644 index 0000000000..c7e9dd49b6 --- /dev/null +++ b/docs/api/apis/onap3gppServiceInstances-api.rst @@ -0,0 +1,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 | ++------------------+---------+-----------+-------+------------------------------------------------------------------------+ |