5 "title": "SO Guilin APIs"
9 "name": "e2eServiceInstances"
12 "name": "3gppservices"
15 "name": "globalhealthcheck"
18 "name": "nodehealthcheck"
21 "name": "onapsoinfraorchestrationRequests"
24 "name": "onapsoinfraserviceInstantiation"
27 "name": "onapsoinfratasks"
30 "name": "onapsoinfracloudResources"
33 "name": "onapsoinfracloudResourcesRequests"
36 "name": "onapsoinframodelDistributions"
43 "/onap/so/infra/e2eServiceInstances/{version}": {
48 "summary": "Create an E2E Service Instance on a version provided",
50 "operationId": "createE2EServiceInstance",
71 "pattern": "[vV][3-5]"
76 "description": "successful operation"
81 "/onap/so/infra/e2eServiceInstances/{version}/{serviceId}": {
86 "summary": "Update an E2E Service Instance on a version provided and serviceId",
88 "operationId": "updateE2EServiceInstance",
109 "pattern": "[vV][3-5]"
120 "description": "successful operation"
126 "e2eServiceInstances"
128 "summary": "Delete E2E Service Instance on a specified version and serviceId",
130 "operationId": "deleteE2EServiceInstance",
151 "pattern": "[vV][3-5]"
162 "description": "successful operation"
167 "/onap/so/infra/e2eServiceInstances/{version}/{serviceId}/operations/{operationId}": {
170 "e2eServiceInstances"
172 "summary": "Find e2eServiceInstances Requests for a given serviceId and operationId",
174 "operationId": "getE2EServiceInstances",
190 "pattern": "[vV][3-5]"
193 "name": "operationId",
201 "description": "successful operation"
206 "/onap/so/infra/e2eServiceInstances/{version}/{serviceId}/scale": {
209 "e2eServiceInstances"
211 "summary": "Scale E2E Service Instance on a specified version",
213 "operationId": "scaleE2EServiceInstance",
234 "pattern": "[vV][3-5]"
245 "description": "successful operation"
250 "/onap/so/infra/e2eServiceInstances/{version}/{serviceId}/modeldifferences": {
253 "e2eServiceInstances"
255 "summary": "Find added and deleted resources of target model for the e2eserviceInstance on a given serviceId ",
257 "operationId": "compareModelwithTargetVersion",
284 "pattern": "[vV][3-5]"
289 "description": "successful operation"
294 "/onap/so/infra/3gppservices/{version}/allocate": {
299 "summary": "Create a 3GPP Service Instance on a version provided",
301 "operationId": "allocate3gppService",
314 "$ref": "#/definitions/Allocate3gppService"
327 "description": "successful operation",
329 "$ref": "#/definitions/3gppServiceResponse"
335 "/onap/so/infra/3gppservices/{version}/deAllocate": {
340 "summary": "Terminate/Deallocate a 3GPP Service Instance on a version provided",
342 "operationId": "deallocate3gppService",
355 "$ref": "#/definitions/DeAllocate3gppService"
368 "description": "successful operation",
370 "$ref": "#/definitions/3gppServiceResponse"
376 "/onap/so/infra/3gppservices/{version}/modify": {
381 "summary": "Modify a 3GPP Service Instance on a version provided",
383 "operationId": "modify3gppService",
396 "$ref": "#/definitions/Modify3gppService"
409 "description": "successful operation",
411 "$ref": "#/definitions/3gppServiceResponse"
417 "/onap/so/infra/3gppservices/{version}/activate": {
422 "summary": "Activate a 3GPP Service Instance on a version provided",
424 "operationId": "activate3gppService",
437 "$ref": "#/definitions/3gppServiceActivation"
450 "description": "successful operation",
452 "$ref": "#/definitions/3gppServiceResponse"
458 "/onap/so/infra/3gppservices/{version}/deActivate": {
463 "summary": "Deactivate a 3GPP Service Instance on a version provided",
465 "operationId": "deactivate3gppService",
478 "$ref": "#/definitions/3gppServiceActivation"
491 "description": "successful operation",
493 "$ref": "#/definitions/3gppServiceResponse"
499 "/onap/so/infra/3gppservices/{version}/subnetCapabilityQuery": {
504 "summary": "Provides subnet capability based on subnet types",
506 "operationId": "querySubnetCapability",
519 "$ref": "#/definitions/QuerySubnetCapability"
532 "description": "successful operation with capabilities for the queried subnetTypes",
540 "/globalhealthcheck": {
545 "summary": "Performing global health check",
547 "operationId": "globalHealthcheck",
553 "name": "enableBpmn",
562 "description": "successful operation"
567 "/nodehealthcheck": {
572 "summary": "Performing node health check",
574 "operationId": "nodeHealthcheck",
581 "description": "successful operation"
586 "/onap/so/infra/orchestrationRequests/{version}": {
589 "onapsoinfraorchestrationRequests"
591 "summary": "Find Orchestrated Requests for a URI Information",
593 "operationId": "getOrchestrationRequest",
603 "pattern": "[vV][4-7]"
608 "description": "successful operation"
613 "/onap/so/infra/orchestrationRequests/{version}/{requestId}": {
616 "onapsoinfraorchestrationRequests"
618 "summary": "Find Orchestrated Requests for a given requestId",
620 "operationId": "getOrchestrationRequestForReqId",
636 "pattern": "[vV][4-7]"
641 "description": "successful operation"
646 "/onap/so/infra/orchestrationRequests/{version}/{requestId}/unlock": {
649 "onapsoinfraorchestrationRequests"
651 "summary": "Unlock Orchestrated Requests for a given requestId",
653 "operationId": "unlockOrchestrationRequest",
680 "pattern": "[vV][4-7]"
685 "description": "successful operation"
690 "/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/vnfs/{vnfInstanceId}/vfModules/{vfmoduleInstanceId}/deactivateAndCloudDelete": {
693 "onapsoinfraserviceInstantiation"
695 "summary": "Deactivate and Cloud Delete VfModule instance",
697 "operationId": "deactivateAndCloudDeleteVfModuleInstance",
721 "name": "serviceInstanceId",
727 "name": "vnfInstanceId",
733 "name": "vfmoduleInstanceId",
741 "description": "successful operation"
746 "/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/configurations/{configurationInstanceId}/enablePort": {
749 "onapsoinfraserviceInstantiation"
751 "summary": "Enable Port Mirroring",
753 "operationId": "enablePort",
774 "pattern": "[vV][5-7]"
777 "name": "serviceInstanceId",
783 "name": "configurationInstanceId",
791 "description": "successful operation"
796 "/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/configurations/{configurationInstanceId}/disablePort": {
799 "onapsoinfraserviceInstantiation"
801 "summary": "Disable Port Mirroring",
803 "operationId": "disablePort",
824 "pattern": "[vV][5-7]"
827 "name": "serviceInstanceId",
833 "name": "configurationInstanceId",
841 "description": "successful operation"
846 "/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/configurations/{configurationInstanceId}/activate": {
849 "onapsoinfraserviceInstantiation"
851 "summary": "Activate Port Mirroring",
853 "operationId": "activatePort",
874 "pattern": "[vV][5-7]"
877 "name": "serviceInstanceId",
883 "name": "configurationInstanceId",
891 "description": "successful operation"
896 "/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/configurations/{configurationInstanceId}/deactivate": {
899 "onapsoinfraserviceInstantiation"
901 "summary": "Deactivate Port Mirroring",
903 "operationId": "deactivatePort",
924 "pattern": "[vV][5-7]"
927 "name": "serviceInstanceId",
933 "name": "configurationInstanceId",
941 "description": "successful operation"
946 "/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/addRelationships": {
949 "onapsoinfraserviceInstantiation"
951 "summary": "Add Relationships to a Service Instance",
953 "operationId": "addRelationships",
974 "pattern": "[vV][6-7]"
977 "name": "serviceInstanceId",
985 "description": "successful operation"
990 "/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/vnfs/{vnfInstanceId}/vfModules/scaleOut": {
993 "onapsoinfraserviceInstantiation"
995 "summary": "VF Auto Scale Out",
997 "operationId": "scaleOutVfModule",
1018 "pattern": "[vV][7]"
1021 "name": "serviceInstanceId",
1027 "name": "vnfInstanceId",
1035 "description": "successful operation"
1040 "/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/vnfs/{vnfInstanceId}/inPlaceSoftwareUpdate": {
1043 "onapsoinfraserviceInstantiation"
1045 "summary": "Perform VNF software update",
1047 "operationId": "inPlaceSoftwareUpdate",
1068 "pattern": "[vV][6-7]"
1071 "name": "serviceInstanceId",
1077 "name": "vnfInstanceId",
1085 "description": "successful operation"
1090 "/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/vnfs/{vnfInstanceId}/applyUpdatedConfig": {
1093 "onapsoinfraserviceInstantiation"
1095 "summary": "Apply updated configuration",
1097 "operationId": "applyUpdatedConfig",
1118 "pattern": "[vV][6-7]"
1121 "name": "serviceInstanceId",
1127 "name": "vnfInstanceId",
1135 "description": "successful operation"
1140 "/onap/so/infra/serviceInstantiation/{version}/serviceInstances": {
1143 "onapsoinfraserviceInstantiation"
1145 "summary": "Create a Service Instance on a version provided",
1147 "operationId": "createServiceInstance",
1168 "pattern": "[vV][5-7]"
1173 "description": "successful operation"
1178 "/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/activate": {
1181 "onapsoinfraserviceInstantiation"
1183 "summary": "Activate provided Service Instance",
1185 "operationId": "activateServiceInstance",
1206 "pattern": "[vV][5-7]"
1209 "name": "serviceInstanceId",
1217 "description": "successful operation"
1222 "/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/deactivate": {
1225 "onapsoinfraserviceInstantiation"
1227 "summary": "Deactivate provided Service Instance",
1229 "operationId": "deactivateServiceInstance",
1250 "pattern": "[vV][5-7]"
1253 "name": "serviceInstanceId",
1261 "description": "successful operation"
1266 "/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}": {
1269 "onapsoinfraserviceInstantiation"
1271 "summary": "Delete provided Service Instance",
1273 "operationId": "deleteServiceInstance",
1294 "pattern": "[vV][5-7]"
1297 "name": "serviceInstanceId",
1305 "description": "successful operation"
1310 "/onap/so/infra/serviceInstantiation/{version}/serviceInstances/assign": {
1313 "onapsoinfraserviceInstantiation"
1315 "summary": "Assign Service Instance",
1317 "operationId": "assignServiceInstance",
1338 "pattern": "[vV][7]"
1343 "description": "successful operation"
1348 "/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/unassign": {
1351 "onapsoinfraserviceInstantiation"
1353 "summary": "Unassign Service Instance",
1355 "operationId": "unassignServiceInstance",
1376 "pattern": "[vV][7]"
1379 "name": "serviceInstanceId",
1387 "description": "successful operation"
1392 "/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/configurations": {
1395 "onapsoinfraserviceInstantiation"
1397 "summary": "Create Port Mirroring Configuration",
1399 "operationId": "createPortConfiguration",
1420 "pattern": "[vV][5-7]"
1423 "name": "serviceInstanceId",
1431 "description": "successful operation"
1436 "/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/configurations/{configurationInstanceId}": {
1439 "onapsoinfraserviceInstantiation"
1441 "summary": "Delete provided Port",
1443 "operationId": "deletePortConfiguration",
1464 "pattern": "[vV][5-7]"
1467 "name": "serviceInstanceId",
1473 "name": "configurationInstanceId",
1481 "description": "successful operation"
1486 "/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/removeRelationships": {
1489 "onapsoinfraserviceInstantiation"
1491 "summary": "Remove Relationships from Service Instance",
1493 "operationId": "removeRelationships",
1514 "pattern": "[vV][6-7]"
1517 "name": "serviceInstanceId",
1525 "description": "successful operation"
1530 "/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/vnfs": {
1533 "onapsoinfraserviceInstantiation"
1535 "summary": "Create VNF on a specified version and serviceInstance",
1537 "operationId": "createVnfInstance",
1558 "pattern": "[vV][5-7]"
1561 "name": "serviceInstanceId",
1569 "description": "successful operation"
1574 "/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/vnfs/{vnfInstanceId}/replace": {
1577 "onapsoinfraserviceInstantiation"
1579 "summary": "Replace provided VNF instance",
1581 "operationId": "replaceVnfInstance",
1602 "pattern": "[vV][5-7]"
1605 "name": "serviceInstanceId",
1611 "name": "vnfInstanceId",
1619 "description": "successful operation"
1624 "/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/vnfs/{vnfInstanceId}": {
1627 "onapsoinfraserviceInstantiation"
1629 "summary": "Update VNF on a specified version, serviceInstance and vnfInstance",
1631 "operationId": "updateVnfInstance",
1652 "pattern": "[vV][5-7]"
1655 "name": "serviceInstanceId",
1661 "name": "vnfInstanceId",
1669 "description": "successful operation"
1675 "onapsoinfraserviceInstantiation"
1677 "summary": "Delete provided VNF instance",
1679 "operationId": "deleteVnfInstance",
1700 "pattern": "[vV][5-7]"
1703 "name": "serviceInstanceId",
1709 "name": "vnfInstanceId",
1717 "description": "successful operation"
1722 "/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/vnfs/{vnfInstanceId}/vfModules": {
1725 "onapsoinfraserviceInstantiation"
1727 "summary": "Create VfModule on a specified version, serviceInstance and vnfInstance",
1729 "operationId": "createVfModuleInstance",
1750 "pattern": "[vV][5-7]"
1753 "name": "serviceInstanceId",
1759 "name": "vnfInstanceId",
1767 "description": "successful operation"
1772 "/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/vnfs/{vnfInstanceId}/vfModules/{vfmoduleInstanceId}/replace": {
1775 "onapsoinfraserviceInstantiation"
1777 "summary": "Create VfModule on a specified version, serviceInstance and vnfInstance",
1779 "operationId": "replaceVfModuleInstance",
1800 "pattern": "[vV][5-7]"
1803 "name": "serviceInstanceId",
1809 "name": "vnfInstanceId",
1815 "name": "vfmoduleInstanceId",
1823 "description": "successful operation"
1828 "/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/vnfs/{vnfInstanceId}/vfModules/{vfmoduleInstanceId}": {
1831 "onapsoinfraserviceInstantiation"
1833 "summary": "Update VfModule on a specified version, serviceInstance, vnfInstance and vfModule",
1835 "operationId": "updateVfModuleInstance",
1856 "pattern": "[vV][5-7]"
1859 "name": "serviceInstanceId",
1865 "name": "vnfInstanceId",
1871 "name": "vfmoduleInstanceId",
1879 "description": "successful operation"
1885 "onapsoinfraserviceInstantiation"
1887 "summary": "Delete provided VfModule instance",
1889 "operationId": "deleteVfModuleInstance",
1910 "pattern": "[vV][5-7]"
1913 "name": "serviceInstanceId",
1919 "name": "vnfInstanceId",
1925 "name": "vfmoduleInstanceId",
1933 "description": "successful operation"
1938 "/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/vnfs/{vnfInstanceId}/volumeGroups": {
1941 "onapsoinfraserviceInstantiation"
1943 "summary": "Create VolumeGroup on a specified version, serviceInstance, vnfInstance",
1945 "operationId": "createVolumeGroupInstance",
1966 "pattern": "[vV][5-7]"
1969 "name": "serviceInstanceId",
1975 "name": "vnfInstanceId",
1983 "description": "successful operation"
1988 "/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/vnfs/{vnfInstanceId}/volumeGroups/{volumeGroupInstanceId}": {
1991 "onapsoinfraserviceInstantiation"
1993 "summary": "Update VolumeGroup on a specified version, serviceInstance, vnfInstance and volumeGroup",
1995 "operationId": "updateVolumeGroupInstance",
2016 "pattern": "[vV][5-7]"
2019 "name": "serviceInstanceId",
2025 "name": "vnfInstanceId",
2031 "name": "volumeGroupInstanceId",
2039 "description": "successful operation"
2045 "onapsoinfraserviceInstantiation"
2047 "summary": "Delete provided VolumeGroup instance",
2049 "operationId": "deleteVolumeGroupInstance",
2070 "pattern": "[vV][5-7]"
2073 "name": "serviceInstanceId",
2079 "name": "vnfInstanceId",
2085 "name": "volumeGroupInstanceId",
2093 "description": "successful operation"
2098 "/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/networks": {
2101 "onapsoinfraserviceInstantiation"
2103 "summary": "Create NetworkInstance on a specified version and serviceInstance ",
2105 "operationId": "createNetworkInstance",
2126 "pattern": "[vV][5-7]"
2129 "name": "serviceInstanceId",
2137 "description": "successful operation"
2142 "/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/networks/{networkInstanceId}": {
2145 "onapsoinfraserviceInstantiation"
2147 "summary": "Update VolumeGroup on a specified version, serviceInstance, networkInstance",
2149 "operationId": "updateNetworkInstance",
2170 "pattern": "[vV][5-7]"
2173 "name": "serviceInstanceId",
2179 "name": "networkInstanceId",
2187 "description": "successful operation"
2193 "onapsoinfraserviceInstantiation"
2195 "summary": "Delete provided Network instance",
2197 "operationId": "deleteNetworkInstance",
2218 "pattern": "[vV][5-7]"
2221 "name": "serviceInstanceId",
2227 "name": "networkInstanceId",
2235 "description": "successful operation"
2240 "/onap/so/infra/tasks/{version}": {
2245 "summary": "Finds Manual Tasks",
2247 "operationId": "queryFilters",
2256 "name": "originalRequestId",
2262 "name": "subscriptionServiceType",
2274 "name": "buildingBlockName",
2280 "name": "originalRequestDate",
2286 "name": "originalRequestorId",
2301 "description": "successful operation"
2306 "/onap/so/infra/cloudResources/{version}/operationalEnvironments": {
2309 "onapsoinfracloudResources"
2311 "summary": "Create an Operational Environment",
2313 "operationId": "createOperationEnvironment",
2334 "pattern": "[vV][1]"
2339 "description": "successful operation"
2344 "/onap/so/infra/cloudResources/{version}/operationalEnvironments/{operationalEnvironmentId}/activate": {
2347 "onapsoinfracloudResources"
2349 "summary": "Activate an Operational Environment",
2351 "operationId": "activateOperationEnvironment",
2372 "pattern": "[vV][1]"
2375 "name": "operationalEnvironmentId",
2383 "description": "successful operation"
2388 "/onap/so/infra/cloudResources/{version}/operationalEnvironments/{operationalEnvironmentId}/deactivate": {
2391 "onapsoinfracloudResources"
2393 "summary": "Deactivate an Operational Environment",
2395 "operationId": "deactivateOperationEnvironment",
2416 "pattern": "[vV][1]"
2419 "name": "operationalEnvironmentId",
2427 "description": "successful operation"
2432 "/onap/so/infra/cloudResourcesRequests/{version}/{requestId}/unlock": {
2435 "onapsoinfracloudResourcesRequests"
2437 "summary": "Unlock CloudOrchestration requests for a specified requestId",
2439 "operationId": "unlockOrchestrationRequestForReqId",
2456 "name": "requestId",
2466 "pattern": "[vV][1]"
2471 "description": "successful operation"
2476 "/onap/so/infra/cloudResourcesRequests/{version}": {
2479 "onapsoinfracloudResourcesRequests"
2481 "summary": "Get status of an Operational Environment based on filter criteria",
2483 "operationId": "getOperationEnvironmentStatusFilter",
2496 "pattern": "[vV][1]"
2501 "description": "successful operation"
2506 "/onap/so/infra/modelDistributions/{version}/distributions/{distributionId}": {
2509 "onapsoinframodelDistributions"
2511 "summary": "Update model distribution status",
2513 "operationId": "updateModelDistributionStatus",
2534 "pattern": "[vV][1]"
2537 "name": "distributionId",
2545 "description": "successful operation"
2552 "Allocate3gppService": {
2553 "description": "This describes the request body for 3gpp service allocation",
2557 "description": "Name of the service to allocate",
2560 "modelInvariantUuid": {
2561 "description": "Model Invariant UUID corresponding to the service. For E.g : NSST Model invariant uuid in case of NSSI creation",
2565 "description": "Model UUID corresponding to the service. For E.g : NSST Model uuid in case of NSSI creation",
2568 "globalSubscriberId": {
2571 "subscriptionServiceType": {
2572 "description": "Service type for the subscription. For E.G :5G",
2576 "description": "Network type. For E.G :AN/CN/TN",
2579 "additionalProperties": {
2580 "description": "Map of additional properties required for service allocation",
2585 "DeAllocate3gppService": {
2586 "description": "This describes the request body for 3gpp service Termination/Deallocation",
2589 "serviceInstanceID": {
2590 "description": "ID of the service to terminate",
2593 "globalSubscriberId": {
2596 "subscriptionServiceType": {
2597 "description": "Service type for the subscription. For E.G :5G",
2601 "description": "Network type. For E.G :AN/CN/TN",
2604 "additionalProperties": {
2605 "description": "Map of additional properties required for service deallocation",
2610 "Modify3gppService": {
2611 "description": "This describes the request body for 3gpp service modification",
2615 "description": "Name of the service to modify",
2618 "serviceInstanceID": {
2619 "description": "ID of the service to modify",
2622 "globalSubscriberId": {
2625 "subscriptionServiceType": {
2626 "description": "Service type for the subscription. For E.G :5G",
2630 "description": "Network type. For E.G :AN/CN/TN",
2633 "additionalProperties": {
2634 "description": "Map of additional properties required for service modification",
2639 "3gppServiceActivation": {
2640 "description": "This describes the request body for 3gpp service activation/deactivation",
2643 "serviceInstanceID": {
2644 "description": "ID of the service to be activated/deactivated",
2647 "globalSubscriberId": {
2650 "subscriptionServiceType": {
2651 "description": "Service type for the subscription. For E.G :5G",
2655 "description": "Network type. For E.G :AN/CN/TN",
2658 "additionalProperties": {
2659 "description": "Map of additional properties required for service activation/deactivation",
2664 "QuerySubnetCapability": {
2665 "description": "This describes the subnet capabilities that can be queried",
2671 "$ref": "#/definitions/SubnetTypes"
2677 "description": "This describes allowed subnet types",
2688 "3gppServiceResponse": {
2689 "description": "This describes the response for 3gpp services",
2693 "description": "Job ID to be used to identify the status of the job",
2697 "description": "status of the job",
2700 "statusDescription": {
2701 "description": "Description on status in case of erroneous response",