4 "title": "SO Guilin APIs",
14 "name": "e2eServiceInstances"
17 "name": "Onap3gppServiceInstances"
20 "name": "globalhealthcheck"
23 "name": "nodehealthcheck"
26 "name": "onapsoinfraorchestrationRequests"
29 "name": "onapsoinfraorchestrationTasks"
32 "name": "onapsoinfraserviceInstantiation"
35 "name": "onapsoinfratasks"
38 "name": "onapsoinfracloudResources"
41 "name": "onapsoinfracloudResourcesRequests"
44 "name": "onapsoinframodelDistributions"
47 "name": "onapsoinfraworkflowSpecifications"
50 "name": "onapsoinfrainstanceManagement"
54 "/onap/so/infra/e2eServiceInstances/{version}": {
59 "summary": "Create an E2E Service Instance on a version provided",
60 "operationId": "createE2EServiceInstance",
67 "pattern": "[vV][3-5]",
84 "description": "successful operation",
88 "x-codegen-request-body-name": "body"
91 "/onap/so/infra/e2eServiceInstances/{version}/{serviceId}": {
96 "summary": "Update an E2E Service Instance on a version provided and serviceId",
97 "operationId": "updateE2EServiceInstance",
104 "pattern": "[vV][3-5]",
119 "application/json": {
129 "description": "successful operation",
133 "x-codegen-request-body-name": "body"
137 "e2eServiceInstances"
139 "summary": "Delete E2E Service Instance on a specified version and serviceId",
140 "operationId": "deleteE2EServiceInstance",
147 "pattern": "[vV][3-5]",
162 "application/json": {
172 "description": "successful operation",
176 "x-codegen-request-body-name": "body"
179 "/onap/so/infra/e2eServiceInstances/{version}/{serviceId}/{operationType}": {
182 "e2eServiceInstances"
184 "summary": "Activate/Deactivate 5G slice Service on a specified version and serviceId",
185 "operationId": "activateE2EServiceInstances",
192 "pattern": "[vV][3-5]",
205 "name": "operationType",
209 "pattern": "activate/deactivate",
216 "application/json": {
226 "description": "successful operation",
230 "x-codegen-request-body-name": "body"
233 "/onap/so/infra/e2eServiceInstances/{version}/{serviceId}/operations/{operationId}": {
236 "e2eServiceInstances"
238 "summary": "Find e2eServiceInstances Requests for a given serviceId and operationId",
239 "operationId": "getE2EServiceInstances",
254 "pattern": "[vV][3-5]",
259 "name": "operationId",
269 "description": "successful operation",
275 "/onap/so/infra/e2eServiceInstances/{version}/{serviceId}/scale": {
278 "e2eServiceInstances"
280 "summary": "Scale E2E Service Instance on a specified version",
281 "operationId": "scaleE2EServiceInstance",
288 "pattern": "[vV][3-5]",
303 "application/json": {
313 "description": "successful operation",
317 "x-codegen-request-body-name": "body"
320 "/onap/so/infra/e2eServiceInstances/{version}/{serviceId}/modeldifferences": {
323 "e2eServiceInstances"
325 "summary": "Find added and deleted resources of target model for the e2eserviceInstance on a given serviceId",
326 "operationId": "compareModelwithTargetVersion",
341 "pattern": "[vV][3-5]",
348 "application/json": {
358 "description": "successful operation",
362 "x-codegen-request-body-name": "body"
365 "/onap/so/infra/3gppservices/{version}/allocate": {
368 "Onap3gppServiceInstances"
370 "summary": "Create a 3GPP Service Instance on a version provided",
371 "operationId": "allocate3gppService",
378 "pattern": "[vV][1]",
385 "application/json": {
387 "$ref": "#/components/schemas/Allocate3gppService"
395 "description": "successful operation",
397 "application/json": {
399 "$ref": "#/components/schemas/3gppServiceResponse"
405 "x-codegen-request-body-name": "body"
408 "/onap/so/infra/3gppservices/{version}/deAllocate": {
411 "Onap3gppServiceInstances"
413 "summary": "Terminate/Deallocate a 3GPP Service Instance on a version provided",
414 "operationId": "deallocate3gppService",
421 "pattern": "[vV][1]",
428 "application/json": {
430 "$ref": "#/components/schemas/DeAllocate3gppService"
438 "description": "successful operation",
440 "application/json": {
442 "$ref": "#/components/schemas/3gppServiceResponse"
448 "x-codegen-request-body-name": "body"
451 "/onap/so/infra/3gppservices/{version}/modify": {
454 "Onap3gppServiceInstances"
456 "summary": "Modify a 3GPP Service Instance on a version provided",
457 "operationId": "modify3gppService",
464 "pattern": "[vV][1]",
471 "application/json": {
473 "$ref": "#/components/schemas/Modify3gppService"
481 "description": "successful operation",
483 "application/json": {
485 "$ref": "#/components/schemas/3gppServiceResponse"
491 "x-codegen-request-body-name": "body"
494 "/onap/so/infra/3gppservices/{version}/activate": {
497 "Onap3gppServiceInstances"
499 "summary": "Activate a 3GPP Service Instance on a version provided",
500 "operationId": "activate3gppService",
507 "pattern": "[vV][1]",
514 "application/json": {
516 "$ref": "#/components/schemas/3gppServiceActivation"
524 "description": "successful operation",
526 "application/json": {
528 "$ref": "#/components/schemas/3gppServiceResponse"
534 "x-codegen-request-body-name": "body"
537 "/onap/so/infra/3gppservices/{version}/deActivate": {
540 "Onap3gppServiceInstances"
542 "summary": "Deactivate a 3GPP Service Instance on a version provided",
543 "operationId": "deactivate3gppService",
550 "pattern": "[vV][1]",
557 "application/json": {
559 "$ref": "#/components/schemas/3gppServiceActivation"
567 "description": "successful operation",
569 "application/json": {
571 "$ref": "#/components/schemas/3gppServiceResponse"
577 "x-codegen-request-body-name": "body"
580 "/onap/so/infra/3gppservices/{version}/subnetCapabilityQuery": {
583 "Onap3gppServiceInstances"
585 "summary": "Provides subnet capability based on subnet types",
586 "operationId": "querySubnetCapability",
593 "pattern": "[vV][1]",
600 "application/json": {
602 "$ref": "#/components/schemas/QuerySubnetCapability"
610 "description": "successful operation with capabilities for the queried subnetTypes",
612 "application/json": {
620 "x-codegen-request-body-name": "body"
623 "/globalhealthcheck": {
628 "summary": "Performing global health check",
629 "operationId": "globalHealthcheck",
632 "name": "enableBpmn",
642 "description": "successful operation",
648 "/nodehealthcheck": {
653 "summary": "Performing node health check",
654 "operationId": "nodeHealthcheck",
657 "description": "successful operation",
663 "/onap/so/infra/orchestrationRequests/{version}": {
666 "onapsoinfraorchestrationRequests"
668 "summary": "Find Orchestrated Requests for a URI Information",
669 "operationId": "getOrchestrationRequest",
676 "pattern": "[vV][4-7]",
683 "description": "successful operation",
689 "/onap/so/infra/orchestrationRequests/{version}/{requestId}": {
692 "onapsoinfraorchestrationRequests"
694 "summary": "Find Orchestrated Requests for a given requestId",
695 "operationId": "getOrchestrationRequestForReqId",
710 "pattern": "[vV][4-7]",
717 "description": "successful operation",
723 "/onap/so/infra/orchestrationRequests/{version}/{requestId}/unlock": {
726 "onapsoinfraorchestrationRequests"
728 "summary": "Unlock Orchestrated Requests for a given requestId",
729 "operationId": "unlockOrchestrationRequest",
744 "pattern": "[vV][4-7]",
751 "application/json": {
761 "description": "successful operation",
765 "x-codegen-request-body-name": "body"
768 "/onap/so/infra/orchestrationTasks/{version}": {
771 "onapsoinfraorchestrationTasks"
773 "summary": "Get all orchestrationTasks",
774 "operationId": "getAllOrchestrationTasks",
781 "pattern": "[vV][4-7]",
788 "description": "successful operation",
795 "onapsoinfraorchestrationTasks"
797 "summary": "Create an orchestrationTask",
798 "operationId": "createOrchestrationTask",
805 "pattern": "[vV][4-7]",
822 "description": "successful operation",
826 "x-codegen-request-body-name": "body"
829 "/onap/so/infra/orchestrationTasks/{version}/{taskId}": {
832 "onapsoinfraorchestrationTasks"
834 "summary": "Get orchestrationTask for a given taskId",
835 "operationId": "getOrchestrationTask",
850 "pattern": "[vV][4-7]",
857 "description": "successful operation",
864 "onapsoinfraorchestrationTasks"
866 "summary": "update orchestrationTask for a given taskId",
867 "operationId": "updateOrchestrationTask",
882 "pattern": "[vV][4-7]",
899 "description": "successful operation",
903 "x-codegen-request-body-name": "body"
907 "onapsoinfraorchestrationTasks"
909 "summary": "delete orchestrationTask for a given taskId",
910 "operationId": "deleteOrchestrationTask",
925 "pattern": "[vV][4-7]",
932 "description": "successful operation",
938 "/onap/so/infra/orchestrationTasks/{version}/{taskId}/commit": {
941 "onapsoinfraorchestrationTasks"
943 "summary": "commit orchestrationTask for a given taskId",
944 "operationId": "commitOrchestrationTask",
959 "pattern": "[vV][4-7]",
976 "description": "successful operation",
980 "x-codegen-request-body-name": "body"
983 "/onap/so/infra/orchestrationTasks/{version}/{taskId}/abort": {
986 "onapsoinfraorchestrationTasks"
988 "summary": "abort orchestrationTask for a given taskId",
989 "operationId": "abortOrchestrationTask",
1004 "pattern": "[vV][4-7]",
1021 "description": "successful operation",
1025 "x-codegen-request-body-name": "body"
1028 "/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/vnfs/{vnfInstanceId}/vfModules/{vfmoduleInstanceId}/deactivateAndCloudDelete": {
1031 "onapsoinfraserviceInstantiation"
1033 "summary": "Deactivate and Cloud Delete VfModule instance",
1034 "operationId": "deactivateAndCloudDeleteVfModuleInstance",
1041 "pattern": "[vV][7]",
1046 "name": "serviceInstanceId",
1054 "name": "vnfInstanceId",
1062 "name": "vfmoduleInstanceId",
1072 "application/json": {
1082 "description": "successful operation",
1086 "x-codegen-request-body-name": "body"
1089 "/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/configurations/{configurationInstanceId}/enablePort": {
1092 "onapsoinfraserviceInstantiation"
1094 "summary": "Enable Port Mirroring",
1095 "operationId": "enablePort",
1102 "pattern": "[vV][5-7]",
1107 "name": "serviceInstanceId",
1115 "name": "configurationInstanceId",
1125 "application/json": {
1135 "description": "successful operation",
1139 "x-codegen-request-body-name": "body"
1142 "/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/configurations/{configurationInstanceId}/disablePort": {
1145 "onapsoinfraserviceInstantiation"
1147 "summary": "Disable Port Mirroring",
1148 "operationId": "disablePort",
1155 "pattern": "[vV][5-7]",
1160 "name": "serviceInstanceId",
1168 "name": "configurationInstanceId",
1178 "application/json": {
1188 "description": "successful operation",
1192 "x-codegen-request-body-name": "body"
1195 "/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/configurations/{configurationInstanceId}/activate": {
1198 "onapsoinfraserviceInstantiation"
1200 "summary": "Activate Port Mirroring",
1201 "operationId": "activatePort",
1208 "pattern": "[vV][5-7]",
1213 "name": "serviceInstanceId",
1221 "name": "configurationInstanceId",
1231 "application/json": {
1241 "description": "successful operation",
1245 "x-codegen-request-body-name": "body"
1248 "/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/configurations/{configurationInstanceId}/deactivate": {
1251 "onapsoinfraserviceInstantiation"
1253 "summary": "Deactivate Port Mirroring",
1254 "operationId": "deactivatePort",
1261 "pattern": "[vV][5-7]",
1266 "name": "serviceInstanceId",
1274 "name": "configurationInstanceId",
1284 "application/json": {
1294 "description": "successful operation",
1298 "x-codegen-request-body-name": "body"
1301 "/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/addRelationships": {
1304 "onapsoinfraserviceInstantiation"
1306 "summary": "Add Relationships to a Service Instance",
1307 "operationId": "addRelationships",
1314 "pattern": "[vV][6-7]",
1319 "name": "serviceInstanceId",
1329 "application/json": {
1339 "description": "successful operation",
1343 "x-codegen-request-body-name": "body"
1346 "/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/vnfs/{vnfInstanceId}/vfModules/scaleOut": {
1349 "onapsoinfraserviceInstantiation"
1351 "summary": "VF Auto Scale Out",
1352 "operationId": "scaleOutVfModule",
1359 "pattern": "[vV][7]",
1364 "name": "serviceInstanceId",
1372 "name": "vnfInstanceId",
1382 "application/json": {
1392 "description": "successful operation",
1396 "x-codegen-request-body-name": "body"
1399 "/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/vnfs/{vnfInstanceId}/inPlaceSoftwareUpdate": {
1402 "onapsoinfraserviceInstantiation"
1404 "summary": "Perform VNF software update",
1405 "operationId": "inPlaceSoftwareUpdate",
1412 "pattern": "[vV][6-7]",
1417 "name": "serviceInstanceId",
1425 "name": "vnfInstanceId",
1435 "application/json": {
1445 "description": "successful operation",
1449 "x-codegen-request-body-name": "body"
1452 "/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/vnfs/{vnfInstanceId}/applyUpdatedConfig": {
1455 "onapsoinfraserviceInstantiation"
1457 "summary": "Apply updated configuration",
1458 "operationId": "applyUpdatedConfig",
1465 "pattern": "[vV][6-7]",
1470 "name": "serviceInstanceId",
1478 "name": "vnfInstanceId",
1488 "application/json": {
1498 "description": "successful operation",
1502 "x-codegen-request-body-name": "body"
1505 "/onap/so/infra/serviceInstantiation/{version}/serviceInstances": {
1508 "SO service Instantiation"
1510 "summary": "Create a Service Instance on a version provided",
1511 "operationId": "createServiceInstance",
1518 "pattern": "[vV][5-7]",
1525 "application/json": {
1529 "$ref": "#/components/schemas/CreateServiceInstanceParamaters"
1538 "modelInvariantId": "0b1f4362-fed9-45fc-a2e1-6fd3e52f4c1a",
1539 "modelType": "service",
1540 "modelName": "service_test_1",
1541 "modelVersion": "2.0",
1542 "modelVersionId": "beb1259e-dad8-4ee0-a40e-1af20f775d54",
1543 "modelUuid": "beb1259e-dad8-4ee0-a40e-1af20f775d54",
1544 "modelInvariantUuid": "0b1f4362-fed9-45fc-a2e1-6fd3e52f4c1a"
1547 "globalSubscriberId": "basicnf-customer"
1550 "suppressRollback": false,
1551 "productFamilyId": "bb0838ec-2ef7-4382-820f-0d34efdb1ccd",
1552 "requestorId": "Portal",
1553 "instanceName": "ORAN_CU_3",
1557 "projectName": "Project-5GCustomer"
1560 "owningEntityId": "67f2e84c-734d-4e90-a1e4-d2ffa2e75849",
1561 "owningEntityName": "OE-5GCustomer"
1563 "requestParameters": {
1564 "subscriptionServiceType": "5G",
1566 "usePreload": false,
1569 "Homing_Solution": false
1576 "instanceName": "service_test_1",
1581 "modelName": "cu_sim_1901",
1582 "modelVersionId": "40f11fb2-931d-408d-a949-99e9289d3c02",
1583 "modelInvariantUuid": "f6c202d8-94bd-496e-878e-448da0ed0a6a",
1584 "modelVersion": "1.0",
1585 "modelCustomizationId": "5a2eec30-80c5-47cc-9117-3d8659c38202",
1586 "modelInstanceName": "cu_sim_2022 0"
1588 "cloudConfiguration": {
1589 "cloudOwner": "k8scloudowner4",
1590 "lcpCloudRegionId": "k8sregionfour",
1591 "tenantId": "6bbd2981b210461dbc8fe846df1a7808"
1594 "platformName": "test"
1597 "lineOfBusinessName": "LOB-5G"
1599 "productFamilyId": "productFamilyId123",
1600 "instanceName": "CUCP_1",
1607 "modelName": "CuSim1901..helm_cucp..module-1",
1608 "modelVersionId": "9b7723ff-25ac-44af-a7ac-9cfbf2d4285f",
1609 "modelInvariantUuid": "63af164d-9276-4e08-98fb-059d1c5b80e4",
1611 "modelCustomizationId": "b7a0bd1d-4832-4ad3-9199-6e1eab543a45"
1613 "instanceName": "module-1",
1623 "modelVersion": "2.0",
1624 "modelVersionId": "77bea973-570b-4f73-9049-87c37d3de8ca",
1625 "modelInvariantId": "b7a3f00b-8fb2-4791-b0ff-71d83f97ab0b",
1626 "modelName": "service_model",
1627 "modelType": "service"
1641 "modelInvariantId": "040a21d5-b208-490b-9c69-c12ae2b2b958",
1642 "modelName": "ORAN_RU_SIM_Service",
1643 "modelType": "service",
1644 "modelVersion": "2.0",
1645 "modelVersionId": "2f40ddbd-0acc-4e59-8fb3-77a6f84ae28c"
1648 "owningEntityId": "3804b4ac-4d9c-482a-ad0b-5806f8849907",
1649 "owningEntityName": "oran_owner"
1652 "projectName": "oran_project"
1655 "instanceName": "ORAN_RU_SIM",
1656 "productFamilyId": "oran-service",
1657 "requestorId": "PORTAL",
1659 "suppressRollback": false
1661 "requestParameters": {
1663 "subscriptionServiceType": "oran_service",
1666 "Homing_Solution": "none"
1670 "instanceName": "ORAN_RU_SIM_Service_1",
1671 "instanceParams": [],
1673 "modelInvariantId": "040a21d5-b208-490b-9c69-c12ae2b2b958",
1674 "modelName": "ORAN_RU_SIM_Service",
1675 "modelType": "service",
1676 "modelVersion": "2.0",
1677 "modelVersionId": "2f40ddbd-0acc-4e59-8fb3-77a6f84ae28c"
1682 "instanceName": "ORAN_RU_PNF_1",
1683 "instanceParams": [],
1685 "lineOfBusinessName": "oran_lob"
1688 "modelCustomizationId": "5e3a18ce-8bbd-40fc-a197-becca92ac05b",
1689 "modelCustomizationName": "ORAN_RU_PNF_1",
1690 "modelInstanceName": "ORAN_RU_PNF_ORAN_RU_SIM_Service",
1691 "modelInvariantId": "486f38e8-1710-4875-b732-a8b3301a7786",
1692 "modelName": "ORAN_RU_PNF",
1694 "modelVersion": "1.0",
1695 "modelVersionId": "e95310e1-e1d2-471f-aa26-d24849a7e61a"
1698 "platformName": "oran_platform"
1700 "productFamilyId": "oran-service"
1710 "globalSubscriberId": "ORANTownCustomer"
1722 "description": "successful operation",
1726 "x-codegen-request-body-name": "requestBody"
1729 "/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/activate": {
1732 "onapsoinfraserviceInstantiation"
1734 "summary": "Activate provided Service Instance",
1735 "operationId": "activateServiceInstance",
1742 "pattern": "[vV][5-7]",
1747 "name": "serviceInstanceId",
1757 "application/json": {
1767 "description": "successful operation",
1771 "x-codegen-request-body-name": "body"
1774 "/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/deactivate": {
1777 "onapsoinfraserviceInstantiation"
1779 "summary": "Deactivate provided Service Instance",
1780 "operationId": "deactivateServiceInstance",
1787 "pattern": "[vV][5-7]",
1792 "name": "serviceInstanceId",
1802 "application/json": {
1812 "description": "successful operation",
1816 "x-codegen-request-body-name": "body"
1819 "/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}": {
1822 "onapsoinfraserviceInstantiation"
1824 "summary": "Delete provided Service Instance",
1825 "operationId": "deleteServiceInstance",
1832 "pattern": "[vV][5-7]",
1837 "name": "serviceInstanceId",
1847 "application/json": {
1857 "description": "successful operation",
1861 "x-codegen-request-body-name": "body"
1864 "/onap/so/infra/serviceInstantiation/{version}/serviceInstances/assign": {
1867 "onapsoinfraserviceInstantiation"
1869 "summary": "Assign Service Instance",
1870 "operationId": "assignServiceInstance",
1877 "pattern": "[vV][7]",
1884 "application/json": {
1894 "description": "successful operation",
1898 "x-codegen-request-body-name": "body"
1901 "/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/unassign": {
1904 "onapsoinfraserviceInstantiation"
1906 "summary": "Unassign Service Instance",
1907 "operationId": "unassignServiceInstance",
1914 "pattern": "[vV][7]",
1919 "name": "serviceInstanceId",
1929 "application/json": {
1939 "description": "successful operation",
1943 "x-codegen-request-body-name": "body"
1946 "/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/configurations": {
1949 "onapsoinfraserviceInstantiation"
1951 "summary": "Create Port Mirroring Configuration",
1952 "operationId": "createPortConfiguration",
1959 "pattern": "[vV][5-7]",
1964 "name": "serviceInstanceId",
1974 "application/json": {
1984 "description": "successful operation",
1988 "x-codegen-request-body-name": "body"
1991 "/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/configurations/{configurationInstanceId}": {
1994 "onapsoinfraserviceInstantiation"
1996 "summary": "Delete provided Port",
1997 "operationId": "deletePortConfiguration",
2004 "pattern": "[vV][5-7]",
2009 "name": "serviceInstanceId",
2017 "name": "configurationInstanceId",
2027 "application/json": {
2037 "description": "successful operation",
2041 "x-codegen-request-body-name": "body"
2044 "/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/removeRelationships": {
2047 "onapsoinfraserviceInstantiation"
2049 "summary": "Remove Relationships from Service Instance",
2050 "operationId": "removeRelationships",
2057 "pattern": "[vV][6-7]",
2062 "name": "serviceInstanceId",
2072 "application/json": {
2082 "description": "successful operation",
2086 "x-codegen-request-body-name": "body"
2089 "/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/vnfs": {
2092 "onapsoinfraserviceInstantiation"
2094 "summary": "Create VNF on a specified version and serviceInstance",
2095 "operationId": "createVnfInstance",
2102 "pattern": "[vV][5-7]",
2107 "name": "serviceInstanceId",
2117 "application/json": {
2127 "description": "successful operation",
2131 "x-codegen-request-body-name": "body"
2134 "/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/vnfs/{vnfInstanceId}/replace": {
2137 "onapsoinfraserviceInstantiation"
2139 "summary": "Replace provided VNF instance",
2140 "operationId": "replaceVnfInstance",
2147 "pattern": "[vV][5-7]",
2152 "name": "serviceInstanceId",
2160 "name": "vnfInstanceId",
2170 "application/json": {
2180 "description": "successful operation",
2184 "x-codegen-request-body-name": "body"
2187 "/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/vnfs/{vnfInstanceId}": {
2190 "onapsoinfraserviceInstantiation"
2192 "summary": "Update VNF on a specified version, serviceInstance and vnfInstance",
2193 "operationId": "updateVnfInstance",
2200 "pattern": "[vV][5-7]",
2205 "name": "serviceInstanceId",
2213 "name": "vnfInstanceId",
2223 "application/json": {
2233 "description": "successful operation",
2237 "x-codegen-request-body-name": "body"
2241 "onapsoinfraserviceInstantiation"
2243 "summary": "Delete provided VNF instance",
2244 "operationId": "deleteVnfInstance",
2251 "pattern": "[vV][5-7]",
2256 "name": "serviceInstanceId",
2264 "name": "vnfInstanceId",
2274 "application/json": {
2284 "description": "successful operation",
2288 "x-codegen-request-body-name": "body"
2291 "/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/vnfs/{vnfInstanceId}/vfModules": {
2294 "onapsoinfraserviceInstantiation"
2296 "summary": "Create VfModule on a specified version, serviceInstance and vnfInstance",
2297 "operationId": "createVfModuleInstance",
2304 "pattern": "[vV][5-7]",
2309 "name": "serviceInstanceId",
2317 "name": "vnfInstanceId",
2327 "application/json": {
2337 "description": "successful operation",
2341 "x-codegen-request-body-name": "body"
2344 "/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/vnfs/{vnfInstanceId}/vfModules/{vfmoduleInstanceId}/replace": {
2347 "onapsoinfraserviceInstantiation"
2349 "summary": "Create VfModule on a specified version, serviceInstance and vnfInstance",
2350 "operationId": "replaceVfModuleInstance",
2357 "pattern": "[vV][5-7]",
2362 "name": "serviceInstanceId",
2370 "name": "vnfInstanceId",
2378 "name": "vfmoduleInstanceId",
2388 "application/json": {
2398 "description": "successful operation",
2402 "x-codegen-request-body-name": "body"
2405 "/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/vnfs/{vnfInstanceId}/vfModules/{vfmoduleInstanceId}": {
2408 "onapsoinfraserviceInstantiation"
2410 "summary": "Update VfModule on a specified version, serviceInstance, vnfInstance and vfModule",
2411 "operationId": "updateVfModuleInstance",
2418 "pattern": "[vV][5-7]",
2423 "name": "serviceInstanceId",
2431 "name": "vnfInstanceId",
2439 "name": "vfmoduleInstanceId",
2449 "application/json": {
2459 "description": "successful operation",
2463 "x-codegen-request-body-name": "body"
2467 "onapsoinfraserviceInstantiation"
2469 "summary": "Delete provided VfModule instance",
2470 "operationId": "deleteVfModuleInstance",
2477 "pattern": "[vV][5-7]",
2482 "name": "serviceInstanceId",
2490 "name": "vnfInstanceId",
2498 "name": "vfmoduleInstanceId",
2508 "application/json": {
2518 "description": "successful operation",
2522 "x-codegen-request-body-name": "body"
2525 "/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/vnfs/{vnfInstanceId}/volumeGroups": {
2528 "onapsoinfraserviceInstantiation"
2530 "summary": "Create VolumeGroup on a specified version, serviceInstance, vnfInstance",
2531 "operationId": "createVolumeGroupInstance",
2538 "pattern": "[vV][5-7]",
2543 "name": "serviceInstanceId",
2551 "name": "vnfInstanceId",
2561 "application/json": {
2571 "description": "successful operation",
2575 "x-codegen-request-body-name": "body"
2578 "/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/vnfs/{vnfInstanceId}/volumeGroups/{volumeGroupInstanceId}": {
2581 "onapsoinfraserviceInstantiation"
2583 "summary": "Update VolumeGroup on a specified version, serviceInstance, vnfInstance and volumeGroup",
2584 "operationId": "updateVolumeGroupInstance",
2591 "pattern": "[vV][5-7]",
2596 "name": "serviceInstanceId",
2604 "name": "vnfInstanceId",
2612 "name": "volumeGroupInstanceId",
2622 "application/json": {
2632 "description": "successful operation",
2636 "x-codegen-request-body-name": "body"
2640 "onapsoinfraserviceInstantiation"
2642 "summary": "Delete provided VolumeGroup instance",
2643 "operationId": "deleteVolumeGroupInstance",
2650 "pattern": "[vV][5-7]",
2655 "name": "serviceInstanceId",
2663 "name": "vnfInstanceId",
2671 "name": "volumeGroupInstanceId",
2681 "application/json": {
2691 "description": "successful operation",
2695 "x-codegen-request-body-name": "body"
2698 "/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/networks": {
2701 "onapsoinfraserviceInstantiation"
2703 "summary": "Create NetworkInstance on a specified version and serviceInstance ",
2704 "operationId": "createNetworkInstance",
2711 "pattern": "[vV][5-7]",
2716 "name": "serviceInstanceId",
2726 "application/json": {
2736 "description": "successful operation",
2740 "x-codegen-request-body-name": "body"
2743 "/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/networks/{networkInstanceId}": {
2746 "onapsoinfraserviceInstantiation"
2748 "summary": "Update VolumeGroup on a specified version, serviceInstance, networkInstance",
2749 "operationId": "updateNetworkInstance",
2756 "pattern": "[vV][5-7]",
2761 "name": "serviceInstanceId",
2769 "name": "networkInstanceId",
2779 "application/json": {
2789 "description": "successful operation",
2793 "x-codegen-request-body-name": "body"
2797 "onapsoinfraserviceInstantiation"
2799 "summary": "Delete provided Network instance",
2800 "operationId": "deleteNetworkInstance",
2807 "pattern": "[vV][5-7]",
2812 "name": "serviceInstanceId",
2820 "name": "networkInstanceId",
2830 "application/json": {
2840 "description": "successful operation",
2844 "x-codegen-request-body-name": "body"
2847 "/onap/so/infra/tasks/{version}": {
2852 "summary": "Finds Manual Tasks",
2853 "operationId": "queryFilters",
2863 "name": "originalRequestId",
2870 "name": "subscriptionServiceType",
2884 "name": "buildingBlockName",
2891 "name": "originalRequestDate",
2898 "name": "originalRequestorId",
2916 "description": "successful operation",
2922 "/onap/so/infra/cloudResources/{version}/operationalEnvironments": {
2925 "onapsoinfracloudResources"
2927 "summary": "Create an Operational Environment",
2928 "operationId": "createOperationEnvironment",
2935 "pattern": "[vV][1]",
2942 "application/json": {
2952 "description": "successful operation",
2956 "x-codegen-request-body-name": "body"
2959 "/onap/so/infra/cloudResources/{version}/operationalEnvironments/{operationalEnvironmentId}/activate": {
2962 "onapsoinfracloudResources"
2964 "summary": "Activate an Operational Environment",
2965 "operationId": "activateOperationEnvironment",
2972 "pattern": "[vV][1]",
2977 "name": "operationalEnvironmentId",
2987 "application/json": {
2997 "description": "successful operation",
3001 "x-codegen-request-body-name": "body"
3004 "/onap/so/infra/cloudResources/{version}/operationalEnvironments/{operationalEnvironmentId}/deactivate": {
3007 "onapsoinfracloudResources"
3009 "summary": "Deactivate an Operational Environment",
3010 "operationId": "deactivateOperationEnvironment",
3017 "pattern": "[vV][1]",
3022 "name": "operationalEnvironmentId",
3032 "application/json": {
3042 "description": "successful operation",
3046 "x-codegen-request-body-name": "body"
3049 "/onap/so/infra/cloudResourcesRequests/{version}/{requestId}/unlock": {
3052 "onapsoinfracloudResourcesRequests"
3054 "summary": "Unlock CloudOrchestration requests for a specified requestId",
3055 "operationId": "unlockOrchestrationRequestForReqId",
3058 "name": "requestId",
3070 "pattern": "[vV][1]",
3077 "application/json": {
3087 "description": "successful operation",
3091 "x-codegen-request-body-name": "body"
3094 "/onap/so/infra/cloudResourcesRequests/{version}": {
3097 "onapsoinfracloudResourcesRequests"
3099 "summary": "Get status of an Operational Environment based on filter criteria",
3100 "operationId": "getOperationEnvironmentStatusFilter",
3107 "pattern": "[vV][1]",
3114 "description": "successful operation",
3120 "/onap/so/infra/modelDistributions/{version}/distributions/{distributionId}": {
3123 "onapsoinframodelDistributions"
3125 "summary": "Update model distribution status",
3126 "operationId": "updateModelDistributionStatus",
3133 "pattern": "[vV][1]",
3138 "name": "distributionId",
3148 "application/json": {
3158 "description": "successful operation",
3162 "x-codegen-request-body-name": "body"
3165 "/onap/so/infra/workflowSpecifications/{version}/workflows": {
3168 "onapsoinfraworkflowSpecifications"
3170 "summary": "Retrieve Workflow details based on the filter criteria",
3171 "operationId": "queryWorkflowSpecifications",
3174 "name": "resourceTarget",
3185 "pattern": "[vV][1]",
3192 "description": "List of workflow specifications on successful operation",
3194 "application/json": {
3196 "$ref": "#/components/schemas/RetrievingWorkflowResponse"
3204 "/onap/so/infra/instanceManagement/{version}/serviceInstances/{serviceInstanceId}/workflows/{workflow_UUID}": {
3207 "onapsoinfrainstanceManagement"
3209 "summary": "Executing service level custom workflow",
3210 "operationId": "executeServiceLevelCustomWorkflow",
3217 "pattern": "[vV][1]",
3222 "name": "serviceInstanceId",
3230 "name": "workflow_UUID",
3240 "application/json": {
3242 "$ref": "#/components/schemas/ServiceLevelWorkflowExecution"
3250 "description": "successful operation",
3254 "x-codegen-request-body-name": "body"
3257 "/onap/so/infra/instanceManagement/{version}/serviceInstances/{serviceInstanceId}/pnfs/${pnfName}/workflows/${workflow_UUID}": {
3260 "onapsoinfrainstanceManagement"
3262 "summary": "Executing download/activate custom workflow",
3263 "operationId": "executePNFCustomWorkflow",
3270 "pattern": "[vV][1]",
3275 "name": "serviceInstanceId",
3291 "name": "workflow_UUID",
3301 "application/json": {
3303 "$ref": "#/components/schemas/PNFCustomWorkflowExecution"
3311 "description": "successful operation",
3315 "x-codegen-request-body-name": "body"
3321 "Allocate3gppService": {
3326 "description": "Name of the service to allocate"
3328 "modelInvariantUuid": {
3330 "description": "Model Invariant UUID corresponding to the service. For E.g : NSST Model invariant uuid in case of NSSI creation"
3334 "description": "Model UUID corresponding to the service. For E.g : NSST Model uuid in case of NSSI creation"
3336 "globalSubscriberId": {
3339 "subscriptionServiceType": {
3341 "description": "Service type for the subscription. For E.G :5G"
3345 "description": "Network type. For E.G :AN/CN/TN"
3347 "additionalProperties": {
3350 "description": "Map of additional properties required for service allocation"
3353 "description": "This describes the request body for 3gpp service allocation"
3355 "DeAllocate3gppService": {
3358 "serviceInstanceID": {
3360 "description": "ID of the service to terminate"
3362 "globalSubscriberId": {
3365 "subscriptionServiceType": {
3367 "description": "Service type for the subscription. For E.G :5G"
3371 "description": "Network type. For E.G :AN/CN/TN"
3373 "additionalProperties": {
3376 "description": "Map of additional properties required for service deallocation"
3379 "description": "This describes the request body for 3gpp service Termination/Deallocation"
3381 "Modify3gppService": {
3386 "description": "Name of the service to modify"
3388 "serviceInstanceID": {
3390 "description": "ID of the service to modify"
3392 "globalSubscriberId": {
3395 "subscriptionServiceType": {
3397 "description": "Service type for the subscription. For E.G :5G"
3401 "description": "Network type. For E.G :AN/CN/TN"
3403 "additionalProperties": {
3406 "description": "Map of additional properties required for service modification"
3409 "description": "This describes the request body for 3gpp service modification"
3411 "3gppServiceActivation": {
3414 "serviceInstanceID": {
3416 "description": "ID of the service to be activated/deactivated"
3418 "globalSubscriberId": {
3421 "subscriptionServiceType": {
3423 "description": "Service type for the subscription. For E.G :5G"
3427 "description": "Network type. For E.G :AN/CN/TN"
3429 "additionalProperties": {
3432 "description": "Map of additional properties required for service activation/deactivation"
3435 "description": "This describes the request body for 3gpp service activation/deactivation"
3437 "QuerySubnetCapability": {
3443 "$ref": "#/components/schemas/SubnetTypes"
3447 "description": "This describes the subnet capabilities that can be queried"
3451 "description": "This describes allowed subnet types",
3461 "3gppServiceResponse": {
3466 "description": "Job ID to be used to identify the status of the job"
3470 "description": "status of the job"
3472 "statusDescription": {
3475 "description": "Description on status in case of erroneous response"
3478 "description": "This describes the response for 3gpp services"
3480 "RetrievingWorkflowResponse": {
3483 "workflowSpecificationList": {
3485 "description": "List of Workflow specification data",
3487 "$ref": "#/components/schemas/WorkflowSpecification"
3491 "description": "Response body of fetching workflows using resource target"
3493 "WorkflowSpecification": {
3501 "description": "Type of the artifact to be queried"
3505 "description": "UUID of the artifact"
3509 "description": "Name of the artifact"
3511 "artifactVersion": {
3513 "description": "Artifact's Version"
3515 "artifactDescription": {
3521 "description": "Name of the workflow fetched for the resource type"
3525 "description": "Mapped operation name of the corresponding workflow"
3531 "workflowResourceTarget": {
3533 "description": "Type of Resource mapped against the workflow"
3536 "description": "Attributes related to artifact information "
3539 "description": "This describes workflow specification object"
3541 "ServiceLevelWorkflowExecution": {
3549 "description": "Name of the sender"
3551 "suppressRollback": {
3553 "description": "Enable/disable rollback suppression"
3557 "description": "Id of the sender"
3560 "description": "Request object contains source information"
3567 "description": "Type of the model to be executed"
3569 "modelInvariantUuid": {
3571 "description": "Model invariant id corresponding to the service"
3575 "description": "Model uuid corresponding to the service"
3579 "description": "Model version of the service instance"
3583 "description": "Name of the service"
3587 "description": "Version of the service instance"
3590 "description": "Parameters related to the service model"
3592 "requestParameters": {
3595 "subscriptionServiceType": {
3597 "description": "Type of service subscription"
3600 "description": "User parameter object"
3605 "globalSubscriberId": {
3607 "description": "Id of the subscriber sending the request"
3610 "description": "Subscriber id information"
3617 "description": "Name of the target project"
3620 "description": "Information about the target project name"
3627 "description": "Id of the owning Entity"
3629 "owningEntityName": {
3631 "description": "Name of the owning Entity"
3634 "description": "Object describes the entity details"
3637 "description": "This describes the request body of service level custom workflow execution"
3639 "PNFCustomWorkflowExecution": {
3647 "description": "Name of the sender"
3649 "suppressRollback": {
3651 "description": "Enable/disable rollback suppression"
3655 "description": "Id of the sender"
3658 "description": "Request object contains source information"
3665 "description": "Type of the model to be executed"
3667 "modelInvariantUuid": {
3669 "description": "Model invariant id corresponding to the service"
3673 "description": "Model uuid corresponding to the service"
3677 "description": "Model version of the service instance"
3681 "description": "Name of the service"
3685 "description": "Version of the service instance"
3688 "description": "Parameters related to the service model"
3690 "requestParameters": {
3693 "subscriptionServiceType": {
3695 "description": "Type of service subscription"
3698 "description": "User parameter object"
3703 "globalSubscriberId": {
3705 "description": "Id of the subscriber sending the request"
3708 "description": "Subscriber id information"
3715 "description": "Name of the target project"
3718 "description": "Information about the target project name"
3725 "description": "Id of the owning Entity"
3727 "owningEntityName": {
3729 "description": "Name of the owning Entity"
3732 "description": "Object describes the entity details"
3735 "description": "This describes the request body of PNF custom workflow execution"
3737 "CreateServiceInstanceParamaters": {
3742 "description": "Contains data associated with a request",
3744 "requestParameters": {
3746 "description": "Contains all the parameters, associated with this request",
3748 "subscriptionServiceType": {
3750 "description": "Type of service subscriptions of customer resource"
3754 "description": "Array of data that contains information about Service",
3758 "$ref": "#/components/schemas/CreateServiceInstParamsUserParamsHoming"
3761 "$ref": "#/components/schemas/CreateServiceInstParamsUserParamsService"
3768 "description": "Enable “A La Carte” mode. In this mode, the user creates and submits operations for each object to be created."
3772 "description": "Special value required to use additional Policy settings"
3778 "description": "Contains information about the currently used Service Model model",
3780 "modelInvariantId": {
3782 "description": "Unique identifier corresponding to the main definition of a model in SDC"
3786 "description": "Type of service model, created in SDC"
3790 "description": "Name of the model, which can change from version to version."
3794 "description": "Unique identifier corresponding to one version of a model in SDC"
3798 "description": "The SDC model version for this resource or service model."
3802 "description": "Unique identifier corresponding to the main definition of a model in SDC"
3804 "modelInvariantUuid": {
3806 "description": "Unique identifier corresponding to the main definition of a model in SDC"
3812 "description": "Represents some information for the request",
3814 "productFamilyId": {
3816 "description": "SDC catalog service type"
3820 "description": "Determines only the source from whom the request came"
3824 "description": "Defines the name of the instance to be created"
3826 "suppressRollback": {
3828 "description": "If false – the rollback process will not start if something goes wrong in execution BB. If true - QueryRainyDayTable task will start and make querying policy in table rainy_day_handler_macro"
3832 "description": "User Id or Application Id, initiating the Assessment"
3838 "description": "Represents the object that groups service instances used by a customer",
3840 "globalSubscriberId": {
3842 "description": "Global Subscriber Id used across ONAP to uniquely identify subscriber."
3848 "description": "Represents the project, which will own the service instance",
3852 "description": "Name of the project deploying a service"
3858 "description": "Represents the entity, which will own the service instance",
3862 "description": "UUID of an owning entity"
3864 "owningEntityName": {
3866 "description": "Owning entity name"
3874 "CreateServiceInstParamsUserParamsHoming": {
3879 "Homing_Solution": {
3881 "description": "Switches on an optimization service to deploy services automatically across multiple sites and multiple clouds"
3887 "CreateServiceInstParamsUserParamsService": {
3894 "description": "Includes information about all created instances",
3898 "description": "Includes a set of specific parameters",
3906 "description": "Defines the name of the instance to be created"
3913 "description": "Contains information about VNF parameters",
3919 "description": "Contains information about the currently used Service Model model",
3921 "modelInvariantId": {
3923 "description": "Unique identifier corresponding to the main definition of a model in SDC"
3927 "description": "Type of Service Model, created in SDC"
3931 "description": "Name of the model, which can change from version to version."
3935 "description": "Unique identifier corresponding to one version of a model in SDC"
3939 "description": "The SDC model version for this resource or service model."
3943 "description": "Unique identifier corresponding to the main definition of a model in SDC"
3945 "modelInvariantUuid": {
3947 "description": "Unique identifier corresponding to the main definition of a model in SDC"
3951 "cloudConfiguration": {
3956 "description": "Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname"
3958 "lcpCloudRegionId": {
3960 "description": "Cloud-owner defined type indicator (Openstack region)"
3964 "description": "Unique id relative to the cloud-region."
3970 "description": "Represents the platform, on which the VNFs/CNFs will run",
3974 "description": "Name of the platform"
3980 "description": "Represents the business line, owns the VNFs/CNFs instances",
3982 "lineOfBusinessName": {
3984 "description": "Name of the line-of-business (product)"
3988 "productFamilyId": {
3990 "description": "Define SDC catalog service type"
3994 "description": "Defines the name of the instance to be created"
3998 "description": "Includes a set of specific parameters of instance",
4006 "description": "Сontains a set of parameters of VF Modules",
4012 "description": "Contains information about the currently used Service Model model",
4014 "modelInvariantId": {
4016 "description": "Unique identifier corresponding to the main definition of a model in SDC"
4020 "description": "Type of service model, created in SDC"
4024 "description": "Name of the model, which can change from version to version."
4028 "description": "Unique identifier corresponding to one version of a model in SDC"
4032 "description": "The SDC model version for this resource or service model."
4036 "description": "Unique identifier corresponding to the main definition of a model in SDC"
4038 "modelInvariantUuid": {
4040 "description": "Unique identifier corresponding to the main definition of a model in SDC"
4046 "description": "Defines the name of the instance to be created"
4050 "description": "Includes a set of specific parameters",
4066 "description": "Contains information about the currently used Service Model model",
4070 "description": "Name of the model, which can change from version to version."
4074 "description": "Unique identifier corresponding to one version of a model in SDC"
4076 "modelInvariantUuid": {
4078 "description": "Unique identifier corresponding to the main definition of a model in SDC"
4082 "description": "The SDC model version for this resource or service model."
4084 "modelCustomizationId": {
4086 "description": "Unique generated identifier of a model in SDC"