docs/api/apis/serviceInstances-api.rst


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
.highlight .hll { background-color: #ffffcc }
.highlight .c { color: #888888 } /* Comment */
.highlight .err { color: #a61717; background-color: #e3d2d2 } /* Error */
.highlight .k { color: #008800; font-weight: bold } /* Keyword */
.highlight .ch { color: #888888 } /* Comment.Hashbang */
.highlight .cm { color: #888888 } /* Comment.Multiline */
.highlight .cp { color: #cc0000; font-weight: bold } /* Comment.Preproc */
.highlight .cpf { color: #888888 } /* Comment.PreprocFile */
.highlight .c1 { color: #888888 } /* Comment.Single */
.highlight .cs { color: #cc0000; font-weight: bold; background-color: #fff0f0 } /* Comment.Special */
.highlight .gd { color: #000000; background-color: #ffdddd } /* Generic.Deleted */
.highlight .ge { font-style: italic } /* Generic.Emph */
.highlight .gr { color: #aa0000 } /* Generic.Error */
.highlight .gh { color: #333333 } /* Generic.Heading */
.highlight .gi { color: #000000; background-color: #ddffdd } /* Generic.Inserted */
.highlight .go { color: #888888 } /* Generic.Output */
.highlight .gp { color: #555555 } /* Generic.Prompt */
.highlight .gs { font-weight: bold } /* Generic.Strong */
.highlight .gu { color: #666666 } /* Generic.Subheading */
.highlight .gt { color: #aa0000 } /* Generic.Traceback */
.highlight .kc { color: #008800; font-weight: bold } /* Keyword.Constant */
.highlight .kd { color: #008800; font-weight: bold } /* Keyword.Declaration */
.highlight .kn { color: #008800; font-weight: bold } /* Keyword.Namespace */
.highlight .kp { color: #008800 } /* Keyword.Pseudo */
.highlight .kr { color: #008800; font-weight: bold } /* Keyword.Reserved */
.highlight .kt { color: #888888; font-weight: bold } /* Keyword.Type */
.highlight .m { color: #0000DD; font-weight: bold } /* Literal.Number */
.highlight .s { color: #dd2200; background-color: #fff0f0 } /* Literal.String */
.highlight .na { color: #336699 } /* Name.Attribute */
.highlight .nb { color: #003388 } /* Name.Builtin */
.highlight .nc { color: #bb0066; font-weight: bold } /* Name.Class */
.highlight .no { color: #003366; font-weight: bold } /* Name.Constant */
.highlight .nd { color: #555555 } /* Name.Decorator */
.highlight .ne { color: #bb0066; font-weight: bold } /* Name.Exception */
.highlight .nf { color: #0066bb; font-weight: bold } /* Name.Function */
.highlight .nl { color: #336699; font-style: italic } /* Name.Label */
.highlight .nn { color: #bb0066; font-weight: bold } /* Name.Namespace */
.highlight .py { color: #336699; font-weight: bold } /* Name.Property */
.highlight .nt { color: #bb0066; font-weight: bold } /* Name.Tag */
.highlight .nv { color: #336699 } /* Name.Variable */
.highlight .ow { color: #008800 } /* Operator.Word */
.highlight .w { color: #bbbbbb } /* Text.Whitespace */
.highlight .mb { color: #0000DD; font-weight: bold } /* Literal.Number.Bin */
.highlight .mf { color: #0000DD; font-weight: bold } /* Literal.Number.Float */
.highlight .mh { color: #0000DD; font-weight: bold } /* Literal.Number.Hex */
.highlight .mi { color: #0000DD; font-weight: bold } /* Literal.Number.Integer */
.highlight .mo { color: #0000DD; font-weight: bold } /* Literal.Number.Oct */
.highlight .sa { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Affix */
.highlight .sb { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Backtick */
.highlight .sc { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Char */
.highlight .dl { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Delimiter */
.highlight .sd { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Doc */
.highlight .s2 { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Double */
.highlight .se { color: #0044dd; background-color: #fff0f0 } /* Literal.String.Escape */
.highlight .sh { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Heredoc */
.highlight .si { color: #3333bb; background-color: #fff0f0 } /* Literal.String.Interpol */
.highlight .sx { color: #22bb22; background-color: #f0fff0 } /* Literal.String.Other */
.highlight .sr { color: #008800; background-color: #fff0ff } /* Literal.String.Regex */
.highlight .s1 { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Single */
.highlight .ss { color: #aa6600; background-color: #fff0f0 } /* Literal.String.Symbol */
.highlight .bp { color: #003388 } /* Name.Builtin.Pseudo */
.highlight .fm { color: #0066bb; font-weight: bold } /* Name.Function.Magic */
.highlight .vc { color: #336699 } /* Name.Variable.Class */
.highlight .vg { color: #dd7700 } /* Name.Variable.Global */
.highlight .vi { color: #3333bb } /* Name.Variable.Instance */
.highlight .vm { color: #336699 } /* Name.Variable.Magic */
.highlight .il { color: #0000DD; font-weight: bold } /* Literal.Number.Integer.Long */.. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. http://creativecommons.org/licenses/by/4.0
.. Copyright 2017 Huawei Technologies Co., Ltd.

Workspace and Development Tools
===============================

We recognize that there are different ways to set up a workspace and different tools that may be chosen.  This is just one way to set things up.

Suggested Directory Structure
------------------------------
*NOTE*: You may have different versions of eclipse and java.

	onap
	
		.m2
		
		apache-maven-3.3.9
		
		camunda-modeler
		
		eclipse-jee-neon-3-linux-gtk-x86_64
		
		jdk1.8.0_131
		
		workspace
		
			SO
				chef-repo
				
				docker-config
				
				libs
				
				so
				
				so-config
				
Java
-----
Download the latest Java_8_SE_Development_Kit_ from Oracle.   Select a Linux x64 package.

Unpack it.

.. _Java_8_SE_Development_Kit: http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html

Maven
------

Download the Apache_Maven_3.3.9_ binary.  NOTE: 3.3.9 is the recommended version, even though much higher versions are available.

Unpack it.

.. _Apache_Maven_3.3.9: https://archive.apache.org/dist/maven/maven-3/3.3.9/binaries/

Create an .m2 directory for maven and put settings.xml_ in it.  Edit the local repository path in settings.xml to make it correct for your environment.  Everything else should be OK.

.. _settings.xml: https://wiki.onap.org/download/attachments/15997820/settings.xml?version=1&modificationDate=1506156303000&api=v2

Camunda Modeler
---------------

Download the Camunda_Modeler_.  Select the Linux x64 package.
Unpack it.

.. _Camunda_Modeler: https://camunda.org/download/modeler/

Eclipse
-------

Download Eclipse_for_Linux_.  Select the 64-bit Eclipse IDE for Java EE Developers.  Oxygen seems to be the latest version. These instructions were written for Neon.
Unpack it.

.. _Eclipse_for_Linux:  https://www.eclipse.org/downloads/eclipse-packages/?osType=linux

In the eclipse directory, edit eclipse.ini

	Add (or change) the -vm setting so that it points to your JDK.
	
	Adjust the maximum heap space (2GB is recommended).
	
	Example:
	
.. image:: images/Workspace_and_Development_Tools.png	
	
Eclipse Settings
----------------

**Configure eclipse to use your external maven 3.3.9 installation:**
	Go to Window→Preferences→Maven→Installations
	
	Click "Add" and browse to your apache-maven-3.3.9 directory.  Click "OK" to select it.
	
	Click "Finish"
	
.. image:: images/Workspace_and_Development_Tools_2.png

Make sure the external installation is selected:

.. image:: images/Workspace_and_Development_Tools_3.png

**Configure eclipse to use your settings.xml**
	Go to Window→Preferences→Maven→User Settings
	
	Type the full path to your settings.xml file into the "User Settings" box and click "OK".
	
.. image:: images/Workspace_and_Development_Tools_4.png
.. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. http://creativecommons.org/licenses/by/4.0
.. Copyright 2018 Huawei Technologies Co., Ltd.

serviceInstances API
====================


This API allows to generate some requests to manage:

- serviceInstances (create, delete)
- volumeGroups attached to a vnf instance (create, delete)
- vfModules attached to a vnf instance (create, delete)
- vnfs attached to a service instance (create, delete)
- orchestrationRequests (get)

links:

- :ref:`create_service_instance`
- :ref:`delete_service_instance`
- :ref:`create_volume_group`
- :ref:`delete_volume_group`
- :ref:`create_vf_module`
- :ref:`delete_vf_module`
- :ref:`create_vnf`
- :ref:`delete_vnf`
- :ref:`get_orchestration_request_by_id`
- :ref:`get_orchestration_request_all`


.. _create_service_instance:

Create service instance
+++++++++++++++++++++++

+--------------------+--------------------------------------------------------+
|Interface Definition|Description                                             |
+====================+========================================================+
|URI                 |/onap/so/infra/serviceInstantiation/v7/serviceInstances |
+--------------------+--------------------------------------------------------+
|Operation Type      |POST                                                    |
+--------------------+--------------------------------------------------------+
|Content-Type        |application/json                                        |
+--------------------+--------------------------------------------------------+

Request Body:

+----------------+---------+-----------+--------------------------+-------------------------------------------+
|Attribute       |Qualifier|Cardinality|Content                   |Description                                |
+================+=========+===========+==========================+===========================================+
|requestDetails  |M        |1          |requestDetails Object     |Content of requestDetails object.          |
+----------------+---------+-----------+--------------------------+-------------------------------------------+

RequestDetails Object 

+-------------------+--------------------------+-------------------------------------------------+
|Attribute          |Content                   |Description                                      |
+===================+==========================+=================================================+
|modelInfo          |modelInfo Object          |Content of modelInfo object.                     |
+-------------------+--------------------------+-------------------------------------------------+
|subscriberInfo     |subscriberInfo Object     |Content of subscriberInfo object.                |
+-------------------+--------------------------+-------------------------------------------------+
|requestInfo        |requestInfo Object        |Content of requestInfo object.                   |
+-------------------+--------------------------+-------------------------------------------------+
|requestParameters  |requestParameters Object  |Content of requestParameters object.             |
+-------------------+--------------------------+-------------------------------------------------+
|relatedInstanceList|relatedInstanceList Object|Content of relatedInstanceList object.           |
+-------------------+--------------------------+-------------------------------------------------+
|cloudConfiguration |cloudConfiguration Object |Content of cloudConfiguration object.            |
+-------------------+--------------------------+-------------------------------------------------+
|project            |project Object            |Content of project object.                       |
+-------------------+--------------------------+-------------------------------------------------+
|owningEntity       |owningEntity Object       |Content of owningEntity object.                  |
+-------------------+--------------------------+-------------------------------------------------+
|platform           |platform Object           |Content of platform object.                      |
+-------------------+--------------------------+-------------------------------------------------+
|lineOfBusiness     |lineOfBusiness Object     |Content of lineOfBusiness object.                |
+-------------------+--------------------------+-------------------------------------------------+

ModelInfo Object 

+-------------------------+------------------+-------------------------------------------------+
|Attribute                |Content           |Description                                      |
+=========================+==================+=================================================+
|ModelType                |String            |Type of model                                    |
+-------------------------+------------------+-------------------------------------------------+
|ModelInvariantId         |String            |The Model Invariant Id.                          |
+-------------------------+------------------+-------------------------------------------------+
|ModelNameVersionId       |String            |The modelname Version Id                         |
+-------------------------+------------------+-------------------------------------------------+
|ModelName                |String            |Name of the Model                                |
+-------------------------+------------------+-------------------------------------------------+
|ModelVersion             |String            |Version of the model                             |
+-------------------------+------------------+-------------------------------------------------+
|ModelCustomization Name  |String            |The Model Customization name                     |
+-------------------------+------------------+-------------------------------------------------+
|modelCustomizationUuid   |String            |The Model Customization UUid                     |
+-------------------------+------------------+-------------------------------------------------+
|modelVersionId           |String            |The Model version id                             |
+-------------------------+------------------+-------------------------------------------------+
|modelUuid                |String            |The Model UUid                                   |
+-------------------------+------------------+-------------------------------------------------+
|modelInvariantUuid       |String            |The Model Invariant  UUid                        |
+-------------------------+------------------+-------------------------------------------------+
|modelInstanceName        |String            |The Model Instance  name                         |
+-------------------------+------------------+-------------------------------------------------+


SubscriberInfo Object 

+-------------------------+------------------+-------------------------------------------------+
|Attribute                |Content           |Description                                      |
+=========================+==================+=================================================+
|GlobalSubscriberId       |String            |Global customer Id (in A&AI)                     |
+-------------------------+------------------+-------------------------------------------------+
|SubscriberName           |String            |Name of the Subscriber                           |
+-------------------------+------------------+-------------------------------------------------+

RequestInfo Object 

+-------------------------+------------------+-------------------------------------------------+
|Attribute                |Content           |Description                                      |
+=========================+==================+=================================================+
|Source                   |String            |source of the request                            |
+-------------------------+------------------+-------------------------------------------------+
|billingAccountNumber     |String            |billingAccountNumber of the request              |
+-------------------------+------------------+-------------------------------------------------+
|callbackUrl              |String            |callbackUrl of the request                       |
+-------------------------+------------------+-------------------------------------------------+
|correlator               |String            |correlator of the request                        |
+-------------------------+------------------+-------------------------------------------------+
|orderNumber              |String            |orderNumber of the request                       |
+-------------------------+------------------+-------------------------------------------------+
|productFamilyId          |String            |productFamilyId of the request                   |
+-------------------------+------------------+-------------------------------------------------+
|orderVersion             |String            |orderVersion of the request                      |
+-------------------------+------------------+-------------------------------------------------+
|instanceName             |String            |instanceName of the request                      |
+-------------------------+------------------+-------------------------------------------------+
|suppressRollback         |String            |suppressRollback of the request                  |
+-------------------------+------------------+-------------------------------------------------+
|requestorId              |String            |requestorId of the request                       |
+-------------------------+------------------+-------------------------------------------------+

RequestParameters Object 

+-------------------------+------------------+-------------------------------------------------+
|Attribute                |Content           |Description                                      |
+=========================+==================+=================================================+
|SubscriptionServiceType  |String            |The service type of the Subscription             |
+-------------------------+------------------+-------------------------------------------------+
|UserParams               |Array             |The product family Id.                           |
+-------------------------+------------------+-------------------------------------------------+
|aLaCarte                 |Boolean           | aLaCarte                                        |
+-------------------------+------------------+-------------------------------------------------+
|autoBuildVfModules       |Boolean           |autoBuildVfModules                               |
+-------------------------+------------------+-------------------------------------------------+
|cascadeDelete            |Boolean           |cascadeDelete                                    |
+-------------------------+------------------+-------------------------------------------------+
|usePreload               |Boolean           |usePreload                                       |
+-------------------------+------------------+-------------------------------------------------+
|rebuildVolumeGroups      |Boolean           |rebuildVolumeGroups                              |
+-------------------------+------------------+-------------------------------------------------+
|payload                  |String            |payload                                          |
+-------------------------+------------------+-------------------------------------------------+
|controllerType           |String            |controllerType                                   |
+-------------------------+------------------+-------------------------------------------------+

UserParams Object 

+-------------------------+------------------+-------------------------------------------------+
|Attribute                |Content           |Description                                      |
+=========================+==================+=================================================+
|name                     |String            |Tag name of attribute                            |
+-------------------------+------------------+-------------------------------------------------+
|value                    |String            |Value of the tag                                 |
+-------------------------+------------------+-------------------------------------------------+

CloudConfiguration Object 

+-------------------------+------------------+-------------------------------------------------+
|Attribute                |Content           |Description                                      |
+=========================+==================+=================================================+
|lcpCloudRegionId         |String            |CloudRegion Id (in A&AI)                         |
+-------------------------+------------------+-------------------------------------------------+
|tenantId                 |String            |Name of the Subscriber                           |
+-------------------------+------------------+-------------------------------------------------+
|aicNodeClli              |String            |aicNodeClli property                             |
+-------------------------+------------------+-------------------------------------------------+

Project Object

+-------------------------+------------------+-------------------------------------------------+
|Attribute                |Content           |Description                                      |
+=========================+==================+=================================================+
|projectName              |String            |Name of the project                              |
+-------------------------+------------------+-------------------------------------------------+

OwningEntity Object

+-------------------------+------------------+-------------------------------------------------+
|Attribute                |Content           |Description                                      |
+=========================+==================+=================================================+
|owningEntityId           |String            |owningEntityId of the owingEntity                |
+-------------------------+------------------+-------------------------------------------------+
|owningEntityName         |String            |owningEntityName of the owingEntity              |
+-------------------------+------------------+-------------------------------------------------+

Platform Object

+-------------------------+------------------+-------------------------------------------------+
|Attribute                |Content           |Description                                      |
+=========================+==================+=================================================+
|platformName             |String            |Platform Name                                    |
+-------------------------+------------------+-------------------------------------------------+

LineOfBusiness Object

+-------------------------+------------------+-------------------------------------------------+
|Attribute                |Content           |Description                                      |
+=========================+==================+=================================================+
|lineOfBusinessName       |String            |Line Of Business Name                            |
+-------------------------+------------------+-------------------------------------------------+


.. _delete_service_instance:

Delete service instance
+++++++++++++++++++++++

+--------------------+--------------------------------------------------------------------------------+
|Interface Definition|Description                                                                     |
+====================+================================================================================+
|URI                 |/onap/so/infra/serviceInstantiation/v7/serviceInstances/{serviceInstanceId}     |
+--------------------+--------------------------------------------------------------------------------+
|Operation Type      |DELETE                                                                          |
+--------------------+--------------------------------------------------------------------------------+
|Content-Type        |application/json                                                                |
+--------------------+--------------------------------------------------------------------------------+

Request Body:

+----------------+---------+-----------+--------------------------+-------------------------------------------+
|Attribute       |Qualifier|Cardinality|Content                   |Description                                |
+================+=========+===========+==========================+===========================================+
|requestDetails  |M        |1          |requestDetails Object     |Content of requestDetails object.          |
+----------------+---------+-----------+--------------------------+-------------------------------------------+

RequestDetails Object 

+-------------------+-------------------------+-------------------------------------------------+
|Attribute          |Content                  |Description                                      |
+===================+=========================+=================================================+
|modelInfo          |modelInfo Object         |Content of modelInfo object.                     |
+-------------------+-------------------------+-------------------------------------------------+
|requestInfo        |requestInfo Object       |Content of requestInfo object.                   |
+-------------------+-------------------------+-------------------------------------------------+

ModelInfo Object 

+-------------------------+------------------+-------------------------------------------------+
|Attribute                |Content           |Description                                      |
+=========================+==================+=================================================+
|ModelType                |String            |Type of model                                    |
+-------------------------+------------------+-------------------------------------------------+
|ModelInvariantId         |String            |The Model Invariant Id.                          |
+-------------------------+------------------+-------------------------------------------------+
|ModelName                |String            |Name of the Model                                |
+-------------------------+------------------+-------------------------------------------------+
|ModelVersion             |String            |Version of the model                             |
+-------------------------+------------------+-------------------------------------------------+

RequestInfo Object 

+-------------------------+------------------+-------------------------------------------------+
|Attribute                |Content           |Description                                      |
+=========================+==================+=================================================+
|Source                   |String            |source of the request                            |
+-------------------------+------------------+-------------------------------------------------+


.. _create_volume_group:

Create Volume Group
+++++++++++++++++++

+--------------------+------------------------------------------------------------------------------------------------------------------+
|Interface Definition|Description                                                                                                       |
+====================+==================================================================================================================+
|URI                 |/onap/so/infra/serviceInstantiation/v7/serviceInstances/{serviceInstanceId}/vnfs/{vnfInstanceId}/volumeGroups     |
+--------------------+------------------------------------------------------------------------------------------------------------------+
|Operation Type      |POST                                                                                                              |
+--------------------+------------------------------------------------------------------------------------------------------------------+
|Content-Type        |application/json                                                                                                  |
+--------------------+------------------------------------------------------------------------------------------------------------------+

Request Body:

+----------------+---------+-----------+--------------------------+-------------------------------------------+
|Attribute       |Qualifier|Cardinality|Content                   |Description                                |
+================+=========+===========+==========================+===========================================+
|requestDetails  |M        |1          |requestDetails Object     |Content of requestDetails object.          |
+----------------+---------+-----------+--------------------------+-------------------------------------------+

RequestDetails Object 

+-------------------+--------------------------+-------------------------------------------------+
|Attribute          |Content                   |Description                                      |
+===================+==========================+=================================================+
|modelInfo          |modelInfo Object          |Content of modelInfo object.                     |
+-------------------+--------------------------+-------------------------------------------------+
|subscriberInfo     |subscriberInfo Object     |Content of subscriberInfo object.                |
+-------------------+--------------------------+-------------------------------------------------+
|requestInfo        |requestInfo Object        |Content of requestInfo object.                   |
+-------------------+--------------------------+-------------------------------------------------+
|requestParameters  |requestParameters Object  |Content of requestParameters object.             |
+-------------------+--------------------------+-------------------------------------------------+
|relatedInstanceList|relatedInstanceList Object|Content of relatedInstanceList object.           |
+-------------------+--------------------------+-------------------------------------------------+
|cloudConfiguration |cloudConfiguration Object |Content of cloudConfiguration object.            |
+-------------------+--------------------------+-------------------------------------------------+
|project            |project Object            |Content of project object.                       |
+-------------------+--------------------------+-------------------------------------------------+
|owningEntity       |owningEntity Object       |Content of owningEntity object.                  |
+-------------------+--------------------------+-------------------------------------------------+
|platform           |platform Object           |Content of platform object.                      |
+-------------------+--------------------------+-------------------------------------------------+
|lineOfBusiness     |lineOfBusiness Object     |Content of lineOfBusiness object.                |
+-------------------+--------------------------+-------------------------------------------------+

ModelInfo Object 

+-------------------------+------------------+-------------------------------------------------+
|Attribute                |Content           |Description                                      |
+=========================+==================+=================================================+
|ModelType                |String            |Type of model                                    |
+-------------------------+------------------+-------------------------------------------------+
|ModelInvariantId         |String            |The Model Invariant Id.                          |
+-------------------------+------------------+-------------------------------------------------+
|ModelNameVersionId       |String            |The modelname Version Id                         |
+-------------------------+------------------+-------------------------------------------------+
|ModelName                |String            |Name of the Model                                |
+-------------------------+------------------+-------------------------------------------------+
|ModelVersion             |String            |Version of the model                             |
+-------------------------+------------------+-------------------------------------------------+
|ModelCustomization Name  |String            |The Model Customization name                     |
+-------------------------+------------------+-------------------------------------------------+
|modelCustomizationUuid   |String            |The Model Customization UUid                     |
+-------------------------+------------------+-------------------------------------------------+
|modelVersionId           |String            |The Model version id                             |
+-------------------------+------------------+-------------------------------------------------+
|modelUuid                |String            |The Model UUid                                   |
+-------------------------+------------------+-------------------------------------------------+
|modelInvariantUuid       |String            |The Model Invariant  UUid                        |
+-------------------------+------------------+-------------------------------------------------+
|modelInstanceName        |String            |The Model Instance  name                         |
+-------------------------+------------------+-------------------------------------------------+

CloudConfiguration Object 

+-------------------------+------------------+-------------------------------------------------+
|Attribute                |Content           |Description                                      |
+=========================+==================+=================================================+
|lcpCloudRegionId         |String            |CloudRegion Id (in A&AI)                         |
+-------------------------+------------------+-------------------------------------------------+
|tenantId                 |String            |Name of the Subscriber                           |
+-------------------------+------------------+-------------------------------------------------+
|aicNodeClli              |String            |aicNodeClli property                             |
+-------------------------+------------------+-------------------------------------------------+

RequestInfo Object 

+-------------------------+------------------+-------------------------------------------------+
|Attribute                |Content           |Description                                      |
+=========================+==================+=================================================+
|Source                   |String            |source of the request                            |
+-------------------------+------------------+-------------------------------------------------+
|billingAccountNumber     |String            |billingAccountNumber of the request              |
+-------------------------+------------------+-------------------------------------------------+
|callbackUrl              |String            |callbackUrl of the request                       |
+-------------------------+------------------+-------------------------------------------------+
|correlator               |String            |correlator of the request                        |
+-------------------------+------------------+-------------------------------------------------+
|orderNumber              |String            |orderNumber of the request                       |
+-------------------------+------------------+-------------------------------------------------+
|productFamilyId          |String            |productFamilyId of the request                   |
+-------------------------+------------------+-------------------------------------------------+
|orderVersion             |String            |orderVersion of the request                      |
+-------------------------+------------------+-------------------------------------------------+
|instanceName             |String            |instanceName of the request                      |
+-------------------------+------------------+-------------------------------------------------+
|suppressRollback         |String            |suppressRollback of the request                  |
+-------------------------+------------------+-------------------------------------------------+
|requestorId              |String            |requestorId of the request                       |
+-------------------------+------------------+-------------------------------------------------+

relatedInstance List  

+-------------------------+------------------+-------------------------------------------------+
|Attribute                |Content           |Description                                      |
+=========================+==================+=================================================+
|relatedInstance          |Object            |relatedInstance Object                           |
+-------------------------+------------------+-------------------------------------------------+

relatedInstance List  

+-------------------------+------------------+-------------------------------------------------+
|Attribute                |Content           |Description                                      |
+=========================+==================+=================================================+
|instanceId               |String            |instanceId                                       |
+-------------------------+------------------+-------------------------------------------------+
|modelInfo                |Object            |Content of modelInfo object.                     |
+-------------------------+------------------+-------------------------------------------------+

.. _delete_volume_group:

Delete Volume Group
+++++++++++++++++++

+--------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
|Interface Definition|Description                                                                                                                                 |
+====================+============================================================================================================================================+
|URI                 |/onap/so/infra/serviceInstantiation/v7/serviceInstances/{serviceInstanceId}/vnfs/{vnfInstanceId}/volumeGroups/{volume-groupinstance-id}     |
+--------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
|Operation Type      |DELETE                                                                                                                                      |
+--------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
|Content-Type        |application/json                                                                                                                            |
+--------------------+--------------------------------------------------------------------------------------------------------------------------------------------+

Request Body:

+----------------+---------+-----------+--------------------------+-------------------------------------------+
|Attribute       |Qualifier|Cardinality|Content                   |Description                                |
+================+=========+===========+==========================+===========================================+
|requestDetails  |M        |1          |requestDetails Object     |Content of requestDetails object.          |
+----------------+---------+-----------+--------------------------+-------------------------------------------+

RequestDetails Object 

+---------------------+-------------------------+-------------------------------------------------+
|Attribute            |Content                  |Description                                      |
+=====================+=========================+=================================================+
|modelInfo            |modelInfo Object         |Content of modelInfo object.                     |
+---------------------+-------------------------+-------------------------------------------------+
|cloudConfiguration   |cloudConfiguration Object|Content of cloudConfiguration object.            |
+---------------------+-------------------------+-------------------------------------------------+
|requestInfo          |requestInfo Object       |Content of requestInfo object.                   |
+---------------------+-------------------------+-------------------------------------------------+

ModelInfo Object 

+-------------------------+------------------+-------------------------------------------------+
|Attribute                |Content           |Description                                      |
+=========================+==================+=================================================+
|ModelType                |String            |Type of model                                    |
+-------------------------+------------------+-------------------------------------------------+
|ModelName                |String            |Name of the Model                                |
+-------------------------+------------------+-------------------------------------------------+

CloudConfiguration Object 

+-------------------------+------------------+-------------------------------------------------+
|Attribute                |Content           |Description                                      |
+=========================+==================+=================================================+
|lcpCloudRegionId         |String            |CloudRegion Id (in A&AI)                         |
+-------------------------+------------------+-------------------------------------------------+
|tenantId                 |String            |Name of the Subscriber                           |
+-------------------------+------------------+-------------------------------------------------+

RequestInfo Object 

+-------------------------+------------------+-------------------------------------------------+
|Attribute                |Content           |Description                                      |
+=========================+==================+=================================================+
|Source                   |String            |source of the request                            |
+-------------------------+------------------+-------------------------------------------------+

.. _create_vf_module:

Create VF Module
++++++++++++++++

+--------------------+---------------------------------------------------------------------------------------------------------------+
|Interface Definition|Description                                                                                                    |
+====================+===============================================================================================================+
|URI                 |/onap/so/infra/serviceInstantiation/v7/serviceInstances/{serviceInstanceId}/vnfs/{vnfInstanceId}/vfModules     |
+--------------------+---------------------------------------------------------------------------------------------------------------+
|Operation Type      |POST                                                                                                           |
+--------------------+---------------------------------------------------------------------------------------------------------------+
|Content-Type        |application/json                                                                                               |
+--------------------+---------------------------------------------------------------------------------------------------------------+

Request Body:

+----------------+---------+-----------+--------------------------+-------------------------------------------+
|Attribute       |Qualifier|Cardinality|Content                   |Description                                |
+================+=========+===========+==========================+===========================================+
|requestDetails  |M        |1          |requestDetails Object     |Content of requestDetails object.          |
+----------------+---------+-----------+--------------------------+-------------------------------------------+

RequestDetails Object 

+---------------------+-------------------------+-------------------------------------------------+
|Attribute            |Content                  |Description                                      |
+=====================+=========================+=================================================+
|modelInfo            |modelInfo Object         |Content of modelInfo object.                     |
+---------------------+-------------------------+-------------------------------------------------+
|cloudConfiguration   |cloudConfiguration Object|Content of cloudConfiguration object.            |
+---------------------+-------------------------+-------------------------------------------------+
|requestInfo          |requestInfo Object       |Content of requestInfo object.                   |
+---------------------+-------------------------+-------------------------------------------------+
|relatedInstanceList  |List                     |Content of relatedInstanceList.                  |
+---------------------+-------------------------+-------------------------------------------------+

ModelInfo Object 

+-------------------------+------------------+-------------------------------------------------+
|Attribute                |Content           |Description                                      |
+=========================+==================+=================================================+
|ModelType                |String            |Type of model                                    |
+-------------------------+------------------+-------------------------------------------------+
|ModelInvariantId         |String            |The Model Invariant Id.                          |
+-------------------------+------------------+-------------------------------------------------+
|ModelNameVersionId       |String            |The modelname Version Id                         |
+-------------------------+------------------+-------------------------------------------------+
|ModelName                |String            |Name of the Model                                |
+-------------------------+------------------+-------------------------------------------------+
|ModelVersion             |String            |Version of the model                             |
+-------------------------+------------------+-------------------------------------------------+
|ModelCustomization Name  |String            |The Model Customization name                     |
+-------------------------+------------------+-------------------------------------------------+

CloudConfiguration Object 

+-------------------------+------------------+-------------------------------------------------+
|Attribute                |Content           |Description                                      |
+=========================+==================+=================================================+
|lcpCloudRegionId         |String            |CloudRegion Id (in A&AI)                         |
+-------------------------+------------------+-------------------------------------------------+
|tenantId                 |String            |Name of the Subscriber                           |
+-------------------------+------------------+-------------------------------------------------+

RequestInfo Object 

+-------------------------+------------------+-------------------------------------------------+
|Attribute                |Content           |Description                                      |
+=========================+==================+=================================================+
|InstanceName             |String            |The instance Name                                |
+-------------------------+------------------+-------------------------------------------------+
|Source                   |String            |source of the request                            |
+-------------------------+------------------+-------------------------------------------------+
|SuppressRollback         |Boolean           |SuppressRollback                                 |
+-------------------------+------------------+-------------------------------------------------+

relatedInstance List  

+-------------------------+------------------+-------------------------------------------------+
|Attribute                |Content           |Description                                      |
+=========================+==================+=================================================+
|relatedInstance          |Object            |relatedInstance Object                           |
+-------------------------+------------------+-------------------------------------------------+

relatedInstance List  

+-------------------------+------------------+-------------------------------------------------+
|Attribute                |Content           |Description                                      |
+=========================+==================+=================================================+
|instanceId               |String            |instanceId                                       |
+-------------------------+------------------+-------------------------------------------------+
|modelInfo                |Object            |Content of modelInfo object.                     |
+-------------------------+------------------+-------------------------------------------------+
|instanceName             |String            |Name of the instance                             |
+-------------------------+------------------+-------------------------------------------------+

.. _delete_vf_module:

Delete VF Module
++++++++++++++++

+--------------------+-------------------------------------------------------------------------------------------------------------------------------------+
|Interface Definition|Description                                                                                                                          |
+====================+=====================================================================================================================================+
|URI                 |/onap/so/infra/serviceInstantiation/v7/serviceInstances/{serviceInstanceId}/vnfs/{vnfInstanceId}/vfModules/{vfmoduleinstance-id}     |
+--------------------+-------------------------------------------------------------------------------------------------------------------------------------+
|Operation Type      |DELETE                                                                                                                               |
+--------------------+-------------------------------------------------------------------------------------------------------------------------------------+
|Content-Type        |application/json                                                                                                                     |
+--------------------+-------------------------------------------------------------------------------------------------------------------------------------+

Request Body:

+----------------+---------+-----------+--------------------------+-------------------------------------------+
|Attribute       |Qualifier|Cardinality|Content                   |Description                                |
+================+=========+===========+==========================+===========================================+
|requestDetails  |M        |1          |requestDetails Object     |Content of requestDetails object.          |
+----------------+---------+-----------+--------------------------+-------------------------------------------+

RequestDetails Object 

+---------------------+-------------------------+-------------------------------------------------+
|Attribute            |Content                  |Description                                      |
+=====================+=========================+=================================================+
|modelInfo            |modelInfo Object         |Content of modelInfo object.                     |
+---------------------+-------------------------+-------------------------------------------------+
|cloudConfiguration   |cloudConfiguration Object|Content of cloudConfiguration object.            |
+---------------------+-------------------------+-------------------------------------------------+
|requestInfo          |requestInfo Object       |Content of requestInfo object.                   |
+---------------------+-------------------------+-------------------------------------------------+

ModelInfo Object 

+-------------------------+------------------+-------------------------------------------------+
|Attribute                |Content           |Description                                      |
+=========================+==================+=================================================+
|ModelType                |String            |Type of model                                    |
+-------------------------+------------------+-------------------------------------------------+
|ModelInvariantId         |String            |The Model Invariant Id.                          |
+-------------------------+------------------+-------------------------------------------------+
|ModelNameVersionId       |String            |The modelname Version Id                         |
+-------------------------+------------------+-------------------------------------------------+
|ModelName                |String            |Name of the Model                                |
+-------------------------+------------------+-------------------------------------------------+
|ModelVersion             |String            |Version of the model                             |
+-------------------------+------------------+-------------------------------------------------+
|ModelCustomization Name  |String            |The Model Customization name                     |
+-------------------------+------------------+-------------------------------------------------+

CloudConfiguration Object 

+-------------------------+------------------+-------------------------------------------------+
|Attribute                |Content           |Description                                      |
+=========================+==================+=================================================+
|lcpCloudRegionId         |String            |CloudRegion Id (in A&AI)                         |
+-------------------------+------------------+-------------------------------------------------+
|tenantId                 |String            |Name of the Subscriber                           |
+-------------------------+------------------+-------------------------------------------------+

RequestInfo Object 

+-------------------------+------------------+-------------------------------------------------+
|Attribute                |Content           |Description                                      |
+=========================+==================+=================================================+
|Source                   |String            |source of the request                            |
+-------------------------+------------------+-------------------------------------------------+


.. _create_vnf:

Create VNF
++++++++++

+--------------------+-------------------------------------------------------------------------------------+
|Interface Definition|Description                                                                          |
+====================+=====================================================================================+
|URI                 |/onap/so/infra/serviceInstantiation/v7/serviceInstances/{serviceInstanceId}/vnfs     |
+--------------------+-------------------------------------------------------------------------------------+
|Operation Type      |POST                                                                                 |
+--------------------+-------------------------------------------------------------------------------------+
|Content-Type        |application/json                                                                     |
+--------------------+-------------------------------------------------------------------------------------+

Request Body:

+----------------+---------+-----------+--------------------------+-------------------------------------------+
|Attribute       |Qualifier|Cardinality|Content                   |Description                                |
+================+=========+===========+==========================+===========================================+
|requestDetails  |M        |1          |requestDetails Object     |Content of requestDetails object.          |
+----------------+---------+-----------+--------------------------+-------------------------------------------+

RequestDetails Object 

+-------------------+--------------------------+-------------------------------------------------+
|Attribute          |Content                   |Description                                      |
+===================+==========================+=================================================+
|modelInfo          |modelInfo Object          |Content of modelInfo object.                     |
+-------------------+--------------------------+-------------------------------------------------+
|subscriberInfo     |subscriberInfo Object     |Content of subscriberInfo object.                |
+-------------------+--------------------------+-------------------------------------------------+
|requestInfo        |requestInfo Object        |Content of requestInfo object.                   |
+-------------------+--------------------------+-------------------------------------------------+
|requestParameters  |requestParameters Object  |Content of requestParameters object.             |
+-------------------+--------------------------+-------------------------------------------------+
|relatedInstanceList|relatedInstanceList Object|Content of relatedInstanceList object.           |
+-------------------+--------------------------+-------------------------------------------------+
|cloudConfiguration |cloudConfiguration Object |Content of cloudConfiguration object.            |
+-------------------+--------------------------+-------------------------------------------------+
|project            |project Object            |Content of project object.                       |
+-------------------+--------------------------+-------------------------------------------------+
|owningEntity       |owningEntity Object       |Content of owningEntity object.                  |
+-------------------+--------------------------+-------------------------------------------------+
|platform           |platform Object           |Content of platform object.                      |
+-------------------+--------------------------+-------------------------------------------------+
|lineOfBusiness     |lineOfBusiness Object     |Content of lineOfBusiness object.                |
+-------------------+--------------------------+-------------------------------------------------+

ModelInfo Object 

+-------------------------+------------------+-------------------------------------------------+
|Attribute                |Content           |Description                                      |
+=========================+==================+=================================================+
|ModelType                |String            |Type of model                                    |
+-------------------------+------------------+-------------------------------------------------+
|ModelInvariantId         |String            |The Model Invariant Id.                          |
+-------------------------+------------------+-------------------------------------------------+
|ModelNameVersionId       |String            |The modelname Version Id                         |
+-------------------------+------------------+-------------------------------------------------+
|ModelName                |String            |Name of the Model                                |
+-------------------------+------------------+-------------------------------------------------+
|ModelVersion             |String            |Version of the model                             |
+-------------------------+------------------+-------------------------------------------------+
|ModelCustomization Name  |String            |The Model Customization name                     |
+-------------------------+------------------+-------------------------------------------------+
|modelCustomizationUuid   |String            |The Model Customization UUid                     |
+-------------------------+------------------+-------------------------------------------------+
|modelVersionId           |String            |The Model version id                             |
+-------------------------+------------------+-------------------------------------------------+
|modelUuid                |String            |The Model UUid                                   |
+-------------------------+------------------+-------------------------------------------------+
|modelInvariantUuid       |String            |The Model Invariant  UUid                        |
+-------------------------+------------------+-------------------------------------------------+
|modelInstanceName        |String            |The Model Instance  name                         |
+-------------------------+------------------+-------------------------------------------------+

CloudConfiguration Object 

+-------------------------+------------------+-------------------------------------------------+
|Attribute                |Content           |Description                                      |
+=========================+==================+=================================================+
|lcpCloudRegionId         |String            |CloudRegion Id (in A&AI)                         |
+-------------------------+------------------+-------------------------------------------------+
|tenantId                 |String            |Name of the Subscriber                           |
+-------------------------+------------------+-------------------------------------------------+

RequestInfo Object 

+-------------------------+------------------+-------------------------------------------------+
|Attribute                |Content           |Description                                      |
+=========================+==================+=================================================+
|Source                   |String            |source of the request                            |
+-------------------------+------------------+-------------------------------------------------+
|billingAccountNumber     |String            |billingAccountNumber of the request              |
+-------------------------+------------------+-------------------------------------------------+
|callbackUrl              |String            |callbackUrl of the request                       |
+-------------------------+------------------+-------------------------------------------------+
|correlator               |String            |correlator of the request                        |
+-------------------------+------------------+-------------------------------------------------+
|orderNumber              |String            |orderNumber of the request                       |
+-------------------------+------------------+-------------------------------------------------+
|productFamilyId          |String            |productFamilyId of the request                   |
+-------------------------+------------------+-------------------------------------------------+
|orderVersion             |String            |orderVersion of the request                      |
+-------------------------+------------------+-------------------------------------------------+
|instanceName             |String            |instanceName of the request                      |
+-------------------------+------------------+-------------------------------------------------+
|suppressRollback         |String            |suppressRollback of the request                  |
+-------------------------+------------------+-------------------------------------------------+
|requestorId              |String            |requestorId of the request                       |
+-------------------------+------------------+-------------------------------------------------+

relatedInstance List  

+-------------------------+------------------+-------------------------------------------------+
|Attribute                |Content           |Description                                      |
+=========================+==================+=================================================+
|relatedInstance          |Object            |relatedInstance Object                           |
+-------------------------+------------------+-------------------------------------------------+

relatedInstance List  

+-------------------------+------------------+-------------------------------------------------+
|Attribute                |Content           |Description                                      |
+=========================+==================+=================================================+
|instanceId               |String            |instanceId                                       |
+-------------------------+------------------+-------------------------------------------------+
|modelInfo                |Object            |Content of modelInfo object.                     |
+-------------------------+------------------+-------------------------------------------------+

RequestParameters Object 

+-------------------------+------------------+-------------------------------------------------+
|Attribute                |Content           |Description                                      |
+=========================+==================+=================================================+
|UserParams               |Array             |The product family Id.                           |
+-------------------------+------------------+-------------------------------------------------+

UserParams Object 

+-------------------------+------------------+-------------------------------------------------+
|Attribute                |Content           |Description                                      |
+=========================+==================+=================================================+
|name                     |String            |Tag name of attribute                            |
+-------------------------+------------------+-------------------------------------------------+
|value                    |String            |Value of the tag                                 |
+-------------------------+------------------+-------------------------------------------------+

.. _delete_vnf:

Delete VNF
++++++++++

+--------------------+-----------------------------------------------------------------------------------------------------+
|Interface Definition|Description                                                                                          |
+====================+=====================================================================================================+
|URI                 |/onap/so/infra/serviceInstantiation/v7/serviceInstances/{serviceInstanceId}/vnfs/{vnfInstanceId}     |
+--------------------+-----------------------------------------------------------------------------------------------------+
|Operation Type      |DELETE                                                                                               |
+--------------------+-----------------------------------------------------------------------------------------------------+
|Content-Type        |application/json                                                                                     |
+--------------------+-----------------------------------------------------------------------------------------------------+

Request Body:

+----------------+---------+-----------+--------------------------+-------------------------------------------+
|Attribute       |Qualifier|Cardinality|Content                   |Description                                |
+================+=========+===========+==========================+===========================================+
|requestDetails  |M        |1          |requestDetails Object     |Content of requestDetails object.          |
+----------------+---------+-----------+--------------------------+-------------------------------------------+

RequestDetails Object 

+---------------------+-------------------------+-------------------------------------------------+
|Attribute            |Content                  |Description                                      |
+=====================+=========================+=================================================+
|modelInfo            |modelInfo Object         |Content of modelInfo object.                     |
+---------------------+-------------------------+-------------------------------------------------+
|cloudConfiguration   |cloudConfiguration Object|Content of cloudConfiguration object.            |
+---------------------+-------------------------+-------------------------------------------------+
|requestInfo          |requestInfo Object       |Content of requestInfo object.                   |
+---------------------+-------------------------+-------------------------------------------------+
|requestParameters    |requestParameters Object |Content of requestParameters object.             |
+---------------------+-------------------------+-------------------------------------------------+

ModelInfo Object 

+-------------------------+------------------+-------------------------------------------------+
|Attribute                |Content           |Description                                      |
+=========================+==================+=================================================+
|ModelType                |String            |Type of model                                    |
+-------------------------+------------------+-------------------------------------------------+
|ModelName                |String            |Name of the Model                                |
+-------------------------+------------------+-------------------------------------------------+

CloudConfiguration Object 

+-------------------------+------------------+-------------------------------------------------+
|Attribute                |Content           |Description                                      |
+=========================+==================+=================================================+
|lcpCloudRegionId         |String            |CloudRegion Id (in A&AI)                         |
+-------------------------+------------------+-------------------------------------------------+
|tenantId                 |String            |Name of the Subscriber                           |
+-------------------------+------------------+-------------------------------------------------+

RequestInfo Object 

+-------------------------+------------------+-------------------------------------------------+
|Attribute                |Content           |Description                                      |
+=========================+==================+=================================================+
|Source                   |String            |source of the request                            |
+-------------------------+------------------+-------------------------------------------------+

RequestParameters Object 

+-------------------------+------------------+-------------------------------------------------+
|Attribute                |Content           |Description                                      |
+=========================+==================+=================================================+
|UserParams               |Array             |The product family Id.                           |
+-------------------------+------------------+-------------------------------------------------+

UserParams Object 

+-------------------------+------------------+-------------------------------------------------+
|Attribute                |Content           |Description                                      |
+=========================+==================+=================================================+
|name                     |String            |Tag name of attribute                            |
+-------------------------+------------------+-------------------------------------------------+
|value                    |String            |Value of the tag                                 |
+-------------------------+------------------+-------------------------------------------------+

.. _get_orchestration_request_by_id:

GET Orchestration Request
+++++++++++++++++++++++++

+--------------------+-------------------------------------------------------------------------------------+
|Interface Definition|Description                                                                          |
+====================+=====================================================================================+
|URI                 |/onap/so/infra/orchestrationRequests/v7/{request-id}                                 |
+--------------------+-------------------------------------------------------------------------------------+
|Operation Type      |GET                                                                                  |
+--------------------+-------------------------------------------------------------------------------------+
|Content-Type        |application/json                                                                     |
+--------------------+-------------------------------------------------------------------------------------+

Response Body:

+----------------+---------+-----------+--------------------------+-------------------------------------------+
|Attribute       |Qualifier|Cardinality|Content                   |Description                                |
+================+=========+===========+==========================+===========================================+
|request         |M        |1          |request Object            |Content of request object.                 |
+----------------+---------+-----------+--------------------------+-------------------------------------------+

Request Object

+-------------------+---------+-----------+--------------------------+-------------------------------------------+
|Attribute          |Qualifier|Cardinality|Content                   |Description                                |
+===================+=========+===========+==========================+===========================================+
|requestId          |M        |1          |String                    |Request Id                                 |
+-------------------+---------+-----------+--------------------------+-------------------------------------------+
|startTime          |M        |1          |request Object            |Start time.                                |
+-------------------+---------+-----------+--------------------------+-------------------------------------------+
|requestScope       |M        |1          |request Object            |Scope of the request.                      |
+-------------------+---------+-----------+--------------------------+-------------------------------------------+
|requestType        |M        |1          |request Object            |Type of the request.                       |
+-------------------+---------+-----------+--------------------------+-------------------------------------------+
|requestDetails     |M        |1          |requestDetails Object     |Type of the request.                       |
+-------------------+---------+-----------+--------------------------+-------------------------------------------+
|requestStatus      |M        |1          |requestStatus Object      |Type of the request.                       |
+-------------------+---------+-----------+--------------------------+-------------------------------------------+

RequestDetails Object 

+-------------------+--------------------------+-------------------------------------------------+
|Attribute          |Content                   |Description                                      |
+===================+==========================+=================================================+
|modelInfo          |modelInfo Object          |Content of modelInfo object.                     |
+-------------------+--------------------------+-------------------------------------------------+
|subscriberInfo     |subscriberInfo Object     |Content of subscriberInfo object.                |
+-------------------+--------------------------+-------------------------------------------------+
|requestInfo        |requestInfo Object        |Content of requestInfo object.                   |
+-------------------+--------------------------+-------------------------------------------------+
|requestParameters  |requestParameters Object  |Content of requestParameters object.             |
+-------------------+--------------------------+-------------------------------------------------+
|relatedInstanceList|relatedInstanceList Object|Content of relatedInstanceList object.           |
+-------------------+--------------------------+-------------------------------------------------+
|cloudConfiguration |cloudConfiguration Object |Content of cloudConfiguration object.            |
+-------------------+--------------------------+-------------------------------------------------+
|project            |project Object            |Content of project object.                       |
+-------------------+--------------------------+-------------------------------------------------+
|owningEntity       |owningEntity Object       |Content of owningEntity object.                  |
+-------------------+--------------------------+-------------------------------------------------+
|platform           |platform Object           |Content of platform object.                      |
+-------------------+--------------------------+-------------------------------------------------+
|lineOfBusiness     |lineOfBusiness Object     |Content of lineOfBusiness object.                |
+-------------------+--------------------------+-------------------------------------------------+

ModelInfo Object 

+-------------------------+------------------+-------------------------------------------------+
|Attribute                |Content           |Description                                      |
+=========================+==================+=================================================+
|ModelType                |String            |Type of model                                    |
+-------------------------+------------------+-------------------------------------------------+
|ModelInvariantId         |String            |The Model Invariant Id.                          |
+-------------------------+------------------+-------------------------------------------------+
|ModelNameVersionId       |String            |The modelname Version Id                         |
+-------------------------+------------------+-------------------------------------------------+
|ModelName                |String            |Name of the Model                                |
+-------------------------+------------------+-------------------------------------------------+
|ModelVersion             |String            |Version of the model                             |
+-------------------------+------------------+-------------------------------------------------+
|ModelCustomization Name  |String            |The Model Customization name                     |
+-------------------------+------------------+-------------------------------------------------+
|modelCustomizationUuid   |String            |The Model Customization UUid                     |
+-------------------------+------------------+-------------------------------------------------+
|modelVersionId           |String            |The Model version id                             |
+-------------------------+------------------+-------------------------------------------------+
|modelUuid                |String            |The Model UUid                                   |
+-------------------------+------------------+-------------------------------------------------+
|modelInvariantUuid       |String            |The Model Invariant  UUid                        |
+-------------------------+------------------+-------------------------------------------------+
|modelInstanceName        |String            |The Model Instance  name                         |
+-------------------------+------------------+-------------------------------------------------+

SubscriberInfo Object 

+-------------------------+------------------+-------------------------------------------------+
|Attribute                |Content           |Description                                      |
+=========================+==================+=================================================+
|GlobalSubscriberId       |String            |Global customer Id (in A&AI)                     |
+-------------------------+------------------+-------------------------------------------------+
|SubscriberName           |String            |Name of the Subscriber                           |
+-------------------------+------------------+-------------------------------------------------+

RequestInfo Object 

+-------------------------+------------------+-------------------------------------------------+
|Attribute                |Content           |Description                                      |
+=========================+==================+=================================================+
|Source                   |String            |source of the request                            |
+-------------------------+------------------+-------------------------------------------------+
|billingAccountNumber     |String            |billingAccountNumber of the request              |
+-------------------------+------------------+-------------------------------------------------+
|callbackUrl              |String            |callbackUrl of the request                       |
+-------------------------+------------------+-------------------------------------------------+
|correlator               |String            |correlator of the request                        |
+-------------------------+------------------+-------------------------------------------------+
|orderNumber              |String            |orderNumber of the request                       |
+-------------------------+------------------+-------------------------------------------------+
|productFamilyId          |String            |productFamilyId of the request                   |
+-------------------------+------------------+-------------------------------------------------+
|orderVersion             |String            |orderVersion of the request                      |
+-------------------------+------------------+-------------------------------------------------+
|instanceName             |String            |instanceName of the request                      |
+-------------------------+------------------+-------------------------------------------------+
|suppressRollback         |String            |suppressRollback of the request                  |
+-------------------------+------------------+-------------------------------------------------+
|requestorId              |String            |requestorId of the request                       |
+-------------------------+------------------+-------------------------------------------------+

RequestParameters Object 

+-------------------------+------------------+-------------------------------------------------+
|Attribute                |Content           |Description                                      |
+=========================+==================+=================================================+
|SubscriptionServiceType  |String            |The service type of the Subscription             |
+-------------------------+------------------+-------------------------------------------------+

RequestStatus Object

+-------------------------+------------------+-------------------------------------------------+
|Attribute                |Content           |Description                                      |
+=========================+==================+=================================================+
|finishTime               |String            |Time                                             |
+-------------------------+------------------+-------------------------------------------------+
|requestState             |String            |state of the request                             |
+-------------------------+------------------+-------------------------------------------------+
|statusMessage            |String            |statusMessage                                    |
+-------------------------+------------------+-------------------------------------------------+
|percentProgress          |String            |percentage of progress                           |
+-------------------------+------------------+-------------------------------------------------+


.. _get_orchestration_request_all:

GET Orchestration Requests
++++++++++++++++++++++++++

+--------------------+--------------------------------------------------------------+
|Interface Definition|Description                                                   |
+====================+==============================================================+
|URI                 |/onap/so/infra/orchestrationRequests/v7                       |
+--------------------+--------------------------------------------------------------+
|Operation Type      |GET                                                           |
+--------------------+--------------------------------------------------------------+
|Content-Type        |application/json                                              |
+--------------------+--------------------------------------------------------------+

Response Body:

+----------------+---------+-----------+--------------------------+-------------------------------------------+
|Attribute       |Qualifier|Cardinality|Content                   |Description                                |
+================+=========+===========+==========================+===========================================+
|requestList     |M        |1          |Array                     |Content of request List.                   |
+----------------+---------+-----------+--------------------------+-------------------------------------------+

RequestList : 

+----------------+---------+-----------+--------------------------+-------------------------------------------+
|Attribute       |Qualifier|Cardinality|Content                   |Description                                |
+================+=========+===========+==========================+===========================================+
|request         |M        |1          |request Object            |Content of request object.                 |
+----------------+---------+-----------+--------------------------+-------------------------------------------+

Request Object

+-------------------+---------+-----------+--------------------------+-------------------------------------------+
|Attribute          |Qualifier|Cardinality|Content                   |Description                                |
+===================+=========+===========+==========================+===========================================+
|requestId          |M        |1          |String                    |Request Id.                                |
+-------------------+---------+-----------+--------------------------+-------------------------------------------+
|startTime          |M        |1          |request Object            |Start time.                                |
+-------------------+---------+-----------+--------------------------+-------------------------------------------+
|requestScope       |M        |1          |request Object            |Scope of the request.                      |
+-------------------+---------+-----------+--------------------------+-------------------------------------------+
|requestType        |M        |1          |request Object            |Type of the request.                       |
+-------------------+---------+-----------+--------------------------+-------------------------------------------+
|requestDetails     |M        |1          |requestDetails Object     |Type of the request.                       |
+-------------------+---------+-----------+--------------------------+-------------------------------------------+
|requestStatus      |M        |1          |requestStatus Object      |Type of the request.                       |
+-------------------+---------+-----------+--------------------------+-------------------------------------------+

RequestDetails Object 

+-------------------+--------------------------+-------------------------------------------------+
|Attribute          |Content                   |Description                                      |
+===================+==========================+=================================================+
|modelInfo          |modelInfo Object          |Content of modelInfo object.                     |
+-------------------+--------------------------+-------------------------------------------------+
|subscriberInfo     |subscriberInfo Object     |Content of subscriberInfo object.                |
+-------------------+--------------------------+-------------------------------------------------+
|requestInfo        |requestInfo Object        |Content of requestInfo object.                   |
+-------------------+--------------------------+-------------------------------------------------+
|requestParameters  |requestParameters Object  |Content of requestParameters object.             |
+-------------------+--------------------------+-------------------------------------------------+
|relatedInstanceList|relatedInstanceList Object|Content of relatedInstanceList object.           |
+-------------------+--------------------------+-------------------------------------------------+
|cloudConfiguration |cloudConfiguration Object |Content of cloudConfiguration object.            |
+-------------------+--------------------------+-------------------------------------------------+
|project            |project Object            |Content of project object.                       |
+-------------------+--------------------------+-------------------------------------------------+
|owningEntity       |owningEntity Object       |Content of owningEntity object.                  |
+-------------------+--------------------------+-------------------------------------------------+
|platform           |platform Object           |Content of platform object.                      |
+-------------------+--------------------------+-------------------------------------------------+
|lineOfBusiness     |lineOfBusiness Object     |Content of lineOfBusiness object.                |
+-------------------+--------------------------+-------------------------------------------------+

ModelInfo Object 

+-------------------------+------------------+-------------------------------------------------+
|Attribute                |Content           |Description                                      |
+=========================+==================+=================================================+
|ModelType                |String            |Type of model                                    |
+-------------------------+------------------+-------------------------------------------------+
|ModelInvariantId         |String            |The Model Invariant Id.                          |
+-------------------------+------------------+-------------------------------------------------+
|ModelNameVersionId       |String            |The modelname Version Id                         |
+-------------------------+------------------+-------------------------------------------------+
|ModelName                |String            |Name of the Model                                |
+-------------------------+------------------+-------------------------------------------------+
|ModelVersion             |String            |Version of the model                             |
+-------------------------+------------------+-------------------------------------------------+
|ModelCustomization Name  |String            |The Model Customization name                     |
+-------------------------+------------------+-------------------------------------------------+
|modelCustomizationUuid   |String            |The Model Customization UUid                     |
+-------------------------+------------------+-------------------------------------------------+
|modelVersionId           |String            |The Model version id                             |
+-------------------------+------------------+-------------------------------------------------+
|modelUuid                |String            |The Model UUid                                   |
+-------------------------+------------------+-------------------------------------------------+
|modelInvariantUuid       |String            |The Model Invariant  UUid                        |
+-------------------------+------------------+-------------------------------------------------+
|modelInstanceName        |String            |The Model Instance  name                         |
+-------------------------+------------------+-------------------------------------------------+

SubscriberInfo Object 

+-------------------------+------------------+-------------------------------------------------+
|Attribute                |Content           |Description                                      |
+=========================+==================+=================================================+
|GlobalSubscriberId       |String            |Global customer Id (in A&AI)                     |
+-------------------------+------------------+-------------------------------------------------+
|SubscriberName           |String            |Name of the Subscriber                           |
+-------------------------+------------------+-------------------------------------------------+

RequestInfo Object 

+-------------------------+------------------+-------------------------------------------------+
|Attribute                |Content           |Description                                      |
+=========================+==================+=================================================+
|Source                   |String            |source of the request                            |
+-------------------------+------------------+-------------------------------------------------+
|billingAccountNumber     |String            |billingAccountNumber of the request              |
+-------------------------+------------------+-------------------------------------------------+
|callbackUrl              |String            |callbackUrl of the request                       |
+-------------------------+------------------+-------------------------------------------------+
|correlator               |String            |correlator of the request                        |
+-------------------------+------------------+-------------------------------------------------+
|orderNumber              |String            |orderNumber of the request                       |
+-------------------------+------------------+-------------------------------------------------+
|productFamilyId          |String            |productFamilyId of the request                   |
+-------------------------+------------------+-------------------------------------------------+
|orderVersion             |String            |orderVersion of the request                      |
+-------------------------+------------------+-------------------------------------------------+
|instanceName             |String            |instanceName of the request                      |
+-------------------------+------------------+-------------------------------------------------+
|suppressRollback         |String            |suppressRollback of the request                  |
+-------------------------+------------------+-------------------------------------------------+
|requestorId              |String            |requestorId of the request                       |
+-------------------------+------------------+-------------------------------------------------+

RequestParameters Object 

+-------------------------+------------------+-------------------------------------------------+
|Attribute                |Content           |Description                                      |
+=========================+==================+=================================================+
|SubscriptionServiceType  |String            |The service type of the Subscription             |
+-------------------------+------------------+-------------------------------------------------+

RequestStatus Object

+-------------------------+------------------+-------------------------------------------------+
|Attribute                |Content           |Description                                      |
+=========================+==================+=================================================+
|finishTime               |String            |Time                                             |
+-------------------------+------------------+-------------------------------------------------+
|requestState             |String            |state of the request                             |
+-------------------------+------------------+-------------------------------------------------+
|statusMessage            |String            |statusMessage                                    |
+-------------------------+------------------+-------------------------------------------------+
|percentProgress          |String            |percentage of progress                           |
+-------------------------+------------------+-------------------------------------------------+