summaryrefslogtreecommitdiffstats
path: root/docs/api
diff options
context:
space:
mode:
Diffstat (limited to 'docs/api')
-rw-r--r--docs/api/apis/serviceInstances-api.rst103
1 files changed, 103 insertions, 0 deletions
diff --git a/docs/api/apis/serviceInstances-api.rst b/docs/api/apis/serviceInstances-api.rst
index a46af713dc..8eafe05a2e 100644
--- a/docs/api/apis/serviceInstances-api.rst
+++ b/docs/api/apis/serviceInstances-api.rst
@@ -43,6 +43,14 @@ Create service instance
|Content-Type |application/json |
+--------------------+--------------------------------------------------------+
+Request Headers:
+
++-------------------+---------+-----------------------------------------------------------------------------------------+
+|Header Name |Required |Description |
++===================+=========+=========================================================================================+
+|Authorization |Y |Base64 encoded username:password |
++-------------------+---------+-----------------------------------------------------------------------------------------+
+
Request Body:
+----------------+---------+-----------+--------------------------+-------------------------------------------+
@@ -238,6 +246,14 @@ Delete service instance
|Content-Type |application/json |
+--------------------+--------------------------------------------------------------------------------+
+Request Headers:
+
++-------------------+---------+-----------------------------------------------------------------------------------------+
+|Header Name |Required |Description |
++===================+=========+=========================================================================================+
+|Authorization |Y |Base64 encoded username:password |
++-------------------+---------+-----------------------------------------------------------------------------------------+
+
Request Body:
+----------------+---------+-----------+--------------------------+-------------------------------------------+
@@ -294,6 +310,14 @@ Create Volume Group
|Content-Type |application/json |
+--------------------+------------------------------------------------------------------------------------------------------------------+
+Request Headers:
+
++-------------------+---------+-----------------------------------------------------------------------------------------+
+|Header Name |Required |Description |
++===================+=========+=========================================================================================+
+|Authorization |Y |Base64 encoded username:password |
++-------------------+---------+-----------------------------------------------------------------------------------------+
+
Request Body:
+----------------+---------+-----------+--------------------------+-------------------------------------------+
@@ -427,6 +451,14 @@ Delete Volume Group
|Content-Type |application/json |
+--------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
+Request Headers:
+
++-------------------+---------+-----------------------------------------------------------------------------------------+
+|Header Name |Required |Description |
++===================+=========+=========================================================================================+
+|Authorization |Y |Base64 encoded username:password |
++-------------------+---------+-----------------------------------------------------------------------------------------+
+
Request Body:
+----------------+---------+-----------+--------------------------+-------------------------------------------+
@@ -490,6 +522,14 @@ Create VF Module
|Content-Type |application/json |
+--------------------+---------------------------------------------------------------------------------------------------------------+
+Request Headers:
+
++-------------------+---------+-----------------------------------------------------------------------------------------+
+|Header Name |Required |Description |
++===================+=========+=========================================================================================+
+|Authorization |Y |Base64 encoded username:password |
++-------------------+---------+-----------------------------------------------------------------------------------------+
+
Request Body:
+----------------+---------+-----------+--------------------------+-------------------------------------------+
@@ -587,6 +627,14 @@ Delete VF Module
|Content-Type |application/json |
+--------------------+-------------------------------------------------------------------------------------------------------------------------------------+
+Request Headers:
+
++-------------------+---------+-----------------------------------------------------------------------------------------+
+|Header Name |Required |Description |
++===================+=========+=========================================================================================+
+|Authorization |Y |Base64 encoded username:password |
++-------------------+---------+-----------------------------------------------------------------------------------------+
+
Request Body:
+----------------+---------+-----------+--------------------------+-------------------------------------------+
@@ -659,6 +707,14 @@ Create VNF
|Content-Type |application/json |
+--------------------+-------------------------------------------------------------------------------------+
+Request Headers:
+
++-------------------+---------+-----------------------------------------------------------------------------------------+
+|Header Name |Required |Description |
++===================+=========+=========================================================================================+
+|Authorization |Y |Base64 encoded username:password |
++-------------------+---------+-----------------------------------------------------------------------------------------+
+
Request Body:
+----------------+---------+-----------+--------------------------+-------------------------------------------+
@@ -808,6 +864,14 @@ Delete VNF
|Content-Type |application/json |
+--------------------+-----------------------------------------------------------------------------------------------------+
+Request Headers:
+
++-------------------+---------+-----------------------------------------------------------------------------------------+
+|Header Name |Required |Description |
++===================+=========+=========================================================================================+
+|Authorization |Y |Base64 encoded username:password |
++-------------------+---------+-----------------------------------------------------------------------------------------+
+
Request Body:
+----------------+---------+-----------+--------------------------+-------------------------------------------+
@@ -891,6 +955,14 @@ GET Orchestration Request
|Content-Type |application/json |
+--------------------+-------------------------------------------------------------------------------------+
+Request Headers:
+
++-------------------+---------+-----------------------------------------------------------------------------------------+
+|Header Name |Required |Description |
++===================+=========+=========================================================================================+
+|Authorization |Y |Base64 encoded username:password |
++-------------------+---------+-----------------------------------------------------------------------------------------+
+
Response Body:
+----------------+---------+-----------+--------------------------+-------------------------------------------+
@@ -1045,6 +1117,37 @@ GET Orchestration Requests
|Content-Type |application/json |
+--------------------+--------------------------------------------------------------+
+Request Headers:
+
++-------------------+---------+-----------------------------------------------------------------------------------------+
+|Header Name |Required |Description |
++===================+=========+=========================================================================================+
+|Authorization |Y |Base64 encoded username:password |
++-------------------+---------+-----------------------------------------------------------------------------------------+
+
+Query Parameters:
+
++-------------------+---------+-----------+-------+-----------------------------------------------------------------------------------------------------+
+|Attribute |Required |Cardinality|Content|Description |
++===================+=========+===========+=======+=====================================================================================================+
+|filter |Y |1 |String | Orchestration filter (scheme KeyTypes:Option:Value) |
+| | | | | |
+| | | | | KeyTypes: |
+| | | | | serviceInstanceId, serviceInstanceName, vnfInstanceId, pnfName, vnfInstanceName, |
+| | | | | vfModuleInstanceId, vfModuleInstanceName, volumeGroupInstanceId, volumeGroupInstanceName, |
+| | | | | networkInstanceId, networkInstanceName, configurationInstanceId, configurationInstanceName, |
+| | | | | lcpCloudRegionId, tenantId, modelType, requestorId, requestExecutionDate, startTime, requestScope |
+| | | | | |
+| | | | | Option: |
+| | | | | EQUALS (or any not null string), DOES_NOT_EQUAL [e.g. modelType:EQUALS:VNF, modelType:qwe:VNF] |
+| | | | | for KeyTypes equals startTime or requestExecutionDate: DOES_NOT_EQUAL, BETWEEN_DATES |
+| | | | | [e.g. startTime:BETWEEN_DATES:30-5-2000:30-5-2030] |
++-------------------+---------+-----------+-------+-----------------------------------------------------------------------------------------------------+
+|includeCloudRequest|N |1 |Boolean| Enable or disable cloud data request |
++-------------------+---------+-----------+-------+-----------------------------------------------------------------------------------------------------+
+|format |N |1 |String | Orchestration request format [DETAIL, STATUSDETAIL, SIMPLE, SIMPLENOTASKINFO] |
++-------------------+---------+-----------+-------+-----------------------------------------------------------------------------------------------------+
+
Response Body:
+----------------+---------+-----------+--------------------------+-------------------------------------------+