vid - ARCHIVED- 2022-02-15 at the request of the project

about summary refs log tree commit diff stats
Age	Commit message (Collapse)	Author	Files	Lines
2019-12-10	Address licence discrepancy	Ittay Stern	1	-0/+0
	Issue-ID: VID-378 Change-Id: I431f58ae2e1b8442dea2ffd84b7100999172eb9b Signed-off-by: Ittay Stern <ittay.stern@att.com>
2019-11-25	identify macro services without instantiation type in BE by feature flag	Eylon Malin	1	-0/+0
	Issue-ID: VID-705 Change-Id: Ia618f91133cdecbd35eac4346496a6ff38a3753e Signed-off-by: Eylon Malin <eylon.malin@intl.att.com>
2019-11-19	a-la-carte services new instantiation ui selenium test	Eylon Malin	1	-0/+0
	Issue-ID: VID-701 Change-Id: I72f5245493d0ad3e3cc4447617c4b6a011bfd41c Signed-off-by: Eylon Malin <eylon.malin@intl.att.com> Signed-off-by: Ittay Stern <ittay.stern@att.com>
2019-11-13	Retry Simulator's DB queries upon failure	Ittay Stern	1	-2/+13
	In tests env, sometimes DB drops unused connections with error: java.sql.SQLNonTransientConnectionException: (conn=3439) Connection reset Issue-ID: VID-647 Change-Id: If8211db653d4b3b3efc4edbe8b3ad6d3dd7d65e2 Signed-off-by: Ittay Stern <ittay.stern@att.com>
2019-11-13	fix browse sdc with macro instantiation type to use unique IDs	Eylon Malin	1	-0/+0
	Issue-ID: VID-701 Signed-off-by: Eylon Malin <eylon.malin@intl.att.com> Change-Id: I6760450d2069495a06e5178f1a51c269e78da22e
2019-11-12	allow openPreviousVersionPopup test to handle modern UI aLaCarte dialog	Eylon Malin	1	-0/+0
	Issue-ID: VID-701 Change-Id: I6b58e24d3029642775132b1b6f0c086a507109a2 Signed-off-by: Eylon Malin <eylon.malin@intl.att.com>
2019-11-11	adjust BrowseASDCTest with ↵	Eylon Malin	1	-0/+0
	FLAG_2002_ANY_ALACARTE_BESIDES_EXCLUDED_NEW_INSTANTIATION_UI Issue-ID: VID-701 Change-Id: Ieed6340e3ff1e727521d8d1747ff2db96614664d Signed-off-by: Eylon Malin <eylon.malin@intl.att.com>
2019-11-04	remove internal urls	Amichai Hemli	1	-1/+0
	Issue-ID: VID-646 Signed-off-by: Amichai Hemli <amichai.hemli@intl.att.com> Change-Id: Ie76259a41909ae5667053a2ef2ab6f0094dc6b6c
2019-09-16	Upgrade FasterXML/Jackson to version 2.9.9.3	Amichai Hemli	1	-2/+3
	FasterXML jackson-databind versions 2.x through 2.9.9.1 are vulnerable. we will use 2.9.9.3 for jackson-databind only Issue-ID: VID-640 Signed-off-by: Amichai Hemli <amichai.hemli@intl.att.com> Change-Id: I537cb83ad787522b75fdee59ffabb51def747096
2019-09-15	change operational-environment-type on operational-environments query	Eylon Malin	1	-3/+3
	Issue-ID: VID-637 Signed-off-by: Eylon Malin <eylon.malin@intl.att.com> Change-Id: Ia9340269dd6a4a6616a6fdbfe166eea0731490de
2019-09-10	update MSO create service instance URL	Eylon Malin	3	-6/+6
	align MSO create service instance URL to /serviceInstantiation/v7/serviceInstances also unify some system properties variables Issue-ID: VID-622 Signed-off-by: Eylon Malin <eylon.malin@intl.att.com> Change-Id: I7a0744f5d6cfe776ce2f17b11aa5ebba4c8e65fb Signed-off-by: Eylon Malin <eylon.malin@intl.att.com>
2019-09-04	Improve vid-simulator cloud-nativeness (fix)	Ittay Stern	1	-0/+1
	Change-Id: I575294b0d085887c398c9ca0138b36a9e0c7bc3b Issue-ID: VID-608 Signed-off-by: Ittay Stern <ittay.stern@att.com>
2019-09-04	Improve vid-simulator cloud-nativeness	Ittay Stern	2	-2/+13
	Issue-ID: VID-608 * Integrative tests will look at `SIM_HOST` that may differ from `VID_HOST`. * Simulator will look at `hibernate.connection.url` property for db-connection config * Don't skip DB connection if schema not ready, by removing schema validation Change-Id: Idb4587c30dd0cbc0fe7e7362cb691a4cb425fd10 Signed-off-by: Ittay Stern <ittay.stern@att.com>
2019-08-13	tests - rename csar file names for alignment with code	Eylon Malin	3	-0/+0
	Issue-ID: VID-378 Signed-off-by: Eylon Malin <eylon.malin@intl.att.com> Change-Id: I5313de573f8077e3ddcea565c0d056c2cb5857a5
2019-08-13	Merge "Change out-of-the-box config to work on dev's environment"	Amichai Hemli	1	-25/+50

2019-08-12	Upgrade pom files	Einat Vinouze	1	-1/+1
	versions:use-latest-releases Issue-ID: VID-512 Change-Id: I3bdc7ff06717776e4f15316cca623e8025066495 Signed-off-by: Einat Vinouze <einat.vinouze@intl.att.com> Signed-off-by: Ittay Stern <ittay.stern@att.com>
2019-08-12	Change out-of-the-box config to work on dev's environment	Ittay Stern	1	-25/+50
	1) Fill-up system.properties's missing fields, and same for system_template.properties. This modifies some SO endpoints, most significantly -- mso.restapi.vnf.instance is now /serviceInstantiation/v7/serviceInstances/<service_instance_id>/vnfs instead of /serviceInstances/v6/<service_instance_id>/vnfs 2) Configure endpoint's to a local simulator's location: * ecomp_rest_url in portal.properties * mso.server.url, aai.server.url in system.properties * asdc.client.rest.host in asdc.properties 3) Added always-on getSessionSlotCheckInterval in simulator. Issue-ID: VID-564 Change-Id: Icc7bdc83ed65df3415a4b0f36f98291775909f49 Signed-off-by: Ittay Stern <ittay.stern@att.com>
2019-07-14	Add and upgrade dependencies on pom files	Einat Vinouze	1	-2/+0
	Issue-ID: VID-512 Signed-off-by: Einat Vinouze <einat.vinouze@intl.att.com> Change-Id: I1800a2cc7bfdbbc015399092da24b430c5faab66
2019-07-09	Merge changes Ib4430bf2,Icc0bdb9e,I2736b984	Amichai Hemli	74	-855/+137
	* changes: Merge from ecomp 718fd196 - Ext. Services Simulator Merge from ecomp 718fd196 - Integration Tests Merge from ecomp 718fd196 - Modern UI
2019-07-09	Merge from ecomp 718fd196 - Ext. Services Simulator	Ittay Stern	74	-855/+137
	Issue-ID: VID-378 Change-Id: Ib4430bf23d109e6fdfe38c55e55b7d3b96fff3af Signed-off-by: Ittay Stern <ittay.stern@att.com>
2019-07-08	Upgrade to Spring 5.1.6 + simulator fasterxml	Einat Vinouze	1	-2/+13
	Issue-ID: VID-512 Change-Id: I9a74e6357671c5eee0a425354dcd07c762c69c83 Signed-off-by: Einat Vinouze <einat.vinouze@intl.att.com>
2019-07-03	Let build module vid-ext-services-simulator without docker	Ittay Stern	1	-2/+17
	Issue-ID: VID-507 Change-Id: Iac58cb56c3e121302e93c5720daa11fb264529c6 Signed-off-by: Ittay Stern <ittay.stern@att.com>
2019-07-02	Revert "Build module vid-ext-services-simulator"	Ittay Stern	1	-14/+2
	Issue-ID: VID-507 This reverts commit 6946c31e, as it does not "deploy" successfully in vid-master-merge-java. Change-Id: I3863829a43d4232b6533cca75a7dd33a41e75c5f Signed-off-by: Ittay Stern <ittay.stern@att.com>
2019-07-01	Build module vid-ext-services-simulator	Ittay Stern	1	-2/+14
	Issue-ID: VID-507 Change-Id: I8f44a4c9b1502e9803dcafe9bce4c59d392c0dfd Signed-off-by: Ittay Stern <ittay.stern@att.com>
2019-06-19	Normalize slashes in repositories paths	Ittay Stern	1	-4/+4
	This lets vid-master-release-version-java-daily go green. Issue-ID: CIMAN-234 Change-Id: I87f2f0925388cf7f5129cce37ace9321f3533f7c Signed-off-by: Ittay Stern <ittay.stern@att.com>
2019-04-18	Address licence discrepancy	Ittay Stern	15	-0/+0
	Issue-ID: VID-378 Change-Id: I81f6adef541b78a656ca5820a4174cadad12fc77 Signed-off-by: Ittay Stern <ittay.stern@att.com>
2019-04-17	fixing backEnd local workflow type	Bartosz Gardziejewski	1	-1/+1
	Change-Id: Ifd6f0718135d38135f57496e4f816e48324cfb7d Issue-ID: VID-401 Signed-off-by: Bartosz Gardziejewski <bartosz.gardziejewski@nokia.com>
2019-04-11	modify local workflow parameters to much native ones	Bartosz Gardziejewski	1	-1/+93
	Change-Id: I8d3e6b204a1b327d7b754c5bc723ae4268174393 Issue-ID: VID-401 Signed-off-by: Bartosz Gardziejewski <bartosz.gardziejewski@nokia.com>
2019-04-09	Merge "align logic to new so api"	Wojciech Sliwka	4	-60/+113

2019-04-08	align logic to new so api	Wojciech Sliwka	4	-60/+113
	Change-Id: Ic1a975eb6d3d9487fc2e006d2f171fa044806ef3 Issue-ID: VID-400 Signed-off-by: Wojciech Sliwka <wojciech.sliwka@nokia.com>
2019-04-02	Display Human-readable timeout in Manual Task popup	Ittay Stern	1	-1/+1
	Issue-ID: VID-403 Change-Id: Iac5d7eb4ab92d967151fcf9ef439dd038f903c08 Signed-off-by: Ittay Stern <ittay.stern@att.com>
2019-04-02	Merge "Sending workflow data from UI to SO"	Wojciech Sliwka	6	-5/+89

2019-04-01	Sending workflow data from UI to SO	Bartosz Gardziejewski	6	-5/+89
	Change-Id: I39c78584c61eb317d4eaf2861ece810c1b60ab01 Issue-ID: VID-401 Signed-off-by: Bartosz Gardziejewski <bartosz.gardziejewski@nokia.com>
2019-04-01	Display Manual Task description in actions popup	Ittay Stern	2	-1/+3
	Change-Id: I3aa990785b340cdff647154016ae6078aabc3ee7 Issue-ID: VID-403 Signed-off-by: Ittay Stern <ittay.stern@att.com>
2019-03-26	Upgrade springframework to 4.3.22 (was 4.2.x)	Ittay Stern	1	-1/+1
	Issue-ID: VID-435 Change-Id: Ib7722368894fb39119d47602bca5c4453430ab8e Signed-off-by: Ittay Stern <ittay.stern@att.com>
2019-03-21	Merge "Preset for Workflows action:EQUALS:scaleOut"	Ittay Stern	2	-19/+54

2019-03-20	Merge "Merge simulator from ECOMP's repository"	Ittay Stern	92	-1368/+2421

2019-03-19	Preset for Workflows action:EQUALS:scaleOut	Ittay Stern	2	-20/+55
	Change I71d44c6b36babcc5b8931cda65ab86940062deda modified MsoBusinessLogicImpl.getOrchestrationRequestsForDashboard to require having a response from MSO for action:EQUALS:scaleOut in order to see the other modelType:EQUALS:vnf workflows. Change-Id: Ib5466c366938653f1cb3edfeb07328a4bc0b5afc Issue-ID: VID-403 Signed-off-by: Ittay Stern <ittay.stern@att.com>
2019-03-15	new presets	Wojciech Sliwka	3	-0/+2663
	add new presets to fill change-management popup Change-Id: I3bfac732f9c16fe22aa2bddfde946314e7294792 Issue-ID: VID-397 Signed-off-by: Wojciech Sliwka <wojciech.sliwka@nokia.com>
2019-03-11	Merge simulator from ECOMP's repository	Ittay Stern	92	-1368/+2421
	Reference commit in ECOMP: 8e92a8c6 Issue-ID: VID-378 Change-Id: Ifd87e07db55a760fc94c582758a7413103b5fdd8 Signed-off-by: Ittay Stern <ittay.stern@att.com>
2019-02-21	workflow parameters API	Wojciech Sliwka	4	-0/+122
	Change-Id: If79e410608a0562ddef86d9a3a451d4addf66a0f Issue-ID: VID-419 Signed-off-by: Wojciech Sliwka <wojciech.sliwka@nokia.com>
2019-02-18	Introduced mocked SO workflows in VID FE	golabek	2	-6/+23
	Mocked SO workflows joined with list of workflows from VIDs DB. (Contains: Mocked BE service to return workflow list) Change-Id: I10336238cfeb8819e0a2b3e88cd86c338cab86fa Issue-ID: VID-399 Signed-off-by: Tomasz Golabek <tomasz.golabek@nokia.com>
2019-01-09	Merge from ECOMP's repository	Ittay Stern	1	-3/+3
	Main Features -------------- - Async-Instantiation jobs mechanism major update; still WIP (package `org.onap.vid.job`) - New features in View/Edit: Activate fabric configuration; show related networks; soft delete - Support AAI service-tree traversal (`AAIServiceTree`) - In-memory cache for SDC models and certain A&AI queries (`CacheProviderWithLoadingCache`) - Upgrade TOSCA Parser and add parsing options; fix malformed TOSCA models - Resolve Cloud-Owner values for MSO - Pass X-ONAP headers to MSO Infrastructure -------------- - Remove codehaus' jackson mapper; use soley fasterxml 2.9.7 - Surefire invokes both TestNG and JUnit tests - Support Kotlin source files - AaiController2 which handles errors in a "Spring manner" - Inline generated-sources and remove jsonschema2pojo Quality -------- - Cumulative bug fixes (A&AI API, UI timeouts, and many more) - Many Sonar issues cleaned-up - Some unused classes removed - Minor changes in vid-automation project, allowing some API verification to run Hard Merges ------------ - HTTP Clients (MSO, A&AI, WebConfig, OutgoingRequestHeadersTest) - Moved `package org.onap.vid.controllers` to `controller`, without plural -- just to keep semantic sync with ECOMP. Reference commit in ECOMP: 3d1141625 Issue-ID: VID-378 Change-Id: I9c8d1e74caa41815891d441fc0760bb5f29c5788 Signed-off-by: Ittay Stern <ittay.stern@att.com>
2018-12-20	pom.xml cleanup	biniek	1	-35/+2
	Change-Id: I7622437fbd6d4d4a0b09782c8a6fa2d6016f90ab Issue-ID: VID-368 Signed-off-by: biniek <lukasz.biniek@nokia.com>
2018-12-14	.gitignore cleanup	biniek	6	-66/+5
	Change-Id: Ibfce4d25dba62bfc4eb00f761f7b893aefb1b69d Issue-ID: VID-367 Signed-off-by: biniek <lukasz.biniek@nokia.com>
2018-12-04	Add simulator to docker-compose.yml	kurczews	2	-0/+62
	Issue-ID: VID-354 Change-Id: If531a133c6d6267e5b956cbb9852fc15e24642d5 Signed-off-by: kurczews <krzysztof.kurczewski@nokia.com>
2018-09-26	Merge "Fix simulator preset"	Amichai Hemli	1	-3/+3

2018-09-20	Fix simulator preset	kurczews	1	-3/+3
	After Portal API update simulator preset needs to be updated Issue-ID: VID-313 Change-Id: I960fed36f0bbc82bc6b3a2b2e01d9b22322b5719 Signed-off-by: kurczews <krzysztof.kurczewski@nokia.com>
2018-09-17	Add new SDC service model to simulator	Joanna Jeremicz	2	-0/+56
	Change-Id: I92ba14ef2c157abd130aa1eaaf9dc89aa5437a77 Issue-ID: VID-205 Signed-off-by: Joanna Jeremicz <joanna.jeremicz@nokia.com>
2018-08-21	Rename vid-simulator packages	Joanna Jeremicz	9	-12/+12
	- Rename from openecomp to onap and update imports - Fix small bug in README.txt Change-Id: I099b010adf7ed6dd708c9feae0340be462b1d195 Issue-ID: VID-205 Signed-off-by: Joanna Jeremicz <joanna.jeremicz@nokia.com>
a id='n1362' href='#n1362'>1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 3206 3207 3208 3209 3210 3211 3212 3213 3214 3215 3216 3217 3218 3219 3220 3221 3222 3223 3224 3225 3226 3227 3228 3229 3230 3231 3232 3233 3234 3235 3236 3237 3238 3239 3240 3241 3242 3243 3244 3245 3246 3247 3248 3249 3250 3251 3252 3253 3254 3255 3256 3257 3258 3259 3260 3261 3262 3263 3264 3265 3266 3267 3268 3269 3270 3271 3272 3273 3274 3275 3276 3277 3278 3279 3280 3281 3282 3283 3284 3285 3286 3287 3288 3289 3290 3291 3292 3293 3294 3295 3296 3297 3298 3299 3300 3301 3302 3303 3304 3305 3306 3307 3308 3309 3310 3311 3312 3313 3314 3315 3316 3317 3318 3319 3320 3321 3322 3323 3324 3325 3326 3327 3328 3329 3330 3331 3332 3333 3334 3335 3336 3337 3338 3339 3340 3341 3342 3343 3344 3345 3346 3347 3348 3349 3350 3351 3352 3353 3354 3355 3356 3357 3358 3359 3360 3361 3362 3363 3364 3365 3366 3367 3368 3369 3370 3371 3372 3373 3374 3375 3376 3377 3378 3379 3380 3381 3382 3383 3384 3385 3386 3387 3388 3389 3390 3391 3392 3393 3394 3395 3396 3397 3398 3399 3400 3401 3402 3403 3404 3405 3406 3407 3408 3409 3410 3411 3412 3413 3414 3415 3416 3417 3418 3419 3420 3421 3422 3423 3424 3425 3426 3427 3428 3429 3430 3431 3432 3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443 3444 3445 3446 3447 3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571 3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 3652 3653 3654 3655 3656 3657 3658 3659 3660 3661 3662 3663 3664 3665 3666 3667 3668 3669 3670 3671 3672 3673 3674 3675 3676 3677 3678 3679 3680 3681 3682 3683 3684 3685 3686 3687 3688 3689 3690 3691 3692 3693 3694 3695 3696 3697 3698 3699 3700 3701 3702 3703 3704 3705 3706 3707 3708 3709 3710 3711 3712 3713 3714 3715 3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 3726 3727 3728 3729 3730 3731 3732 3733 3734 3735 3736 3737 3738 3739 3740 3741 3742 3743 3744 3745 3746 3747 3748 3749 3750 3751 3752 3753 3754 3755 3756 3757 3758 3759 3760 3761 3762 3763 3764 3765 3766 3767 3768 3769 3770 3771 3772 3773 3774 3775 3776 3777 3778 3779 3780 3781 3782 3783 3784 3785 3786 3787 3788 3789 3790 3791 3792 3793 3794 3795 3796 3797 3798 3799 3800 3801 3802 3803 3804 3805 3806 3807 3808 3809 3810 3811 3812 3813 3814 3815 3816 3817 3818 3819 3820 3821 3822 3823 3824 3825 3826 3827 3828 3829 3830 3831 3832 3833 3834 3835 3836 3837 3838 3839 3840 3841 3842 3843 3844 3845 3846 3847 3848 3849 3850 3851 3852 3853 3854 3855 3856 3857 3858 3859 3860 3861 3862 3863 3864 3865 3866 3867 3868 3869 3870 3871 3872 3873 3874 3875 3876 3877 3878 3879 3880 3881 3882 3883 3884 3885 3886 3887 3888 3889 3890 3891 3892 3893 3894 3895 3896 3897 3898 3899 3900 3901 3902 3903 3904 3905 3906 3907 3908 3909 3910 3911 3912 3913 3914 3915 3916 3917 3918 3919 3920 3921 3922 3923 3924 3925 3926 3927 3928 3929 3930 3931 3932 3933 3934 3935 3936 3937 3938 3939 3940 3941 3942 3943 3944 3945 3946 3947 3948 3949 3950 3951 3952 3953 3954 3955 3956 3957 3958 3959 3960 3961 3962 3963 3964 3965 3966 3967 3968 3969 3970 3971 3972 3973 3974 3975 3976 3977 3978 3979 3980 3981 3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 3992 3993 3994 3995 3996 3997 3998 3999 4000 4001 4002 4003 4004 4005 4006 4007 4008 4009 4010 4011 4012 4013 4014 4015 4016 4017 4018 4019 4020 4021 4022 4023 4024 4025 4026 4027 4028 4029 4030 4031 4032 4033 4034 4035 4036 4037 4038 4039 4040 4041 4042 4043 4044 4045 4046 4047 4048 4049 4050 4051 4052 4053 4054 4055 4056 4057 4058 4059 4060 4061 4062 4063 4064 4065 4066 4067 4068 4069 4070 4071 4072 4073 4074 4075 4076 4077 4078 4079 4080 4081 4082 4083 4084 4085 4086 4087 4088 4089 4090 4091 4092 4093 4094 4095 4096 4097 4098 4099 4100 4101 4102 4103 4104 4105 4106 4107 4108 4109 4110 4111 4112 4113 4114 4115 4116 4117 4118 4119 4120 4121 4122 4123 4124 4125 4126 4127 4128 4129 4130 4131 4132 4133 4134 4135 4136 4137 4138 4139 4140 4141 4142 4143 4144 4145 4146 4147 4148 4149 4150 4151 4152 4153 4154 4155 4156 4157 4158 4159 4160 4161 4162 4163 4164 4165 4166 4167 4168 4169 4170 4171 4172
.. 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.

SO Amsterdam Interfaces
================

.. image:: images/SO_R1_1.png

SO APIs
============

North Bound APIs
----------------
Create service instance
++++++++++++++++++++++++

+--------------------+-------------------------------------+
|Interface Definition|Description                          |
+====================+=====================================+
|URI                 |{serverRoot}/serviceInstances/v2     |
+--------------------+-------------------------------------+
|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.             |
+-------------------+-------------------------+-------------------------------------------------+

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                     |
+-------------------------+------------------+-------------------------------------------------+

SubscriberInfo Object 

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

RequestInfo Object 

+-------------------------+------------------+-------------------------------------------------+
|Attribute                |Content           |Description                                      |
+=========================+==================+=================================================+
|InstanceName             |String            |The instance Name                                |
+-------------------------+------------------+-------------------------------------------------+
|ProductFamilyId          |String            |The product family Id.                           |
+-------------------------+------------------+-------------------------------------------------+
|Source                   |String            |source of the request                            |
+-------------------------+------------------+-------------------------------------------------+
|SuppressRollback         |Boolean           |SuppressRollback                                 |
+-------------------------+------------------+-------------------------------------------------+

RequestParameters Object 

+-------------------------+------------------+-------------------------------------------------+
|Attribute                |Content           |Description                                      |
+=========================+==================+=================================================+
|SubscriptionServiceType  |String            |The service type of the Subscription             |
+-------------------------+------------------+-------------------------------------------------+
|UserParams               |Array             |The product family Id.                           |
+-------------------------+------------------+-------------------------------------------------+

UserParams Object 

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

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

+--------------------+---------------------------------------------------------+
|Interface Definition|Description                                              |
+====================+=========================================================+
|URI                 |{serverRoot}/serviceInstances/v2/{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
++++++++++++++++++++++++

+--------------------+-------------------------------------------------------------------------------------------+
|Interface Definition|Description                                                                                |
+====================+===========================================================================================+
|URI                 |{serverRoot}/serviceInstances/v2/{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.                     |
+---------------------+-------------------------+-------------------------------------------------+
|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.                     |
+-------------------------+------------------+-------------------------------------------------+

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

+--------------------+---------------------------------------------------------------------------------------------------------------------+
|Interface Definition|Description                                                                                                          |
+====================+=====================================================================================================================+
|URI                 |{serverRoot}/serviceInstances/v2/{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
+++++++++++++++++

+--------------------+----------------------------------------------------------------------------------------+
|Interface Definition|Description                                                                             |
+====================+========================================================================================+
|URI                 |{serverRoot}/serviceInstances/v2/{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 Volume Group
++++++++++++++++++++++++

+--------------------+--------------------------------------------------------------------------------------------------------------+
|Interface Definition|Description                                                                                                   |
+====================+==============================================================================================================+
|URI                 |{serverRoot}/serviceInstances/v2/{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 Network
+++++++++++++++

+--------------------+------------------------------------------------------------------+
|Interface Definition|Description                                                       |
+====================+==================================================================+
|URI                 |{serverRoot}/serviceInstances/v2/{serviceInstanceId}/networks     |
+--------------------+------------------------------------------------------------------+
|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.                  |
+---------------------+-------------------------+-------------------------------------------------+
|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                                      |
+=========================+==================+=================================================+
|InstanceName             |String            |The instance Name                                |
+-------------------------+------------------+-------------------------------------------------+
|ProductFamilyId          |String            |The product family Id.                           |
+-------------------------+------------------+-------------------------------------------------+
|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.                     |
+-------------------------+------------------+-------------------------------------------------+

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 Network
+++++++++++++++

+--------------------+--------------------------------------------------------------------------------------+
|Interface Definition|Description                                                                           |
+====================+======================================================================================+
|URI                 |{serverRoot}/serviceInstances/v2/{serviceInstanceId}/networks/{networkInstanceId}     |
+--------------------+--------------------------------------------------------------------------------------+
|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 VNF
+++++++++++++++

+--------------------+--------------------------------------------------------------+
|Interface Definition|Description                                                   |
+====================+==============================================================+
|URI                 |{serverRoot}/serviceInstances/v2/{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.                     |
+---------------------+-------------------------+-------------------------------------------------+
|cloudConfiguration   |cloudConfiguration Object|Content of cloudConfiguration object.            |
+---------------------+-------------------------+-------------------------------------------------+
|requestInfo          |requestInfo Object       |Content of requestInfo object.                   |
+---------------------+-------------------------+-------------------------------------------------+
|relatedInstanceList  |List                     |Content of relatedInstanceList.                  |
+---------------------+-------------------------+-------------------------------------------------+
|requestParameters    |requestParameters Object |Content of requestParameters 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                                      |
+=========================+==================+=================================================+
|InstanceName             |String            |The instance Name                                |
+-------------------------+------------------+-------------------------------------------------+
|ProductFamilyId          |String            |The product family Id.                           |
+-------------------------+------------------+-------------------------------------------------+
|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.                     |
+-------------------------+------------------+-------------------------------------------------+

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
+++++++++++++++

+--------------------+------------------------------------------------------------------------------+
|Interface Definition|Description                                                                   |
+====================+==============================================================================+
|URI                 |{serverRoot}/serviceInstances/v2/{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
++++++++++++++++++++++++++

+--------------------+--------------------------------------------------------------+
|Interface Definition|Description                                                   |
+====================+==============================================================+
|URI                 |{serverRoot}/orchestrationRequests/v2/{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.                                |
+-------------------+---------+-----------+--------------------------+-------------------------------------------+
|serviceInstanceId  |M        |1          |request Object            |Service Instance id.                       |
+-------------------+---------+-----------+--------------------------+-------------------------------------------+
|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.             |
+-------------------+-------------------------+-------------------------------------------------+

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                             |
+-------------------------+------------------+-------------------------------------------------+

SubscriberInfo Object 

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

RequestInfo Object 

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

RequestParameters Object 

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

RequestStatus Object

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

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

+--------------------+--------------------------------------------------------------+
|Interface Definition|Description                                                   |
+====================+==============================================================+
|URI                 |{serverRoot}/orchestrationRequests/v2                         |
+--------------------+--------------------------------------------------------------+
|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.                                |
+-------------------+---------+-----------+--------------------------+-------------------------------------------+
|serviceInstanceId  |M        |1          |request Object            |Service Instance id.                       |
+-------------------+---------+-----------+--------------------------+-------------------------------------------+
|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.             |
+-------------------+-------------------------+-------------------------------------------------+

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                             |
+-------------------------+------------------+-------------------------------------------------+

SubscriberInfo Object 

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

RequestInfo Object 

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

RequestParameters Object 

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

RequestStatus Object

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

SDC API
--------

Get List of Existing Catalog Assets 
+++++++++++++++++++++++++++++++++++

+--------------------+--------------------------+
|Interface Definition|Description               |
+====================+==========================+
|URI                 |sdc/v1/catalog/{assetType}|
+--------------------+--------------------------+
|Operation Type      |GET                       |
+--------------------+--------------------------+

Request Parameters:

+-------------------+---------+-----------+-------+-------------------------------------------------------------+
|Attribute          |Qualifier|Cardinality|Content|Description                                                  |
+===================+=========+===========+=======+=============================================================+
|assetType          |M        |1          |String |The requested asset type.valid values are resources/services.|
+-------------------+---------+-----------+-------+-------------------------------------------------------------+
|service-type       |M        |1          |String |Service Type                                                 |
+-------------------+---------+-----------+-------+-------------------------------------------------------------+
|service-instance-id|M        |1          |String |Service Instance ID                                          |
+-------------------+---------+-----------+-------+-------------------------------------------------------------+

Request Headers:

+-------------------+---------+-----------------------------------------------------------------------------------------+
|Header Name        |Qualifier|Description                                                                              |
+===================+=========+=========================================================================================+
|X-ECOMP-RequestID  |N        |request ID.If it is not sent it will be automatically generated by SDC on request receipt|
+-------------------+---------+-----------------------------------------------------------------------------------------+
|X-ECOMP-InstanceID |Y        |Instance ID                                                                              |
+-------------------+---------+-----------------------------------------------------------------------------------------+
|Accept             |N        |Determines the format of the body of the response. Valid values are :  “application/json”|
+-------------------+---------+-----------------------------------------------------------------------------------------+
|Authorization      |Y        |Base64 encoded username:password                                                         |
+-------------------+---------+-----------------------------------------------------------------------------------------+

Response:

+------------------+---------+-----------+-------+--------------------------------------------------------------------------------------+
|Attribute         |Qualifier|Cardinality|Content|Description                                                                           |
+==================+=========+===========+=======+======================================================================================+
|uuid              |M        |1          |String |Global Asset Version Identifier: UUID generated by SDC per each version of the asset. |
+------------------+---------+-----------+-------+--------------------------------------------------------------------------------------+
|invariantUUID     |M        |1          |String |UUID generated by SDC per each asset.                                                 |
+------------------+---------+-----------+-------+--------------------------------------------------------------------------------------+
|name              |M        |1          |String |The name of the asset                                                                 |
+------------------+---------+-----------+-------+--------------------------------------------------------------------------------------+
|version           |M        |1          |String |The asset version in SDC catalog.                                                     |
+------------------+---------+-----------+-------+--------------------------------------------------------------------------------------+
|toscaModelURL     |M        |1          |String |Relative asset’s URL. Should be used in REST GET API to download the asset’s CSAR.    |
+------------------+---------+-----------+-------+--------------------------------------------------------------------------------------+
|category          |M        |1          |String |Category of the asset.                                                                |
+------------------+---------+-----------+-------+--------------------------------------------------------------------------------------+
|subcategory       |M        |1          |String |Sub-category of the asset                                                             |
+------------------+---------+-----------+-------+--------------------------------------------------------------------------------------+
|resourceType      |M        |1          |String |The type of resource.resource types are VF, VL, CP, VFC, VFCMT, PNF.                  |
+------------------+---------+-----------+-------+--------------------------------------------------------------------------------------+
|lifecycleState    |M        |1          |String |The lifecycle state of the asset                                                      |
+------------------+---------+-----------+-------+--------------------------------------------------------------------------------------+
|lastUpdaterUserId |M        |1          |String |UserID of the SDC designer who was the last to update the asset for this major version|
+------------------+---------+-----------+-------+--------------------------------------------------------------------------------------+

Get Specific Asset Detailed Metadata 
++++++++++++++++++++++++++++++++++++

+--------------------+-------------------------------------------+
|Interface Definition|Description                                |
+====================+===========================================+
|URI                 |/sdc/v1/catalog/{assetType}/{uuid}/metadata|
+--------------------+-------------------------------------------+
|Operation Type      |GET                                        |
+--------------------+-------------------------------------------+

Request Parameters:

+-------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
|Attribute          |Qualifier|Cardinality|Content|Description                                                                          |
+===================+=========+===========+=======+=====================================================================================+
|assetType          |M        |1          |String |The requested asset type.valid values are resources/services.                        |
+-------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
|uuid               |M        |1          |String |Global Asset Version Identifier: UUID generated by SDC per each version of the asset.|
+-------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+

Request Headers:

+-------------------+---------+-----------------------------------------------------------------------------------------+
|Header Name        |Qualifier|Description                                                                              |
+===================+=========+=========================================================================================+
|X-ECOMP-RequestID  |N        |request ID.If it is not sent it will be automatically generated by SDC on request receipt|
+-------------------+---------+-----------------------------------------------------------------------------------------+
|X-ECOMP-InstanceID |Y        |Instance ID                                                                              |
+-------------------+---------+-----------------------------------------------------------------------------------------+
|Accept             |N        |Determines the format of the body of the response. Valid values are :  “application/json”|
+-------------------+---------+-----------------------------------------------------------------------------------------+
|Authorization      |Y        |Base64 encoded username:password                                                         |
+-------------------+---------+-----------------------------------------------------------------------------------------+

Response:

+--------------------+---------+-------+--------------------------------------------------------------------------------------+
|Attribute           |Qualifier|Content|Description                                                                           |
+====================+=========+=======+======================================================================================+
|uuid                |M        |String |Global Asset Version Identifier: UUID generated by SDC per each version of the asset. |
+--------------------+---------+-------+--------------------------------------------------------------------------------------+
|invariantUUID       |M        |String |UUID generated by SDC per each asset.                                                 |
+--------------------+---------+-------+--------------------------------------------------------------------------------------+
|name                |M        |String |The name of the asset                                                                 |
+--------------------+---------+-------+--------------------------------------------------------------------------------------+
|version             |M        |String |The asset version in SDC catalog.                                                     |
+--------------------+---------+-------+--------------------------------------------------------------------------------------+
|toscaModelURL       |M        |String |Relative asset’s URL. Should be used in REST GET API to download the asset’s CSAR.    |
+--------------------+---------+-------+--------------------------------------------------------------------------------------+
|description         |M        |String |Short description of the resource                                                     |
+--------------------+---------+-------+--------------------------------------------------------------------------------------+
|lastUpdaterUserId   |M        |String |UserID of the SDC designer who was the last to update the asset for this major version|
+--------------------+---------+-------+--------------------------------------------------------------------------------------+
|lastUpdaterFullName |M        |String |UserID of the SDC designer who was the last to update the asset for this major version|
+--------------------+---------+-------+--------------------------------------------------------------------------------------+
|category            |M        |String |Category of the asset                                                                 |
+--------------------+---------+-------+--------------------------------------------------------------------------------------+
|subCategory         |M        |String |Sub-category of the asset.                                                            |
+--------------------+---------+-------+--------------------------------------------------------------------------------------+
|toscaResourceName   |M        |String |The full name of the asset                                                            |
+--------------------+---------+-------+--------------------------------------------------------------------------------------+
|resourceType        |M        |String |The type of resource.                                                                 |
+--------------------+---------+-------+--------------------------------------------------------------------------------------+
|lifecycleState      |M        |String |The lifecycle state of the asset                                                      |
+--------------------+---------+-------+--------------------------------------------------------------------------------------+
|resources           |N        |Object |Category of the asset                                                                 |
+--------------------+---------+-------+--------------------------------------------------------------------------------------+
|artifacts           |M        |Object |Category of the asset                                                                 |
+--------------------+---------+-------+--------------------------------------------------------------------------------------+

Resource Object:

+---------------------+---------+-------+-------------------------------------------------------------------------------------------------------------------+
|Attribute            |Qualifier|Content|Description                                                                                                        |                                                                         |
+=====================+=========+=======+===================================================================================================================+
|resourceInstanceName |M        |String |Logical Resource Instance Name.Unique Identifier of  the instance of the  specific resource in the service context.|
+---------------------+---------+-------+-------------------------------------------------------------------------------------------------------------------+
|resourceName         |M        |String |Resource Name                                                                                                      |
+---------------------+---------+-------+-------------------------------------------------------------------------------------------------------------------+
|resourceInvariantUUID|M        |String |The invariant UUID of the resource                                                                                 |
+---------------------+---------+-------+-------------------------------------------------------------------------------------------------------------------+
|resourceVersion      |M        |String |Resource Version                                                                                                   |
+---------------------+---------+-------+-------------------------------------------------------------------------------------------------------------------+
|resoucreType         |M        |String |Resource Type                                                                                                      |
+---------------------+---------+-------+-------------------------------------------------------------------------------------------------------------------+
|resourceUUID         |M        |String |Global UUID of the resource that specific artifact belongs to                                                      |
+---------------------+---------+-------+-------------------------------------------------------------------------------------------------------------------+
|artifacts            |M        |Object |Array of  resource instance deployment artifacts.                                                                  |
+---------------------+---------+-------+-------------------------------------------------------------------------------------------------------------------+

Artifact Metadata Object:

+---------------------+---------+--------+-------------------------------------------------------------------------------------------------------------------+
|Attribute            |Qualifier|Content |Description                                                                                                        |
+=====================+=========+========+===================================================================================================================+
|artifactName         |M        |String  |Artifact File name                                                                                                 |
+---------------------+---------+--------+-------------------------------------------------------------------------------------------------------------------+
|artifactLabel        |M        |String  |Identifier of the artifact within the VF / Service.                                                                |
+---------------------+---------+--------+-------------------------------------------------------------------------------------------------------------------+
|artifactType         |M        |String  |Artifact Type                                                                                                      |
+---------------------+---------+--------+-------------------------------------------------------------------------------------------------------------------+
|artifactGroupType    |M        |String  |Whether the artifact is informational or deployment.                                                               |
+---------------------+---------+--------+-------------------------------------------------------------------------------------------------------------------+
|artifactURL          |M        |String  |Relative artifact’s URL.                                                                                           |
+---------------------+---------+--------+-------------------------------------------------------------------------------------------------------------------+
|artifactDescription  |M        |String  |Artifact Description                                                                                               |
+---------------------+---------+--------+-------------------------------------------------------------------------------------------------------------------+
|artifactTimeout      |N        |Integer |Artifact Description                                                                                               |
+---------------------+---------+--------+-------------------------------------------------------------------------------------------------------------------+
|artifactChecksum     |M        |String  |Base-64 encoded MD5 checksum of the artifact’s payload.                                                            |
+---------------------+---------+--------+-------------------------------------------------------------------------------------------------------------------+
|artifactUUID         |M        |String  |Global UUID generated by SDC each time  when artifact payload is  updated.                                         |
+---------------------+---------+--------+-------------------------------------------------------------------------------------------------------------------+
|artifactVersion      |M        |String  |Service Version                                                                                                    |
+---------------------+---------+--------+-------------------------------------------------------------------------------------------------------------------+
|generatedFromUUID    |N        |String  |This attribute will be  sent only  in the case of  an artifact  generated on basis of  other artifact              |
+---------------------+---------+--------+-------------------------------------------------------------------------------------------------------------------+

Download (CSAR of) Specific Asset
+++++++++++++++++++++++++++++++++

+--------------------+-----------------------------------------------------------+
|Interface Definition|Description                                                |
+====================+===========================================================+
|URI                 |/sdc/v1/catalog/{assetType}/{uuid}/artifacts/{artifactUUID}|
+--------------------+-----------------------------------------------------------+
|Operation Type      |GET                                                        |
+--------------------+-----------------------------------------------------------+

Request Parameters:

+-------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
|Attribute          |Qualifier|Cardinality|Content|Description                                                                          |
+===================+=========+===========+=======+=====================================================================================+
|assetType          |M        |1          |String |The requested asset type.valid values are resources/services.                        |
+-------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
|Uuid               |M        |1          |String |The uuid of the asset as published in the metadata                                   |
+-------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
|artifactUUID       |M        |1          |String |The artifactUUID of the asset as published in the metadata                           |
+-------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+

Response:

+--------------------+---------+--------------------------------------------------------------------------------------------------------------------------+
|Header name         |Qualifier|Description                                                                                                               |
+====================+=========+==========================================================================================================================+
|Content-Type        |M        |Specifies the  downloaded payload format as “ arbitrary data in binary format” .Valid value is : application/octet-stream |
+--------------------+---------+--------------------------------------------------------------------------------------------------------------------------+
|Content-Length      |M        |Streamed artifact payload size                                                                                            |
+--------------------+---------+--------------------------------------------------------------------------------------------------------------------------+
|Content-Disposition |M        |Specifies  the name of  file to  store the  downloaded artifact’s  payload  ( RFC 2183) .                                 |
+--------------------+---------+--------------------------------------------------------------------------------------------------------------------------+

Upload Artifact 
+++++++++++++++

+--------------------+-----------------------------------------------------------------------------------------------+
|Interface Definition|Description                                                                                    |
+====================+===============================================================================================+
|URI                 |/sdc/v1/catalog/{assetType}/{uuid}/resourceInstances/{resourceInstanceNormalizedName}/artifacts|
+--------------------+-----------------------------------------------------------------------------------------------+
|Operation Type      |POST                                                                                           |
+--------------------+-----------------------------------------------------------------------------------------------+

Request Parameters:

+------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
|Attribute                     |Qualifier|Cardinality|Content|Description                                                                          |
+==============================+=========+===========+=======+=====================================================================================+
|assetType                     |M        |1          |String |The requested asset type.valid values are resources/services.                        |
+------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
|Uuid                          |M        |1          |String |The uuid of the asset as published in the metadata                                   |
+------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
|resourceInstanceNormalizedName|M        |1          |String |Normalized name of resource                                                          |
+------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+

Request Body
++++++++++++

+------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
|Attribute                     |Qualifier|Cardinality|Content|Description                                                                          |
+==============================+=========+===========+=======+=====================================================================================+
|payloadData                   |M        |1          |String |The data of the artifact after Base64 encoding                                       |
+------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
|artifactLabel                 |M        |1          |String |Identifier of the artifact within the VF / Service.                                  |
+------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
|artifactName                  |M        |1          |String |The name of the artifact                                                             |
+------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
|artifactType                  |M        |1          |String |The type of the artifact                                                             |
+------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
|artifactGroupType             |M        |1          |String |Whether the artifact is informational or deployment.                                 |
+------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
|description                   |M        |1          |String |Description of the artifact                                                          |
+------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+

Request Headers:

+-------------------+---------+-----------------------------------------------------------------------------------------+
|Header Name        |Qualifier|Description                                                                              |
+===================+=========+=========================================================================================+
|X-ECOMP-RequestID  |N        |request ID.If it is not sent it will be automatically generated by SDC on request receipt|
+-------------------+---------+-----------------------------------------------------------------------------------------+
|X-ECOMP-InstanceID |Y        |Instance ID                                                                              |
+-------------------+---------+-----------------------------------------------------------------------------------------+
|Accept             |N        |Determines the format of the body of the response. Valid values are :  “application/json”|
+-------------------+---------+-----------------------------------------------------------------------------------------+
|Authorization      |Y        |Base64 encoded username:password                                                         |
+-------------------+---------+-----------------------------------------------------------------------------------------+
|USER_ID            |Y        |The user ID of the DCAE Designer. This user must also have Designer role in SDC          |
+-------------------+---------+-----------------------------------------------------------------------------------------+
|Content-Type       |Y        |Valid value is : application/json                                                        |
+-------------------+---------+-----------------------------------------------------------------------------------------+
|Content-MD5        |Y        |The value for this header must be the MD5 checksum over the whole json body              |
+-------------------+---------+-----------------------------------------------------------------------------------------+

Response:

+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
|Attribute           |Qualifier|Content|Description                                                                                        |
+====================+=========+=======+===================================================================================================+
|artifactName        |M        |String |Artifact File name                                                                                 |
+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
|artifactType        |M        |String |Artifact Type                                                                                      |
+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
|artifactURL         |M        |String |Relative artifact’s URL.                                                                           |
+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
|artifactDescription |M        |String |Artifact Description.                                                                              |
+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
|artifactTimeout     |N        |String |Will be populated only if its value is not 0.                                                      |
+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
|artifactChecksum    |Y        |String |Base-64 encoded MD5 checksum of the artifact’s payload.                                            |
+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
|artifactUUID        |Y        |String |Global UUID generated by SDC each time  when artifact payload is  updated.                         |
+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
|artifactVersion     |Y        |String |Service Version .                                                                                  |
+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
|generatedFromUUID   |N        |String |This attribute will be sent only  in the case of an artifact generated on basis of other artifact  |
+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+

Update Artifact  
+++++++++++++++

+--------------------+--------------------------------------------------------------------------------------------------------------+
|Interface Definition|Description                                                                                                   |
+====================+==============================================================================================================+
|URI                 |/sdc/v1/catalog/{assetType}/{uuid}/resourceInstances/{resourceInstanceNormalizedName}/artifacts/{artifactUUID}|
+--------------------+--------------------------------------------------------------------------------------------------------------+
|Operation Type      |POST                                                                                                          |
+--------------------+--------------------------------------------------------------------------------------------------------------+

Request Parameters:

+------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
|Attribute                     |Qualifier|Cardinality|Content|Description                                                                          |
+==============================+=========+===========+=======+=====================================================================================+
|assetType                     |M        |1          |String |The requested asset type.valid values are resources/services.                        |
+------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
|Uuid                          |M        |1          |String |The uuid of the asset as published in the metadata                                   |
+------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
|artifactUUID                  |M        |1          |String |The uuid of the artifact as published in the response of the upload/update operation |
+------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
|resourceInstanceNormalizedName|M        |1          |String |Normalized name of resource                                                          |
+------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+

Request Headers:

+-------------------+---------+-----------------------------------------------------------------------------------------+
|Header Name        |Qualifier|Description                                                                              |
+===================+=========+=========================================================================================+
|X-ECOMP-RequestID  |N        |request ID.If it is not sent it will be automatically generated by SDC on request receipt|
+-------------------+---------+-----------------------------------------------------------------------------------------+
|X-ECOMP-InstanceID |Y        |Instance ID                                                                              |
+-------------------+---------+-----------------------------------------------------------------------------------------+
|Accept             |N        |Determines the format of the body of the response. Valid values are :  “application/json”|
+-------------------+---------+-----------------------------------------------------------------------------------------+
|Authorization      |Y        |Base64 encoded username:password                                                         |
+-------------------+---------+-----------------------------------------------------------------------------------------+
|USER_ID            |Y        |The user ID of the DCAE Designer. This user must also have Designer role in SDC          |
+-------------------+---------+-----------------------------------------------------------------------------------------+
|Content-Type       |Y        |Valid value is : application/json                                                        |
+-------------------+---------+-----------------------------------------------------------------------------------------+
|Content-MD5        |Y        |The value for this header must be the MD5 checksum over the whole json body              |
+-------------------+---------+-----------------------------------------------------------------------------------------+

Request Body:

+------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
|Attribute                     |Qualifier|Cardinality|Content|Description                                                                          |
+==============================+=========+===========+=======+=====================================================================================+
|payloadData                   |M        |1          |String |The data of the artifact after Base64 encoding                                       |
+------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
|artifactLabel                 |M        |1          |String |Identifier of the artifact within the VF / Service.                                  |
+------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
|artifactName                  |M        |1          |String |The name of the artifact                                                             |
+------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
|artifactType                  |M        |1          |String |The type of the artifact                                                             |
+------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
|artifactGroupType             |M        |1          |String |Whether the artifact is informational or deployment.                                 |
+------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
|description                   |M        |1          |String |Description of the artifact                                                          |
+------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+

Response:

+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
|Attribute           |Qualifier|Content|Description                                                                                        |
+====================+=========+=======+===================================================================================================+
|artifactName        |M        |String |Artifact File name                                                                                 |
+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
|artifactType        |M        |String |Artifact Type                                                                                      |
+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
|artifactURL         |M        |String |Relative artifact’s URL.                                                                           |
+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
|artifactDescription |M        |String |Artifact Description.                                                                              |
+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
|artifactTimeout     |N        |String |Will be populated only if its value is not 0.                                                      |
+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
|artifactChecksum    |Y        |String |Base-64 encoded MD5 checksum of the artifact’s payload.                                            |
+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
|artifactUUID        |Y        |String |Global UUID generated by SDC each time  when artifact payload is  updated.                         |
+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
|artifactVersion     |Y        |String |Service Version .                                                                                  |
+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
|generatedFromUUID   |N        |String |This attribute will be sent only  in the case of an artifact generated on basis of other artifact  |
+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+

Delete Artifact   
+++++++++++++++

+--------------------+--------------------------------------------------------------------------------------------------------------+
|Interface Definition|Description                                                                                                   |
+====================+==============================================================================================================+
|URI                 |/sdc/v1/catalog/{assetType}/{uuid}/resourceInstances/{resourceInstanceNormalizedName}/artifacts/{artifactUUID}|
+--------------------+--------------------------------------------------------------------------------------------------------------+
|Operation Type      |DELETE                                                                                                        |
+--------------------+--------------------------------------------------------------------------------------------------------------+

Request Parameters:

+------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
|Attribute                     |Qualifier|Cardinality|Content|Description                                                                          |
+==============================+=========+===========+=======+=====================================================================================+
|assetType                     |M        |1          |String |The requested asset type.valid values are resources/services.                        |
+------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
|Uuid                          |M        |1          |String |The uuid of the asset as published in the metadata                                   |
+------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
|artifactUUID                  |M        |1          |String |The uuid of the artifact as published in the response of the upload/update operation |
+------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+
|resourceInstanceNormalizedName|M        |1          |String |Normalized name of resource                                                          |
+------------------------------+---------+-----------+-------+-------------------------------------------------------------------------------------+

Request Headers:

+-------------------+---------+-----------------------------------------------------------------------------------------+
|Header Name        |Qualifier|Description                                                                              |
+===================+=========+=========================================================================================+
|X-ECOMP-RequestID  |N        |request ID.If it is not sent it will be automatically generated by SDC on request receipt|
+-------------------+---------+-----------------------------------------------------------------------------------------+
|X-ECOMP-InstanceID |Y        |Instance ID                                                                              |
+-------------------+---------+-----------------------------------------------------------------------------------------+
|Accept             |N        |Determines the format of the body of the response. Valid values are :  “application/json”|
+-------------------+---------+-----------------------------------------------------------------------------------------+
|Authorization      |Y        |Base64 encoded username:password                                                         |
+-------------------+---------+-----------------------------------------------------------------------------------------+
|USER_ID            |Y        |The user ID of the DCAE Designer. This user must also have Designer role in SDC          |
+-------------------+---------+-----------------------------------------------------------------------------------------+

Response:

+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
|Attribute           |Qualifier|Content|Description                                                                                        |
+====================+=========+=======+===================================================================================================+
|artifactUUID        |Y        |String |Global UUID generated by SDC each time  when artifact payload is  updated.                         |
+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+

Update Lifecycle   
++++++++++++++++

+--------------------+--------------------------------------------------------------------------------------------------------------+
|Interface Definition|Description                                                                                                   |
+====================+==============================================================================================================+
|URI                 |/sdc/v1/catalog/{assetType}/{uuid}/lifecycleState/{lifecycleOperation}                                        |
+--------------------+--------------------------------------------------------------------------------------------------------------+
|Operation Type      |POST                                                                                                          |
+--------------------+--------------------------------------------------------------------------------------------------------------+

Request Parameters:

+------------------------------+---------+-----------+-------+-----------------------------------------------------------------------------------------------------+
|Attribute                     |Qualifier|Cardinality|Content|Description                                                                                          |
+==============================+=========+===========+=======+=====================================================================================================+
|assetType                     |M        |1          |String |The requested asset type.valid values are resources/services.                                        |
+------------------------------+---------+-----------+-------+-----------------------------------------------------------------------------------------------------+
|Uuid                          |M        |1          |String |The uuid of the asset as published in the metadata                                                   |
+------------------------------+---------+-----------+-------+-----------------------------------------------------------------------------------------------------+
|lifecycleOperation            |M        |1          |String |The lifecycle operation to be performed on the asset.Valid values are: Checkin / Checkout /  Certify |
+------------------------------+---------+-----------+-------+-----------------------------------------------------------------------------------------------------+

Request Headers:

+-------------------+---------+-----------------------------------------------------------------------------------------+
|Header Name        |Qualifier|Description                                                                              |
+===================+=========+=========================================================================================+
|X-ECOMP-RequestID  |N        |request ID.If it is not sent it will be automatically generated by SDC on request receipt|
+-------------------+---------+-----------------------------------------------------------------------------------------+
|X-ECOMP-InstanceID |Y        |Instance ID                                                                              |
+-------------------+---------+-----------------------------------------------------------------------------------------+
|Accept             |N        |Determines the format of the body of the response. Valid values are :  “application/json”|
+-------------------+---------+-----------------------------------------------------------------------------------------+
|Authorization      |Y        |Base64 encoded username:password                                                         |
+-------------------+---------+-----------------------------------------------------------------------------------------+
|USER_ID            |Y        |The user ID of the DCAE Designer. This user must also have Designer role in SDC          |
+-------------------+---------+-----------------------------------------------------------------------------------------+

Request Parameters:

+-------------------+---------+-----------------------------------------------------------------------------------------+
|Attribute          |Qualifier|Description                                                                              |
+===================+=========+=========================================================================================+
|userRemarks        |N        |Short description (free text) about the asset version being changed                      |
+-------------------+---------+-----------------------------------------------------------------------------------------+

Response:

+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
|Attribute           |Qualifier|Content|Description                                                                                        |
+====================+=========+=======+===================================================================================================+
|uuid                |Y        |String |UUID generated by SDC per each major version of the asset                                          |
+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
|invariantUUID       |Y        |String |UUID generated by SDC per each asset. This UUID stays constant for all the asset’s versions        |
+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
|name                |Y        |String |The name of the asset.                                                                             |
+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
|version             |Y        |String |The asset version in SDC catalog                                                                   |
+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
|category            |Y        |String |Category of the asset.                                                                             |
+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
|subcategory         |Y        |String |Sub-category of the asset.                                                                         |
+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
|resourceType        |Y        |String |The type of resource.                                                                              |
+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
|lifecycleState      |Y        |String |The lifecycle state of the asset.                                                                  |
+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
|lastUpdaterUserId   |Y        |String |User ID of the SDC designer who was the last to update the asset for this major version.           |
+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+

Create Resource   
+++++++++++++++

+--------------------+--------------------------------------------------------------------------------------------------------------+
|Interface Definition|Description                                                                                                   |
+====================+==============================================================================================================+
|URI                 |/sdc/v1/catalog/resources                                                                                     |
+--------------------+--------------------------------------------------------------------------------------------------------------+
|Operation Type      |POST                                                                                                          |
+--------------------+--------------------------------------------------------------------------------------------------------------+

Request Headers:

+-------------------+---------+-----------------------------------------------------------------------------------------+
|Header Name        |Qualifier|Description                                                                              |
+===================+=========+=========================================================================================+
|X-ECOMP-RequestID  |N        |request ID.If it is not sent it will be automatically generated by SDC on request receipt|
+-------------------+---------+-----------------------------------------------------------------------------------------+
|X-ECOMP-InstanceID |Y        |Instance ID                                                                              |
+-------------------+---------+-----------------------------------------------------------------------------------------+
|Accept             |N        |Determines the format of the body of the response. Valid values are :  “application/json”|
+-------------------+---------+-----------------------------------------------------------------------------------------+
|Authorization      |Y        |Base64 encoded username:password                                                         |
+-------------------+---------+-----------------------------------------------------------------------------------------+
|USER_ID            |Y        |The user ID of the DCAE Designer. This user must also have Designer role in SDC          |
+-------------------+---------+-----------------------------------------------------------------------------------------+
|Content-Type       |Y        |Valid value is : application/json                                                        |
+-------------------+---------+-----------------------------------------------------------------------------------------+

Request Parameters:

+-------------------+---------+-----------------------------------------------------------------------------------------+
|Attribute          |Qualifier|Description                                                                              |
+===================+=========+=========================================================================================+
|name               |Y        |The name of the resource                                                                 |
+-------------------+---------+-----------------------------------------------------------------------------------------+
|description        |Y        |Short description of the resource                                                        |
+-------------------+---------+-----------------------------------------------------------------------------------------+
|resourceType       |Y        |“VFCMT” / “VF” / “PNF”                                                                   |
+-------------------+---------+-----------------------------------------------------------------------------------------+
|category           |Y        |VFCMT category is “Template”.                                                            |
+-------------------+---------+-----------------------------------------------------------------------------------------+
|subcategory        |Y        |VFCMT subcategory is “Monitoring Template”.                                              |
+-------------------+---------+-----------------------------------------------------------------------------------------+
|vendorName         |Y        |Vendor Name                                                                              |
+-------------------+---------+-----------------------------------------------------------------------------------------+
|vendorRelease      |Y        |Vendor Release                                                                           |
+-------------------+---------+-----------------------------------------------------------------------------------------+
|tags               |Y        |The tags are used for search options.                                                    |
+-------------------+---------+-----------------------------------------------------------------------------------------+
|icon               |Y        |The icon should be pre-defined in SDC.                                                   |
+-------------------+---------+-----------------------------------------------------------------------------------------+
|contactId          |Y        |The user ID of user responsible for this VFCMT.                                          |
+-------------------+---------+-----------------------------------------------------------------------------------------+

Response:

+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
|Attribute           |Qualifier|Content|Description                                                                                        |
+====================+=========+=======+===================================================================================================+
|uuid                |Y        |String |UUID generated by SDC per each major version of the asset                                          |
+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
|invariantUUID       |Y        |String |UUID generated by SDC per each asset. This UUID stays constant for all the asset’s versions        |
+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
|name                |Y        |String |The name of the asset.                                                                             |
+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
|version             |Y        |String |The asset version in SDC catalog                                                                   |
+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
|category            |Y        |String |Category of the asset.                                                                             |
+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
|subcategory         |Y        |String |Sub-category of the asset.                                                                         |
+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
|resourceType        |Y        |String |The type of resource.                                                                              |
+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
|lifecycleState      |Y        |String |The lifecycle state of the asset.                                                                  |
+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+
|lastUpdaterUserId   |Y        |String |User ID of the SDC designer who was the last to update the asset for this major version.           |
+--------------------+---------+-------+---------------------------------------------------------------------------------------------------+

UUI API
----------------
Create E2E service instance
++++++++++++++++++++++++++++

+--------------------+-------------------------------------+
|Interface Definition|Description                          |
+====================+=====================================+
|URI                 |{serverRoot}/e2eServiceInstances/v3  |
+--------------------+-------------------------------------+
|Operation Type      |POST                                 |
+--------------------+-------------------------------------+
|Content-Type        |application/json                     |
+--------------------+-------------------------------------+

Request Body:

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

Service Object 

+----------------+------------------+-------------------------------------------------+
|Attribute       |Content           |Description                                      |
+================+==================+=================================================+
|name            |String            |Service instance name.                           |
+----------------+------------------+-------------------------------------------------+
|description     |String            |Service instance description                     |
+----------------+------------------+-------------------------------------------------+
|serviceDef ID   |String            |The service invariantUUID. It is defined in SDC. |
+----------------+------------------+-------------------------------------------------+
|templateId      |String            |The service Template UUID. It is defined in SDC. |
+----------------+------------------+-------------------------------------------------+
|parameters      |Parameter Object  |Parameter Object                                 |
+----------------+------------------+-------------------------------------------------+

Parameter Object

+----------------------+------------------+-----------------------------------------------------+
|Attribute             |Content           |Description                                          |
+======================+==================+=====================================================+
|globalSubscriberId    |String            |The subscriber id. It is defined in AAI              |
+----------------------+------------------+-----------------------------------------------------+
|subscriberName        |String            |The subscriber name. It is defined in AAI            |
+----------------------+------------------+-----------------------------------------------------+
|serviceType           |String            |The service type. It is defined in AAI               |
+----------------------+------------------+-----------------------------------------------------+
|templateName          |String            |The service Template name                            |
+----------------------+------------------+-----------------------------------------------------+
|resources             |Object            |This field manages parameters of resources           |
+----------------------+------------------+-----------------------------------------------------+
|resourceName          |String            |The resource name                                    |
+----------------------+------------------+-----------------------------------------------------+
|resouceDefId          |String            |The resource invariantUUID. It is defined in SDC.    |
+----------------------+------------------+-----------------------------------------------------+
|resourceId            |String            |The resource UUID. It is defined in SDC.             |
+----------------------+------------------+-----------------------------------------------------+
|nsParameters          |String            |Parameters for current resource object.              |
+----------------------+------------------+-----------------------------------------------------+
|locationConstraints   |String            |The DC location info for each VNF of current service |
+----------------------+------------------+-----------------------------------------------------+
|vnfProfileId          |String            |VNFD id                                              |
+----------------------+------------------+-----------------------------------------------------+
|additionalParamForNs  |String            |The parameter for current resource                   |
+----------------------+------------------+-----------------------------------------------------+


Response:

+-------------+---------+-----------+-------+------------------------------------------------------------------------+
|Attribute    |Qualifier|Cardinality|Content|Description                                                             |
+-------------+---------+-----------+-------+------------------------------------------------------------------------+
|serviceId    |M        |1          |String |Service instance ID.                                                    |
+-------------+---------+-----------+-------+------------------------------------------------------------------------+
|operationId  |M        |1          |String |Service Operation ID.                                                   |
+-------------+---------+-----------+-------+------------------------------------------------------------------------+

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

+--------------------+-----------------------------------------------+
|Interface Definition|Description                                    |
+====================+===============================================+
|URI                 |{serverRoot}/e2eServiceInstances/v3/{serviceId}|
+--------------------+-----------------------------------------------+
|Operation Type      |DELETE                                         |
+--------------------+-----------------------------------------------+

Request Parameters:

+-------------------+---------+-----------+-------+----------------------------------------+
|Attribute          |Qualifier|Cardinality|Content|Description                             |
+===================+=========+===========+=======+========================================+
|globalSubscriberId |M        |1          |String |The subscriber id. It is defined in AAI |
+-------------------+---------+-----------+-------+----------------------------------------+
|serviceType        |M        |1          |String |The service type. It is defined in AAI  |
+-------------------+---------+-----------+-------+----------------------------------------+

Response:

+-------------+---------+-----------+-------+------------------------------------------------------------------------+
|Attribute    |Qualifier|Cardinality|Content|Description                                                             |
+-------------+---------+-----------+-------+------------------------------------------------------------------------+
|operationId  |M        |1          |String |The operation id.                                                       |
+-------------+---------+-----------+-------+------------------------------------------------------------------------+

Query E2E service operation result
++++++++++++++++++++++++++

+--------------------+------------------------------------------------------------------------+
|Interface Definition|Description                                                             |
+====================+========================================================================+
|URI                 |{serverRoot}/e2eServiceInstances/v3/{serviceId}/operations/{operationId}|
+--------------------+------------------------------------------------------------------------+
|Operation Type      |GET                                                                     |
+--------------------+------------------------------------------------------------------------+

Request Parameters:

+--------------+---------+-----------+-------+--------------+
|Attribute     |Qualifier|Cardinality|Content|Description   |
+==============+=========+===========+=======+==============+
|serviceId     |M        |1          |Service instance ID.  |
+--------------+---------+-----------+-------+--------------+
|operationId   |M        |1          |Service Operation ID. |
+--------------+---------+-----------+-------+--------------+

Response:

+------------------+---------+-----------+-------+------------------------------------------------------------------------+
|Attribute         |Qualifier|Cardinality|Content|Description                                                             |
+------------------+---------+-----------+-------+------------------------------------------------------------------------+
|operation         |M        |1          |String |Operation object identify.                                              |
+------------------+---------+-----------+-------+------------------------------------------------------------------------+
|operationId       |M        |1          |String |Operation ID.                                                           |
+------------------+---------+-----------+-------+------------------------------------------------------------------------+
|operation         |M        |1          |String |Operation type, create|delete.                                          |
+------------------+---------+-----------+-------+------------------------------------------------------------------------+
|result            |M        |1          |String |Operation result: finished, error, processing.                          |
+------------------+---------+-----------+-------+------------------------------------------------------------------------+
|reason            |M        |1          |String |If failing, need to write fail reason.                                  |
+------------------+---------+-----------+-------+------------------------------------------------------------------------+
|userId            |M        |1          |String |Operation user ID.                                                      |
+------------------+---------+-----------+-------+------------------------------------------------------------------------+
|operationContent  |M        |1          |String |The status detail of current operation which is being executing.        |
+------------------+---------+-----------+-------+------------------------------------------------------------------------+
|progress          |M        |1          |String |Current operation progress.                                             |
+------------------+---------+-----------+-------+------------------------------------------------------------------------+
|operateAt         |M        |1          |String |Time that it starts to execute operation.                               |
+------------------+---------+-----------+-------+------------------------------------------------------------------------+
|finishedAt        |M        |1          |String |Time that it finished executing operation.                              |
+------------------+---------+-----------+-------+------------------------------------------------------------------------+

Inventory APIs
----------------

create or update an existing service-instance
+++++++++++++++++++++++++++++++++++++++++++++

+--------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Interface Definition|Description                                                                                                                                                         |
+====================+====================================================================================================================================================================+
|URI                 |/business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}|
+--------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Operation Type      |PUT                                                                                                                                                                 |
+--------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+

Request Parameters:

+-------------------+---------+-----------+-------+-----------------------+
|Attribute          |Qualifier|Cardinality|Content|Description            |
+===================+=========+===========+=======+=======================+
|global-customer-id |M        |1          |String |Global Customer ID     |
+-------------------+---------+-----------+-------+-----------------------+
|service-type       |M        |1          |String |Service Type           |
+-------------------+---------+-----------+-------+-----------------------+
|service-instance-id|M        |1          |String |Service Instance ID    |
+-------------------+---------+-----------+-------+-----------------------+

Response:

+---------+---------+-----------+-------+-------------------+
|Attribute|Qualifier|Cardinality|Content|Description        |
+---------+---------+-----------+-------+-------------------+
|HTTP code|M        |1          |Integer|HTTP response code |
+---------+---------+-----------+-------+-------------------+

delete an existing service-instance
+++++++++++++++++++++++++++++++++++

+--------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Interface Definition|Description                                                                                                                                                         |
+====================+====================================================================================================================================================================+
|URI                 |/business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}|
+--------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Operation Type      |DELETE                                                                                                                                                              |
+--------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+

Request Parameters:

+-------------------+---------+-----------+-------+-----------------------+
|Attribute          |Qualifier|Cardinality|Content|Description            |
+===================+=========+===========+=======+=======================+
|global-customer-id |M        |1          |String |Global Customer ID     |
+-------------------+---------+-----------+-------+-----------------------+
|service-type       |M        |1          |String |Service Type           |
+-------------------+---------+-----------+-------+-----------------------+
|service-instance-id|M        |1          |String |Service Instance ID    |
+-------------------+---------+-----------+-------+-----------------------+

Response:

+---------+---------+-----------+-------+-------------------+
|Attribute|Qualifier|Cardinality|Content|Description        |
+---------+---------+-----------+-------+-------------------+
|HTTP code|M        |1          |Integer|HTTP response code |
+---------+---------+-----------+-------+-------------------+

get service-instances
+++++++++++++++++++++

+--------------------+-----------------------------------------------------------------------------------------------------------------------------+
|Interface Definition|Description                                                                                                                  |
+====================+=============================================================================================================================+
|URI                 |/business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances|
+--------------------+-----------------------------------------------------------------------------------------------------------------------------+
|Operation Type      |GET                                                                                                                          |
+--------------------+-----------------------------------------------------------------------------------------------------------------------------+

Request Parameters:

+-------------------+---------+-----------+-------+-----------------------+
|Attribute          |Qualifier|Cardinality|Content|Description            |
+===================+=========+===========+=======+=======================+
|global-customer-id |M        |1          |String |Global Customer ID     |
+-------------------+---------+-----------+-------+-----------------------+
|service-type       |M        |1          |String |Service Type           |
+-------------------+---------+-----------+-------+-----------------------+

Response:

+-----------------+---------+-----------+----------------+-------------------+
|Attribute        |Qualifier|Cardinality|Content         |Description        |
+-----------------+---------+-----------+----------------+-------------------+
|service-instances|M        |1          |ServiceInstances|Service Instances  |
+-----------------+---------+-----------+----------------+-------------------+

get service-instance
++++++++++++++++++++

+--------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Interface Definition|Description                                                                                                                                                         |
+====================+====================================================================================================================================================================+
|URI                 |/business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}|
+--------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Operation Type      |GET                                                                                                                                                                 |
+--------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+

Request Parameters:

+-------------------+---------+-----------+-------+-----------------------+
|Attribute          |Qualifier|Cardinality|Content|Description            |
+===================+=========+===========+=======+=======================+
|global-customer-id |M        |1          |String |Global Customer ID     |
+-------------------+---------+-----------+-------+-----------------------+
|service-type       |M        |1          |String |Service Type           |
+-------------------+---------+-----------+-------+-----------------------+
|service-instance-id|M        |1          |String |Service instance ID    |
+-------------------+---------+-----------+-------+-----------------------+

Response:

+-----------------+---------+-----------+----------------+-------------------+
|Attribute        |Qualifier|Cardinality|Content         |Description        |
+-----------------+---------+-----------+----------------+-------------------+
|service-instance |M        |1          |ServiceInstance |Service Instance   |
+-----------------+---------+-----------+----------------+-------------------+

see node definition for valid relationships
+++++++++++++++++++++++++++++++++++++++++++

+--------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Interface Definition|Description                                                                                                                                                                                        |
+====================+===================================================================================================================================================================================================+
|URI                 |/business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/relationship-list/relationship|
+--------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Operation Type      |PUT                                                                                                                                                                                                |
+--------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

Request Parameters:

+-------------------+---------+-----------+-------+-----------------------+
|Attribute          |Qualifier|Cardinality|Content|Description            |
+===================+=========+===========+=======+=======================+
|global-customer-id |M        |1          |String |Global Customer ID     |
+-------------------+---------+-----------+-------+-----------------------+
|service-type       |M        |1          |String |Service Type           |
+-------------------+---------+-----------+-------+-----------------------+
|service-instance-id|M        |1          |String |Service instance ID    |
+-------------------+---------+-----------+-------+-----------------------+

Response:

+---------+---------+-----------+-------+-------------------+
|Attribute|Qualifier|Cardinality|Content|Description        |
+---------+---------+-----------+-------+-------------------+
|HTTP code|M        |1          |Integer|HTTP response code |
+---------+---------+-----------+-------+-------------------+

delete an existing relationship
+++++++++++++++++++++++++++++++

+--------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Interface Definition|Description                                                                                                                                                                                        |
+====================+===================================================================================================================================================================================================+
|URI                 |/business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/relationship-list/relationship|
+--------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|Operation Type      |DELETE                                                                                                                                                                                             |
+--------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+

Request Parameters:

+-------------------+---------+-----------+-------+-----------------------+
|Attribute          |Qualifier|Cardinality|Content|Description            |
+===================+=========+===========+=======+=======================+
|global-customer-id |M        |1          |String |Global Customer ID     |
+-------------------+---------+-----------+-------+-----------------------+
|service-type       |M        |1          |String |Service Type           |
+-------------------+---------+-----------+-------+-----------------------+
|service-instance-id|M        |1          |String |Service instance ID    |
+-------------------+---------+-----------+-------+-----------------------+

Response:

+---------+---------+-----------+-------+-------------------+
|Attribute|Qualifier|Cardinality|Content|Description        |
+---------+---------+-----------+-------+-------------------+
|HTTP code|M        |1          |Integer|HTTP response code |
+---------+---------+-----------+-------+-------------------+


VFC APIs
---------

Create NS
+++++++++++

+--------------------+-------------------+
|Interface Definition|Description        |
+====================+===================+
|URI                 |/ns                |
+--------------------+-------------------+
|Operation Type      |POST               |
+--------------------+-------------------+
|Content-Type        |application/json   |
+--------------------+-------------------+

Request Parameters:

+-------------------+---------+-----------+-------+-----------------------+
|Attribute          |Qualifier|Cardinality|Content|Description            |
+===================+=========+===========+=======+=======================+
|context            |M        |1          |Object |Context                |
+-------------------+---------+-----------+-------+-----------------------+
|csarId             |M        |1          |String |csarId                 |
+-------------------+---------+-----------+-------+-----------------------+
|nsName             |M        |1          |String |Name of the NS         |
+-------------------+---------+-----------+-------+-----------------------+
|description        |M        |1          |String |description            |
+-------------------+---------+-----------+-------+-----------------------+

Response:

+-----------------+---------+-----------+----------------+-------------------+
|Attribute        |Qualifier|Cardinality|Content         |Description        |
+-----------------+---------+-----------+----------------+-------------------+
|nsInstanceId     |M        |1          |String          |nsInstanceId       |
+-----------------+---------+-----------+----------------+-------------------+

Get NS
+++++++

+--------------------+-------------------+
|Interface Definition|Description        |
+====================+===================+
|URI                 |/ns                |
+--------------------+-------------------+
|Operation Type      |GET                |
+--------------------+-------------------+
|Content-Type        |application/json   |
+--------------------+-------------------+

Response:

+-----------------+---------+-----------+----------------+-------------------+
|Attribute        |Qualifier|Cardinality|Content         |Description        |
+-----------------+---------+-----------+----------------+-------------------+
|nsInstanceId     |M        |1          |String          |nsInstanceId       |
+-----------------+---------+-----------+----------------+-------------------+
|nsName           |M        |1          |String          |The name of ns     |
+-----------------+---------+-----------+----------------+-------------------+
|description      |M        |1          |String          |description        |
+-----------------+---------+-----------+----------------+-------------------+
|nsdId            |M        |1          |String          |ID of ns           |
+-----------------+---------+-----------+----------------+-------------------+
|vnfInfo          |M        |1          |Array           |Vnf information    |
+-----------------+---------+-----------+----------------+-------------------+
|vlInfo           |M        |1          |Array           |vl information     |
+-----------------+---------+-----------+----------------+-------------------+
|vnffgInfo        |M        |1          |Array           |vnffg information  |
+-----------------+---------+-----------+----------------+-------------------+
|nsState          |M        |1          |String          |state of ns        |
+-----------------+---------+-----------+----------------+-------------------+

vnfInfo Object: 

+-----------------+---------+-----------+----------------+-------------------+
|Attribute        |Qualifier|Cardinality|Content         |Description        |
+-----------------+---------+-----------+----------------+-------------------+
|vnfInstanceId    |M        |1          |String          |vnfInstanceId      |
+-----------------+---------+-----------+----------------+-------------------+
|vnfInstanceName  |M        |1          |String          |vnfInstanceName    |
+-----------------+---------+-----------+----------------+-------------------+
|vnfdId           |M        |1          |String          |vnfdId             |
+-----------------+---------+-----------+----------------+-------------------+

vlInfo Object: 

+----------------------+---------+-----------+----------------+-------------------+
|Attribute             |Qualifier|Cardinality|Content         |Description        |
+----------------------+---------+-----------+----------------+-------------------+
|vlInstanceId          |M        |1          |String          |vlInstanceId       |
+----------------------+---------+-----------+----------------+-------------------+
|vlInstanceName        |M        |1          |String          |vlInstanceName     |
+----------------------+---------+-----------+----------------+-------------------+
|vldId                 |M        |1          |String          |vldId              |
+----------------------+---------+-----------+----------------+-------------------+
|relatedCpInstanceId   |M        |1          |Array           |relatedCpInstanceId|
+----------------------+---------+-----------+----------------+-------------------+

relatedCpInstanceId Array: 

+----------------------+---------+-----------+----------------+-------------------+
|Attribute             |Qualifier|Cardinality|Content         |Description        |
+----------------------+---------+-----------+----------------+-------------------+
|cpInstanceId          |M        |1          |String          |cpInstanceId       |
+----------------------+---------+-----------+----------------+-------------------+
|cpInstanceName        |M        |1          |String          |cpInstanceName     |
+----------------------+---------+-----------+----------------+-------------------+
|cpdId                 |M        |1          |String          |cpdId              |
+----------------------+---------+-----------+----------------+-------------------+

vnffgInfo Array:

+----------------------+---------+-----------+----------------+-------------------+
|Attribute             |Qualifier|Cardinality|Content         |Description        |
+----------------------+---------+-----------+----------------+-------------------+
|vnffgInstanceId       |M        |1          |String          |vnffgInstanceId    |
+----------------------+---------+-----------+----------------+-------------------+
|vnfId                 |M        |1          |String          |vnfId              |
+----------------------+---------+-----------+----------------+-------------------+
|pnfId                 |M        |1          |String          |pnfId              |
+----------------------+---------+-----------+----------------+-------------------+
|virtualLinkId         |M        |1          |Array           |virtualLinkId      |
+----------------------+---------+-----------+----------------+-------------------+
|cpId                  |M        |1          |Array           |cpId               |
+----------------------+---------+-----------+----------------+-------------------+
|nfp                   |M        |1          |Array           |nfp                |
+----------------------+---------+-----------+----------------+-------------------+

Instantiate NS
+++++++++++++++

+--------------------+-------------------------------------+
|Interface Definition|Description                          |
+====================+=====================================+
|URI                 |/ns/{nsInstanceId}/Instantiate       |
+--------------------+-------------------------------------+
|Operation Type      |POST                                 |
+--------------------+-------------------------------------+
|Content-Type        |application/json                     |
+--------------------+-------------------------------------+

Request Parameters:

+----------------------+---------+-----------+-------+-----------------------+
|Attribute             |Qualifier|Cardinality|Content|Description            |
+======================+=========+===========+=======+=======================+
|LocationConstraints   |M        |1          |Array  |LocationConstraints    |
+----------------------+---------+-----------+-------+-----------------------+
|additionalParamForNs  |M        |1          |String |additionalParamForNs   |
+----------------------+---------+-----------+-------+-----------------------+
|nsInstanceId          |M        |1          |String |nsInstanceId           |
+----------------------+---------+-----------+-------+-----------------------+

LocationConstraints Array:

+----------------------+---------+-----------+-------+-----------------------+
|Attribute             |Qualifier|Cardinality|Content|Description            |
+======================+=========+===========+=======+=======================+
|vnfProfileId          |M        |1          |String  |vnfProfileId          |
+----------------------+---------+-----------+-------+-----------------------+
|vimid                 |M        |1          |String |vimid                  |
+----------------------+---------+-----------+-------+-----------------------+

Response:

+--------------+---------+-----------+-------+-----------------------+
|Attribute     |Qualifier|Cardinality|Content|Description            |
+==============+=========+===========+=======+=======================+
|jobId         |M        |1          |String |jobId                  |
+--------------+---------+-----------+-------+-----------------------+

Terminate NS
+++++++++++++++

+--------------------+-------------------------------------+
|Interface Definition|Description                          |
+====================+=====================================+
|URI                 |/ns/{ns_instance_id}/terminate       |
+--------------------+-------------------------------------+
|Operation Type      |POST                                 |
+--------------------+-------------------------------------+
|Content-Type        |application/json                     |
+--------------------+-------------------------------------+

Request Parameters:

+----------------------------+---------+-----------+-------+-----------------------------+
|Attribute                   |Qualifier|Cardinality|Content|Description                  |
+============================+=========+===========+=======+=============================+
|terminationType             |M        |1          |String |terminationType              |
+----------------------------+---------+-----------+-------+-----------------------------+
|gracefulTerminationTimeout  |M        |1          |String |gracefulTerminationTimeout   |
+----------------------------+---------+-----------+-------+-----------------------------+
|nsInstanceId                |M        |1          |String |nsInstanceId                 |
+----------------------------+---------+-----------+-------+-----------------------------+

Response:

+--------------+---------+-----------+-------+-----------------------+
|Attribute     |Qualifier|Cardinality|Content|Description            |
+==============+=========+===========+=======+=======================+
|jobId         |M        |1          |String |jobId                  |
+--------------+---------+-----------+-------+-----------------------+

Delete NS
+++++++++++++++

+--------------------+-------------------------------------+
|Interface Definition|Description                          |
+====================+=====================================+
|URI                 |/ns/{ns_instance_id}                 |
+--------------------+-------------------------------------+
|Operation Type      |DELETE                               |
+--------------------+-------------------------------------+

Request Parameters:

+----------------------------+---------+-----------+-------+-----------------------------+
|Attribute                   |Qualifier|Cardinality|Content|Description                  |
+============================+=========+===========+=======+=============================+
|nsInstanceId                |M        |1          |String |nsInstanceId                 |
+----------------------------+---------+-----------+-------+-----------------------------+

MultiVIM API
----------------
Get token
++++++++++

https://developer.openstack.org/api-ref/identity/v3/#password-authentication-with-unscoped-authorization

+--------------------+-----------------------------------------------------------------------------------------------+
|Interface Definition|Description                                                                                    |
+====================+===============================================================================================+
|URI                 |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/identity/v3/auth/tokens     |
+--------------------+-----------------------------------------------------------------------------------------------+
|Operation Type      |POST                                                                                           |
+--------------------+-----------------------------------------------------------------------------------------------+
|Content-Type        |application/json                                                                               |
+--------------------+-----------------------------------------------------------------------------------------------+

Request Body:

+----------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
|Attribute       |Qualifier|Cardinality|Content                   |Description                                                                                                                                     |
+================+=========+===========+==========================+================================================================================================================================================+
|nocatalog       |O        |1          |string                    |The authentication response excludes the service catalog. By default, the response includes the service catalog.                                |
+----------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
|name            |O        |1          |string                    |The user name. Required if you do not specify the ID of the user. If you specify the user name, you must also specify the domain, by ID or name.|
+----------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
|auth            |M        |1          |object                    |An auth object.                                                                                                                                 |
+----------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
|user            |M        |1          |object                    |A user object.                                                                                                                                  |
+----------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
|scope           |O        |1          |string                    |The authorization scope, including either a project or a domain                                                                                 |
+----------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
|password        |M        |1          |object                    |The password object, contains the authentication information.                                                                                   |
+----------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
|id              |O        |1          |string                    |The ID of the user. Required if you do not specify the user name.                                                                               |
+----------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
|identity        |M        |1          |object                    |An identity object.                                                                                                                             |
+----------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+
|methods         |M        |1          |array                     |The authentication method. For password authentication, specify password.                                                                       |
+----------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------------------------------------------------------+

Response:

+-------------------------+------------------+--------------------------------------------------------------------------+
|Attribute                |Content           |Description                                                               |
+=========================+==================+==========================================================================+
|X-Subject-Token          |String            |The authentication token.                                                 |
+-------------------------+------------------+--------------------------------------------------------------------------+
|domain                   |object            |A domain object, containing:                                              |
+-------------------------+------------------+--------------------------------------------------------------------------+
|region_id                |String            |The ID of the region that contains the service endpoint.                  |
+-------------------------+------------------+--------------------------------------------------------------------------+
|methods                  |array             |The authentication method. For password authentication, specify password. |
+-------------------------+------------------+--------------------------------------------------------------------------+
|roles                    |array             |A list of role objects, each containing:                                  |
+-------------------------+------------------+--------------------------------------------------------------------------+
|url                      |String            |The endpoint URL.                                                         |
+-------------------------+------------------+--------------------------------------------------------------------------+
|region                   |String            |The geographic location of the service endpoint.                          |
+-------------------------+------------------+--------------------------------------------------------------------------+
|token                    |object            |A token object.                                                           |
+-------------------------+------------------+--------------------------------------------------------------------------+
|expires_at               |String            |The date and time when the token expires.                                 |
+-------------------------+------------------+--------------------------------------------------------------------------+
|project                  |object            |A project object, containing:                                             |
+-------------------------+------------------+--------------------------------------------------------------------------+
|issued_at                |String            |The date and time when the token was issued.                              |
+-------------------------+------------------+--------------------------------------------------------------------------+
|catalog                  |array             |A catalog object.                                                         |
+-------------------------+------------------+--------------------------------------------------------------------------+
|extras                   |object            |A set of metadata key and value pairs, if any.                            |
+-------------------------+------------------+--------------------------------------------------------------------------+
|user                     |object            |A user object.                                                            |
+-------------------------+------------------+--------------------------------------------------------------------------+
|audit_ids                |array             |A list of one or two audit IDs.                                           |
+-------------------------+------------------+--------------------------------------------------------------------------+
|interface                |String            |The interface type, which describes the visibility of the endpoint.       |
+-------------------------+------------------+--------------------------------------------------------------------------+
|endpoints                |array             |A list of endpoint objects.                                               |
+-------------------------+------------------+--------------------------------------------------------------------------+
|type                     |String            |The endpoint type.                                                        |
+-------------------------+------------------+--------------------------------------------------------------------------+
|id                       |String            |The ID of the user. Required if you do not specify the user name.         |
+-------------------------+------------------+--------------------------------------------------------------------------+
|name                     |String            |The user name.                                                            |
+-------------------------+------------------+--------------------------------------------------------------------------+

Create stack
+++++++++++++

https://developer.openstack.org/api-ref/orchestration/v1/#create-stack

+--------------------+-----------------------------------------------------------------------------------------------+
|Interface Definition|Description                                                                                    |
+====================+===============================================================================================+
|URI                 |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/heat/v1/{tenant-id}/stacks  |
+--------------------+-----------------------------------------------------------------------------------------------+
|Operation Type      |POST                                                                                           |
+--------------------+-----------------------------------------------------------------------------------------------+
|Content-Type        |application/json                                                                               |
+--------------------+-----------------------------------------------------------------------------------------------+

Request Body:

+------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
|Attribute         |Qualifier|Cardinality|Content                   |Description                                                                                      |
+==================+=========+===========+==========================+=================================================================================================+
|tenant_id         |M        |1          |string                    |The UUID of the tenant. A tenant is also known as a project.                                     |
+------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
|disable_rollback  |O        |1          |boolean                   |Enables or disables deletion of all stack resources when stack creation fails.                   |
+------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
|environment       |O        |1          |object                    |A JSON environment for the stack.                                                                |
+------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
|files             |O        |1          |object                    |Supplies the contents of files referenced in the template or the environment.                    |
+------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
|parameters        |O        |1          |object                    |Supplies arguments for parameters defined in the stack template.                                 |
+------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
|stack_name        |M        |1          |string                    |A name for the stack.                                                                            |
+------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
|tags              |O        |1          |string                    |One or more simple string tags to associate with the stack.                                      |
+------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
|template          |O        |1          |object                    |The stack template on which to perform the operation.                                            |
+------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
|template_url      |O        |1          |string                    |A URI to the location containing the stack template on which to perform the operation.           |
+------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
|timeout_mins      |O        |1          |integer                   |The timeout for stack creation in minutes.                                                       |
+------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+

Response:

+-------------------------+------------------+--------------------------------------------------------------------------+
|Attribute                |Content           |Description                                                               |
+=========================+==================+==========================================================================+
|location                 |String            |For asynchronous resource operations.                                     |
+-------------------------+------------------+--------------------------------------------------------------------------+
|X-Openstack-Reqeuest-Id  |object            |A domain object, containing:                                              |
+-------------------------+------------------+--------------------------------------------------------------------------+
|stack                    |String            |The ID of the region that contains the service endpoint.                  |
+-------------------------+------------------+--------------------------------------------------------------------------+
|id                       |String            |The authentication method. For password authentication, specify password. |
+-------------------------+------------------+--------------------------------------------------------------------------+
|links                    |String            |The authentication method. For password authentication, specify password. |
+-------------------------+------------------+--------------------------------------------------------------------------+

Get stack
+++++++++++++

https://developer.openstack.org/api-ref/orchestration/v1/#show-stack-details

+--------------------+-----------------------------------------------------------------------------------------------------------------------+
|Interface Definition|Description                                                                                                            |
+====================+=======================================================================================================================+
|URI                 |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/heat/v1/{tenant-id}/stacks/{stack-name}/{stack-id}  |
+--------------------+-----------------------------------------------------------------------------------------------------------------------+
|Operation Type      |GET                                                                                                                    |
+--------------------+-----------------------------------------------------------------------------------------------------------------------+
|Content-Type        |application/json                                                                                                       |
+--------------------+-----------------------------------------------------------------------------------------------------------------------+

Request Body:

+------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
|Attribute         |Qualifier|Cardinality|Content                   |Description                                                                                      |
+==================+=========+===========+==========================+=================================================================================================+
|tenant_id         |M        |1          |string                    |The UUID of the tenant. A tenant is also known as a project.                                     |
+------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
|stack_name        |M        |1          |string                    |The name of a stack.                                                                             |
+------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
|stack_id          |M        |1          |string                    |The UUID of the stack.                                                                           |
+------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
|resolve_outputs   |O        |1          |boolean                   |A boolean indicating whether the outputs section of a stack should be resolved.                  |
+------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+

Response:

+-------------------------+------------------+------------------------------------------------------------------------------+
|Attribute                |Content           |Description                                                                   |
+=========================+==================+==============================================================================+
|X-Openstack-Reqeuest-Id  |String            |A unique ID for tracking service request.                                     |
+-------------------------+------------------+------------------------------------------------------------------------------+
|stack                    |Object            |The stack object.                                                             |
+-------------------------+------------------+------------------------------------------------------------------------------+
|capabilities             |array             |List of stack capabilities for stack.                                         |
+-------------------------+------------------+------------------------------------------------------------------------------+
|creation_time            |String            |The date and time when the resource was created.                              |
+-------------------------+------------------+------------------------------------------------------------------------------+
|deletion_time            |String            |The date and time when the resource was (soft-) deleted.                      |
+-------------------------+------------------+------------------------------------------------------------------------------+
|description              |String            |The description of the stack resource.                                        |
+-------------------------+------------------+------------------------------------------------------------------------------+
|disable_rollback         |boolean           |Whether deletion of all stack resources when stack creation fails is enabled. |
+-------------------------+------------------+------------------------------------------------------------------------------+
|id                       |String            |The UUID of the stack.                                                        |
+-------------------------+------------------+------------------------------------------------------------------------------+
|links                    |array             |A list of URLs for the stack.                                                 |
+-------------------------+------------------+------------------------------------------------------------------------------+
|notification_topics      |array             |List of notification topics for stack.                                        |
+-------------------------+------------------+------------------------------------------------------------------------------+
|outputs                  |array             |A list of stack outputs.                                                      |
+-------------------------+------------------+------------------------------------------------------------------------------+
|parameters               |object            |	A group of key-value pairs                                                  |
+-------------------------+------------------+------------------------------------------------------------------------------+
|parent                   |String            |The stack ID of the parent stack, if this is a nested stack.                  |
+-------------------------+------------------+------------------------------------------------------------------------------+
|stack_name               |String            |A name for the stack.                                                         |
+-------------------------+------------------+------------------------------------------------------------------------------+
|stack_owner              |String            |The owner of the stack.                                                       |
+-------------------------+------------------+------------------------------------------------------------------------------+
|stack_status             |String            |The status of the stack.                                                      |
+-------------------------+------------------+------------------------------------------------------------------------------+
|stack_status_reason      |String            |The reason for the current status of the stack.                               |
+-------------------------+------------------+------------------------------------------------------------------------------+
|stack_user_project_id    |String            |The project UUID of the stack user.                                           |
+-------------------------+------------------+------------------------------------------------------------------------------+
|tags                     |array             |The stack tags.                                                               |
+-------------------------+------------------+------------------------------------------------------------------------------+
|template_description     |String            |The description of the stack template.                                        |
+-------------------------+------------------+------------------------------------------------------------------------------+
|timeout_mins             |integer           |The timeout for stack creation in minutes.                                    |
+-------------------------+------------------+------------------------------------------------------------------------------+
|updated_time             |String            |The date and time when the object was updated.                                |
+-------------------------+------------------+------------------------------------------------------------------------------+

Delete stack
+++++++++++++

https://developer.openstack.org/api-ref/orchestration/v1/#show-stack-details

+--------------------+-----------------------------------------------------------------------------------------------------------------------+
|Interface Definition|Description                                                                                                            |
+====================+=======================================================================================================================+
|URI                 |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/heat/v1/{tenant-id}/stacks/{stack-name}/{stack-id}  |
+--------------------+-----------------------------------------------------------------------------------------------------------------------+
|Operation Type      |DELETE                                                                                                                 |
+--------------------+-----------------------------------------------------------------------------------------------------------------------+
|Content-Type        |application/json                                                                                                       |
+--------------------+-----------------------------------------------------------------------------------------------------------------------+

Request Body:

+------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
|Attribute         |Qualifier|Cardinality|Content                   |Description                                                                                      |
+==================+=========+===========+==========================+=================================================================================================+
|tenant_id         |M        |1          |string                    |The UUID of the tenant. A tenant is also known as a project.                                     |
+------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
|stack_name        |M        |1          |string                    |The name of a stack.                                                                             |
+------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
|stack_id          |M        |1          |string                    |The UUID of the stack.                                                                           |
+------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+

Create server
+++++++++++++

https://developer.openstack.org/api-ref/compute/#create-server

+--------------------+-----------------------------------------------------------------------------------------------------------------------+
|Interface Definition|Description                                                                                                            |
+====================+=======================================================================================================================+
|URI                 |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/nova/v2.1/{tenant_id}/servers                       |
+--------------------+-----------------------------------------------------------------------------------------------------------------------+
|Operation Type      |POST                                                                                                                   |
+--------------------+-----------------------------------------------------------------------------------------------------------------------+
|Content-Type        |application/json                                                                                                       |
+--------------------+-----------------------------------------------------------------------------------------------------------------------+

Request Body:

+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
|Attribute                                       |Qualifier|Cardinality|Content                   |Description                                                                                      |
+================================================+=========+===========+==========================+=================================================================================================+
|server                                          |M        |1          |object                    |A server object.                                                                                 |
+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
|name                                            |M        |1          |string                    |The server name.                                                                                 |
+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
|flavorRef                                       |M        |1          |string                    |The flavor reference, as an ID (including a UUID) or full URL                                    |
+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
|imageRef                                        |M        |1          |string                    |The UUID of the image to use for your server instance                                            |
+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
|security_groups                                 |O        |1          |array                     |One or more security groups.                                                                     |
+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
|metadata                                        |O        |1          |object                    |Metadata key and value pairs.                                                                    |
+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
|accessIPv4                                      |O        |1          |string                    |IPv4 address that should be used to access this server.                                          |
+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
|accessIPv6                                      |O        |1          |string                    |IPv6 address that should be used to access this server.                                          |
+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
|adminPass                                       |O        |1          |string                    |The administrative password of the server.                                                       |
+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
|user_data                                       |O        |1          |string                    |Configuration information or scripts to use upon launch.                                         |
+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
|availability_zone                               |O        |1          |string                    |The availability zone from which to launch the server.                                           |
+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
|networks                                        |M        |1          |object                    |A networks object.                                                                               |
+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
|networks.uuid                                   |O        |1          |string                    |To provision the server instance with a NIC for a network                                        |
+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
|networks.port                                   |O        |1          |string                    |To provision the server instance with a NIC for an already existing port                         |
+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
|networks.fixed_ip                               |O        |1          |string                    |A fixed IPv4 address for the NIC                                                                 |
+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
|networks.tag                                    |O        |1          |string                    |A device role tag that can be applied to a network interface.                                    |
+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
|personality                                     |O        |1          |array                     |The file path and contents, text only, to inject into the server at launch.                      |
+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
|block_device_mapping_v2                         |O        |1          |array                     |Enables fine grained control of the block device mapping for an instance.                        |
+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
|block_device_mapping_v2.device_name             |M        |1          |string                    |A path to the device for the volume that you want to use to boot the server.                     |
+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
|block_device_mapping_v2.source_type             |M        |1          |string                    |The source type of the volume.                                                                   |
+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
|block_device_mapping_v2.destination_type        |O        |1          |string                    |Defines where the volume comes from.                                                             |
+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
|block_device_mapping_v2.delete_on_termination   |O        |1          |string                    |To delete the boot volume when the server is destroyed, specify true.                            |
+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
|block_device_mapping_v2.guest_format            |M        |1          |string                    |Specifies the guest server disk file system format, such as ephemeral or swap.                   |
+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
|block_device_mapping_v2.boot_index              |M        |1          |string                    |Defines the order in which a hypervisor tries devices                                            |
+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
|block_device_mapping_v2.uuid                    |O        |1          |string                    |This is the uuid of source resource.                                                             |
+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
|block_device_mapping_v2.tag                     |O        |1          |string                    |A device role tag that can be applied to a block device.                                         |
+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
|block_device_mapping_v2.disk_bus                |O        |1          |string                    |Disk bus type, some hypervisors (currently only libvirt) support specify this parameter          |
+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
|config_drive                                    |O        |1          |boolean                   |Indicates whether a configuration drive enables metadata injection.                              |
+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
|key_name                                        |O        |1          |string                    |Key pair name.                                                                                   |
+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
|os:scheduler_hints                              |O        |1          |object                    |The dictionary of data to send to the scheduler.                                                 |
+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
|OS-DCF:diskConfig                               |O        |1          |string                    |Controls how the API partitions the disk when you create, rebuild, or resize servers.            |
+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
|description                                     |O        |1          |string                    |A free form description of the server.                                                           |
+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
|tags                                            |O        |1          |array                     |A list of tags.                                                                                  |
+------------------------------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+

Response:

+-------------------------+------------------+------------------------------------------------------------------------------+
|Attribute                |Content           |Description                                                                   |
+=========================+==================+==============================================================================+
|server                   |object            |A server object.                                                              |
+-------------------------+------------------+------------------------------------------------------------------------------+
|id                       |String            |The UUID of the server.                                                       |
+-------------------------+------------------+------------------------------------------------------------------------------+
|links                    |array             |Links to the resources in question.                                           |
+-------------------------+------------------+------------------------------------------------------------------------------+
|OS-DCF:diskConfig        |String            |Disk configuration.                                                           |
+-------------------------+------------------+------------------------------------------------------------------------------+
|security_groups          |array             |One or more security groups objects.                                          |
+-------------------------+------------------+------------------------------------------------------------------------------+
|security_groups.name     |String            |The security group name.                                                      |
+-------------------------+------------------+------------------------------------------------------------------------------+
|adminPass                |String            |The administrative password for the server.                                   |
+-------------------------+------------------+------------------------------------------------------------------------------+

Delete server
+++++++++++++

https://developer.openstack.org/api-ref/compute/#delete-server

+--------------------+-----------------------------------------------------------------------------------------------------------------------+
|Interface Definition|Description                                                                                                            |
+====================+=======================================================================================================================+
|URI                 |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/nova/v2.1/{tenant_id}/servers/{server_id}           |
+--------------------+-----------------------------------------------------------------------------------------------------------------------+
|Operation Type      |DELETE                                                                                                                 |
+--------------------+-----------------------------------------------------------------------------------------------------------------------+
|Content-Type        |application/json                                                                                                       |
+--------------------+-----------------------------------------------------------------------------------------------------------------------+

Request Body:

+------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
|Attribute         |Qualifier|Cardinality|Content                   |Description                                                                                      |
+==================+=========+===========+==========================+=================================================================================================+
|server_id         |M        |1          |string                    |The UUID of the server.                                                                          |
+------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+

Create Keypair
+++++++++++++++

https://developer.openstack.org/api-ref/compute/#create-or-import-keypair

+--------------------+-----------------------------------------------------------------------------------------------------------------------+
|Interface Definition|Description                                                                                                            |
+====================+=======================================================================================================================+
|URI                 |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/nova/v2.1/{tenant_id}/os-keypairs                   |
+--------------------+-----------------------------------------------------------------------------------------------------------------------+
|Operation Type      |POST                                                                                                                   |
+--------------------+-----------------------------------------------------------------------------------------------------------------------+
|Content-Type        |application/json                                                                                                       |
+--------------------+-----------------------------------------------------------------------------------------------------------------------+

Request Body:

+------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
|Attribute         |Qualifier|Cardinality|Content                   |Description                                                                                      |
+==================+=========+===========+==========================+=================================================================================================+
|keypair           |M        |1          |Object                    |Keypair object                                                                                   |
+------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
|name              |M        |1          |string                    |A name for the keypair which will be used to reference it later.                                 |
+------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
|public_key        |O        |1          |string                    |The public ssh key to import. If you omit this value, a keypair is generated for you.            |
+------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
|type              |O        |1          |string                    |The type of the keypair.                                                                         |
+------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
|user_id           |O        |1          |string                    |The user_id for a keypair.                                                                       |
+------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+

Response:

+-----------------+------------------+------------------------------------------------------------------------------+
|Attribute        |Content           |Description                                                                   |
+=================+==================+==============================================================================+
|keypair          |object            |Keypair object                                                                |
+-----------------+------------------+------------------------------------------------------------------------------+
|name             |String            |A name for the keypair which will be used to reference it later.              |
+-----------------+------------------+------------------------------------------------------------------------------+
|public_key       |String            |The keypair public key.                                                       |
+-----------------+------------------+------------------------------------------------------------------------------+
|fingerprint      |String            |The fingerprint for the keypair.                                              |
+-----------------+------------------+------------------------------------------------------------------------------+
|user_id          |String            |The user_id for a keypair.                                                    |
+-----------------+------------------+------------------------------------------------------------------------------+
|private_key      |String            |If you do not provide a public key on create                                  |
+-----------------+------------------+------------------------------------------------------------------------------+
|type             |String            |The type of the keypair.                                                      |
+-----------------+------------------+------------------------------------------------------------------------------+

Delete Keypair
+++++++++++++++

https://developer.openstack.org/api-ref/compute/#delete-keypair

+--------------------+-----------------------------------------------------------------------------------------------------------------------+
|Interface Definition|Description                                                                                                            |
+====================+=======================================================================================================================+
|URI                 |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/nova/v2.1/{tenant_id}/os-keypairs/{keypair-id}      |
+--------------------+-----------------------------------------------------------------------------------------------------------------------+
|Operation Type      |DELETE                                                                                                                 |
+--------------------+-----------------------------------------------------------------------------------------------------------------------+
|Content-Type        |application/json                                                                                                       |
+--------------------+-----------------------------------------------------------------------------------------------------------------------+

Request Body:

+------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
|Attribute         |Qualifier|Cardinality|Content                   |Description                                                                                      |
+==================+=========+===========+==========================+=================================================================================================+
|keypair_name      |M        |1          |String                    |The keypair name.                                                                                |
+------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
|user_id           |O        |1          |String                    |This allows administrative users to operate key-pairs of specified user ID.                      |
+------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+

Create Network
+++++++++++++++

https://developer.openstack.org/api-ref/network/v2/?expanded=create-network-detail#create-network

+--------------------+-----------------------------------------------------------------------------------------------------------------------+
|Interface Definition|Description                                                                                                            |
+====================+=======================================================================================================================+
|URI                 |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/neutron/v2.0/networks                               |
+--------------------+-----------------------------------------------------------------------------------------------------------------------+
|Operation Type      |POST                                                                                                                   |
+--------------------+-----------------------------------------------------------------------------------------------------------------------+
|Content-Type        |application/json                                                                                                       |
+--------------------+-----------------------------------------------------------------------------------------------------------------------+

Request Body:

+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
|Attribute                   |Qualifier|Cardinality|Content                   |Description                                                                                      |
+============================+=========+===========+==========================+=================================================================================================+
|network                     |M        |1          |Object                    |A network object.                                                                                |
+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
|admin_state_up              |O        |1          |boolean                   |The administrative state of the network, which is up (true) or down (false).                     |
+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
|dns_domain                  |O        |1          |string                    |A valid DNS domain.                                                                              |
+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
|mtu                         |O        |1          |integer                   |The maximum transmission unit (MTU) value to address fragmentation.                              |
+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
|name                        |O        |1          |string                    |Human-readable name of the network.                                                              |
+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
|port_security_enabled       |O        |1          |boolean                   |The port security status of the network.                                                         |
+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
|project_id                  |O        |1          |string                    |The ID of the project that owns the resource.                                                    |
+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
|provider:network_type       |O        |1          |string                    |The type of physical network that this network should be mapped to.                              |
+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
|provider:physical_network   |O        |1          |string                    |The physical network where this network should be implemented.                                   |
+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
|provider:segmentation_id    |O        |1          |integer                   |The ID of the isolated segment on the physical network.                                          |
+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
|qos_policy_id               |O        |1          |string                    |The ID of the QoS policy.                                                                        |
+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
|router:external             |O        |1          |boolean                   |Indicates whether this network can provide floating IPs via a router.                            |
+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
|segments                    |O        |1          |array                     |A list of provider segment objects.                                                              |
+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
|shared                      |O        |1          |boolean                   |Indicates whether this network is shared across all tenants.                                     |
+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
|tenant_id                   |O        |1          |string                    |The ID of the project that owns the resource.                                                    |
+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
|vlan_transparent            |O        |1          |boolean                   |Indicates the VLAN transparency mode of the network,                                             |
+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
|description                 |O        |1          |string                    |A human-readable description for the resource.                                                   |
+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+

Response:

+-----------------------------+------------------+------------------------------------------------------------------------------+
|Attribute                    |Content           |Description                                                                   |
+=============================+==================+==============================================================================+
|network                      |object            |A network object.                                                             |
+-----------------------------+------------------+------------------------------------------------------------------------------+
|admin_state_up               |boolean           |The administrative state of the network, which is up (true) or down (false).  |
+-----------------------------+------------------+------------------------------------------------------------------------------+
|availability_zone_hints      |array             |The availability zone candidate for the network.                              |
+-----------------------------+------------------+------------------------------------------------------------------------------+
|availability_zones           |array             |The availability zone for the network.                                        |
+-----------------------------+------------------+------------------------------------------------------------------------------+
|dns_domain                   |String            |A valid DNS domain.                                                           |
+-----------------------------+------------------+------------------------------------------------------------------------------+
|id                           |String            |The ID of the network.                                                        |
+-----------------------------+------------------+------------------------------------------------------------------------------+
|mtu                          |integer           |The maximum transmission unit (MTU) value to address fragmentation.           |
+-----------------------------+------------------+------------------------------------------------------------------------------+
|name                         |String            |Human-readable name of the network.                                           |
+-----------------------------+------------------+------------------------------------------------------------------------------+
|port_security_enabled        |boolean           |The port security status of the network.                                      |
+-----------------------------+------------------+------------------------------------------------------------------------------+
|project_id                   |String            |The ID of the project.                                                        |
+-----------------------------+------------------+------------------------------------------------------------------------------+
|provider:network_type        |String            |The type of physical network that this network is mapped to.                  |
+-----------------------------+------------------+------------------------------------------------------------------------------+
|provider:physical_network    |String            |The physical network where this network is implemented.                       |
+-----------------------------+------------------+------------------------------------------------------------------------------+
|provider:segmentation_id     |integer           |The ID of the isolated segment on the physical network.                       |
+-----------------------------+------------------+------------------------------------------------------------------------------+
|qos_policy_id                |String            |The ID of the QoS policy.                                                     |
+-----------------------------+------------------+------------------------------------------------------------------------------+
|revision_number              |integer           |The revision number of the resource.                                          |
+-----------------------------+------------------+------------------------------------------------------------------------------+
|router:external              |boolean           |Indicates whether this network can provide floating IPs via a router.         |
+-----------------------------+------------------+------------------------------------------------------------------------------+
|segments                     |array             |A list of provider segment objects.                                           |
+-----------------------------+------------------+------------------------------------------------------------------------------+
|shared                       |boolean           |Indicates whether this network is shared across all tenants.                  |
+-----------------------------+------------------+------------------------------------------------------------------------------+
|status                       |String            |The network status. Values are ACTIVE, DOWN, BUILD or ERROR.                  |
+-----------------------------+------------------+------------------------------------------------------------------------------+
|subnets                      |array             |The associated subnets.                                                       |
+-----------------------------+------------------+------------------------------------------------------------------------------+
|tenant_id                    |String            |The ID of the project.                                                        |
+-----------------------------+------------------+------------------------------------------------------------------------------+
|vlan_transparent             |boolean           |Indicates the VLAN transparency mode of the network.                          |
+-----------------------------+------------------+------------------------------------------------------------------------------+
|description                  |String            |A human-readable description for the resource.                                |
+-----------------------------+------------------+------------------------------------------------------------------------------+

Delete Network
+++++++++++++++

https://developer.openstack.org/api-ref/network/v2/?expanded=create-network-detail#delete-network

+--------------------+-----------------------------------------------------------------------------------------------------------------------+
|Interface Definition|Description                                                                                                            |
+====================+=======================================================================================================================+
|URI                 |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/neutron/v2.0/networks/{network-id}                  |
+--------------------+-----------------------------------------------------------------------------------------------------------------------+
|Operation Type      |DELETE                                                                                                                 |
+--------------------+-----------------------------------------------------------------------------------------------------------------------+
|Content-Type        |application/json                                                                                                       |
+--------------------+-----------------------------------------------------------------------------------------------------------------------+

Request Body:

+----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+
|Attribute                   |Qualifier|Cardinality|Content                   |Description                                                   |
+============================+=========+===========+==========================+==============================================================+
|network_id                  |M        |1          |Object                    |The ID of the network.                                        |
+----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+

Create Subnet
+++++++++++++++

https://developer.openstack.org/api-ref/network/v2/?expanded=create-network-detail,create-subnet-detail#create-subnet

+--------------------+-----------------------------------------------------------------------------------------------------------------------+
|Interface Definition|Description                                                                                                            |
+====================+=======================================================================================================================+
|URI                 |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/neutron/v2.0/subnets                                |
+--------------------+-----------------------------------------------------------------------------------------------------------------------+
|Operation Type      |POST                                                                                                                   |
+--------------------+-----------------------------------------------------------------------------------------------------------------------+
|Content-Type        |application/json                                                                                                       |
+--------------------+-----------------------------------------------------------------------------------------------------------------------+

Request Body:

+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
|Attribute                   |Qualifier|Cardinality|Content                   |Description                                                                                      |
+============================+=========+===========+==========================+=================================================================================================+
|subnet                      |M        |1          |string                    |A subnet object.                                                                                 |
+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
|tenant_id                   |O        |1          |string                    |The ID of the project that owns the resource.                                                    |
+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
|project_id                  |O        |1          |string                    |The ID of the project that owns the resource.                                                    |
+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
|name                        |O        |1          |string                    |Human-readable name of the resource.                                                             |
+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
|enable_dhcp                 |O        |1          |boolean                   |Indicates whether dhcp is enabled or disabled for the subnet.                                    |
+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
|network_id                  |M        |1          |string                    |The ID of the network to which the subnet belongs.                                               |
+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
|dns_nameservers             |O        |1          |array                     |List of dns name servers associated with the subnet.                                             |
+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
|allocation_pools            |O        |1          |array                     |Allocation pools with start and end IP addresses for this subnet.                                |
+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
|host_routes                 |O        |1          |array                     |Additional routes for the subnet.                                                                |
+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
|ip_version                  |M        |1          |integer                   |The IP protocol version. Value is 4 or 6.                                                        |
+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
|gateway_ip                  |O        |1          |string                    |Gateway IP of this subnet.                                                                       |
+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
|cidr                        |M        |1          |string                    |The CIDR of the subnet.                                                                          |
+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
|description                 |O        |1          |string                    |A human-readable description for the resource.                                                   |
+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
|ipv6_address_mode           |O        |1          |string                    |The IPv6 address modes specifies mechanisms for assigning IP addresses.                          |
+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
|ipv6_ra_mode                |O        |1          |string                    |The IPv6 router advertisement specifies whether the networking service                           |
+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
|segment_id                  |O        |1          |string                    |The ID of a network segment the subnet is associated with.                                       |
+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
|subnetpool_id               |O        |1          |string                    |The ID of the subnet pool associated with the subnet.                                            |
+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
|use_default_subnetpool      |O        |1          |boolean                   |Whether to allocate this subnet from the default subnet pool.                                    |
+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+

Response:

+-----------------------------+------------------+------------------------------------------------------------------------------+
|Attribute                    |Content           |Description                                                                   |
+=============================+==================+==============================================================================+
|subnet                       |string            |A subnet object.                                                              |
+-----------------------------+------------------+------------------------------------------------------------------------------+
|id                           |string            |The ID of the subnet.                                                         |
+-----------------------------+------------------+------------------------------------------------------------------------------+
|tenant_id                    |string            |The ID of the project.                                                        |
+-----------------------------+------------------+------------------------------------------------------------------------------+
|project_id                   |string            |The ID of the project.                                                        |
+-----------------------------+------------------+------------------------------------------------------------------------------+
|name                         |String            |Human-readable name of the resource.                                          |
+-----------------------------+------------------+------------------------------------------------------------------------------+
|enable_dhcp                  |boolean           |Indicates whether dhcp is enabled or disabled for the subnet.                 |
+-----------------------------+------------------+------------------------------------------------------------------------------+
|network_id                   |String            |The ID of the network to which the subnet belongs.                            |
+-----------------------------+------------------+------------------------------------------------------------------------------+
|dns_nameservers              |array             |List of dns name servers associated with the subnet.                          |
+-----------------------------+------------------+------------------------------------------------------------------------------+
|allocation_pools             |array             |Allocation pools with start and end IP addresses for this subnet.             |
+-----------------------------+------------------+------------------------------------------------------------------------------+
|host_routes                  |array             |Additional routes for the subnet.                                             |
+-----------------------------+------------------+------------------------------------------------------------------------------+
|ip_version                   |integer           |The IP protocol version. Value is 4 or 6.                                     |
+-----------------------------+------------------+------------------------------------------------------------------------------+
|gateway_ip                   |string            |Gateway IP of this subnet.                                                    |
+-----------------------------+------------------+------------------------------------------------------------------------------+
|cidr                         |string            |The CIDR of the subnet.                                                       |
+-----------------------------+------------------+------------------------------------------------------------------------------+
|created_at                   |string            |Time at which the subnet has been created.                                    |
+-----------------------------+------------------+------------------------------------------------------------------------------+
|description                  |string            |A human-readable description for the resource.                                |
+-----------------------------+------------------+------------------------------------------------------------------------------+
|ipv6_address_mode            |string            |The IPv6 address modes specifies mechanisms for assigning IP addresses.       |
+-----------------------------+------------------+------------------------------------------------------------------------------+
|ipv6_ra_mode                 |string            |The IPv6 router advertisement specifies whether the networking service        |
+-----------------------------+------------------+------------------------------------------------------------------------------+
|revision_number              |integer           |The revision number of the resource.                                          |
+-----------------------------+------------------+------------------------------------------------------------------------------+
|service_types                |string            |The service types associated with the subnet.                                 |
+-----------------------------+------------------+------------------------------------------------------------------------------+
|subnetpool_id                |string            |The ID of the subnet pool associated with the subnet.                         |
+-----------------------------+------------------+------------------------------------------------------------------------------+
|segment_id                   |string            |The ID of a network segment the subnet is associated with.                    |
+-----------------------------+------------------+------------------------------------------------------------------------------+
|updated_at                   |string            |Time at which the subnet has been updated.                                    |
+-----------------------------+------------------+------------------------------------------------------------------------------+

Delete Subnet
+++++++++++++++

https://developer.openstack.org/api-ref/networking/v2/?expanded=create-network-detail,delete-subnet-detail#delete-subnet

+--------------------+-----------------------------------------------------------------------------------------------------------------------+
|Interface Definition|Description                                                                                                            |
+====================+=======================================================================================================================+
|URI                 |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/neutron/v2.0/subnets/{subnet-id}                    |
+--------------------+-----------------------------------------------------------------------------------------------------------------------+
|Operation Type      |DELETE                                                                                                                 |
+--------------------+-----------------------------------------------------------------------------------------------------------------------+
|Content-Type        |application/json                                                                                                       |
+--------------------+-----------------------------------------------------------------------------------------------------------------------+

Request Body:

+----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+
|Attribute                   |Qualifier|Cardinality|Content                   |Description                                                   |
+============================+=========+===========+==========================+==============================================================+
|subnet_id                   |M        |1          |String                    |The ID of the subnet.                                         |
+----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+

Create Port
+++++++++++++++

https://developer.openstack.org/api-ref/networking/v2/#create-port

+--------------------+-----------------------------------------------------------------------------------------------------------------------+
|Interface Definition|Description                                                                                                            |
+====================+=======================================================================================================================+
|URI                 |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/neutron/v2.0/ports                                  |
+--------------------+-----------------------------------------------------------------------------------------------------------------------+
|Operation Type      |POST                                                                                                                   |
+--------------------+-----------------------------------------------------------------------------------------------------------------------+
|Content-Type        |application/json                                                                                                       |
+--------------------+-----------------------------------------------------------------------------------------------------------------------+

Request Body:

+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
|Attribute                   |Qualifier|Cardinality|Content                   |Description                                                                                      |
+============================+=========+===========+==========================+=================================================================================================+
|port                        |M        |1          |object                    |A port object.                                                                                   |
+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
|admin_state_up              |O        |1          |boolean                   |The administrative state of the resource.                                                        |
+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
|allowed_address_pairs       |O        |1          |array                     |A set of zero or more allowed address pairs.                                                     |
+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
|binding:host_id             |O        |1          |string                    |The ID of the host where the port resides.                                                       |
+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
|binding:profile             |O        |1          |string                    |A dictionary that enables the application running on the specific host                           |
+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
|binding:vnic_type           |O        |1          |string                    |The type of vNIC which this port should be attached to.                                          |
+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
|description                 |O        |1          |string                    |A human-readable description for the resource.                                                   |
+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
|device_id                   |O        |1          |string                    |The ID of the device that uses this port.                                                        |
+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
|device_owner                |O        |1          |string                    |The entity type that uses this port.                                                             |
+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
|dns_domain                  |O        |1          |string                    |A valid DNS domain.                                                                              |
+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
|dns_name                    |O        |1          |string                    |A valid DNS name.                                                                                |
+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
|extra_dhcp_opts             |O        |1          |array                     |A set of zero or more extra DHCP option pairs.                                                   |
+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
|fixed_ips                   |O        |1          |array                     |The IP addresses for the port.                                                                   |
+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
|mac_address                 |O        |1          |string                    |The MAC address of the port.                                                                     |
+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
|name                        |O        |1          |string                    |Human-readable name of the resource.                                                             |
+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
|network_id                  |M        |1          |string                    |The ID of the attached network.                                                                  |
+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
|port_security_enabled       |O        |1          |boolean                   |The port security status.                                                                        |
+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
|project_id                  |O        |1          |string                    |The ID of the project that owns the resource.                                                    |
+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
|security_groups             |O        |1          |array                     |The IDs of security groups applied to the port.                                                  |
+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+
|tenant_id                   |O        |1          |string                    |The ID of the project that owns the resource.                                                    |
+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+

Response:

+-----------------------------+------------------+------------------------------------------------------------------------------+
|Attribute                    |Content           |Description                                                                   |
+=============================+==================+==============================================================================+
|port                         |object            |A port object.                                                                |
+-----------------------------+------------------+------------------------------------------------------------------------------+
|admin_state_up               |boolean           |The administrative state of the resource.                                     |
+-----------------------------+------------------+------------------------------------------------------------------------------+
|allowed_address_pairs        |array             |A set of zero or more allowed address pairs.                                  |
+-----------------------------+------------------+------------------------------------------------------------------------------+
|binding:host_id              |string            |The ID of the host where the port resides.                                    |
+-----------------------------+------------------+------------------------------------------------------------------------------+
|binding:profile              |String            |A dictionary that enables the application running on the specific host        |
+-----------------------------+------------------+------------------------------------------------------------------------------+
|binding:vif_details          |object            |A dictionary which contains additional information on the port.               |
+-----------------------------+------------------+------------------------------------------------------------------------------+
|binding:vif_type             |String            |The type of which mechanism is used for the port.                             |
+-----------------------------+------------------+------------------------------------------------------------------------------+
|binding:vnic_type            |string            |The type of vNIC which this port should be attached to.                       |
+-----------------------------+------------------+------------------------------------------------------------------------------+
|created_at                   |string            |Time at which port has been created.                                          |
+-----------------------------+------------------+------------------------------------------------------------------------------+
|data_plane_status            |string            |Status of the underlying data plane of a port.                                |
+-----------------------------+------------------+------------------------------------------------------------------------------+
|description                  |string            |A human-readable description for the resource.                                |
+-----------------------------+------------------+------------------------------------------------------------------------------+
|device_id                    |string            |The ID of the device that uses this port.                                     |
+-----------------------------+------------------+------------------------------------------------------------------------------+
|device_owner                 |string            |The entity type that uses this port.                                          |
+-----------------------------+------------------+------------------------------------------------------------------------------+
|dns_assignment               |object            |Data assigned to a port by the Networking internal DNS                        |
+-----------------------------+------------------+------------------------------------------------------------------------------+
|dns_domain                   |string            |A valid DNS domain.                                                           |
+-----------------------------+------------------+------------------------------------------------------------------------------+
|dns_name                     |string            |A valid DNS name.                                                             |
+-----------------------------+------------------+------------------------------------------------------------------------------+
|extra_dhcp_opts              |array             |A set of zero or more extra DHCP option pairs.                                |
+-----------------------------+------------------+------------------------------------------------------------------------------+
|fixed_ips                    |array             |The IP addresses for the port.                                                |
+-----------------------------+------------------+------------------------------------------------------------------------------+
|id                           |string            |The ID of the resource.                                                       |
+-----------------------------+------------------+------------------------------------------------------------------------------+
|mac_address                  |string            |The MAC address of the port.                                                  |
+-----------------------------+------------------+------------------------------------------------------------------------------+
|name                         |string            |Human-readable name of the resource.                                          |
+-----------------------------+------------------+------------------------------------------------------------------------------+
|network_id                   |string            |The ID of the attached network.                                               |
+-----------------------------+------------------+------------------------------------------------------------------------------+
|port_security_enabled        |boolean           |The port security status.                                                     |
+-----------------------------+------------------+------------------------------------------------------------------------------+
|project_id                   |string            |The ID of the project.                                                        |
+-----------------------------+------------------+------------------------------------------------------------------------------+
|revision_number              |integer           |The revision number of the resource.                                          |
+-----------------------------+------------------+------------------------------------------------------------------------------+
|security_groups              |array             |The IDs of security groups applied to the port.                               |
+-----------------------------+------------------+------------------------------------------------------------------------------+
|status                       |string            |The port status. Values are ACTIVE, DOWN, BUILD and ERROR.                    |
+-----------------------------+------------------+------------------------------------------------------------------------------+
|tenant_id                    |string            |The ID of the project.                                                        |
+-----------------------------+------------------+------------------------------------------------------------------------------+
|updated_at                   |string            |Time at which port has been updated.                                          |
+-----------------------------+------------------+------------------------------------------------------------------------------+

Delete Port
+++++++++++++++

https://developer.openstack.org/api-ref/network/v2/#delete-port

+--------------------+-----------------------------------------------------------------------------------------------------------------------+
|Interface Definition|Description                                                                                                            |
+====================+=======================================================================================================================+
|URI                 |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/neutron/v2.0/ports/{port-id}                        |
+--------------------+-----------------------------------------------------------------------------------------------------------------------+
|Operation Type      |DELETE                                                                                                                 |
+--------------------+-----------------------------------------------------------------------------------------------------------------------+
|Content-Type        |application/json                                                                                                       |
+--------------------+-----------------------------------------------------------------------------------------------------------------------+

Request Body:

+----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+
|Attribute                   |Qualifier|Cardinality|Content                   |Description                                                   |
+============================+=========+===========+==========================+==============================================================+
|port_id                     |M        |1          |String                    |The ID of the port.                                           |
+----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+

Create Security Group
++++++++++++++++++++++

https://developer.openstack.org/api-ref/network/v2/#create-security-group

+--------------------+-----------------------------------------------------------------------------------------------------------------------+
|Interface Definition|Description                                                                                                            |
+====================+=======================================================================================================================+
|URI                 |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/neutron/v2.0/security-groups                        |
+--------------------+-----------------------------------------------------------------------------------------------------------------------+
|Operation Type      |POST                                                                                                                   |
+--------------------+-----------------------------------------------------------------------------------------------------------------------+
|Content-Type        |application/json                                                                                                       |
+--------------------+-----------------------------------------------------------------------------------------------------------------------+

Request Body:

+----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+
|Attribute                   |Qualifier|Cardinality|Content                   |Description                                                   |
+============================+=========+===========+==========================+==============================================================+
|security_group              |M        |1          |object                    |A security_group object.                                      |
+----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+
|tenant_id                   |M        |1          |string                    |The ID of the project.                                        |
+----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+
|project_id                  |M        |1          |string                    |The ID of the project.                                        |
+----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+
|description                 |O        |1          |string                    |A human-readable description for the resource.                |
+----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+
|name                        |M        |1          |string                    |Human-readable name of the resource.                          |
+----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+

Response:

+-----------------------------+------------------+------------------------------------------------------------------------------+
|Attribute                    |Content           |Description                                                                   |
+=============================+==================+==============================================================================+
|security_group               |object            |A security_group object.                                                      |
+-----------------------------+------------------+------------------------------------------------------------------------------+
|id                           |string            |The ID of the security group.                                                 |
+-----------------------------+------------------+------------------------------------------------------------------------------+
|tenant_id                    |string            |The ID of the project.                                                        |
+-----------------------------+------------------+------------------------------------------------------------------------------+
|project_id                   |string            |The ID of the project.                                                        |
+-----------------------------+------------------+------------------------------------------------------------------------------+
|revision_number              |integer           |The revision number of the resource.                                          |
+-----------------------------+------------------+------------------------------------------------------------------------------+
|name                         |string            |Human-readable name of the resource.                                          |
+-----------------------------+------------------+------------------------------------------------------------------------------+
|description                  |string            |A human-readable description for the resource.                                |
+-----------------------------+------------------+------------------------------------------------------------------------------+
|security_group_rules         |array             |A list of security_group_rule objects.                                        |
+-----------------------------+------------------+------------------------------------------------------------------------------+

Delete security group
++++++++++++++++++++++

https://developer.openstack.org/api-ref/network/v2/#delete-security-group

+--------------------+-----------------------------------------------------------------------------------------------------------------------+
|Interface Definition|Description                                                                                                            |
+====================+=======================================================================================================================+
|URI                 |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/neutron/v2.0/security-groups/{security-group-id}    |
+--------------------+-----------------------------------------------------------------------------------------------------------------------+
|Operation Type      |DELETE                                                                                                                 |
+--------------------+-----------------------------------------------------------------------------------------------------------------------+
|Content-Type        |application/json                                                                                                       |
+--------------------+-----------------------------------------------------------------------------------------------------------------------+

Request Body:

+----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+
|Attribute                   |Qualifier|Cardinality|Content                   |Description                                                   |
+============================+=========+===========+==========================+==============================================================+
|security_group_id           |M        |1          |String                    |The ID of the security group.                                 |
+----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+

Create Security Group Rule
++++++++++++++++++++++++++

https://developer.openstack.org/api-ref/network/v2/#create-security-group-rule

+--------------------+-----------------------------------------------------------------------------------------------------------------------+
|Interface Definition|Description                                                                                                            |
+====================+=======================================================================================================================+
|URI                 |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/neutron/v2.0/security-group-rules                   |
+--------------------+-----------------------------------------------------------------------------------------------------------------------+
|Operation Type      |POST                                                                                                                   |
+--------------------+-----------------------------------------------------------------------------------------------------------------------+
|Content-Type        |application/json                                                                                                       |
+--------------------+-----------------------------------------------------------------------------------------------------------------------+

Request Body:

+----------------------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------+
|Attribute                   |Qualifier|Cardinality|Content                   |Description                                                                                     |
+============================+=========+===========+==========================+================================================================================================+
|security_group_rule         |M        |1          |object                    |A security_group_rule object.                                                                   |
+----------------------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------+
|remote_group_id             |O        |1          |string                    |The remote group UUID to associate with this security group rule.                               |
+----------------------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------+
|direction                   |M        |1          |string                    |Ingress or egress, which is the direction in which the metering rule is applied.                |
+----------------------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------+
|protocol                    |M        |1          |string                    |The IP protocol can be represented by a string, an integer, or null.                            |
+----------------------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------+
|ethertype                   |O        |1          |string                    |Must be IPv4 or IPv6, and addresses represented in CIDR must match the ingress or egress rules. |
+----------------------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------+
|port_range_max              |O        |1          |integer                   |The maximum port number in the range that is matched by the security group rule.                |
+----------------------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------+
|security_group_id           |M        |1          |string                    |The security group ID to associate with this security group rule.                               |
+----------------------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------+
|port_range_min              |O        |1          |integer                   |The minimum port number in the range that is matched by the security group rule.                |
+----------------------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------+
|remote_ip_prefix            |M        |1          |string                    |The remote IP prefix to associate with this metering rule packet.                               |
+----------------------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------+
|description                 |O        |1          |string                    |A human-readable description for the resource. Default is an empty string.                      |
+----------------------------+---------+-----------+--------------------------+------------------------------------------------------------------------------------------------+

Response:

+-----------------------------+------------------+-------------------------------------------------------------------------------------------------+
|Attribute                    |Content           |Description                                                                                      |
+=============================+==================+=================================================================================================+
|security_group_rule          |object            |A security_group_rule object.                                                                    |
+-----------------------------+------------------+-------------------------------------------------------------------------------------------------+
|remote_group_id              |string            |The remote group UUID to associate with this security group rule.                                |
+-----------------------------+------------------+-------------------------------------------------------------------------------------------------+
|direction                    |string            |Ingress or egress, which is the direction in which the metering rule is applied.                 |
+-----------------------------+------------------+-------------------------------------------------------------------------------------------------+
|protocol                     |string            |The IP protocol can be represented by a string, an integer, or null.                             |
+-----------------------------+------------------+-------------------------------------------------------------------------------------------------+
|ethertype                    |string            |Must be IPv4 or IPv6, and addresses represented in CIDR must match the ingress or egress rules.  |
+-----------------------------+------------------+-------------------------------------------------------------------------------------------------+
|port_range_max               |integer           |The maximum port number in the range that is matched by the security group rule.                 |
+-----------------------------+------------------+-------------------------------------------------------------------------------------------------+
|security_group_id            |string            |The security group ID to associate with this security group rule.                                |
+-----------------------------+------------------+-------------------------------------------------------------------------------------------------+
|tenant_id                    |string            |The ID of the project.                                                                           |
+-----------------------------+------------------+-------------------------------------------------------------------------------------------------+
|project_id                   |string            |The ID of the project.                                                                           |
+-----------------------------+------------------+-------------------------------------------------------------------------------------------------+
|port_range_min               |integer           |The minimum port number in the range that is matched by the security group rule.                 |
+-----------------------------+------------------+-------------------------------------------------------------------------------------------------+
|remote_ip_prefix             |string            |The remote IP prefix to associate with this metering rule packet.                                |
+-----------------------------+------------------+-------------------------------------------------------------------------------------------------+
|revision_number              |integer           |The revision number of the resource.                                                             |
+-----------------------------+------------------+-------------------------------------------------------------------------------------------------+
|id                           |string            |The ID of the security group rule.                                                               |
+-----------------------------+------------------+-------------------------------------------------------------------------------------------------+
|description                  |string            |A human-readable description for the resource.                                                   |
+-----------------------------+------------------+-------------------------------------------------------------------------------------------------+

Delete security group
++++++++++++++++++++++

https://developer.openstack.org/api-ref/networking/v2/#delete-security-group-rule

+--------------------+---------------------------------------------------------------------------------------------------------------------------------+
|Interface Definition|Description                                                                                                                      |
+====================+=================================================================================================================================+
|URI                 |http://msb.onap.org/api/multicloud/v0/{cloud-owner}_{cloud-region}/neutron/v2.0/security-group-rules/{security-group-rule-id}    |
+--------------------+---------------------------------------------------------------------------------------------------------------------------------+
|Operation Type      |DELETE                                                                                                                           |
+--------------------+---------------------------------------------------------------------------------------------------------------------------------+
|Content-Type        |application/json                                                                                                                 |
+--------------------+---------------------------------------------------------------------------------------------------------------------------------+

Request Body:

+----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+
|Attribute                   |Qualifier|Cardinality|Content                   |Description                                                   |
+============================+=========+===========+==========================+==============================================================+
|security_group_rule_id      |M        |1          |String                    |The ID of the security group rule.                            |
+----------------------------+---------+-----------+--------------------------+--------------------------------------------------------------+

Policy API
----------

Create a dictionary item 
++++++++++++++++++++++++

+--------------------+--------------------------+
|Interface Definition|Description               |
+====================+==========================+
|URI                 |/createDictionaryItem     |
+--------------------+--------------------------+
|Operation Type      |PUT                       |
+--------------------+--------------------------+

Request Parameters:

+-------------------+---------+-----------+-------+-------------------------------------------------------------+
|Attribute          |Qualifier|Cardinality|Content|Description                                                  |
+===================+=========+===========+=======+=============================================================+
|dictionory         |M        |1          |String |                                                             |
+-------------------+---------+-----------+-------+-------------------------------------------------------------+
|dictionaryJson     |M        |1          |String |                                                             |
+-------------------+---------+-----------+-------+-------------------------------------------------------------+
|dictionaryType     |M        |1          |String |                                                             |
+-------------------+---------+-----------+-------+-------------------------------------------------------------+
|requestId          |M        |1          |String |                                                             |
+-------------------+---------+-----------+-------+-------------------------------------------------------------+

Request Headers:

+-------------------+---------+-----------------------------------------------------------------------------------------+
|Header Name        |Qualifier|Description                                                                              |
+===================+=========+=========================================================================================+
|ClientAuth         |Y        |encoded client authentication details                                                    |
+-------------------+---------+-----------------------------------------------------------------------------------------+
|X-ECOMP-RequestID  |N        |Request ID  to track the requests                                                        |
+-------------------+---------+-----------------------------------------------------------------------------------------+
|Environment        |Y        |execution environments                                                                   |
+-------------------+---------+-----------------------------------------------------------------------------------------+
|Authorization      |Y        |Base64 encoded username:password                                                         |
+-------------------+---------+-----------------------------------------------------------------------------------------+

HTTP Response Code:

+------------------+---------------------+
|HTTP CODE         |Description          |
+==================+=====================+
|200               |successful           |
+------------------+---------------------+
|400               |Invalid Request      |
+------------------+---------------------+
|401               |Unauthorized         |
+------------------+---------------------+
|500               |Error                |
+------------------+---------------------+

Create Policy 
+++++++++++++

+--------------------+--------------------------+
|Interface Definition|Description               |
+====================+==========================+
|URI                 |/createPolicy             |
+--------------------+--------------------------+
|Operation Type      |PUT                       |
+--------------------+--------------------------+

Request Parameters:

+-------------------+---------+-----------+-------+-------------------------------------------------------------+
|Attribute          |Qualifier|Cardinality|Content|Description                                                  |
+===================+=========+===========+=======+=============================================================+
|attributes         |M        |1          |Object |set of attributes in key value pair                          |
+-------------------+---------+-----------+-------+-------------------------------------------------------------+
|configBody         |M        |1          |String |                                                             |
+-------------------+---------+-----------+-------+-------------------------------------------------------------+
|configBodyType     |M        |1          |String |                                                             |
+-------------------+---------+-----------+-------+-------------------------------------------------------------+
|configName         |M        |1          |String |                                                             |
+-------------------+---------+-----------+-------+-------------------------------------------------------------+
|ecompName          |M        |1          |String |                                                             |
+-------------------+---------+-----------+-------+-------------------------------------------------------------+
|policyClass        |M        |1          |String |                                                             |
+-------------------+---------+-----------+-------+-------------------------------------------------------------+
|policyConfigType   |M        |1          |String |                                                             |
+-------------------+---------+-----------+-------+-------------------------------------------------------------+
|policyDescription  |M        |1          |String |                                                             |
+-------------------+---------+-----------+-------+-------------------------------------------------------------+
|policyName         |M        |1          |String |                                                             |
+-------------------+---------+-----------+-------+-------------------------------------------------------------+
|requestID          |M        |1          |String |request ID                                                   |
+-------------------+---------+-----------+-------+-------------------------------------------------------------+

Request Headers:

+-------------------+---------+-----------------------------------------------------------------------------------------+
|Header Name        |Qualifier|Description                                                                              |
+===================+=========+=========================================================================================+
|ClientAuth         |Y        |encoded client authentication details                                                    |
+-------------------+---------+-----------------------------------------------------------------------------------------+
|X-ECOMP-RequestID  |N        |Request ID  to track the requests                                                        |
+-------------------+---------+-----------------------------------------------------------------------------------------+
|Environment        |Y        |execution environments                                                                   |
+-------------------+---------+-----------------------------------------------------------------------------------------+
|Authorization      |Y        |Base64 encoded username:password                                                         |
+-------------------+---------+-----------------------------------------------------------------------------------------+

HTTP Response Code:

+------------------+---------------------+
|HTTP CODE         |Description          |
+==================+=====================+
|200               |successful           |
+------------------+---------------------+
|400               |Invalid Request      |
+------------------+---------------------+
|401               |Unauthorized         |
+------------------+---------------------+
|500               |Error                |
+------------------+---------------------+

Delete Policy 
+++++++++++++

+--------------------+--------------------------+
|Interface Definition|Description               |
+====================+==========================+
|URI                 |/deletePolicy             |
+--------------------+--------------------------+
|Operation Type      |DELETE                    |
+--------------------+--------------------------+

Request Parameters:

+-------------------+---------+-----------+-------+-------------------------------------------------------------+
|Attribute          |Qualifier|Cardinality|Content|Description                                                  |
+===================+=========+===========+=======+=============================================================+
|deleteCondition    |M        |1          |String |                                                             |
+-------------------+---------+-----------+-------+-------------------------------------------------------------+
|pdpGroup           |M        |1          |String |                                                             |
+-------------------+---------+-----------+-------+-------------------------------------------------------------+
|policyComponent    |M        |1          |String |                                                             |
+-------------------+---------+-----------+-------+-------------------------------------------------------------+
|policyName         |M        |1          |String |                                                             |
+-------------------+---------+-----------+-------+-------------------------------------------------------------+
|policyType         |M        |1          |String |                                                             |
+-------------------+---------+-----------+-------+-------------------------------------------------------------+
|requestID          |M        |1          |String |request ID                                                   |
+-------------------+---------+-----------+-------+-------------------------------------------------------------+

Request Headers:

+-------------------+---------+-----------------------------------------------------------------------------------------+
|Header Name        |Qualifier|Description                                                                              |
+===================+=========+=========================================================================================+
|ClientAuth         |Y        |encoded client authentication details                                                    |
+-------------------+---------+-----------------------------------------------------------------------------------------+
|X-ECOMP-RequestID  |N        |Request ID  to track the requests                                                        |
+-------------------+---------+-----------------------------------------------------------------------------------------+
|Environment        |Y        |execution environments                                                                   |
+-------------------+---------+-----------------------------------------------------------------------------------------+
|Authorization      |Y        |Base64 encoded username:password                                                         |
+-------------------+---------+-----------------------------------------------------------------------------------------+

HTTP Response Code:

+------------------+---------------------+
|HTTP CODE         |Description          |
+==================+=====================+
|200               |successful           |
+------------------+---------------------+
|400               |Invalid Request      |
+------------------+---------------------+
|401               |Unauthorized         |
+------------------+---------------------+
|500               |Error                |
+------------------+---------------------+

Get Configuration
+++++++++++++++++

+--------------------+--------------------------+
|Interface Definition|Description               |
+====================+==========================+
|URI                 |/getConfig                |
+--------------------+--------------------------+
|Operation Type      |POST                      |
+--------------------+--------------------------+

Request Parameters:

+-------------------+---------+-----------+-------+-------------------------------------------------------------+
|Attribute          |Qualifier|Cardinality|Content|Description                                                  |
+===================+=========+===========+=======+=============================================================+
|configAttributes   |M        |1          |String |                                                             |
+-------------------+---------+-----------+-------+-------------------------------------------------------------+
|configName         |M        |1          |String |                                                             |
+-------------------+---------+-----------+-------+-------------------------------------------------------------+
|ecompName          |M        |1          |String |                                                             |
+-------------------+---------+-----------+-------+-------------------------------------------------------------+
|policyName         |M        |1          |String |                                                             |
+-------------------+---------+-----------+-------+-------------------------------------------------------------+
|unique             |M        |1          |Boolean|                                                             |
+-------------------+---------+-----------+-------+-------------------------------------------------------------+
|requestID          |M        |1          |String |request ID                                                   |
+-------------------+---------+-----------+-------+-------------------------------------------------------------+

Request Headers:

+-------------------+---------+-----------------------------------------------------------------------------------------+
|Header Name        |Qualifier|Description                                                                              |
+===================+=========+=========================================================================================+
|ClientAuth         |Y        |encoded client authentication details                                                    |
+-------------------+---------+-----------------------------------------------------------------------------------------+
|X-ECOMP-RequestID  |N        |Request ID  to track the requests                                                        |
+-------------------+---------+-----------------------------------------------------------------------------------------+
|Environment        |Y        |execution environments                                                                   |
+-------------------+---------+-----------------------------------------------------------------------------------------+
|Authorization      |Y        |Base64 encoded username:password                                                         |
+-------------------+---------+-----------------------------------------------------------------------------------------+

HTTP Response Code:

+------------------+---------------------+
|HTTP CODE         |Description          |
+==================+=====================+
|200               |successful           |
+------------------+---------------------+
|400               |Invalid Request      |
+------------------+---------------------+
|401               |Unauthorized         |
+------------------+---------------------+
|500               |Error                |
+------------------+---------------------+

Get Decision     
++++++++++++     

+--------------------+--------------------------+
|Interface Definition|Description               |
+====================+==========================+
|URI                 |/getDecision              |
+--------------------+--------------------------+
|Operation Type      |POST                      |
+--------------------+--------------------------+

Request Parameters:

+-------------------+---------+-----------+-------+-------------------------------------------------------------+
|Attribute          |Qualifier|Cardinality|Content|Description                                                  |
+===================+=========+===========+=======+=============================================================+
|decisionAttributes |M        |1          |Object |                                                             |
+-------------------+---------+-----------+-------+-------------------------------------------------------------+
|ecompComponentName |M        |1          |String |                                                             |
+-------------------+---------+-----------+-------+-------------------------------------------------------------+
|requestID          |M        |1          |String |request ID                                                   |
+-------------------+---------+-----------+-------+-------------------------------------------------------------+

Request Headers:

+-------------------+---------+-----------------------------------------------------------------------------------------+
|Header Name        |Qualifier|Description                                                                              |
+===================+=========+=========================================================================================+
|ClientAuth         |Y        |encoded client authentication details                                                    |
+-------------------+---------+-----------------------------------------------------------------------------------------+
|X-ECOMP-RequestID  |N        |Request ID  to track the requests                                                        |
+-------------------+---------+-----------------------------------------------------------------------------------------+
|Environment        |Y        |execution environments                                                                   |
+-------------------+---------+-----------------------------------------------------------------------------------------+
|Authorization      |Y        |Base64 encoded username:password                                                         |
+-------------------+---------+-----------------------------------------------------------------------------------------+

HTTP Response Code:

+------------------+---------------------+
|HTTP CODE         |Description          |
+==================+=====================+
|200               |successful           |
+------------------+---------------------+
|400               |Invalid Request      |
+------------------+---------------------+
|401               |Unauthorized         |
+------------------+---------------------+
|500               |Error                |
+------------------+---------------------+

Response Parameters:

+-------------------+---------+-----------+-------+-------------------------------------------------------------+
|Attribute          |Qualifier|Cardinality|Content|Description                                                  |
+===================+=========+===========+=======+=============================================================+
|decision           |N        |1          |String |                                                             |
+-------------------+---------+-----------+-------+-------------------------------------------------------------+
|details            |N        |1          |String |                                                             |
+-------------------+---------+-----------+-------+-------------------------------------------------------------+

Get Dictionary Items
++++++++++++++++++++

+--------------------+--------------------------+
|Interface Definition|Description               |
+====================+==========================+
|URI                 |/getDictionaryItems       |
+--------------------+--------------------------+
|Operation Type      |POST                      |
+--------------------+--------------------------+

Request Parameters:

+-------------------+---------+-----------+-------+-------------------------------------------------------------+
|Attribute          |Qualifier|Cardinality|Content|Description                                                  |
+===================+=========+===========+=======+=============================================================+
|dictionary         |N        |1          |String |                                                             |
+-------------------+---------+-----------+-------+-------------------------------------------------------------+
|dictionaryJson     |N        |1          |String |                                                             |
+-------------------+---------+-----------+-------+-------------------------------------------------------------+
|dictionaryType     |N        |1          |String |                                                             |
+-------------------+---------+-----------+-------+-------------------------------------------------------------+
|requestID          |M        |1          |String |request ID                                                   |
+-------------------+---------+-----------+-------+-------------------------------------------------------------+

Request Headers:

+-------------------+---------+-----------------------------------------------------------------------------------------+
|Header Name        |Qualifier|Description                                                                              |
+===================+=========+=========================================================================================+
|ClientAuth         |Y        |encoded client authentication details                                                    |
+-------------------+---------+-----------------------------------------------------------------------------------------+
|X-ECOMP-RequestID  |N        |Request ID  to track the requests                                                        |
+-------------------+---------+-----------------------------------------------------------------------------------------+
|Environment        |Y        |execution environments                                                                   |
+-------------------+---------+-----------------------------------------------------------------------------------------+
|Authorization      |Y        |Base64 encoded username:password                                                         |
+-------------------+---------+-----------------------------------------------------------------------------------------+

HTTP Response Code:

+------------------+---------------------+
|HTTP CODE         |Description          |
+==================+=====================+
|200               |successful           |
+------------------+---------------------+
|400               |Invalid Request      |
+------------------+---------------------+
|401               |Unauthorized         |
+------------------+---------------------+
|500               |Error                |
+------------------+---------------------+

Response Parameters:

+-------------------+---------+-----------+-------+-------------------------------------------------------------+
|Attribute          |Qualifier|Cardinality|Content|Description                                                  |
+===================+=========+===========+=======+=============================================================+
|dictionaryData     |N        |1          |Object |                                                             |
+-------------------+---------+-----------+-------+-------------------------------------------------------------+
|dictionaryJson     |N        |1          |Object |                                                             |
+-------------------+---------+-----------+-------+-------------------------------------------------------------+
|responseCode       |N        |1          |Integer|                                                             |
+-------------------+---------+-----------+-------+-------------------------------------------------------------+
|responseMessage    |N        |1          |Object |                                                             |
+-------------------+---------+-----------+-------+-------------------------------------------------------------+

Get Metrics         
+++++++++++

+--------------------+--------------------------+
|Interface Definition|Description               |
+====================+==========================+
|URI                 |/getMetrics               |
+--------------------+--------------------------+
|Operation Type      |GET                       |
+--------------------+--------------------------+

Request Headers:

+-------------------+---------+-----------------------------------------------------------------------------------------+
|Header Name        |Qualifier|Description                                                                              |
+===================+=========+=========================================================================================+
|ClientAuth         |Y        |encoded client authentication details                                                    |
+-------------------+---------+-----------------------------------------------------------------------------------------+
|X-ECOMP-RequestID  |N        |Request ID  to track the requests                                                        |
+-------------------+---------+-----------------------------------------------------------------------------------------+
|Environment        |Y        |execution environments                                                                   |
+-------------------+---------+-----------------------------------------------------------------------------------------+
|Authorization      |Y        |Base64 encoded username:password                                                         |
+-------------------+---------+-----------------------------------------------------------------------------------------+

HTTP Response Code:

+------------------+---------------------+
|HTTP CODE         |Description          |
+==================+=====================+
|200               |successful           |
+------------------+---------------------+
|400               |Invalid Request      |
+------------------+---------------------+
|401               |Unauthorized         |
+------------------+---------------------+
|500               |Error                |
+------------------+---------------------+

Response Parameters:

+-------------------+---------+-----------+-------+-------------------------------------------------------------+
|Attribute          |Qualifier|Cardinality|Content|Description                                                  |
+===================+=========+===========+=======+=============================================================+
|metricsTotal       |N        |1          |Integer|                                                             |
+-------------------+---------+-----------+-------+-------------------------------------------------------------+
|papMetrics         |N        |1          |Integer|                                                             |
+-------------------+---------+-----------+-------+-------------------------------------------------------------+
|pdpMetrics         |N        |1          |Integer|                                                             |
+-------------------+---------+-----------+-------+-------------------------------------------------------------+
|responseCode       |N        |1          |Object |                                                             |
+-------------------+---------+-----------+-------+-------------------------------------------------------------+
|responseMessage    |N        |1          |String |                                                             |
+-------------------+---------+-----------+-------+-------------------------------------------------------------+

Get Notification    
++++++++++++++++

+--------------------+--------------------------+
|Interface Definition|Description               |
+====================+==========================+
|URI                 |/getNotification          |
+--------------------+--------------------------+
|Operation Type      |POST                      |
+--------------------+--------------------------+

Request Headers:

+-------------------+---------+-----------------------------------------------------------------------------------------+
|Header Name        |Qualifier|Description                                                                              |
+===================+=========+=========================================================================================+
|ClientAuth         |Y        |encoded client authentication details                                                    |
+-------------------+---------+-----------------------------------------------------------------------------------------+
|X-ECOMP-RequestID  |N        |Request ID  to track the requests                                                        |
+-------------------+---------+-----------------------------------------------------------------------------------------+
|Environment        |Y        |execution environments                                                                   |
+-------------------+---------+-----------------------------------------------------------------------------------------+
|Authorization      |Y        |Base64 encoded username:password                                                         |
+-------------------+---------+-----------------------------------------------------------------------------------------+

HTTP Response Code:

+------------------+---------------------+
|HTTP CODE         |Description          |
+==================+=====================+
|200               |successful           |
+------------------+---------------------+
|400               |Invalid Request      |
+------------------+---------------------+
|401               |Unauthorized         |
+------------------+---------------------+
|500               |Error                |
+------------------+---------------------+

Response Parameters:

+-------------------+---------+-----------+-------+-------------------------------------------------------------+
|Attribute          |Qualifier|Cardinality|Content|Description                                                  |
+===================+=========+===========+=======+=============================================================+
|metricsTotal       |N        |1          |Integer|                                                             |
+-------------------+---------+-----------+-------+-------------------------------------------------------------+
|papMetrics         |N        |1          |Integer|                                                             |
+-------------------+---------+-----------+-------+-------------------------------------------------------------+
|pdpMetrics         |N        |1          |Integer|                                                             |
+-------------------+---------+-----------+-------+-------------------------------------------------------------+
|responseCode       |N        |1          |Object |                                                             |
+-------------------+---------+-----------+-------+-------------------------------------------------------------+
|responseMessage    |N        |1          |String |                                                             |
+-------------------+---------+-----------+-------+-------------------------------------------------------------+

List Configuration  
++++++++++++++++++

+--------------------+--------------------------+
|Interface Definition|Description               |
+====================+==========================+
|URI                 |/listConfiguration        |
+--------------------+--------------------------+
|Operation Type      |POST                      |
+--------------------+--------------------------+

Request Headers:

+-------------------+---------+-----------------------------------------------------------------------------------------+
|Header Name        |Qualifier|Description                                                                              |
+===================+=========+=========================================================================================+
|ClientAuth         |Y        |encoded client authentication details                                                    |
+-------------------+---------+-----------------------------------------------------------------------------------------+
|X-ECOMP-RequestID  |N        |Request ID  to track the requests                                                        |
+-------------------+---------+-----------------------------------------------------------------------------------------+
|Environment        |Y        |execution environments                                                                   |
+-------------------+---------+-----------------------------------------------------------------------------------------+
|Authorization      |Y        |Base64 encoded username:password                                                         |
+-------------------+---------+-----------------------------------------------------------------------------------------+

Request Parameters:

+-------------------+---------+-----------+-------+-------------------------------------------------------------+
|Attribute          |Qualifier|Cardinality|Content|Description                                                  |
+===================+=========+===========+=======+=============================================================+
|configAttributes   |N        |1          |Object |                                                             |
+-------------------+---------+-----------+-------+-------------------------------------------------------------+
|configName         |N        |1          |String |                                                             |
+-------------------+---------+-----------+-------+-------------------------------------------------------------+
|ecompName          |N        |1          |String |                                                             |
+-------------------+---------+-----------+-------+-------------------------------------------------------------+
|policyName         |N        |1          |String |                                                             |
+-------------------+---------+-----------+-------+-------------------------------------------------------------+
|requestID          |N        |1          |String |                                                             |
+-------------------+---------+-----------+-------+-------------------------------------------------------------+
|unique             |N        |1          |Boolean|                                                             |
+-------------------+---------+-----------+-------+-------------------------------------------------------------+

HTTP Response Code:

+------------------+---------------------+
|HTTP CODE         |Description          |
+==================+=====================+
|200               |successful           |
+------------------+---------------------+
|400               |Invalid Request      |
+------------------+---------------------+
|401               |Unauthorized         |
+------------------+---------------------+
|500               |Error                |
+------------------+---------------------+

Import policy
+++++++++++++

+--------------------+--------------------------+
|Interface Definition|Description               |
+====================+==========================+
|URI                 |/policyEngineImport       |
+--------------------+--------------------------+
|Operation Type      |POST                      |
+--------------------+--------------------------+

Request Headers:

+-------------------+---------+-----------------------------------------------------------------------------------------+
|Header Name        |Qualifier|Description                                                                              |
+===================+=========+=========================================================================================+
|ClientAuth         |Y        |encoded client authentication details                                                    |
+-------------------+---------+-----------------------------------------------------------------------------------------+
|X-ECOMP-RequestID  |N        |Request ID  to track the requests                                                        |
+-------------------+---------+-----------------------------------------------------------------------------------------+
|Environment        |Y        |execution environments                                                                   |
+-------------------+---------+-----------------------------------------------------------------------------------------+
|Authorization      |Y        |Base64 encoded username:password                                                         |
+-------------------+---------+-----------------------------------------------------------------------------------------+

Request Parameters:

+-------------------+---------+-----------+-------+-------------------------------------------------------------+
|Attribute          |Qualifier|Cardinality|Content|Description                                                  |
+===================+=========+===========+=======+=============================================================+
|importParameterJson|Y        |1          |String |                                                             |
+-------------------+---------+-----------+-------+-------------------------------------------------------------+
|file               |Y        |1          |File   |                                                             |
+-------------------+---------+-----------+-------+-------------------------------------------------------------+

HTTP Response Code:

+------------------+---------------------+
|HTTP CODE         |Description          |
+==================+=====================+
|200               |successful           |
+------------------+---------------------+
|400               |Invalid Request      |
+------------------+---------------------+
|401               |Unauthorized         |
+------------------+---------------------+
|500               |Error                |
+------------------+---------------------+

Push Policy
+++++++++++

+--------------------+--------------------------+
|Interface Definition|Description               |
+====================+==========================+
|URI                 |/pushPolicy               |
+--------------------+--------------------------+
|Operation Type      |PUT                       |
+--------------------+--------------------------+

Request Headers:

+-------------------+---------+-----------------------------------------------------------------------------------------+
|Header Name        |Qualifier|Description                                                                              |
+===================+=========+=========================================================================================+
|ClientAuth         |Y        |encoded client authentication details                                                    |
+-------------------+---------+-----------------------------------------------------------------------------------------+
|X-ECOMP-RequestID  |N        |Request ID  to track the requests                                                        |
+-------------------+---------+-----------------------------------------------------------------------------------------+
|Environment        |Y        |execution environments                                                                   |
+-------------------+---------+-----------------------------------------------------------------------------------------+
|Authorization      |Y        |Base64 encoded username:password                                                         |
+-------------------+---------+-----------------------------------------------------------------------------------------+

Request Parameters:

+-------------------+---------+-----------+-------+-------------------------------------------------------------+
|Attribute          |Qualifier|Cardinality|Content|Description                                                  |
+===================+=========+===========+=======+=============================================================+
|pdpGroup           |N        |1          |String |                                                             |
+-------------------+---------+-----------+-------+-------------------------------------------------------------+
|policyName         |N        |1          |String |                                                             |
+-------------------+---------+-----------+-------+-------------------------------------------------------------+
|policyType         |N        |1          |String |                                                             |
+-------------------+---------+-----------+-------+-------------------------------------------------------------+

HTTP Response Code:

+------------------+---------------------+
|HTTP CODE         |Description          |
+==================+=====================+
|200               |successful           |
+------------------+---------------------+
|400               |Invalid Request      |
+------------------+---------------------+
|401               |Unauthorized         |
+------------------+---------------------+
|500               |Error                |
+------------------+---------------------+

Send Event 
++++++++++

+--------------------+--------------------------+
|Interface Definition|Description               |
+====================+==========================+
|URI                 |/sendEvent                |
+--------------------+--------------------------+
|Operation Type      |POST                      |
+--------------------+--------------------------+

Request Headers:

+-------------------+---------+-----------------------------------------------------------------------------------------+
|Header Name        |Qualifier|Description                                                                              |
+===================+=========+=========================================================================================+
|ClientAuth         |Y        |encoded client authentication details                                                    |
+-------------------+---------+-----------------------------------------------------------------------------------------+
|X-ECOMP-RequestID  |N        |Request ID  to track the requests                                                        |
+-------------------+---------+-----------------------------------------------------------------------------------------+
|Environment        |Y        |execution environments                                                                   |
+-------------------+---------+-----------------------------------------------------------------------------------------+
|Authorization      |Y        |Base64 encoded username:password                                                         |
+-------------------+---------+-----------------------------------------------------------------------------------------+

Request Parameters:

+-------------------+---------+-----------+-------+-------------------------------------------------------------+
|Attribute          |Qualifier|Cardinality|Content|Description                                                  |
+===================+=========+===========+=======+=============================================================+
|eventAttributes    |N        |1          |Object |                                                             |
+-------------------+---------+-----------+-------+-------------------------------------------------------------+
|requestID          |N        |1          |String |                                                             |
+-------------------+---------+-----------+-------+-------------------------------------------------------------+

HTTP Response Code:

+------------------+---------------------+
|HTTP CODE         |Description          |
+==================+=====================+
|200               |successful           |
+------------------+---------------------+
|400               |Invalid Request      |
+------------------+---------------------+
|401               |Unauthorized         |
+------------------+---------------------+
|500               |Error                |
+------------------+---------------------+

Send Heartbeat
++++++++++++++

+--------------------+--------------------------+
|Interface Definition|Description               |
+====================+==========================+
|URI                 |/sendEvent                |
+--------------------+--------------------------+
|Operation Type      |POST                      |
+--------------------+--------------------------+

Request Headers:

+-------------------+---------+-----------------------------------------------------------------------------------------+
|Header Name        |Qualifier|Description                                                                              |
+===================+=========+=========================================================================================+
|ClientAuth         |Y        |encoded client authentication details                                                    |
+-------------------+---------+-----------------------------------------------------------------------------------------+
|X-ECOMP-RequestID  |N        |Request ID  to track the requests                                                        |
+-------------------+---------+-----------------------------------------------------------------------------------------+
|Environment        |Y        |execution environments                                                                   |
+-------------------+---------+-----------------------------------------------------------------------------------------+
|Authorization      |Y        |Base64 encoded username:password                                                         |
+-------------------+---------+-----------------------------------------------------------------------------------------+

Request Parameters:

+-------------------+---------+-----------+-------+-------------------------------------------------------------+
|Attribute          |Qualifier|Cardinality|Content|Description                                                  |
+===================+=========+===========+=======+=============================================================+
|notificationTopic  |Y        |1          |String |                                                             |
+-------------------+---------+-----------+-------+-------------------------------------------------------------+

HTTP Response Code:

+------------------+---------------------+
|HTTP CODE         |Description          |
+==================+=====================+
|200               |successful           |
+------------------+---------------------+
|400               |Invalid Request      |
+------------------+---------------------+
|401               |Unauthorized         |
+------------------+---------------------+
|500               |Error                |
+------------------+---------------------+

Stop Notification
+++++++++++++++++

+--------------------+--------------------------+
|Interface Definition|Description               |
+====================+==========================+
|URI                 |/stopNotification         |
+--------------------+--------------------------+
|Operation Type      |POST                      |
+--------------------+--------------------------+

Request Headers:

+-------------------+---------+-----------------------------------------------------------------------------------------+
|Header Name        |Qualifier|Description                                                                              |
+===================+=========+=========================================================================================+
|ClientAuth         |Y        |encoded client authentication details                                                    |
+-------------------+---------+-----------------------------------------------------------------------------------------+
|X-ECOMP-RequestID  |N        |Request ID  to track the requests                                                        |
+-------------------+---------+-----------------------------------------------------------------------------------------+
|Environment        |Y        |execution environments                                                                   |
+-------------------+---------+-----------------------------------------------------------------------------------------+
|Authorization      |Y        |Base64 encoded username:password                                                         |
+-------------------+---------+-----------------------------------------------------------------------------------------+

Request Parameters:

+-------------------+---------+-----------+-------+-------------------------------------------------------------+
|Attribute          |Qualifier|Cardinality|Content|Description                                                  |
+===================+=========+===========+=======+=============================================================+
|notificationTopic  |Y        |1          |String |                                                             |
+-------------------+---------+-----------+-------+-------------------------------------------------------------+

HTTP Response Code:

+------------------+---------------------+
|HTTP CODE         |Description          |
+==================+=====================+
|200               |successful           |
+------------------+---------------------+
|400               |Invalid Request      |
+------------------+---------------------+
|401               |Unauthorized         |
+------------------+---------------------+
|500               |Error                |
+------------------+---------------------+

Update Dictionary
+++++++++++++++++

+--------------------+--------------------------+
|Interface Definition|Description               |
+====================+==========================+
|URI                 |/updateDictionaryItem     |
+--------------------+--------------------------+
|Operation Type      |PUT                       |
+--------------------+--------------------------+

Request Headers:

+-------------------+---------+-----------------------------------------------------------------------------------------+
|Header Name        |Qualifier|Description                                                                              |
+===================+=========+=========================================================================================+
|ClientAuth         |Y        |encoded client authentication details                                                    |
+-------------------+---------+-----------------------------------------------------------------------------------------+
|X-ECOMP-RequestID  |N        |Request ID  to track the requests                                                        |
+-------------------+---------+-----------------------------------------------------------------------------------------+
|Environment        |Y        |execution environments                                                                   |
+-------------------+---------+-----------------------------------------------------------------------------------------+
|Authorization      |Y        |Base64 encoded username:password                                                         |
+-------------------+---------+-----------------------------------------------------------------------------------------+

Request Parameters:

+-------------------+---------+-----------+-------+-------------------------------------------------------------+
|Attribute          |Qualifier|Cardinality|Content|Description                                                  |
+===================+=========+===========+=======+=============================================================+
|dictionary         |N        |1          |String |                                                             |
+-------------------+---------+-----------+-------+-------------------------------------------------------------+
|dictionaryJson     |N        |1          |String |                                                             |
+-------------------+---------+-----------+-------+-------------------------------------------------------------+
|dictionaryType     |N        |1          |String |                                                             |
+-------------------+---------+-----------+-------+-------------------------------------------------------------+
|requestID          |N        |1          |String |                                                             |
+-------------------+---------+-----------+-------+-------------------------------------------------------------+

HTTP Response Code:

+------------------+---------------------+
|HTTP CODE         |Description          |
+==================+=====================+
|200               |successful           |
+------------------+---------------------+
|400               |Invalid Request      |
+------------------+---------------------+
|401               |Unauthorized         |
+------------------+---------------------+
|500               |Error                |
+------------------+---------------------+

Update Policy    
+++++++++++++

+--------------------+--------------------------+
|Interface Definition|Description               |
+====================+==========================+
|URI                 |/updatePolicy             |
+--------------------+--------------------------+
|Operation Type      |PUT                       |
+--------------------+--------------------------+

Request Headers:

+-------------------+---------+-----------------------------------------------------------------------------------------+
|Header Name        |Qualifier|Description                                                                              |
+===================+=========+=========================================================================================+
|ClientAuth         |Y        |encoded client authentication details                                                    |
+-------------------+---------+-----------------------------------------------------------------------------------------+
|X-ECOMP-RequestID  |N        |Request ID  to track the requests                                                        |
+-------------------+---------+-----------------------------------------------------------------------------------------+
|Environment        |Y        |execution environments                                                                   |
+-------------------+---------+-----------------------------------------------------------------------------------------+
|Authorization      |Y        |Base64 encoded username:password                                                         |
+-------------------+---------+-----------------------------------------------------------------------------------------+

Request Parameters:

+-------------------+---------+-----------+-------+-------------------------------------------------------------+
|Attribute          |Qualifier|Cardinality|Content|Description                                                  |
+===================+=========+===========+=======+=============================================================+
|attributes         |N        |1          |Object |                                                             |
+-------------------+---------+-----------+-------+-------------------------------------------------------------+
|configBody         |N        |1          |String |                                                             |
+-------------------+---------+-----------+-------+-------------------------------------------------------------+
|configBodyType     |N        |1          |String |                                                             |
+-------------------+---------+-----------+-------+-------------------------------------------------------------+
|configName         |N        |1          |String |                                                             |
+-------------------+---------+-----------+-------+-------------------------------------------------------------+
|ecompName          |N        |1          |String |                                                             |
+-------------------+---------+-----------+-------+-------------------------------------------------------------+
|policyClass        |N        |1          |String |                                                             |
+-------------------+---------+-----------+-------+-------------------------------------------------------------+
|policyConfigType   |N        |1          |String |                                                             |
+-------------------+---------+-----------+-------+-------------------------------------------------------------+
|policyDescription  |N        |1          |String |                                                             |
+-------------------+---------+-----------+-------+-------------------------------------------------------------+
|policyName         |N        |1          |String |                                                             |
+-------------------+---------+-----------+-------+-------------------------------------------------------------+
|requestID          |N        |1          |String |                                                             |
+-------------------+---------+-----------+-------+-------------------------------------------------------------+

HTTP Response Code:

+------------------+---------------------+
|HTTP CODE         |Description          |
+==================+=====================+
|200               |successful           |
+------------------+---------------------+
|400               |Invalid Request      |
+------------------+---------------------+
|401               |Unauthorized         |
+------------------+---------------------+
|500               |Error                |
+------------------+---------------------+