From cfec14c9a0e51ad025b21812c305cf1ec77ec829 Mon Sep 17 00:00:00 2001 From: seshukm Date: Thu, 15 Nov 2018 17:05:00 +0800 Subject: Update release notes for Casablanca branch. Change-Id: I526efa36cdc29d3d6cd7c48c695d8adfbe218044 Issue-ID: SO-1077 Signed-off-by: seshukm --- docs/release_notes/release-notes.rst | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) (limited to 'docs') diff --git a/docs/release_notes/release-notes.rst b/docs/release_notes/release-notes.rst index f9c7002e8a..4ca1a01953 100644 --- a/docs/release_notes/release-notes.rst +++ b/docs/release_notes/release-notes.rst @@ -11,11 +11,12 @@ The SO provides the highest level of service orchestration in the ONAP architect Version: 1.3.1 -------------- -:Release Date: 2018-09-23 +:Release Date: 2018-10-24 -Temp release for Casablanca at M4. +Branch cut for Casablanca post M4 for integration test. **New Features** +Below features are under test: * Support PNF resource type. * Extend the support of homing to vFW, VDNS usecases. * Workflow Designer Integration. @@ -23,6 +24,12 @@ Temp release for Casablanca at M4. * Support to the CCVPN Usecase. * SO internal architecture improvements +Version: 1.3.0 +-------------- + +:Release Date: 2018-08-22 + +New release over master branch for Casablanca development Version: 1.2.2 -------------- -- cgit 1.2.3-korg From cc4ce80333d6258d4755f812c7933519af61476b Mon Sep 17 00:00:00 2001 From: seshukm Date: Thu, 15 Nov 2018 17:28:02 +0800 Subject: Update swagger html Change-Id: I44ed8b9b38392be1e0fff017dfe06c97fec6310d Issue-ID: SO-1077 Signed-off-by: seshukm --- docs/api/swagger/swagger.html.html | 19377 ----------------------------------- 1 file changed, 19377 deletions(-) delete mode 100644 docs/api/swagger/swagger.html.html (limited to 'docs') diff --git a/docs/api/swagger/swagger.html.html b/docs/api/swagger/swagger.html.html deleted file mode 100644 index dc6064bb80..0000000000 --- a/docs/api/swagger/swagger.html.html +++ /dev/null @@ -1,19377 +0,0 @@ - - - - - SO Casablanca APIs - - - - - - - - - - - - - - - - - -
-
-
- -
-
-
-
-

SO Casablanca APIs

-
-
-
- -
-
-

E2eServiceInstances

-
-
-
-

compareModelwithTargetVersion

-

Find added and deleted resources of target model for the e2eserviceInstance on a given serviceId

-
-
-
-

-

-

-
-
/onap/so/infra/e2eServiceInstances/{version}/{serviceId}/modeldifferences
-

-

Usage and SDK Samples

-

- - -
-
-
curl -X POST "https://localhost/onap/so/infra/e2eServiceInstances/{version}/{serviceId}/modeldifferences"
-
-
-
import io.swagger.client.*;
-import io.swagger.client.auth.*;
-import io.swagger.client.model.*;
-import io.swagger.client.api.E2eServiceInstancesApi;
-
-import java.io.File;
-import java.util.*;
-
-public class E2eServiceInstancesApiExample {
-
-    public static void main(String[] args) {
-        
-        E2eServiceInstancesApi apiInstance = new E2eServiceInstancesApi();
-        String serviceId = serviceId_example; // String | 
-        String version = version_example; // String | 
-        String body = body_example; // String | 
-        try {
-            apiInstance.compareModelwithTargetVersion(serviceId, version, body);
-        } catch (ApiException e) {
-            System.err.println("Exception when calling E2eServiceInstancesApi#compareModelwithTargetVersion");
-            e.printStackTrace();
-        }
-    }
-}
-
- -
-
import io.swagger.client.api.E2eServiceInstancesApi;
-
-public class E2eServiceInstancesApiExample {
-
-    public static void main(String[] args) {
-        E2eServiceInstancesApi apiInstance = new E2eServiceInstancesApi();
-        String serviceId = serviceId_example; // String | 
-        String version = version_example; // String | 
-        String body = body_example; // String | 
-        try {
-            apiInstance.compareModelwithTargetVersion(serviceId, version, body);
-        } catch (ApiException e) {
-            System.err.println("Exception when calling E2eServiceInstancesApi#compareModelwithTargetVersion");
-            e.printStackTrace();
-        }
-    }
-}
-
- -
-
String *serviceId = serviceId_example; // 
-String *version = version_example; // 
-String *body = body_example; //  (optional)
-
-E2eServiceInstancesApi *apiInstance = [[E2eServiceInstancesApi alloc] init];
-
-// Find added and deleted resources of target model for the e2eserviceInstance on a given serviceId 
-[apiInstance compareModelwithTargetVersionWith:serviceId
-    version:version
-    body:body
-              completionHandler: ^(NSError* error) {
-                            if (error) {
-                                NSLog(@"Error: %@", error);
-                            }
-                        }];
-
-
- -
-
var SoCasablancaApIs = require('so_casablanca_ap_is');
-
-var api = new SoCasablancaApIs.E2eServiceInstancesApi()
-
-var serviceId = serviceId_example; // {String} 
-
-var version = version_example; // {String} 
-
-var opts = { 
-  'body': body_example // {String} 
-};
-
-var callback = function(error, data, response) {
-  if (error) {
-    console.error(error);
-  } else {
-    console.log('API called successfully.');
-  }
-};
-api.compareModelwithTargetVersion(serviceId, version, opts, callback);
-
-
- - -
-
using System;
-using System.Diagnostics;
-using IO.Swagger.Api;
-using IO.Swagger.Client;
-using IO.Swagger.Model;
-
-namespace Example
-{
-    public class compareModelwithTargetVersionExample
-    {
-        public void main()
-        {
-            
-            var apiInstance = new E2eServiceInstancesApi();
-            var serviceId = serviceId_example;  // String | 
-            var version = version_example;  // String | 
-            var body = body_example;  // String |  (optional) 
-
-            try
-            {
-                // Find added and deleted resources of target model for the e2eserviceInstance on a given serviceId 
-                apiInstance.compareModelwithTargetVersion(serviceId, version, body);
-            }
-            catch (Exception e)
-            {
-                Debug.Print("Exception when calling E2eServiceInstancesApi.compareModelwithTargetVersion: " + e.Message );
-            }
-        }
-    }
-}
-
-
- -
-
<?php
-require_once(__DIR__ . '/vendor/autoload.php');
-
-$api_instance = new Swagger\Client\Api\E2eServiceInstancesApi();
-$serviceId = serviceId_example; // String | 
-$version = version_example; // String | 
-$body = body_example; // String | 
-
-try {
-    $api_instance->compareModelwithTargetVersion($serviceId, $version, $body);
-} catch (Exception $e) {
-    echo 'Exception when calling E2eServiceInstancesApi->compareModelwithTargetVersion: ', $e->getMessage(), PHP_EOL;
-}
-?>
-
- -
-
use Data::Dumper;
-use WWW::SwaggerClient::Configuration;
-use WWW::SwaggerClient::E2eServiceInstancesApi;
-
-my $api_instance = WWW::SwaggerClient::E2eServiceInstancesApi->new();
-my $serviceId = serviceId_example; # String | 
-my $version = version_example; # String | 
-my $body = WWW::SwaggerClient::Object::String->new(); # String | 
-
-eval { 
-    $api_instance->compareModelwithTargetVersion(serviceId => $serviceId, version => $version, body => $body);
-};
-if ($@) {
-    warn "Exception when calling E2eServiceInstancesApi->compareModelwithTargetVersion: $@\n";
-}
-
- -
-
from __future__ import print_statement
-import time
-import swagger_client
-from swagger_client.rest import ApiException
-from pprint import pprint
-
-# create an instance of the API class
-api_instance = swagger_client.E2eServiceInstancesApi()
-serviceId = serviceId_example # String | 
-version = version_example # String | 
-body = body_example # String |  (optional)
-
-try: 
-    # Find added and deleted resources of target model for the e2eserviceInstance on a given serviceId 
-    api_instance.compare_modelwith_target_version(serviceId, version, body=body)
-except ApiException as e:
-    print("Exception when calling E2eServiceInstancesApi->compareModelwithTargetVersion: %s\n" % e)
-
-
- -

Parameters

- -
Path parameters
- - - - - - - - - - - - - -
NameDescription
serviceId* - - -
-
-
- - String - - -
-
- Required -
-
-
-
version* - - -
-
-
- - String - - -
-
- Required -
-
-
-
- - -
Body parameters
- - - - - - - - - -
NameDescription
body - - - -
-
- - - -

Responses

-

Status: default - successful operation

- - - -
-
- -
-
-
-
-
-
-

createE2EServiceInstance

-

Create an E2E Service Instance on a version provided

-
-
-
-

-

-

-
-
/onap/so/infra/e2eServiceInstances/{version}
-

-

Usage and SDK Samples

-

- - -
-
-
curl -X POST "https://localhost/onap/so/infra/e2eServiceInstances/{version}"
-
-
-
import io.swagger.client.*;
-import io.swagger.client.auth.*;
-import io.swagger.client.model.*;
-import io.swagger.client.api.E2eServiceInstancesApi;
-
-import java.io.File;
-import java.util.*;
-
-public class E2eServiceInstancesApiExample {
-
-    public static void main(String[] args) {
-        
-        E2eServiceInstancesApi apiInstance = new E2eServiceInstancesApi();
-        String version = version_example; // String | 
-        String body = body_example; // String | 
-        try {
-            apiInstance.createE2EServiceInstance(version, body);
-        } catch (ApiException e) {
-            System.err.println("Exception when calling E2eServiceInstancesApi#createE2EServiceInstance");
-            e.printStackTrace();
-        }
-    }
-}
-
- -
-
import io.swagger.client.api.E2eServiceInstancesApi;
-
-public class E2eServiceInstancesApiExample {
-
-    public static void main(String[] args) {
-        E2eServiceInstancesApi apiInstance = new E2eServiceInstancesApi();
-        String version = version_example; // String | 
-        String body = body_example; // String | 
-        try {
-            apiInstance.createE2EServiceInstance(version, body);
-        } catch (ApiException e) {
-            System.err.println("Exception when calling E2eServiceInstancesApi#createE2EServiceInstance");
-            e.printStackTrace();
-        }
-    }
-}
-
- -
-
String *version = version_example; // 
-String *body = body_example; //  (optional)
-
-E2eServiceInstancesApi *apiInstance = [[E2eServiceInstancesApi alloc] init];
-
-// Create an E2E Service Instance on a version provided
-[apiInstance createE2EServiceInstanceWith:version
-    body:body
-              completionHandler: ^(NSError* error) {
-                            if (error) {
-                                NSLog(@"Error: %@", error);
-                            }
-                        }];
-
-
- -
-
var SoCasablancaApIs = require('so_casablanca_ap_is');
-
-var api = new SoCasablancaApIs.E2eServiceInstancesApi()
-
-var version = version_example; // {String} 
-
-var opts = { 
-  'body': body_example // {String} 
-};
-
-var callback = function(error, data, response) {
-  if (error) {
-    console.error(error);
-  } else {
-    console.log('API called successfully.');
-  }
-};
-api.createE2EServiceInstance(version, opts, callback);
-
-
- - -
-
using System;
-using System.Diagnostics;
-using IO.Swagger.Api;
-using IO.Swagger.Client;
-using IO.Swagger.Model;
-
-namespace Example
-{
-    public class createE2EServiceInstanceExample
-    {
-        public void main()
-        {
-            
-            var apiInstance = new E2eServiceInstancesApi();
-            var version = version_example;  // String | 
-            var body = body_example;  // String |  (optional) 
-
-            try
-            {
-                // Create an E2E Service Instance on a version provided
-                apiInstance.createE2EServiceInstance(version, body);
-            }
-            catch (Exception e)
-            {
-                Debug.Print("Exception when calling E2eServiceInstancesApi.createE2EServiceInstance: " + e.Message );
-            }
-        }
-    }
-}
-
-
- -
-
<?php
-require_once(__DIR__ . '/vendor/autoload.php');
-
-$api_instance = new Swagger\Client\Api\E2eServiceInstancesApi();
-$version = version_example; // String | 
-$body = body_example; // String | 
-
-try {
-    $api_instance->createE2EServiceInstance($version, $body);
-} catch (Exception $e) {
-    echo 'Exception when calling E2eServiceInstancesApi->createE2EServiceInstance: ', $e->getMessage(), PHP_EOL;
-}
-?>
-
- -
-
use Data::Dumper;
-use WWW::SwaggerClient::Configuration;
-use WWW::SwaggerClient::E2eServiceInstancesApi;
-
-my $api_instance = WWW::SwaggerClient::E2eServiceInstancesApi->new();
-my $version = version_example; # String | 
-my $body = WWW::SwaggerClient::Object::String->new(); # String | 
-
-eval { 
-    $api_instance->createE2EServiceInstance(version => $version, body => $body);
-};
-if ($@) {
-    warn "Exception when calling E2eServiceInstancesApi->createE2EServiceInstance: $@\n";
-}
-
- -
-
from __future__ import print_statement
-import time
-import swagger_client
-from swagger_client.rest import ApiException
-from pprint import pprint
-
-# create an instance of the API class
-api_instance = swagger_client.E2eServiceInstancesApi()
-version = version_example # String | 
-body = body_example # String |  (optional)
-
-try: 
-    # Create an E2E Service Instance on a version provided
-    api_instance.create_e2_e_service_instance(version, body=body)
-except ApiException as e:
-    print("Exception when calling E2eServiceInstancesApi->createE2EServiceInstance: %s\n" % e)
-
-
- -

Parameters

- -
Path parameters
- - - - - - - - - -
NameDescription
version* - - -
-
-
- - String - - -
-
- Required -
-
-
-
- - -
Body parameters
- - - - - - - - - -
NameDescription
body - - - -
-
- - - -

Responses

-

Status: default - successful operation

- - - -
-
- -
-
-
-
-
-
-

deleteE2EServiceInstance

-

Delete E2E Service Instance on a specified version and serviceId

-
-
-
-

-

-

-
-
/onap/so/infra/e2eServiceInstances/{version}/{serviceId}
-

-

Usage and SDK Samples

-

- - -
-
-
curl -X DELETE "https://localhost/onap/so/infra/e2eServiceInstances/{version}/{serviceId}"
-
-
-
import io.swagger.client.*;
-import io.swagger.client.auth.*;
-import io.swagger.client.model.*;
-import io.swagger.client.api.E2eServiceInstancesApi;
-
-import java.io.File;
-import java.util.*;
-
-public class E2eServiceInstancesApiExample {
-
-    public static void main(String[] args) {
-        
-        E2eServiceInstancesApi apiInstance = new E2eServiceInstancesApi();
-        String version = version_example; // String | 
-        String serviceId = serviceId_example; // String | 
-        String body = body_example; // String | 
-        try {
-            apiInstance.deleteE2EServiceInstance(version, serviceId, body);
-        } catch (ApiException e) {
-            System.err.println("Exception when calling E2eServiceInstancesApi#deleteE2EServiceInstance");
-            e.printStackTrace();
-        }
-    }
-}
-
- -
-
import io.swagger.client.api.E2eServiceInstancesApi;
-
-public class E2eServiceInstancesApiExample {
-
-    public static void main(String[] args) {
-        E2eServiceInstancesApi apiInstance = new E2eServiceInstancesApi();
-        String version = version_example; // String | 
-        String serviceId = serviceId_example; // String | 
-        String body = body_example; // String | 
-        try {
-            apiInstance.deleteE2EServiceInstance(version, serviceId, body);
-        } catch (ApiException e) {
-            System.err.println("Exception when calling E2eServiceInstancesApi#deleteE2EServiceInstance");
-            e.printStackTrace();
-        }
-    }
-}
-
- -
-
String *version = version_example; // 
-String *serviceId = serviceId_example; // 
-String *body = body_example; //  (optional)
-
-E2eServiceInstancesApi *apiInstance = [[E2eServiceInstancesApi alloc] init];
-
-// Delete E2E Service Instance on a specified version and serviceId
-[apiInstance deleteE2EServiceInstanceWith:version
-    serviceId:serviceId
-    body:body
-              completionHandler: ^(NSError* error) {
-                            if (error) {
-                                NSLog(@"Error: %@", error);
-                            }
-                        }];
-
-
- -
-
var SoCasablancaApIs = require('so_casablanca_ap_is');
-
-var api = new SoCasablancaApIs.E2eServiceInstancesApi()
-
-var version = version_example; // {String} 
-
-var serviceId = serviceId_example; // {String} 
-
-var opts = { 
-  'body': body_example // {String} 
-};
-
-var callback = function(error, data, response) {
-  if (error) {
-    console.error(error);
-  } else {
-    console.log('API called successfully.');
-  }
-};
-api.deleteE2EServiceInstance(version, serviceId, opts, callback);
-
-
- - -
-
using System;
-using System.Diagnostics;
-using IO.Swagger.Api;
-using IO.Swagger.Client;
-using IO.Swagger.Model;
-
-namespace Example
-{
-    public class deleteE2EServiceInstanceExample
-    {
-        public void main()
-        {
-            
-            var apiInstance = new E2eServiceInstancesApi();
-            var version = version_example;  // String | 
-            var serviceId = serviceId_example;  // String | 
-            var body = body_example;  // String |  (optional) 
-
-            try
-            {
-                // Delete E2E Service Instance on a specified version and serviceId
-                apiInstance.deleteE2EServiceInstance(version, serviceId, body);
-            }
-            catch (Exception e)
-            {
-                Debug.Print("Exception when calling E2eServiceInstancesApi.deleteE2EServiceInstance: " + e.Message );
-            }
-        }
-    }
-}
-
-
- -
-
<?php
-require_once(__DIR__ . '/vendor/autoload.php');
-
-$api_instance = new Swagger\Client\Api\E2eServiceInstancesApi();
-$version = version_example; // String | 
-$serviceId = serviceId_example; // String | 
-$body = body_example; // String | 
-
-try {
-    $api_instance->deleteE2EServiceInstance($version, $serviceId, $body);
-} catch (Exception $e) {
-    echo 'Exception when calling E2eServiceInstancesApi->deleteE2EServiceInstance: ', $e->getMessage(), PHP_EOL;
-}
-?>
-
- -
-
use Data::Dumper;
-use WWW::SwaggerClient::Configuration;
-use WWW::SwaggerClient::E2eServiceInstancesApi;
-
-my $api_instance = WWW::SwaggerClient::E2eServiceInstancesApi->new();
-my $version = version_example; # String | 
-my $serviceId = serviceId_example; # String | 
-my $body = WWW::SwaggerClient::Object::String->new(); # String | 
-
-eval { 
-    $api_instance->deleteE2EServiceInstance(version => $version, serviceId => $serviceId, body => $body);
-};
-if ($@) {
-    warn "Exception when calling E2eServiceInstancesApi->deleteE2EServiceInstance: $@\n";
-}
-
- -
-
from __future__ import print_statement
-import time
-import swagger_client
-from swagger_client.rest import ApiException
-from pprint import pprint
-
-# create an instance of the API class
-api_instance = swagger_client.E2eServiceInstancesApi()
-version = version_example # String | 
-serviceId = serviceId_example # String | 
-body = body_example # String |  (optional)
-
-try: 
-    # Delete E2E Service Instance on a specified version and serviceId
-    api_instance.delete_e2_e_service_instance(version, serviceId, body=body)
-except ApiException as e:
-    print("Exception when calling E2eServiceInstancesApi->deleteE2EServiceInstance: %s\n" % e)
-
-
- -

Parameters

- -
Path parameters
- - - - - - - - - - - - - -
NameDescription
version* - - -
-
-
- - String - - -
-
- Required -
-
-
-
serviceId* - - -
-
-
- - String - - -
-
- Required -
-
-
-
- - -
Body parameters
- - - - - - - - - -
NameDescription
body - - - -
-
- - - -

Responses

-

Status: default - successful operation

- - - -
-
- -
-
-
-
-
-
-

getE2EServiceInstances

-

Find e2eServiceInstances Requests for a given serviceId and operationId

-
-
-
-

-

-

-
-
/onap/so/infra/e2eServiceInstances/{version}/{serviceId}/operations/{operationId}
-

-

Usage and SDK Samples

-

- - -
-
-
curl -X GET "https://localhost/onap/so/infra/e2eServiceInstances/{version}/{serviceId}/operations/{operationId}"
-
-
-
import io.swagger.client.*;
-import io.swagger.client.auth.*;
-import io.swagger.client.model.*;
-import io.swagger.client.api.E2eServiceInstancesApi;
-
-import java.io.File;
-import java.util.*;
-
-public class E2eServiceInstancesApiExample {
-
-    public static void main(String[] args) {
-        
-        E2eServiceInstancesApi apiInstance = new E2eServiceInstancesApi();
-        String serviceId = serviceId_example; // String | 
-        String version = version_example; // String | 
-        String operationId = operationId_example; // String | 
-        try {
-            apiInstance.getE2EServiceInstances(serviceId, version, operationId);
-        } catch (ApiException e) {
-            System.err.println("Exception when calling E2eServiceInstancesApi#getE2EServiceInstances");
-            e.printStackTrace();
-        }
-    }
-}
-
- -
-
import io.swagger.client.api.E2eServiceInstancesApi;
-
-public class E2eServiceInstancesApiExample {
-
-    public static void main(String[] args) {
-        E2eServiceInstancesApi apiInstance = new E2eServiceInstancesApi();
-        String serviceId = serviceId_example; // String | 
-        String version = version_example; // String | 
-        String operationId = operationId_example; // String | 
-        try {
-            apiInstance.getE2EServiceInstances(serviceId, version, operationId);
-        } catch (ApiException e) {
-            System.err.println("Exception when calling E2eServiceInstancesApi#getE2EServiceInstances");
-            e.printStackTrace();
-        }
-    }
-}
-
- -
-
String *serviceId = serviceId_example; // 
-String *version = version_example; // 
-String *operationId = operationId_example; // 
-
-E2eServiceInstancesApi *apiInstance = [[E2eServiceInstancesApi alloc] init];
-
-// Find e2eServiceInstances Requests for a given serviceId and operationId
-[apiInstance getE2EServiceInstancesWith:serviceId
-    version:version
-    operationId:operationId
-              completionHandler: ^(NSError* error) {
-                            if (error) {
-                                NSLog(@"Error: %@", error);
-                            }
-                        }];
-
-
- -
-
var SoCasablancaApIs = require('so_casablanca_ap_is');
-
-var api = new SoCasablancaApIs.E2eServiceInstancesApi()
-
-var serviceId = serviceId_example; // {String} 
-
-var version = version_example; // {String} 
-
-var operationId = operationId_example; // {String} 
-
-
-var callback = function(error, data, response) {
-  if (error) {
-    console.error(error);
-  } else {
-    console.log('API called successfully.');
-  }
-};
-api.getE2EServiceInstances(serviceId, version, operationId, callback);
-
-
- - -
-
using System;
-using System.Diagnostics;
-using IO.Swagger.Api;
-using IO.Swagger.Client;
-using IO.Swagger.Model;
-
-namespace Example
-{
-    public class getE2EServiceInstancesExample
-    {
-        public void main()
-        {
-            
-            var apiInstance = new E2eServiceInstancesApi();
-            var serviceId = serviceId_example;  // String | 
-            var version = version_example;  // String | 
-            var operationId = operationId_example;  // String | 
-
-            try
-            {
-                // Find e2eServiceInstances Requests for a given serviceId and operationId
-                apiInstance.getE2EServiceInstances(serviceId, version, operationId);
-            }
-            catch (Exception e)
-            {
-                Debug.Print("Exception when calling E2eServiceInstancesApi.getE2EServiceInstances: " + e.Message );
-            }
-        }
-    }
-}
-
-
- -
-
<?php
-require_once(__DIR__ . '/vendor/autoload.php');
-
-$api_instance = new Swagger\Client\Api\E2eServiceInstancesApi();
-$serviceId = serviceId_example; // String | 
-$version = version_example; // String | 
-$operationId = operationId_example; // String | 
-
-try {
-    $api_instance->getE2EServiceInstances($serviceId, $version, $operationId);
-} catch (Exception $e) {
-    echo 'Exception when calling E2eServiceInstancesApi->getE2EServiceInstances: ', $e->getMessage(), PHP_EOL;
-}
-?>
-
- -
-
use Data::Dumper;
-use WWW::SwaggerClient::Configuration;
-use WWW::SwaggerClient::E2eServiceInstancesApi;
-
-my $api_instance = WWW::SwaggerClient::E2eServiceInstancesApi->new();
-my $serviceId = serviceId_example; # String | 
-my $version = version_example; # String | 
-my $operationId = operationId_example; # String | 
-
-eval { 
-    $api_instance->getE2EServiceInstances(serviceId => $serviceId, version => $version, operationId => $operationId);
-};
-if ($@) {
-    warn "Exception when calling E2eServiceInstancesApi->getE2EServiceInstances: $@\n";
-}
-
- -
-
from __future__ import print_statement
-import time
-import swagger_client
-from swagger_client.rest import ApiException
-from pprint import pprint
-
-# create an instance of the API class
-api_instance = swagger_client.E2eServiceInstancesApi()
-serviceId = serviceId_example # String | 
-version = version_example # String | 
-operationId = operationId_example # String | 
-
-try: 
-    # Find e2eServiceInstances Requests for a given serviceId and operationId
-    api_instance.get_e2_e_service_instances(serviceId, version, operationId)
-except ApiException as e:
-    print("Exception when calling E2eServiceInstancesApi->getE2EServiceInstances: %s\n" % e)
-
-
- -

Parameters

- -
Path parameters
- - - - - - - - - - - - - - - - - -
NameDescription
serviceId* - - -
-
-
- - String - - -
-
- Required -
-
-
-
version* - - -
-
-
- - String - - -
-
- Required -
-
-
-
operationId* - - -
-
-
- - String - - -
-
- Required -
-
-
-
- - - - - -

Responses

-

Status: default - successful operation

- - - -
-
- -
-
-
-
-
-
-

scaleE2EServiceInstance

-

Scale E2E Service Instance on a specified version

-
-
-
-

-

-

-
-
/onap/so/infra/e2eServiceInstances/{version}/{serviceId}/scale
-

-

Usage and SDK Samples

-

- - -
-
-
curl -X POST "https://localhost/onap/so/infra/e2eServiceInstances/{version}/{serviceId}/scale"
-
-
-
import io.swagger.client.*;
-import io.swagger.client.auth.*;
-import io.swagger.client.model.*;
-import io.swagger.client.api.E2eServiceInstancesApi;
-
-import java.io.File;
-import java.util.*;
-
-public class E2eServiceInstancesApiExample {
-
-    public static void main(String[] args) {
-        
-        E2eServiceInstancesApi apiInstance = new E2eServiceInstancesApi();
-        String version = version_example; // String | 
-        String serviceId = serviceId_example; // String | 
-        String body = body_example; // String | 
-        try {
-            apiInstance.scaleE2EServiceInstance(version, serviceId, body);
-        } catch (ApiException e) {
-            System.err.println("Exception when calling E2eServiceInstancesApi#scaleE2EServiceInstance");
-            e.printStackTrace();
-        }
-    }
-}
-
- -
-
import io.swagger.client.api.E2eServiceInstancesApi;
-
-public class E2eServiceInstancesApiExample {
-
-    public static void main(String[] args) {
-        E2eServiceInstancesApi apiInstance = new E2eServiceInstancesApi();
-        String version = version_example; // String | 
-        String serviceId = serviceId_example; // String | 
-        String body = body_example; // String | 
-        try {
-            apiInstance.scaleE2EServiceInstance(version, serviceId, body);
-        } catch (ApiException e) {
-            System.err.println("Exception when calling E2eServiceInstancesApi#scaleE2EServiceInstance");
-            e.printStackTrace();
-        }
-    }
-}
-
- -
-
String *version = version_example; // 
-String *serviceId = serviceId_example; // 
-String *body = body_example; //  (optional)
-
-E2eServiceInstancesApi *apiInstance = [[E2eServiceInstancesApi alloc] init];
-
-// Scale E2E Service Instance on a specified version
-[apiInstance scaleE2EServiceInstanceWith:version
-    serviceId:serviceId
-    body:body
-              completionHandler: ^(NSError* error) {
-                            if (error) {
-                                NSLog(@"Error: %@", error);
-                            }
-                        }];
-
-
- -
-
var SoCasablancaApIs = require('so_casablanca_ap_is');
-
-var api = new SoCasablancaApIs.E2eServiceInstancesApi()
-
-var version = version_example; // {String} 
-
-var serviceId = serviceId_example; // {String} 
-
-var opts = { 
-  'body': body_example // {String} 
-};
-
-var callback = function(error, data, response) {
-  if (error) {
-    console.error(error);
-  } else {
-    console.log('API called successfully.');
-  }
-};
-api.scaleE2EServiceInstance(version, serviceId, opts, callback);
-
-
- - -
-
using System;
-using System.Diagnostics;
-using IO.Swagger.Api;
-using IO.Swagger.Client;
-using IO.Swagger.Model;
-
-namespace Example
-{
-    public class scaleE2EServiceInstanceExample
-    {
-        public void main()
-        {
-            
-            var apiInstance = new E2eServiceInstancesApi();
-            var version = version_example;  // String | 
-            var serviceId = serviceId_example;  // String | 
-            var body = body_example;  // String |  (optional) 
-
-            try
-            {
-                // Scale E2E Service Instance on a specified version
-                apiInstance.scaleE2EServiceInstance(version, serviceId, body);
-            }
-            catch (Exception e)
-            {
-                Debug.Print("Exception when calling E2eServiceInstancesApi.scaleE2EServiceInstance: " + e.Message );
-            }
-        }
-    }
-}
-
-
- -
-
<?php
-require_once(__DIR__ . '/vendor/autoload.php');
-
-$api_instance = new Swagger\Client\Api\E2eServiceInstancesApi();
-$version = version_example; // String | 
-$serviceId = serviceId_example; // String | 
-$body = body_example; // String | 
-
-try {
-    $api_instance->scaleE2EServiceInstance($version, $serviceId, $body);
-} catch (Exception $e) {
-    echo 'Exception when calling E2eServiceInstancesApi->scaleE2EServiceInstance: ', $e->getMessage(), PHP_EOL;
-}
-?>
-
- -
-
use Data::Dumper;
-use WWW::SwaggerClient::Configuration;
-use WWW::SwaggerClient::E2eServiceInstancesApi;
-
-my $api_instance = WWW::SwaggerClient::E2eServiceInstancesApi->new();
-my $version = version_example; # String | 
-my $serviceId = serviceId_example; # String | 
-my $body = WWW::SwaggerClient::Object::String->new(); # String | 
-
-eval { 
-    $api_instance->scaleE2EServiceInstance(version => $version, serviceId => $serviceId, body => $body);
-};
-if ($@) {
-    warn "Exception when calling E2eServiceInstancesApi->scaleE2EServiceInstance: $@\n";
-}
-
- -
-
from __future__ import print_statement
-import time
-import swagger_client
-from swagger_client.rest import ApiException
-from pprint import pprint
-
-# create an instance of the API class
-api_instance = swagger_client.E2eServiceInstancesApi()
-version = version_example # String | 
-serviceId = serviceId_example # String | 
-body = body_example # String |  (optional)
-
-try: 
-    # Scale E2E Service Instance on a specified version
-    api_instance.scale_e2_e_service_instance(version, serviceId, body=body)
-except ApiException as e:
-    print("Exception when calling E2eServiceInstancesApi->scaleE2EServiceInstance: %s\n" % e)
-
-
- -

Parameters

- -
Path parameters
- - - - - - - - - - - - - -
NameDescription
version* - - -
-
-
- - String - - -
-
- Required -
-
-
-
serviceId* - - -
-
-
- - String - - -
-
- Required -
-
-
-
- - -
Body parameters
- - - - - - - - - -
NameDescription
body - - - -
-
- - - -

Responses

-

Status: default - successful operation

- - - -
-
- -
-
-
-
-
-
-

updateE2EServiceInstance

-

Update an E2E Service Instance on a version provided and serviceId

-
-
-
-

-

-

-
-
/onap/so/infra/e2eServiceInstances/{version}/{serviceId}
-

-

Usage and SDK Samples

-

- - -
-
-
curl -X PUT "https://localhost/onap/so/infra/e2eServiceInstances/{version}/{serviceId}"
-
-
-
import io.swagger.client.*;
-import io.swagger.client.auth.*;
-import io.swagger.client.model.*;
-import io.swagger.client.api.E2eServiceInstancesApi;
-
-import java.io.File;
-import java.util.*;
-
-public class E2eServiceInstancesApiExample {
-
-    public static void main(String[] args) {
-        
-        E2eServiceInstancesApi apiInstance = new E2eServiceInstancesApi();
-        String version = version_example; // String | 
-        String serviceId = serviceId_example; // String | 
-        String body = body_example; // String | 
-        try {
-            apiInstance.updateE2EServiceInstance(version, serviceId, body);
-        } catch (ApiException e) {
-            System.err.println("Exception when calling E2eServiceInstancesApi#updateE2EServiceInstance");
-            e.printStackTrace();
-        }
-    }
-}
-
- -
-
import io.swagger.client.api.E2eServiceInstancesApi;
-
-public class E2eServiceInstancesApiExample {
-
-    public static void main(String[] args) {
-        E2eServiceInstancesApi apiInstance = new E2eServiceInstancesApi();
-        String version = version_example; // String | 
-        String serviceId = serviceId_example; // String | 
-        String body = body_example; // String | 
-        try {
-            apiInstance.updateE2EServiceInstance(version, serviceId, body);
-        } catch (ApiException e) {
-            System.err.println("Exception when calling E2eServiceInstancesApi#updateE2EServiceInstance");
-            e.printStackTrace();
-        }
-    }
-}
-
- -
-
String *version = version_example; // 
-String *serviceId = serviceId_example; // 
-String *body = body_example; //  (optional)
-
-E2eServiceInstancesApi *apiInstance = [[E2eServiceInstancesApi alloc] init];
-
-// Update an E2E Service Instance on a version provided and serviceId
-[apiInstance updateE2EServiceInstanceWith:version
-    serviceId:serviceId
-    body:body
-              completionHandler: ^(NSError* error) {
-                            if (error) {
-                                NSLog(@"Error: %@", error);
-                            }
-                        }];
-
-
- -
-
var SoCasablancaApIs = require('so_casablanca_ap_is');
-
-var api = new SoCasablancaApIs.E2eServiceInstancesApi()
-
-var version = version_example; // {String} 
-
-var serviceId = serviceId_example; // {String} 
-
-var opts = { 
-  'body': body_example // {String} 
-};
-
-var callback = function(error, data, response) {
-  if (error) {
-    console.error(error);
-  } else {
-    console.log('API called successfully.');
-  }
-};
-api.updateE2EServiceInstance(version, serviceId, opts, callback);
-
-
- - -
-
using System;
-using System.Diagnostics;
-using IO.Swagger.Api;
-using IO.Swagger.Client;
-using IO.Swagger.Model;
-
-namespace Example
-{
-    public class updateE2EServiceInstanceExample
-    {
-        public void main()
-        {
-            
-            var apiInstance = new E2eServiceInstancesApi();
-            var version = version_example;  // String | 
-            var serviceId = serviceId_example;  // String | 
-            var body = body_example;  // String |  (optional) 
-
-            try
-            {
-                // Update an E2E Service Instance on a version provided and serviceId
-                apiInstance.updateE2EServiceInstance(version, serviceId, body);
-            }
-            catch (Exception e)
-            {
-                Debug.Print("Exception when calling E2eServiceInstancesApi.updateE2EServiceInstance: " + e.Message );
-            }
-        }
-    }
-}
-
-
- -
-
<?php
-require_once(__DIR__ . '/vendor/autoload.php');
-
-$api_instance = new Swagger\Client\Api\E2eServiceInstancesApi();
-$version = version_example; // String | 
-$serviceId = serviceId_example; // String | 
-$body = body_example; // String | 
-
-try {
-    $api_instance->updateE2EServiceInstance($version, $serviceId, $body);
-} catch (Exception $e) {
-    echo 'Exception when calling E2eServiceInstancesApi->updateE2EServiceInstance: ', $e->getMessage(), PHP_EOL;
-}
-?>
-
- -
-
use Data::Dumper;
-use WWW::SwaggerClient::Configuration;
-use WWW::SwaggerClient::E2eServiceInstancesApi;
-
-my $api_instance = WWW::SwaggerClient::E2eServiceInstancesApi->new();
-my $version = version_example; # String | 
-my $serviceId = serviceId_example; # String | 
-my $body = WWW::SwaggerClient::Object::String->new(); # String | 
-
-eval { 
-    $api_instance->updateE2EServiceInstance(version => $version, serviceId => $serviceId, body => $body);
-};
-if ($@) {
-    warn "Exception when calling E2eServiceInstancesApi->updateE2EServiceInstance: $@\n";
-}
-
- -
-
from __future__ import print_statement
-import time
-import swagger_client
-from swagger_client.rest import ApiException
-from pprint import pprint
-
-# create an instance of the API class
-api_instance = swagger_client.E2eServiceInstancesApi()
-version = version_example # String | 
-serviceId = serviceId_example # String | 
-body = body_example # String |  (optional)
-
-try: 
-    # Update an E2E Service Instance on a version provided and serviceId
-    api_instance.update_e2_e_service_instance(version, serviceId, body=body)
-except ApiException as e:
-    print("Exception when calling E2eServiceInstancesApi->updateE2EServiceInstance: %s\n" % e)
-
-
- -

Parameters

- -
Path parameters
- - - - - - - - - - - - - -
NameDescription
version* - - -
-
-
- - String - - -
-
- Required -
-
-
-
serviceId* - - -
-
-
- - String - - -
-
- Required -
-
-
-
- - -
Body parameters
- - - - - - - - - -
NameDescription
body - - - -
-
- - - -

Responses

-

Status: default - successful operation

- - - -
-
- -
-
-
-
-
-

Globalhealthcheck

-
-
-
-

globalHealthcheck

-

Performing global health check

-
-
-
-

-

-

-
-
/globalhealthcheck
-

-

Usage and SDK Samples

-

- - -
-
-
curl -X GET "https://localhost/globalhealthcheck?enableBpmn="
-
-
-
import io.swagger.client.*;
-import io.swagger.client.auth.*;
-import io.swagger.client.model.*;
-import io.swagger.client.api.GlobalhealthcheckApi;
-
-import java.io.File;
-import java.util.*;
-
-public class GlobalhealthcheckApiExample {
-
-    public static void main(String[] args) {
-        
-        GlobalhealthcheckApi apiInstance = new GlobalhealthcheckApi();
-        Boolean enableBpmn = true; // Boolean | 
-        try {
-            apiInstance.globalHealthcheck(enableBpmn);
-        } catch (ApiException e) {
-            System.err.println("Exception when calling GlobalhealthcheckApi#globalHealthcheck");
-            e.printStackTrace();
-        }
-    }
-}
-
- -
-
import io.swagger.client.api.GlobalhealthcheckApi;
-
-public class GlobalhealthcheckApiExample {
-
-    public static void main(String[] args) {
-        GlobalhealthcheckApi apiInstance = new GlobalhealthcheckApi();
-        Boolean enableBpmn = true; // Boolean | 
-        try {
-            apiInstance.globalHealthcheck(enableBpmn);
-        } catch (ApiException e) {
-            System.err.println("Exception when calling GlobalhealthcheckApi#globalHealthcheck");
-            e.printStackTrace();
-        }
-    }
-}
-
- -
-
Boolean *enableBpmn = true; //  (optional) (default to true)
-
-GlobalhealthcheckApi *apiInstance = [[GlobalhealthcheckApi alloc] init];
-
-// Performing global health check
-[apiInstance globalHealthcheckWith:enableBpmn
-              completionHandler: ^(NSError* error) {
-                            if (error) {
-                                NSLog(@"Error: %@", error);
-                            }
-                        }];
-
-
- -
-
var SoCasablancaApIs = require('so_casablanca_ap_is');
-
-var api = new SoCasablancaApIs.GlobalhealthcheckApi()
-
-var opts = { 
-  'enableBpmn': true // {Boolean} 
-};
-
-var callback = function(error, data, response) {
-  if (error) {
-    console.error(error);
-  } else {
-    console.log('API called successfully.');
-  }
-};
-api.globalHealthcheck(opts, callback);
-
-
- - -
-
using System;
-using System.Diagnostics;
-using IO.Swagger.Api;
-using IO.Swagger.Client;
-using IO.Swagger.Model;
-
-namespace Example
-{
-    public class globalHealthcheckExample
-    {
-        public void main()
-        {
-            
-            var apiInstance = new GlobalhealthcheckApi();
-            var enableBpmn = true;  // Boolean |  (optional)  (default to true)
-
-            try
-            {
-                // Performing global health check
-                apiInstance.globalHealthcheck(enableBpmn);
-            }
-            catch (Exception e)
-            {
-                Debug.Print("Exception when calling GlobalhealthcheckApi.globalHealthcheck: " + e.Message );
-            }
-        }
-    }
-}
-
-
- -
-
<?php
-require_once(__DIR__ . '/vendor/autoload.php');
-
-$api_instance = new Swagger\Client\Api\GlobalhealthcheckApi();
-$enableBpmn = true; // Boolean | 
-
-try {
-    $api_instance->globalHealthcheck($enableBpmn);
-} catch (Exception $e) {
-    echo 'Exception when calling GlobalhealthcheckApi->globalHealthcheck: ', $e->getMessage(), PHP_EOL;
-}
-?>
-
- -
-
use Data::Dumper;
-use WWW::SwaggerClient::Configuration;
-use WWW::SwaggerClient::GlobalhealthcheckApi;
-
-my $api_instance = WWW::SwaggerClient::GlobalhealthcheckApi->new();
-my $enableBpmn = true; # Boolean | 
-
-eval { 
-    $api_instance->globalHealthcheck(enableBpmn => $enableBpmn);
-};
-if ($@) {
-    warn "Exception when calling GlobalhealthcheckApi->globalHealthcheck: $@\n";
-}
-
- -
-
from __future__ import print_statement
-import time
-import swagger_client
-from swagger_client.rest import ApiException
-from pprint import pprint
-
-# create an instance of the API class
-api_instance = swagger_client.GlobalhealthcheckApi()
-enableBpmn = true # Boolean |  (optional) (default to true)
-
-try: 
-    # Performing global health check
-    api_instance.global_healthcheck(enableBpmn=enableBpmn)
-except ApiException as e:
-    print("Exception when calling GlobalhealthcheckApi->globalHealthcheck: %s\n" % e)
-
-
- -

Parameters

- - - - - -
Query parameters
- - - - - - - - - -
NameDescription
enableBpmn - - -
-
-
- - Boolean - - -
-
-
-
- -

Responses

-

Status: default - successful operation

- - - -
-
- -
-
-
-
-
-

Nodehealthcheck

-
-
-
-

nodeHealthcheck

-

Performing node health check

-
-
-
-

-

-

-
-
/nodehealthcheck
-

-

Usage and SDK Samples

-

- - -
-
-
curl -X GET "https://localhost/nodehealthcheck"
-
-
-
import io.swagger.client.*;
-import io.swagger.client.auth.*;
-import io.swagger.client.model.*;
-import io.swagger.client.api.NodehealthcheckApi;
-
-import java.io.File;
-import java.util.*;
-
-public class NodehealthcheckApiExample {
-
-    public static void main(String[] args) {
-        
-        NodehealthcheckApi apiInstance = new NodehealthcheckApi();
-        try {
-            apiInstance.nodeHealthcheck();
-        } catch (ApiException e) {
-            System.err.println("Exception when calling NodehealthcheckApi#nodeHealthcheck");
-            e.printStackTrace();
-        }
-    }
-}
-
- -
-
import io.swagger.client.api.NodehealthcheckApi;
-
-public class NodehealthcheckApiExample {
-
-    public static void main(String[] args) {
-        NodehealthcheckApi apiInstance = new NodehealthcheckApi();
-        try {
-            apiInstance.nodeHealthcheck();
-        } catch (ApiException e) {
-            System.err.println("Exception when calling NodehealthcheckApi#nodeHealthcheck");
-            e.printStackTrace();
-        }
-    }
-}
-
- -
-

-NodehealthcheckApi *apiInstance = [[NodehealthcheckApi alloc] init];
-
-// Performing node health check
-[apiInstance nodeHealthcheckWithCompletionHandler: 
-              ^(NSError* error) {
-                            if (error) {
-                                NSLog(@"Error: %@", error);
-                            }
-                        }];
-
-
- -
-
var SoCasablancaApIs = require('so_casablanca_ap_is');
-
-var api = new SoCasablancaApIs.NodehealthcheckApi()
-
-var callback = function(error, data, response) {
-  if (error) {
-    console.error(error);
-  } else {
-    console.log('API called successfully.');
-  }
-};
-api.nodeHealthcheck(callback);
-
-
- - -
-
using System;
-using System.Diagnostics;
-using IO.Swagger.Api;
-using IO.Swagger.Client;
-using IO.Swagger.Model;
-
-namespace Example
-{
-    public class nodeHealthcheckExample
-    {
-        public void main()
-        {
-            
-            var apiInstance = new NodehealthcheckApi();
-
-            try
-            {
-                // Performing node health check
-                apiInstance.nodeHealthcheck();
-            }
-            catch (Exception e)
-            {
-                Debug.Print("Exception when calling NodehealthcheckApi.nodeHealthcheck: " + e.Message );
-            }
-        }
-    }
-}
-
-
- -
-
<?php
-require_once(__DIR__ . '/vendor/autoload.php');
-
-$api_instance = new Swagger\Client\Api\NodehealthcheckApi();
-
-try {
-    $api_instance->nodeHealthcheck();
-} catch (Exception $e) {
-    echo 'Exception when calling NodehealthcheckApi->nodeHealthcheck: ', $e->getMessage(), PHP_EOL;
-}
-?>
-
- -
-
use Data::Dumper;
-use WWW::SwaggerClient::Configuration;
-use WWW::SwaggerClient::NodehealthcheckApi;
-
-my $api_instance = WWW::SwaggerClient::NodehealthcheckApi->new();
-
-eval { 
-    $api_instance->nodeHealthcheck();
-};
-if ($@) {
-    warn "Exception when calling NodehealthcheckApi->nodeHealthcheck: $@\n";
-}
-
- -
-
from __future__ import print_statement
-import time
-import swagger_client
-from swagger_client.rest import ApiException
-from pprint import pprint
-
-# create an instance of the API class
-api_instance = swagger_client.NodehealthcheckApi()
-
-try: 
-    # Performing node health check
-    api_instance.node_healthcheck()
-except ApiException as e:
-    print("Exception when calling NodehealthcheckApi->nodeHealthcheck: %s\n" % e)
-
-
- -

Parameters

- - - - - - -

Responses

-

Status: default - successful operation

- - - -
-
- -
-
-
-
-
-

OnapsoinfracloudResources

-
-
-
-

activateOperationEnvironment

-

Activate an Operational Environment

-
-
-
-

-

-

-
-
/onap/so/infra/cloudResources/{version}/operationalEnvironments/{operationalEnvironmentId}/activate
-

-

Usage and SDK Samples

-

- - -
-
-
curl -X POST "https://localhost/onap/so/infra/cloudResources/{version}/operationalEnvironments/{operationalEnvironmentId}/activate"
-
-
-
import io.swagger.client.*;
-import io.swagger.client.auth.*;
-import io.swagger.client.model.*;
-import io.swagger.client.api.OnapsoinfracloudResourcesApi;
-
-import java.io.File;
-import java.util.*;
-
-public class OnapsoinfracloudResourcesApiExample {
-
-    public static void main(String[] args) {
-        
-        OnapsoinfracloudResourcesApi apiInstance = new OnapsoinfracloudResourcesApi();
-        String version = version_example; // String | 
-        String operationalEnvironmentId = operationalEnvironmentId_example; // String | 
-        String body = body_example; // String | 
-        try {
-            apiInstance.activateOperationEnvironment(version, operationalEnvironmentId, body);
-        } catch (ApiException e) {
-            System.err.println("Exception when calling OnapsoinfracloudResourcesApi#activateOperationEnvironment");
-            e.printStackTrace();
-        }
-    }
-}
-
- -
-
import io.swagger.client.api.OnapsoinfracloudResourcesApi;
-
-public class OnapsoinfracloudResourcesApiExample {
-
-    public static void main(String[] args) {
-        OnapsoinfracloudResourcesApi apiInstance = new OnapsoinfracloudResourcesApi();
-        String version = version_example; // String | 
-        String operationalEnvironmentId = operationalEnvironmentId_example; // String | 
-        String body = body_example; // String | 
-        try {
-            apiInstance.activateOperationEnvironment(version, operationalEnvironmentId, body);
-        } catch (ApiException e) {
-            System.err.println("Exception when calling OnapsoinfracloudResourcesApi#activateOperationEnvironment");
-            e.printStackTrace();
-        }
-    }
-}
-
- -
-
String *version = version_example; // 
-String *operationalEnvironmentId = operationalEnvironmentId_example; // 
-String *body = body_example; //  (optional)
-
-OnapsoinfracloudResourcesApi *apiInstance = [[OnapsoinfracloudResourcesApi alloc] init];
-
-// Activate an Operational Environment
-[apiInstance activateOperationEnvironmentWith:version
-    operationalEnvironmentId:operationalEnvironmentId
-    body:body
-              completionHandler: ^(NSError* error) {
-                            if (error) {
-                                NSLog(@"Error: %@", error);
-                            }
-                        }];
-
-
- -
-
var SoCasablancaApIs = require('so_casablanca_ap_is');
-
-var api = new SoCasablancaApIs.OnapsoinfracloudResourcesApi()
-
-var version = version_example; // {String} 
-
-var operationalEnvironmentId = operationalEnvironmentId_example; // {String} 
-
-var opts = { 
-  'body': body_example // {String} 
-};
-
-var callback = function(error, data, response) {
-  if (error) {
-    console.error(error);
-  } else {
-    console.log('API called successfully.');
-  }
-};
-api.activateOperationEnvironment(version, operationalEnvironmentId, opts, callback);
-
-
- - -
-
using System;
-using System.Diagnostics;
-using IO.Swagger.Api;
-using IO.Swagger.Client;
-using IO.Swagger.Model;
-
-namespace Example
-{
-    public class activateOperationEnvironmentExample
-    {
-        public void main()
-        {
-            
-            var apiInstance = new OnapsoinfracloudResourcesApi();
-            var version = version_example;  // String | 
-            var operationalEnvironmentId = operationalEnvironmentId_example;  // String | 
-            var body = body_example;  // String |  (optional) 
-
-            try
-            {
-                // Activate an Operational Environment
-                apiInstance.activateOperationEnvironment(version, operationalEnvironmentId, body);
-            }
-            catch (Exception e)
-            {
-                Debug.Print("Exception when calling OnapsoinfracloudResourcesApi.activateOperationEnvironment: " + e.Message );
-            }
-        }
-    }
-}
-
-
- -
-
<?php
-require_once(__DIR__ . '/vendor/autoload.php');
-
-$api_instance = new Swagger\Client\Api\OnapsoinfracloudResourcesApi();
-$version = version_example; // String | 
-$operationalEnvironmentId = operationalEnvironmentId_example; // String | 
-$body = body_example; // String | 
-
-try {
-    $api_instance->activateOperationEnvironment($version, $operationalEnvironmentId, $body);
-} catch (Exception $e) {
-    echo 'Exception when calling OnapsoinfracloudResourcesApi->activateOperationEnvironment: ', $e->getMessage(), PHP_EOL;
-}
-?>
-
- -
-
use Data::Dumper;
-use WWW::SwaggerClient::Configuration;
-use WWW::SwaggerClient::OnapsoinfracloudResourcesApi;
-
-my $api_instance = WWW::SwaggerClient::OnapsoinfracloudResourcesApi->new();
-my $version = version_example; # String | 
-my $operationalEnvironmentId = operationalEnvironmentId_example; # String | 
-my $body = WWW::SwaggerClient::Object::String->new(); # String | 
-
-eval { 
-    $api_instance->activateOperationEnvironment(version => $version, operationalEnvironmentId => $operationalEnvironmentId, body => $body);
-};
-if ($@) {
-    warn "Exception when calling OnapsoinfracloudResourcesApi->activateOperationEnvironment: $@\n";
-}
-
- -
-
from __future__ import print_statement
-import time
-import swagger_client
-from swagger_client.rest import ApiException
-from pprint import pprint
-
-# create an instance of the API class
-api_instance = swagger_client.OnapsoinfracloudResourcesApi()
-version = version_example # String | 
-operationalEnvironmentId = operationalEnvironmentId_example # String | 
-body = body_example # String |  (optional)
-
-try: 
-    # Activate an Operational Environment
-    api_instance.activate_operation_environment(version, operationalEnvironmentId, body=body)
-except ApiException as e:
-    print("Exception when calling OnapsoinfracloudResourcesApi->activateOperationEnvironment: %s\n" % e)
-
-
- -

Parameters

- -
Path parameters
- - - - - - - - - - - - - -
NameDescription
version* - - -
-
-
- - String - - -
-
- Required -
-
-
-
operationalEnvironmentId* - - -
-
-
- - String - - -
-
- Required -
-
-
-
- - -
Body parameters
- - - - - - - - - -
NameDescription
body - - - -
-
- - - -

Responses

-

Status: default - successful operation

- - - -
-
- -
-
-
-
-
-
-

createOperationEnvironment

-

Create an Operational Environment

-
-
-
-

-

-

-
-
/onap/so/infra/cloudResources/{version}/operationalEnvironments
-

-

Usage and SDK Samples

-

- - -
-
-
curl -X POST "https://localhost/onap/so/infra/cloudResources/{version}/operationalEnvironments"
-
-
-
import io.swagger.client.*;
-import io.swagger.client.auth.*;
-import io.swagger.client.model.*;
-import io.swagger.client.api.OnapsoinfracloudResourcesApi;
-
-import java.io.File;
-import java.util.*;
-
-public class OnapsoinfracloudResourcesApiExample {
-
-    public static void main(String[] args) {
-        
-        OnapsoinfracloudResourcesApi apiInstance = new OnapsoinfracloudResourcesApi();
-        String version = version_example; // String | 
-        String body = body_example; // String | 
-        try {
-            apiInstance.createOperationEnvironment(version, body);
-        } catch (ApiException e) {
-            System.err.println("Exception when calling OnapsoinfracloudResourcesApi#createOperationEnvironment");
-            e.printStackTrace();
-        }
-    }
-}
-
- -
-
import io.swagger.client.api.OnapsoinfracloudResourcesApi;
-
-public class OnapsoinfracloudResourcesApiExample {
-
-    public static void main(String[] args) {
-        OnapsoinfracloudResourcesApi apiInstance = new OnapsoinfracloudResourcesApi();
-        String version = version_example; // String | 
-        String body = body_example; // String | 
-        try {
-            apiInstance.createOperationEnvironment(version, body);
-        } catch (ApiException e) {
-            System.err.println("Exception when calling OnapsoinfracloudResourcesApi#createOperationEnvironment");
-            e.printStackTrace();
-        }
-    }
-}
-
- -
-
String *version = version_example; // 
-String *body = body_example; //  (optional)
-
-OnapsoinfracloudResourcesApi *apiInstance = [[OnapsoinfracloudResourcesApi alloc] init];
-
-// Create an Operational Environment
-[apiInstance createOperationEnvironmentWith:version
-    body:body
-              completionHandler: ^(NSError* error) {
-                            if (error) {
-                                NSLog(@"Error: %@", error);
-                            }
-                        }];
-
-
- -
-
var SoCasablancaApIs = require('so_casablanca_ap_is');
-
-var api = new SoCasablancaApIs.OnapsoinfracloudResourcesApi()
-
-var version = version_example; // {String} 
-
-var opts = { 
-  'body': body_example // {String} 
-};
-
-var callback = function(error, data, response) {
-  if (error) {
-    console.error(error);
-  } else {
-    console.log('API called successfully.');
-  }
-};
-api.createOperationEnvironment(version, opts, callback);
-
-
- - -
-
using System;
-using System.Diagnostics;
-using IO.Swagger.Api;
-using IO.Swagger.Client;
-using IO.Swagger.Model;
-
-namespace Example
-{
-    public class createOperationEnvironmentExample
-    {
-        public void main()
-        {
-            
-            var apiInstance = new OnapsoinfracloudResourcesApi();
-            var version = version_example;  // String | 
-            var body = body_example;  // String |  (optional) 
-
-            try
-            {
-                // Create an Operational Environment
-                apiInstance.createOperationEnvironment(version, body);
-            }
-            catch (Exception e)
-            {
-                Debug.Print("Exception when calling OnapsoinfracloudResourcesApi.createOperationEnvironment: " + e.Message );
-            }
-        }
-    }
-}
-
-
- -
-
<?php
-require_once(__DIR__ . '/vendor/autoload.php');
-
-$api_instance = new Swagger\Client\Api\OnapsoinfracloudResourcesApi();
-$version = version_example; // String | 
-$body = body_example; // String | 
-
-try {
-    $api_instance->createOperationEnvironment($version, $body);
-} catch (Exception $e) {
-    echo 'Exception when calling OnapsoinfracloudResourcesApi->createOperationEnvironment: ', $e->getMessage(), PHP_EOL;
-}
-?>
-
- -
-
use Data::Dumper;
-use WWW::SwaggerClient::Configuration;
-use WWW::SwaggerClient::OnapsoinfracloudResourcesApi;
-
-my $api_instance = WWW::SwaggerClient::OnapsoinfracloudResourcesApi->new();
-my $version = version_example; # String | 
-my $body = WWW::SwaggerClient::Object::String->new(); # String | 
-
-eval { 
-    $api_instance->createOperationEnvironment(version => $version, body => $body);
-};
-if ($@) {
-    warn "Exception when calling OnapsoinfracloudResourcesApi->createOperationEnvironment: $@\n";
-}
-
- -
-
from __future__ import print_statement
-import time
-import swagger_client
-from swagger_client.rest import ApiException
-from pprint import pprint
-
-# create an instance of the API class
-api_instance = swagger_client.OnapsoinfracloudResourcesApi()
-version = version_example # String | 
-body = body_example # String |  (optional)
-
-try: 
-    # Create an Operational Environment
-    api_instance.create_operation_environment(version, body=body)
-except ApiException as e:
-    print("Exception when calling OnapsoinfracloudResourcesApi->createOperationEnvironment: %s\n" % e)
-
-
- -

Parameters

- -
Path parameters
- - - - - - - - - -
NameDescription
version* - - -
-
-
- - String - - -
-
- Required -
-
-
-
- - -
Body parameters
- - - - - - - - - -
NameDescription
body - - - -
-
- - - -

Responses

-

Status: default - successful operation

- - - -
-
- -
-
-
-
-
-
-

deactivateOperationEnvironment

-

Deactivate an Operational Environment

-
-
-
-

-

-

-
-
/onap/so/infra/cloudResources/{version}/operationalEnvironments/{operationalEnvironmentId}/deactivate
-

-

Usage and SDK Samples

-

- - -
-
-
curl -X POST "https://localhost/onap/so/infra/cloudResources/{version}/operationalEnvironments/{operationalEnvironmentId}/deactivate"
-
-
-
import io.swagger.client.*;
-import io.swagger.client.auth.*;
-import io.swagger.client.model.*;
-import io.swagger.client.api.OnapsoinfracloudResourcesApi;
-
-import java.io.File;
-import java.util.*;
-
-public class OnapsoinfracloudResourcesApiExample {
-
-    public static void main(String[] args) {
-        
-        OnapsoinfracloudResourcesApi apiInstance = new OnapsoinfracloudResourcesApi();
-        String version = version_example; // String | 
-        String operationalEnvironmentId = operationalEnvironmentId_example; // String | 
-        String body = body_example; // String | 
-        try {
-            apiInstance.deactivateOperationEnvironment(version, operationalEnvironmentId, body);
-        } catch (ApiException e) {
-            System.err.println("Exception when calling OnapsoinfracloudResourcesApi#deactivateOperationEnvironment");
-            e.printStackTrace();
-        }
-    }
-}
-
- -
-
import io.swagger.client.api.OnapsoinfracloudResourcesApi;
-
-public class OnapsoinfracloudResourcesApiExample {
-
-    public static void main(String[] args) {
-        OnapsoinfracloudResourcesApi apiInstance = new OnapsoinfracloudResourcesApi();
-        String version = version_example; // String | 
-        String operationalEnvironmentId = operationalEnvironmentId_example; // String | 
-        String body = body_example; // String | 
-        try {
-            apiInstance.deactivateOperationEnvironment(version, operationalEnvironmentId, body);
-        } catch (ApiException e) {
-            System.err.println("Exception when calling OnapsoinfracloudResourcesApi#deactivateOperationEnvironment");
-            e.printStackTrace();
-        }
-    }
-}
-
- -
-
String *version = version_example; // 
-String *operationalEnvironmentId = operationalEnvironmentId_example; // 
-String *body = body_example; //  (optional)
-
-OnapsoinfracloudResourcesApi *apiInstance = [[OnapsoinfracloudResourcesApi alloc] init];
-
-// Deactivate an Operational Environment
-[apiInstance deactivateOperationEnvironmentWith:version
-    operationalEnvironmentId:operationalEnvironmentId
-    body:body
-              completionHandler: ^(NSError* error) {
-                            if (error) {
-                                NSLog(@"Error: %@", error);
-                            }
-                        }];
-
-
- -
-
var SoCasablancaApIs = require('so_casablanca_ap_is');
-
-var api = new SoCasablancaApIs.OnapsoinfracloudResourcesApi()
-
-var version = version_example; // {String} 
-
-var operationalEnvironmentId = operationalEnvironmentId_example; // {String} 
-
-var opts = { 
-  'body': body_example // {String} 
-};
-
-var callback = function(error, data, response) {
-  if (error) {
-    console.error(error);
-  } else {
-    console.log('API called successfully.');
-  }
-};
-api.deactivateOperationEnvironment(version, operationalEnvironmentId, opts, callback);
-
-
- - -
-
using System;
-using System.Diagnostics;
-using IO.Swagger.Api;
-using IO.Swagger.Client;
-using IO.Swagger.Model;
-
-namespace Example
-{
-    public class deactivateOperationEnvironmentExample
-    {
-        public void main()
-        {
-            
-            var apiInstance = new OnapsoinfracloudResourcesApi();
-            var version = version_example;  // String | 
-            var operationalEnvironmentId = operationalEnvironmentId_example;  // String | 
-            var body = body_example;  // String |  (optional) 
-
-            try
-            {
-                // Deactivate an Operational Environment
-                apiInstance.deactivateOperationEnvironment(version, operationalEnvironmentId, body);
-            }
-            catch (Exception e)
-            {
-                Debug.Print("Exception when calling OnapsoinfracloudResourcesApi.deactivateOperationEnvironment: " + e.Message );
-            }
-        }
-    }
-}
-
-
- -
-
<?php
-require_once(__DIR__ . '/vendor/autoload.php');
-
-$api_instance = new Swagger\Client\Api\OnapsoinfracloudResourcesApi();
-$version = version_example; // String | 
-$operationalEnvironmentId = operationalEnvironmentId_example; // String | 
-$body = body_example; // String | 
-
-try {
-    $api_instance->deactivateOperationEnvironment($version, $operationalEnvironmentId, $body);
-} catch (Exception $e) {
-    echo 'Exception when calling OnapsoinfracloudResourcesApi->deactivateOperationEnvironment: ', $e->getMessage(), PHP_EOL;
-}
-?>
-
- -
-
use Data::Dumper;
-use WWW::SwaggerClient::Configuration;
-use WWW::SwaggerClient::OnapsoinfracloudResourcesApi;
-
-my $api_instance = WWW::SwaggerClient::OnapsoinfracloudResourcesApi->new();
-my $version = version_example; # String | 
-my $operationalEnvironmentId = operationalEnvironmentId_example; # String | 
-my $body = WWW::SwaggerClient::Object::String->new(); # String | 
-
-eval { 
-    $api_instance->deactivateOperationEnvironment(version => $version, operationalEnvironmentId => $operationalEnvironmentId, body => $body);
-};
-if ($@) {
-    warn "Exception when calling OnapsoinfracloudResourcesApi->deactivateOperationEnvironment: $@\n";
-}
-
- -
-
from __future__ import print_statement
-import time
-import swagger_client
-from swagger_client.rest import ApiException
-from pprint import pprint
-
-# create an instance of the API class
-api_instance = swagger_client.OnapsoinfracloudResourcesApi()
-version = version_example # String | 
-operationalEnvironmentId = operationalEnvironmentId_example # String | 
-body = body_example # String |  (optional)
-
-try: 
-    # Deactivate an Operational Environment
-    api_instance.deactivate_operation_environment(version, operationalEnvironmentId, body=body)
-except ApiException as e:
-    print("Exception when calling OnapsoinfracloudResourcesApi->deactivateOperationEnvironment: %s\n" % e)
-
-
- -

Parameters

- -
Path parameters
- - - - - - - - - - - - - -
NameDescription
version* - - -
-
-
- - String - - -
-
- Required -
-
-
-
operationalEnvironmentId* - - -
-
-
- - String - - -
-
- Required -
-
-
-
- - -
Body parameters
- - - - - - - - - -
NameDescription
body - - - -
-
- - - -

Responses

-

Status: default - successful operation

- - - -
-
- -
-
-
-
-
-

OnapsoinfracloudResourcesRequests

-
-
-
-

getOperationEnvironmentStatusFilter

-

Get status of an Operational Environment based on filter criteria

-
-
-
-

-

-

-
-
/onap/so/infra/cloudResourcesRequests/{version}
-

-

Usage and SDK Samples

-

- - -
-
-
curl -X GET "https://localhost/onap/so/infra/cloudResourcesRequests/{version}"
-
-
-
import io.swagger.client.*;
-import io.swagger.client.auth.*;
-import io.swagger.client.model.*;
-import io.swagger.client.api.OnapsoinfracloudResourcesRequestsApi;
-
-import java.io.File;
-import java.util.*;
-
-public class OnapsoinfracloudResourcesRequestsApiExample {
-
-    public static void main(String[] args) {
-        
-        OnapsoinfracloudResourcesRequestsApi apiInstance = new OnapsoinfracloudResourcesRequestsApi();
-        String version = version_example; // String | 
-        try {
-            apiInstance.getOperationEnvironmentStatusFilter(version);
-        } catch (ApiException e) {
-            System.err.println("Exception when calling OnapsoinfracloudResourcesRequestsApi#getOperationEnvironmentStatusFilter");
-            e.printStackTrace();
-        }
-    }
-}
-
- -
-
import io.swagger.client.api.OnapsoinfracloudResourcesRequestsApi;
-
-public class OnapsoinfracloudResourcesRequestsApiExample {
-
-    public static void main(String[] args) {
-        OnapsoinfracloudResourcesRequestsApi apiInstance = new OnapsoinfracloudResourcesRequestsApi();
-        String version = version_example; // String | 
-        try {
-            apiInstance.getOperationEnvironmentStatusFilter(version);
-        } catch (ApiException e) {
-            System.err.println("Exception when calling OnapsoinfracloudResourcesRequestsApi#getOperationEnvironmentStatusFilter");
-            e.printStackTrace();
-        }
-    }
-}
-
- -
-
String *version = version_example; // 
-
-OnapsoinfracloudResourcesRequestsApi *apiInstance = [[OnapsoinfracloudResourcesRequestsApi alloc] init];
-
-// Get status of an Operational Environment based on filter criteria
-[apiInstance getOperationEnvironmentStatusFilterWith:version
-              completionHandler: ^(NSError* error) {
-                            if (error) {
-                                NSLog(@"Error: %@", error);
-                            }
-                        }];
-
-
- -
-
var SoCasablancaApIs = require('so_casablanca_ap_is');
-
-var api = new SoCasablancaApIs.OnapsoinfracloudResourcesRequestsApi()
-
-var version = version_example; // {String} 
-
-
-var callback = function(error, data, response) {
-  if (error) {
-    console.error(error);
-  } else {
-    console.log('API called successfully.');
-  }
-};
-api.getOperationEnvironmentStatusFilter(version, callback);
-
-
- - -
-
using System;
-using System.Diagnostics;
-using IO.Swagger.Api;
-using IO.Swagger.Client;
-using IO.Swagger.Model;
-
-namespace Example
-{
-    public class getOperationEnvironmentStatusFilterExample
-    {
-        public void main()
-        {
-            
-            var apiInstance = new OnapsoinfracloudResourcesRequestsApi();
-            var version = version_example;  // String | 
-
-            try
-            {
-                // Get status of an Operational Environment based on filter criteria
-                apiInstance.getOperationEnvironmentStatusFilter(version);
-            }
-            catch (Exception e)
-            {
-                Debug.Print("Exception when calling OnapsoinfracloudResourcesRequestsApi.getOperationEnvironmentStatusFilter: " + e.Message );
-            }
-        }
-    }
-}
-
-
- -
-
<?php
-require_once(__DIR__ . '/vendor/autoload.php');
-
-$api_instance = new Swagger\Client\Api\OnapsoinfracloudResourcesRequestsApi();
-$version = version_example; // String | 
-
-try {
-    $api_instance->getOperationEnvironmentStatusFilter($version);
-} catch (Exception $e) {
-    echo 'Exception when calling OnapsoinfracloudResourcesRequestsApi->getOperationEnvironmentStatusFilter: ', $e->getMessage(), PHP_EOL;
-}
-?>
-
- -
-
use Data::Dumper;
-use WWW::SwaggerClient::Configuration;
-use WWW::SwaggerClient::OnapsoinfracloudResourcesRequestsApi;
-
-my $api_instance = WWW::SwaggerClient::OnapsoinfracloudResourcesRequestsApi->new();
-my $version = version_example; # String | 
-
-eval { 
-    $api_instance->getOperationEnvironmentStatusFilter(version => $version);
-};
-if ($@) {
-    warn "Exception when calling OnapsoinfracloudResourcesRequestsApi->getOperationEnvironmentStatusFilter: $@\n";
-}
-
- -
-
from __future__ import print_statement
-import time
-import swagger_client
-from swagger_client.rest import ApiException
-from pprint import pprint
-
-# create an instance of the API class
-api_instance = swagger_client.OnapsoinfracloudResourcesRequestsApi()
-version = version_example # String | 
-
-try: 
-    # Get status of an Operational Environment based on filter criteria
-    api_instance.get_operation_environment_status_filter(version)
-except ApiException as e:
-    print("Exception when calling OnapsoinfracloudResourcesRequestsApi->getOperationEnvironmentStatusFilter: %s\n" % e)
-
-
- -

Parameters

- -
Path parameters
- - - - - - - - - -
NameDescription
version* - - -
-
-
- - String - - -
-
- Required -
-
-
-
- - - - - -

Responses

-

Status: default - successful operation

- - - -
-
- -
-
-
-
-
-
-

unlockOrchestrationRequestForReqId

-

Unlock CloudOrchestration requests for a specified requestId

-
-
-
-

-

-

-
-
/onap/so/infra/cloudResourcesRequests/{version}/{requestId}/unlock
-

-

Usage and SDK Samples

-

- - -
-
-
curl -X POST "https://localhost/onap/so/infra/cloudResourcesRequests/{version}/{requestId}/unlock"
-
-
-
import io.swagger.client.*;
-import io.swagger.client.auth.*;
-import io.swagger.client.model.*;
-import io.swagger.client.api.OnapsoinfracloudResourcesRequestsApi;
-
-import java.io.File;
-import java.util.*;
-
-public class OnapsoinfracloudResourcesRequestsApiExample {
-
-    public static void main(String[] args) {
-        
-        OnapsoinfracloudResourcesRequestsApi apiInstance = new OnapsoinfracloudResourcesRequestsApi();
-        String requestId = requestId_example; // String | 
-        String version = version_example; // String | 
-        String body = body_example; // String | 
-        try {
-            apiInstance.unlockOrchestrationRequestForReqId(requestId, version, body);
-        } catch (ApiException e) {
-            System.err.println("Exception when calling OnapsoinfracloudResourcesRequestsApi#unlockOrchestrationRequestForReqId");
-            e.printStackTrace();
-        }
-    }
-}
-
- -
-
import io.swagger.client.api.OnapsoinfracloudResourcesRequestsApi;
-
-public class OnapsoinfracloudResourcesRequestsApiExample {
-
-    public static void main(String[] args) {
-        OnapsoinfracloudResourcesRequestsApi apiInstance = new OnapsoinfracloudResourcesRequestsApi();
-        String requestId = requestId_example; // String | 
-        String version = version_example; // String | 
-        String body = body_example; // String | 
-        try {
-            apiInstance.unlockOrchestrationRequestForReqId(requestId, version, body);
-        } catch (ApiException e) {
-            System.err.println("Exception when calling OnapsoinfracloudResourcesRequestsApi#unlockOrchestrationRequestForReqId");
-            e.printStackTrace();
-        }
-    }
-}
-
- -
-
String *requestId = requestId_example; // 
-String *version = version_example; // 
-String *body = body_example; //  (optional)
-
-OnapsoinfracloudResourcesRequestsApi *apiInstance = [[OnapsoinfracloudResourcesRequestsApi alloc] init];
-
-// Unlock CloudOrchestration requests for a specified requestId
-[apiInstance unlockOrchestrationRequestForReqIdWith:requestId
-    version:version
-    body:body
-              completionHandler: ^(NSError* error) {
-                            if (error) {
-                                NSLog(@"Error: %@", error);
-                            }
-                        }];
-
-
- -
-
var SoCasablancaApIs = require('so_casablanca_ap_is');
-
-var api = new SoCasablancaApIs.OnapsoinfracloudResourcesRequestsApi()
-
-var requestId = requestId_example; // {String} 
-
-var version = version_example; // {String} 
-
-var opts = { 
-  'body': body_example // {String} 
-};
-
-var callback = function(error, data, response) {
-  if (error) {
-    console.error(error);
-  } else {
-    console.log('API called successfully.');
-  }
-};
-api.unlockOrchestrationRequestForReqId(requestId, version, opts, callback);
-
-
- - -
-
using System;
-using System.Diagnostics;
-using IO.Swagger.Api;
-using IO.Swagger.Client;
-using IO.Swagger.Model;
-
-namespace Example
-{
-    public class unlockOrchestrationRequestForReqIdExample
-    {
-        public void main()
-        {
-            
-            var apiInstance = new OnapsoinfracloudResourcesRequestsApi();
-            var requestId = requestId_example;  // String | 
-            var version = version_example;  // String | 
-            var body = body_example;  // String |  (optional) 
-
-            try
-            {
-                // Unlock CloudOrchestration requests for a specified requestId
-                apiInstance.unlockOrchestrationRequestForReqId(requestId, version, body);
-            }
-            catch (Exception e)
-            {
-                Debug.Print("Exception when calling OnapsoinfracloudResourcesRequestsApi.unlockOrchestrationRequestForReqId: " + e.Message );
-            }
-        }
-    }
-}
-
-
- -
-
<?php
-require_once(__DIR__ . '/vendor/autoload.php');
-
-$api_instance = new Swagger\Client\Api\OnapsoinfracloudResourcesRequestsApi();
-$requestId = requestId_example; // String | 
-$version = version_example; // String | 
-$body = body_example; // String | 
-
-try {
-    $api_instance->unlockOrchestrationRequestForReqId($requestId, $version, $body);
-} catch (Exception $e) {
-    echo 'Exception when calling OnapsoinfracloudResourcesRequestsApi->unlockOrchestrationRequestForReqId: ', $e->getMessage(), PHP_EOL;
-}
-?>
-
- -
-
use Data::Dumper;
-use WWW::SwaggerClient::Configuration;
-use WWW::SwaggerClient::OnapsoinfracloudResourcesRequestsApi;
-
-my $api_instance = WWW::SwaggerClient::OnapsoinfracloudResourcesRequestsApi->new();
-my $requestId = requestId_example; # String | 
-my $version = version_example; # String | 
-my $body = WWW::SwaggerClient::Object::String->new(); # String | 
-
-eval { 
-    $api_instance->unlockOrchestrationRequestForReqId(requestId => $requestId, version => $version, body => $body);
-};
-if ($@) {
-    warn "Exception when calling OnapsoinfracloudResourcesRequestsApi->unlockOrchestrationRequestForReqId: $@\n";
-}
-
- -
-
from __future__ import print_statement
-import time
-import swagger_client
-from swagger_client.rest import ApiException
-from pprint import pprint
-
-# create an instance of the API class
-api_instance = swagger_client.OnapsoinfracloudResourcesRequestsApi()
-requestId = requestId_example # String | 
-version = version_example # String | 
-body = body_example # String |  (optional)
-
-try: 
-    # Unlock CloudOrchestration requests for a specified requestId
-    api_instance.unlock_orchestration_request_for_req_id(requestId, version, body=body)
-except ApiException as e:
-    print("Exception when calling OnapsoinfracloudResourcesRequestsApi->unlockOrchestrationRequestForReqId: %s\n" % e)
-
-
- -

Parameters

- -
Path parameters
- - - - - - - - - - - - - -
NameDescription
requestId* - - -
-
-
- - String - - -
-
- Required -
-
-
-
version* - - -
-
-
- - String - - -
-
- Required -
-
-
-
- - -
Body parameters
- - - - - - - - - -
NameDescription
body - - - -
-
- - - -

Responses

-

Status: default - successful operation

- - - -
-
- -
-
-
-
-
-

OnapsoinframodelDistributions

-
-
-
-

updateModelDistributionStatus

-

Update model distribution status

-
-
-
-

-

-

-
-
/onap/so/infra/modelDistributions/{version}/distributions/{distributionId}
-

-

Usage and SDK Samples

-

- - -
-
-
curl -X POST "https://localhost/onap/so/infra/modelDistributions/{version}/distributions/{distributionId}"
-
-
-
import io.swagger.client.*;
-import io.swagger.client.auth.*;
-import io.swagger.client.model.*;
-import io.swagger.client.api.OnapsoinframodelDistributionsApi;
-
-import java.io.File;
-import java.util.*;
-
-public class OnapsoinframodelDistributionsApiExample {
-
-    public static void main(String[] args) {
-        
-        OnapsoinframodelDistributionsApi apiInstance = new OnapsoinframodelDistributionsApi();
-        String version = version_example; // String | 
-        String distributionId = distributionId_example; // String | 
-        String body = body_example; // String | 
-        try {
-            apiInstance.updateModelDistributionStatus(version, distributionId, body);
-        } catch (ApiException e) {
-            System.err.println("Exception when calling OnapsoinframodelDistributionsApi#updateModelDistributionStatus");
-            e.printStackTrace();
-        }
-    }
-}
-
- -
-
import io.swagger.client.api.OnapsoinframodelDistributionsApi;
-
-public class OnapsoinframodelDistributionsApiExample {
-
-    public static void main(String[] args) {
-        OnapsoinframodelDistributionsApi apiInstance = new OnapsoinframodelDistributionsApi();
-        String version = version_example; // String | 
-        String distributionId = distributionId_example; // String | 
-        String body = body_example; // String | 
-        try {
-            apiInstance.updateModelDistributionStatus(version, distributionId, body);
-        } catch (ApiException e) {
-            System.err.println("Exception when calling OnapsoinframodelDistributionsApi#updateModelDistributionStatus");
-            e.printStackTrace();
-        }
-    }
-}
-
- -
-
String *version = version_example; // 
-String *distributionId = distributionId_example; // 
-String *body = body_example; //  (optional)
-
-OnapsoinframodelDistributionsApi *apiInstance = [[OnapsoinframodelDistributionsApi alloc] init];
-
-// Update model distribution status
-[apiInstance updateModelDistributionStatusWith:version
-    distributionId:distributionId
-    body:body
-              completionHandler: ^(NSError* error) {
-                            if (error) {
-                                NSLog(@"Error: %@", error);
-                            }
-                        }];
-
-
- -
-
var SoCasablancaApIs = require('so_casablanca_ap_is');
-
-var api = new SoCasablancaApIs.OnapsoinframodelDistributionsApi()
-
-var version = version_example; // {String} 
-
-var distributionId = distributionId_example; // {String} 
-
-var opts = { 
-  'body': body_example // {String} 
-};
-
-var callback = function(error, data, response) {
-  if (error) {
-    console.error(error);
-  } else {
-    console.log('API called successfully.');
-  }
-};
-api.updateModelDistributionStatus(version, distributionId, opts, callback);
-
-
- - -
-
using System;
-using System.Diagnostics;
-using IO.Swagger.Api;
-using IO.Swagger.Client;
-using IO.Swagger.Model;
-
-namespace Example
-{
-    public class updateModelDistributionStatusExample
-    {
-        public void main()
-        {
-            
-            var apiInstance = new OnapsoinframodelDistributionsApi();
-            var version = version_example;  // String | 
-            var distributionId = distributionId_example;  // String | 
-            var body = body_example;  // String |  (optional) 
-
-            try
-            {
-                // Update model distribution status
-                apiInstance.updateModelDistributionStatus(version, distributionId, body);
-            }
-            catch (Exception e)
-            {
-                Debug.Print("Exception when calling OnapsoinframodelDistributionsApi.updateModelDistributionStatus: " + e.Message );
-            }
-        }
-    }
-}
-
-
- -
-
<?php
-require_once(__DIR__ . '/vendor/autoload.php');
-
-$api_instance = new Swagger\Client\Api\OnapsoinframodelDistributionsApi();
-$version = version_example; // String | 
-$distributionId = distributionId_example; // String | 
-$body = body_example; // String | 
-
-try {
-    $api_instance->updateModelDistributionStatus($version, $distributionId, $body);
-} catch (Exception $e) {
-    echo 'Exception when calling OnapsoinframodelDistributionsApi->updateModelDistributionStatus: ', $e->getMessage(), PHP_EOL;
-}
-?>
-
- -
-
use Data::Dumper;
-use WWW::SwaggerClient::Configuration;
-use WWW::SwaggerClient::OnapsoinframodelDistributionsApi;
-
-my $api_instance = WWW::SwaggerClient::OnapsoinframodelDistributionsApi->new();
-my $version = version_example; # String | 
-my $distributionId = distributionId_example; # String | 
-my $body = WWW::SwaggerClient::Object::String->new(); # String | 
-
-eval { 
-    $api_instance->updateModelDistributionStatus(version => $version, distributionId => $distributionId, body => $body);
-};
-if ($@) {
-    warn "Exception when calling OnapsoinframodelDistributionsApi->updateModelDistributionStatus: $@\n";
-}
-
- -
-
from __future__ import print_statement
-import time
-import swagger_client
-from swagger_client.rest import ApiException
-from pprint import pprint
-
-# create an instance of the API class
-api_instance = swagger_client.OnapsoinframodelDistributionsApi()
-version = version_example # String | 
-distributionId = distributionId_example # String | 
-body = body_example # String |  (optional)
-
-try: 
-    # Update model distribution status
-    api_instance.update_model_distribution_status(version, distributionId, body=body)
-except ApiException as e:
-    print("Exception when calling OnapsoinframodelDistributionsApi->updateModelDistributionStatus: %s\n" % e)
-
-
- -

Parameters

- -
Path parameters
- - - - - - - - - - - - - -
NameDescription
version* - - -
-
-
- - String - - -
-
- Required -
-
-
-
distributionId* - - -
-
-
- - String - - -
-
- Required -
-
-
-
- - -
Body parameters
- - - - - - - - - -
NameDescription
body - - - -
-
- - - -

Responses

-

Status: default - successful operation

- - - -
-
- -
-
-
-
-
-

OnapsoinfraorchestrationRequests

-
-
-
-

getOrchestrationRequest

-

Find Orchestrated Requests for a URI Information

-
-
-
-

-

-

-
-
/onap/so/infra/orchestrationRequests/{version}
-

-

Usage and SDK Samples

-

- - -
-
-
curl -X GET "https://localhost/onap/so/infra/orchestrationRequests/{version}"
-
-
-
import io.swagger.client.*;
-import io.swagger.client.auth.*;
-import io.swagger.client.model.*;
-import io.swagger.client.api.OnapsoinfraorchestrationRequestsApi;
-
-import java.io.File;
-import java.util.*;
-
-public class OnapsoinfraorchestrationRequestsApiExample {
-
-    public static void main(String[] args) {
-        
-        OnapsoinfraorchestrationRequestsApi apiInstance = new OnapsoinfraorchestrationRequestsApi();
-        String version = version_example; // String | 
-        try {
-            apiInstance.getOrchestrationRequest(version);
-        } catch (ApiException e) {
-            System.err.println("Exception when calling OnapsoinfraorchestrationRequestsApi#getOrchestrationRequest");
-            e.printStackTrace();
-        }
-    }
-}
-
- -
-
import io.swagger.client.api.OnapsoinfraorchestrationRequestsApi;
-
-public class OnapsoinfraorchestrationRequestsApiExample {
-
-    public static void main(String[] args) {
-        OnapsoinfraorchestrationRequestsApi apiInstance = new OnapsoinfraorchestrationRequestsApi();
-        String version = version_example; // String | 
-        try {
-            apiInstance.getOrchestrationRequest(version);
-        } catch (ApiException e) {
-            System.err.println("Exception when calling OnapsoinfraorchestrationRequestsApi#getOrchestrationRequest");
-            e.printStackTrace();
-        }
-    }
-}
-
- -
-
String *version = version_example; // 
-
-OnapsoinfraorchestrationRequestsApi *apiInstance = [[OnapsoinfraorchestrationRequestsApi alloc] init];
-
-// Find Orchestrated Requests for a URI Information
-[apiInstance getOrchestrationRequestWith:version
-              completionHandler: ^(NSError* error) {
-                            if (error) {
-                                NSLog(@"Error: %@", error);
-                            }
-                        }];
-
-
- -
-
var SoCasablancaApIs = require('so_casablanca_ap_is');
-
-var api = new SoCasablancaApIs.OnapsoinfraorchestrationRequestsApi()
-
-var version = version_example; // {String} 
-
-
-var callback = function(error, data, response) {
-  if (error) {
-    console.error(error);
-  } else {
-    console.log('API called successfully.');
-  }
-};
-api.getOrchestrationRequest(version, callback);
-
-
- - -
-
using System;
-using System.Diagnostics;
-using IO.Swagger.Api;
-using IO.Swagger.Client;
-using IO.Swagger.Model;
-
-namespace Example
-{
-    public class getOrchestrationRequestExample
-    {
-        public void main()
-        {
-            
-            var apiInstance = new OnapsoinfraorchestrationRequestsApi();
-            var version = version_example;  // String | 
-
-            try
-            {
-                // Find Orchestrated Requests for a URI Information
-                apiInstance.getOrchestrationRequest(version);
-            }
-            catch (Exception e)
-            {
-                Debug.Print("Exception when calling OnapsoinfraorchestrationRequestsApi.getOrchestrationRequest: " + e.Message );
-            }
-        }
-    }
-}
-
-
- -
-
<?php
-require_once(__DIR__ . '/vendor/autoload.php');
-
-$api_instance = new Swagger\Client\Api\OnapsoinfraorchestrationRequestsApi();
-$version = version_example; // String | 
-
-try {
-    $api_instance->getOrchestrationRequest($version);
-} catch (Exception $e) {
-    echo 'Exception when calling OnapsoinfraorchestrationRequestsApi->getOrchestrationRequest: ', $e->getMessage(), PHP_EOL;
-}
-?>
-
- -
-
use Data::Dumper;
-use WWW::SwaggerClient::Configuration;
-use WWW::SwaggerClient::OnapsoinfraorchestrationRequestsApi;
-
-my $api_instance = WWW::SwaggerClient::OnapsoinfraorchestrationRequestsApi->new();
-my $version = version_example; # String | 
-
-eval { 
-    $api_instance->getOrchestrationRequest(version => $version);
-};
-if ($@) {
-    warn "Exception when calling OnapsoinfraorchestrationRequestsApi->getOrchestrationRequest: $@\n";
-}
-
- -
-
from __future__ import print_statement
-import time
-import swagger_client
-from swagger_client.rest import ApiException
-from pprint import pprint
-
-# create an instance of the API class
-api_instance = swagger_client.OnapsoinfraorchestrationRequestsApi()
-version = version_example # String | 
-
-try: 
-    # Find Orchestrated Requests for a URI Information
-    api_instance.get_orchestration_request(version)
-except ApiException as e:
-    print("Exception when calling OnapsoinfraorchestrationRequestsApi->getOrchestrationRequest: %s\n" % e)
-
-
- -

Parameters

- -
Path parameters
- - - - - - - - - -
NameDescription
version* - - -
-
-
- - String - - -
-
- Required -
-
-
-
- - - - - -

Responses

-

Status: default - successful operation

- - - -
-
- -
-
-
-
-
-
-

getOrchestrationRequestForReqId

-

Find Orchestrated Requests for a given requestId

-
-
-
-

-

-

-
-
/onap/so/infra/orchestrationRequests/{version}/{requestId}
-

-

Usage and SDK Samples

-

- - -
-
-
curl -X GET "https://localhost/onap/so/infra/orchestrationRequests/{version}/{requestId}"
-
-
-
import io.swagger.client.*;
-import io.swagger.client.auth.*;
-import io.swagger.client.model.*;
-import io.swagger.client.api.OnapsoinfraorchestrationRequestsApi;
-
-import java.io.File;
-import java.util.*;
-
-public class OnapsoinfraorchestrationRequestsApiExample {
-
-    public static void main(String[] args) {
-        
-        OnapsoinfraorchestrationRequestsApi apiInstance = new OnapsoinfraorchestrationRequestsApi();
-        String requestId = requestId_example; // String | 
-        String version = version_example; // String | 
-        try {
-            apiInstance.getOrchestrationRequestForReqId(requestId, version);
-        } catch (ApiException e) {
-            System.err.println("Exception when calling OnapsoinfraorchestrationRequestsApi#getOrchestrationRequestForReqId");
-            e.printStackTrace();
-        }
-    }
-}
-
- -
-
import io.swagger.client.api.OnapsoinfraorchestrationRequestsApi;
-
-public class OnapsoinfraorchestrationRequestsApiExample {
-
-    public static void main(String[] args) {
-        OnapsoinfraorchestrationRequestsApi apiInstance = new OnapsoinfraorchestrationRequestsApi();
-        String requestId = requestId_example; // String | 
-        String version = version_example; // String | 
-        try {
-            apiInstance.getOrchestrationRequestForReqId(requestId, version);
-        } catch (ApiException e) {
-            System.err.println("Exception when calling OnapsoinfraorchestrationRequestsApi#getOrchestrationRequestForReqId");
-            e.printStackTrace();
-        }
-    }
-}
-
- -
-
String *requestId = requestId_example; // 
-String *version = version_example; // 
-
-OnapsoinfraorchestrationRequestsApi *apiInstance = [[OnapsoinfraorchestrationRequestsApi alloc] init];
-
-// Find Orchestrated Requests for a given requestId
-[apiInstance getOrchestrationRequestForReqIdWith:requestId
-    version:version
-              completionHandler: ^(NSError* error) {
-                            if (error) {
-                                NSLog(@"Error: %@", error);
-                            }
-                        }];
-
-
- -
-
var SoCasablancaApIs = require('so_casablanca_ap_is');
-
-var api = new SoCasablancaApIs.OnapsoinfraorchestrationRequestsApi()
-
-var requestId = requestId_example; // {String} 
-
-var version = version_example; // {String} 
-
-
-var callback = function(error, data, response) {
-  if (error) {
-    console.error(error);
-  } else {
-    console.log('API called successfully.');
-  }
-};
-api.getOrchestrationRequestForReqId(requestId, version, callback);
-
-
- - -
-
using System;
-using System.Diagnostics;
-using IO.Swagger.Api;
-using IO.Swagger.Client;
-using IO.Swagger.Model;
-
-namespace Example
-{
-    public class getOrchestrationRequestForReqIdExample
-    {
-        public void main()
-        {
-            
-            var apiInstance = new OnapsoinfraorchestrationRequestsApi();
-            var requestId = requestId_example;  // String | 
-            var version = version_example;  // String | 
-
-            try
-            {
-                // Find Orchestrated Requests for a given requestId
-                apiInstance.getOrchestrationRequestForReqId(requestId, version);
-            }
-            catch (Exception e)
-            {
-                Debug.Print("Exception when calling OnapsoinfraorchestrationRequestsApi.getOrchestrationRequestForReqId: " + e.Message );
-            }
-        }
-    }
-}
-
-
- -
-
<?php
-require_once(__DIR__ . '/vendor/autoload.php');
-
-$api_instance = new Swagger\Client\Api\OnapsoinfraorchestrationRequestsApi();
-$requestId = requestId_example; // String | 
-$version = version_example; // String | 
-
-try {
-    $api_instance->getOrchestrationRequestForReqId($requestId, $version);
-} catch (Exception $e) {
-    echo 'Exception when calling OnapsoinfraorchestrationRequestsApi->getOrchestrationRequestForReqId: ', $e->getMessage(), PHP_EOL;
-}
-?>
-
- -
-
use Data::Dumper;
-use WWW::SwaggerClient::Configuration;
-use WWW::SwaggerClient::OnapsoinfraorchestrationRequestsApi;
-
-my $api_instance = WWW::SwaggerClient::OnapsoinfraorchestrationRequestsApi->new();
-my $requestId = requestId_example; # String | 
-my $version = version_example; # String | 
-
-eval { 
-    $api_instance->getOrchestrationRequestForReqId(requestId => $requestId, version => $version);
-};
-if ($@) {
-    warn "Exception when calling OnapsoinfraorchestrationRequestsApi->getOrchestrationRequestForReqId: $@\n";
-}
-
- -
-
from __future__ import print_statement
-import time
-import swagger_client
-from swagger_client.rest import ApiException
-from pprint import pprint
-
-# create an instance of the API class
-api_instance = swagger_client.OnapsoinfraorchestrationRequestsApi()
-requestId = requestId_example # String | 
-version = version_example # String | 
-
-try: 
-    # Find Orchestrated Requests for a given requestId
-    api_instance.get_orchestration_request_for_req_id(requestId, version)
-except ApiException as e:
-    print("Exception when calling OnapsoinfraorchestrationRequestsApi->getOrchestrationRequestForReqId: %s\n" % e)
-
-
- -

Parameters

- -
Path parameters
- - - - - - - - - - - - - -
NameDescription
requestId* - - -
-
-
- - String - - -
-
- Required -
-
-
-
version* - - -
-
-
- - String - - -
-
- Required -
-
-
-
- - - - - -

Responses

-

Status: default - successful operation

- - - -
-
- -
-
-
-
-
-
-

unlockOrchestrationRequest

-

Unlock Orchestrated Requests for a given requestId

-
-
-
-

-

-

-
-
/onap/so/infra/orchestrationRequests/{version}/{requestId}/unlock
-

-

Usage and SDK Samples

-

- - -
-
-
curl -X POST "https://localhost/onap/so/infra/orchestrationRequests/{version}/{requestId}/unlock"
-
-
-
import io.swagger.client.*;
-import io.swagger.client.auth.*;
-import io.swagger.client.model.*;
-import io.swagger.client.api.OnapsoinfraorchestrationRequestsApi;
-
-import java.io.File;
-import java.util.*;
-
-public class OnapsoinfraorchestrationRequestsApiExample {
-
-    public static void main(String[] args) {
-        
-        OnapsoinfraorchestrationRequestsApi apiInstance = new OnapsoinfraorchestrationRequestsApi();
-        String requestId = requestId_example; // String | 
-        String version = version_example; // String | 
-        String body = body_example; // String | 
-        try {
-            apiInstance.unlockOrchestrationRequest(requestId, version, body);
-        } catch (ApiException e) {
-            System.err.println("Exception when calling OnapsoinfraorchestrationRequestsApi#unlockOrchestrationRequest");
-            e.printStackTrace();
-        }
-    }
-}
-
- -
-
import io.swagger.client.api.OnapsoinfraorchestrationRequestsApi;
-
-public class OnapsoinfraorchestrationRequestsApiExample {
-
-    public static void main(String[] args) {
-        OnapsoinfraorchestrationRequestsApi apiInstance = new OnapsoinfraorchestrationRequestsApi();
-        String requestId = requestId_example; // String | 
-        String version = version_example; // String | 
-        String body = body_example; // String | 
-        try {
-            apiInstance.unlockOrchestrationRequest(requestId, version, body);
-        } catch (ApiException e) {
-            System.err.println("Exception when calling OnapsoinfraorchestrationRequestsApi#unlockOrchestrationRequest");
-            e.printStackTrace();
-        }
-    }
-}
-
- -
-
String *requestId = requestId_example; // 
-String *version = version_example; // 
-String *body = body_example; //  (optional)
-
-OnapsoinfraorchestrationRequestsApi *apiInstance = [[OnapsoinfraorchestrationRequestsApi alloc] init];
-
-// Unlock Orchestrated Requests for a given requestId
-[apiInstance unlockOrchestrationRequestWith:requestId
-    version:version
-    body:body
-              completionHandler: ^(NSError* error) {
-                            if (error) {
-                                NSLog(@"Error: %@", error);
-                            }
-                        }];
-
-
- -
-
var SoCasablancaApIs = require('so_casablanca_ap_is');
-
-var api = new SoCasablancaApIs.OnapsoinfraorchestrationRequestsApi()
-
-var requestId = requestId_example; // {String} 
-
-var version = version_example; // {String} 
-
-var opts = { 
-  'body': body_example // {String} 
-};
-
-var callback = function(error, data, response) {
-  if (error) {
-    console.error(error);
-  } else {
-    console.log('API called successfully.');
-  }
-};
-api.unlockOrchestrationRequest(requestId, version, opts, callback);
-
-
- - -
-
using System;
-using System.Diagnostics;
-using IO.Swagger.Api;
-using IO.Swagger.Client;
-using IO.Swagger.Model;
-
-namespace Example
-{
-    public class unlockOrchestrationRequestExample
-    {
-        public void main()
-        {
-            
-            var apiInstance = new OnapsoinfraorchestrationRequestsApi();
-            var requestId = requestId_example;  // String | 
-            var version = version_example;  // String | 
-            var body = body_example;  // String |  (optional) 
-
-            try
-            {
-                // Unlock Orchestrated Requests for a given requestId
-                apiInstance.unlockOrchestrationRequest(requestId, version, body);
-            }
-            catch (Exception e)
-            {
-                Debug.Print("Exception when calling OnapsoinfraorchestrationRequestsApi.unlockOrchestrationRequest: " + e.Message );
-            }
-        }
-    }
-}
-
-
- -
-
<?php
-require_once(__DIR__ . '/vendor/autoload.php');
-
-$api_instance = new Swagger\Client\Api\OnapsoinfraorchestrationRequestsApi();
-$requestId = requestId_example; // String | 
-$version = version_example; // String | 
-$body = body_example; // String | 
-
-try {
-    $api_instance->unlockOrchestrationRequest($requestId, $version, $body);
-} catch (Exception $e) {
-    echo 'Exception when calling OnapsoinfraorchestrationRequestsApi->unlockOrchestrationRequest: ', $e->getMessage(), PHP_EOL;
-}
-?>
-
- -
-
use Data::Dumper;
-use WWW::SwaggerClient::Configuration;
-use WWW::SwaggerClient::OnapsoinfraorchestrationRequestsApi;
-
-my $api_instance = WWW::SwaggerClient::OnapsoinfraorchestrationRequestsApi->new();
-my $requestId = requestId_example; # String | 
-my $version = version_example; # String | 
-my $body = WWW::SwaggerClient::Object::String->new(); # String | 
-
-eval { 
-    $api_instance->unlockOrchestrationRequest(requestId => $requestId, version => $version, body => $body);
-};
-if ($@) {
-    warn "Exception when calling OnapsoinfraorchestrationRequestsApi->unlockOrchestrationRequest: $@\n";
-}
-
- -
-
from __future__ import print_statement
-import time
-import swagger_client
-from swagger_client.rest import ApiException
-from pprint import pprint
-
-# create an instance of the API class
-api_instance = swagger_client.OnapsoinfraorchestrationRequestsApi()
-requestId = requestId_example # String | 
-version = version_example # String | 
-body = body_example # String |  (optional)
-
-try: 
-    # Unlock Orchestrated Requests for a given requestId
-    api_instance.unlock_orchestration_request(requestId, version, body=body)
-except ApiException as e:
-    print("Exception when calling OnapsoinfraorchestrationRequestsApi->unlockOrchestrationRequest: %s\n" % e)
-
-
- -

Parameters

- -
Path parameters
- - - - - - - - - - - - - -
NameDescription
requestId* - - -
-
-
- - String - - -
-
- Required -
-
-
-
version* - - -
-
-
- - String - - -
-
- Required -
-
-
-
- - -
Body parameters
- - - - - - - - - -
NameDescription
body - - - -
-
- - - -

Responses

-

Status: default - successful operation

- - - -
-
- -
-
-
-
-
-

OnapsoinfraserviceInstantiation

-
-
-
-

activatePort

-

Activate Port Mirroring

-
-
-
-

-

-

-
-
/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/configurations/{configurationInstanceId}/activate
-

-

Usage and SDK Samples

-

- - -
-
-
curl -X POST "https://localhost/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/configurations/{configurationInstanceId}/activate"
-
-
-
import io.swagger.client.*;
-import io.swagger.client.auth.*;
-import io.swagger.client.model.*;
-import io.swagger.client.api.OnapsoinfraserviceInstantiationApi;
-
-import java.io.File;
-import java.util.*;
-
-public class OnapsoinfraserviceInstantiationApiExample {
-
-    public static void main(String[] args) {
-        
-        OnapsoinfraserviceInstantiationApi apiInstance = new OnapsoinfraserviceInstantiationApi();
-        String version = version_example; // String | 
-        String serviceInstanceId = serviceInstanceId_example; // String | 
-        String configurationInstanceId = configurationInstanceId_example; // String | 
-        String body = body_example; // String | 
-        try {
-            apiInstance.activatePort(version, serviceInstanceId, configurationInstanceId, body);
-        } catch (ApiException e) {
-            System.err.println("Exception when calling OnapsoinfraserviceInstantiationApi#activatePort");
-            e.printStackTrace();
-        }
-    }
-}
-
- -
-
import io.swagger.client.api.OnapsoinfraserviceInstantiationApi;
-
-public class OnapsoinfraserviceInstantiationApiExample {
-
-    public static void main(String[] args) {
-        OnapsoinfraserviceInstantiationApi apiInstance = new OnapsoinfraserviceInstantiationApi();
-        String version = version_example; // String | 
-        String serviceInstanceId = serviceInstanceId_example; // String | 
-        String configurationInstanceId = configurationInstanceId_example; // String | 
-        String body = body_example; // String | 
-        try {
-            apiInstance.activatePort(version, serviceInstanceId, configurationInstanceId, body);
-        } catch (ApiException e) {
-            System.err.println("Exception when calling OnapsoinfraserviceInstantiationApi#activatePort");
-            e.printStackTrace();
-        }
-    }
-}
-
- -
-
String *version = version_example; // 
-String *serviceInstanceId = serviceInstanceId_example; // 
-String *configurationInstanceId = configurationInstanceId_example; // 
-String *body = body_example; //  (optional)
-
-OnapsoinfraserviceInstantiationApi *apiInstance = [[OnapsoinfraserviceInstantiationApi alloc] init];
-
-// Activate Port Mirroring
-[apiInstance activatePortWith:version
-    serviceInstanceId:serviceInstanceId
-    configurationInstanceId:configurationInstanceId
-    body:body
-              completionHandler: ^(NSError* error) {
-                            if (error) {
-                                NSLog(@"Error: %@", error);
-                            }
-                        }];
-
-
- -
-
var SoCasablancaApIs = require('so_casablanca_ap_is');
-
-var api = new SoCasablancaApIs.OnapsoinfraserviceInstantiationApi()
-
-var version = version_example; // {String} 
-
-var serviceInstanceId = serviceInstanceId_example; // {String} 
-
-var configurationInstanceId = configurationInstanceId_example; // {String} 
-
-var opts = { 
-  'body': body_example // {String} 
-};
-
-var callback = function(error, data, response) {
-  if (error) {
-    console.error(error);
-  } else {
-    console.log('API called successfully.');
-  }
-};
-api.activatePort(version, serviceInstanceId, configurationInstanceId, opts, callback);
-
-
- - -
-
using System;
-using System.Diagnostics;
-using IO.Swagger.Api;
-using IO.Swagger.Client;
-using IO.Swagger.Model;
-
-namespace Example
-{
-    public class activatePortExample
-    {
-        public void main()
-        {
-            
-            var apiInstance = new OnapsoinfraserviceInstantiationApi();
-            var version = version_example;  // String | 
-            var serviceInstanceId = serviceInstanceId_example;  // String | 
-            var configurationInstanceId = configurationInstanceId_example;  // String | 
-            var body = body_example;  // String |  (optional) 
-
-            try
-            {
-                // Activate Port Mirroring
-                apiInstance.activatePort(version, serviceInstanceId, configurationInstanceId, body);
-            }
-            catch (Exception e)
-            {
-                Debug.Print("Exception when calling OnapsoinfraserviceInstantiationApi.activatePort: " + e.Message );
-            }
-        }
-    }
-}
-
-
- -
-
<?php
-require_once(__DIR__ . '/vendor/autoload.php');
-
-$api_instance = new Swagger\Client\Api\OnapsoinfraserviceInstantiationApi();
-$version = version_example; // String | 
-$serviceInstanceId = serviceInstanceId_example; // String | 
-$configurationInstanceId = configurationInstanceId_example; // String | 
-$body = body_example; // String | 
-
-try {
-    $api_instance->activatePort($version, $serviceInstanceId, $configurationInstanceId, $body);
-} catch (Exception $e) {
-    echo 'Exception when calling OnapsoinfraserviceInstantiationApi->activatePort: ', $e->getMessage(), PHP_EOL;
-}
-?>
-
- -
-
use Data::Dumper;
-use WWW::SwaggerClient::Configuration;
-use WWW::SwaggerClient::OnapsoinfraserviceInstantiationApi;
-
-my $api_instance = WWW::SwaggerClient::OnapsoinfraserviceInstantiationApi->new();
-my $version = version_example; # String | 
-my $serviceInstanceId = serviceInstanceId_example; # String | 
-my $configurationInstanceId = configurationInstanceId_example; # String | 
-my $body = WWW::SwaggerClient::Object::String->new(); # String | 
-
-eval { 
-    $api_instance->activatePort(version => $version, serviceInstanceId => $serviceInstanceId, configurationInstanceId => $configurationInstanceId, body => $body);
-};
-if ($@) {
-    warn "Exception when calling OnapsoinfraserviceInstantiationApi->activatePort: $@\n";
-}
-
- -
-
from __future__ import print_statement
-import time
-import swagger_client
-from swagger_client.rest import ApiException
-from pprint import pprint
-
-# create an instance of the API class
-api_instance = swagger_client.OnapsoinfraserviceInstantiationApi()
-version = version_example # String | 
-serviceInstanceId = serviceInstanceId_example # String | 
-configurationInstanceId = configurationInstanceId_example # String | 
-body = body_example # String |  (optional)
-
-try: 
-    # Activate Port Mirroring
-    api_instance.activate_port(version, serviceInstanceId, configurationInstanceId, body=body)
-except ApiException as e:
-    print("Exception when calling OnapsoinfraserviceInstantiationApi->activatePort: %s\n" % e)
-
-
- -

Parameters

- -
Path parameters
- - - - - - - - - - - - - - - - - -
NameDescription
version* - - -
-
-
- - String - - -
-
- Required -
-
-
-
serviceInstanceId* - - -
-
-
- - String - - -
-
- Required -
-
-
-
configurationInstanceId* - - -
-
-
- - String - - -
-
- Required -
-
-
-
- - -
Body parameters
- - - - - - - - - -
NameDescription
body - - - -
-
- - - -

Responses

-

Status: default - successful operation

- - - -
-
- -
-
-
-
-
-
-

activateServiceInstance

-

Activate provided Service Instance

-
-
-
-

-

-

-
-
/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/activate
-

-

Usage and SDK Samples

-

- - -
-
-
curl -X POST "https://localhost/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/activate"
-
-
-
import io.swagger.client.*;
-import io.swagger.client.auth.*;
-import io.swagger.client.model.*;
-import io.swagger.client.api.OnapsoinfraserviceInstantiationApi;
-
-import java.io.File;
-import java.util.*;
-
-public class OnapsoinfraserviceInstantiationApiExample {
-
-    public static void main(String[] args) {
-        
-        OnapsoinfraserviceInstantiationApi apiInstance = new OnapsoinfraserviceInstantiationApi();
-        String version = version_example; // String | 
-        String serviceInstanceId = serviceInstanceId_example; // String | 
-        String body = body_example; // String | 
-        try {
-            apiInstance.activateServiceInstance(version, serviceInstanceId, body);
-        } catch (ApiException e) {
-            System.err.println("Exception when calling OnapsoinfraserviceInstantiationApi#activateServiceInstance");
-            e.printStackTrace();
-        }
-    }
-}
-
- -
-
import io.swagger.client.api.OnapsoinfraserviceInstantiationApi;
-
-public class OnapsoinfraserviceInstantiationApiExample {
-
-    public static void main(String[] args) {
-        OnapsoinfraserviceInstantiationApi apiInstance = new OnapsoinfraserviceInstantiationApi();
-        String version = version_example; // String | 
-        String serviceInstanceId = serviceInstanceId_example; // String | 
-        String body = body_example; // String | 
-        try {
-            apiInstance.activateServiceInstance(version, serviceInstanceId, body);
-        } catch (ApiException e) {
-            System.err.println("Exception when calling OnapsoinfraserviceInstantiationApi#activateServiceInstance");
-            e.printStackTrace();
-        }
-    }
-}
-
- -
-
String *version = version_example; // 
-String *serviceInstanceId = serviceInstanceId_example; // 
-String *body = body_example; //  (optional)
-
-OnapsoinfraserviceInstantiationApi *apiInstance = [[OnapsoinfraserviceInstantiationApi alloc] init];
-
-// Activate provided Service Instance
-[apiInstance activateServiceInstanceWith:version
-    serviceInstanceId:serviceInstanceId
-    body:body
-              completionHandler: ^(NSError* error) {
-                            if (error) {
-                                NSLog(@"Error: %@", error);
-                            }
-                        }];
-
-
- -
-
var SoCasablancaApIs = require('so_casablanca_ap_is');
-
-var api = new SoCasablancaApIs.OnapsoinfraserviceInstantiationApi()
-
-var version = version_example; // {String} 
-
-var serviceInstanceId = serviceInstanceId_example; // {String} 
-
-var opts = { 
-  'body': body_example // {String} 
-};
-
-var callback = function(error, data, response) {
-  if (error) {
-    console.error(error);
-  } else {
-    console.log('API called successfully.');
-  }
-};
-api.activateServiceInstance(version, serviceInstanceId, opts, callback);
-
-
- - -
-
using System;
-using System.Diagnostics;
-using IO.Swagger.Api;
-using IO.Swagger.Client;
-using IO.Swagger.Model;
-
-namespace Example
-{
-    public class activateServiceInstanceExample
-    {
-        public void main()
-        {
-            
-            var apiInstance = new OnapsoinfraserviceInstantiationApi();
-            var version = version_example;  // String | 
-            var serviceInstanceId = serviceInstanceId_example;  // String | 
-            var body = body_example;  // String |  (optional) 
-
-            try
-            {
-                // Activate provided Service Instance
-                apiInstance.activateServiceInstance(version, serviceInstanceId, body);
-            }
-            catch (Exception e)
-            {
-                Debug.Print("Exception when calling OnapsoinfraserviceInstantiationApi.activateServiceInstance: " + e.Message );
-            }
-        }
-    }
-}
-
-
- -
-
<?php
-require_once(__DIR__ . '/vendor/autoload.php');
-
-$api_instance = new Swagger\Client\Api\OnapsoinfraserviceInstantiationApi();
-$version = version_example; // String | 
-$serviceInstanceId = serviceInstanceId_example; // String | 
-$body = body_example; // String | 
-
-try {
-    $api_instance->activateServiceInstance($version, $serviceInstanceId, $body);
-} catch (Exception $e) {
-    echo 'Exception when calling OnapsoinfraserviceInstantiationApi->activateServiceInstance: ', $e->getMessage(), PHP_EOL;
-}
-?>
-
- -
-
use Data::Dumper;
-use WWW::SwaggerClient::Configuration;
-use WWW::SwaggerClient::OnapsoinfraserviceInstantiationApi;
-
-my $api_instance = WWW::SwaggerClient::OnapsoinfraserviceInstantiationApi->new();
-my $version = version_example; # String | 
-my $serviceInstanceId = serviceInstanceId_example; # String | 
-my $body = WWW::SwaggerClient::Object::String->new(); # String | 
-
-eval { 
-    $api_instance->activateServiceInstance(version => $version, serviceInstanceId => $serviceInstanceId, body => $body);
-};
-if ($@) {
-    warn "Exception when calling OnapsoinfraserviceInstantiationApi->activateServiceInstance: $@\n";
-}
-
- -
-
from __future__ import print_statement
-import time
-import swagger_client
-from swagger_client.rest import ApiException
-from pprint import pprint
-
-# create an instance of the API class
-api_instance = swagger_client.OnapsoinfraserviceInstantiationApi()
-version = version_example # String | 
-serviceInstanceId = serviceInstanceId_example # String | 
-body = body_example # String |  (optional)
-
-try: 
-    # Activate provided Service Instance
-    api_instance.activate_service_instance(version, serviceInstanceId, body=body)
-except ApiException as e:
-    print("Exception when calling OnapsoinfraserviceInstantiationApi->activateServiceInstance: %s\n" % e)
-
-
- -

Parameters

- -
Path parameters
- - - - - - - - - - - - - -
NameDescription
version* - - -
-
-
- - String - - -
-
- Required -
-
-
-
serviceInstanceId* - - -
-
-
- - String - - -
-
- Required -
-
-
-
- - -
Body parameters
- - - - - - - - - -
NameDescription
body - - - -
-
- - - -

Responses

-

Status: default - successful operation

- - - -
-
- -
-
-
-
-
-
-

addRelationships

-

Add Relationships to a Service Instance

-
-
-
-

-

-

-
-
/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/addRelationships
-

-

Usage and SDK Samples

-

- - -
-
-
curl -X POST "https://localhost/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/addRelationships"
-
-
-
import io.swagger.client.*;
-import io.swagger.client.auth.*;
-import io.swagger.client.model.*;
-import io.swagger.client.api.OnapsoinfraserviceInstantiationApi;
-
-import java.io.File;
-import java.util.*;
-
-public class OnapsoinfraserviceInstantiationApiExample {
-
-    public static void main(String[] args) {
-        
-        OnapsoinfraserviceInstantiationApi apiInstance = new OnapsoinfraserviceInstantiationApi();
-        String version = version_example; // String | 
-        String serviceInstanceId = serviceInstanceId_example; // String | 
-        String body = body_example; // String | 
-        try {
-            apiInstance.addRelationships(version, serviceInstanceId, body);
-        } catch (ApiException e) {
-            System.err.println("Exception when calling OnapsoinfraserviceInstantiationApi#addRelationships");
-            e.printStackTrace();
-        }
-    }
-}
-
- -
-
import io.swagger.client.api.OnapsoinfraserviceInstantiationApi;
-
-public class OnapsoinfraserviceInstantiationApiExample {
-
-    public static void main(String[] args) {
-        OnapsoinfraserviceInstantiationApi apiInstance = new OnapsoinfraserviceInstantiationApi();
-        String version = version_example; // String | 
-        String serviceInstanceId = serviceInstanceId_example; // String | 
-        String body = body_example; // String | 
-        try {
-            apiInstance.addRelationships(version, serviceInstanceId, body);
-        } catch (ApiException e) {
-            System.err.println("Exception when calling OnapsoinfraserviceInstantiationApi#addRelationships");
-            e.printStackTrace();
-        }
-    }
-}
-
- -
-
String *version = version_example; // 
-String *serviceInstanceId = serviceInstanceId_example; // 
-String *body = body_example; //  (optional)
-
-OnapsoinfraserviceInstantiationApi *apiInstance = [[OnapsoinfraserviceInstantiationApi alloc] init];
-
-// Add Relationships to a Service Instance
-[apiInstance addRelationshipsWith:version
-    serviceInstanceId:serviceInstanceId
-    body:body
-              completionHandler: ^(NSError* error) {
-                            if (error) {
-                                NSLog(@"Error: %@", error);
-                            }
-                        }];
-
-
- -
-
var SoCasablancaApIs = require('so_casablanca_ap_is');
-
-var api = new SoCasablancaApIs.OnapsoinfraserviceInstantiationApi()
-
-var version = version_example; // {String} 
-
-var serviceInstanceId = serviceInstanceId_example; // {String} 
-
-var opts = { 
-  'body': body_example // {String} 
-};
-
-var callback = function(error, data, response) {
-  if (error) {
-    console.error(error);
-  } else {
-    console.log('API called successfully.');
-  }
-};
-api.addRelationships(version, serviceInstanceId, opts, callback);
-
-
- - -
-
using System;
-using System.Diagnostics;
-using IO.Swagger.Api;
-using IO.Swagger.Client;
-using IO.Swagger.Model;
-
-namespace Example
-{
-    public class addRelationshipsExample
-    {
-        public void main()
-        {
-            
-            var apiInstance = new OnapsoinfraserviceInstantiationApi();
-            var version = version_example;  // String | 
-            var serviceInstanceId = serviceInstanceId_example;  // String | 
-            var body = body_example;  // String |  (optional) 
-
-            try
-            {
-                // Add Relationships to a Service Instance
-                apiInstance.addRelationships(version, serviceInstanceId, body);
-            }
-            catch (Exception e)
-            {
-                Debug.Print("Exception when calling OnapsoinfraserviceInstantiationApi.addRelationships: " + e.Message );
-            }
-        }
-    }
-}
-
-
- -
-
<?php
-require_once(__DIR__ . '/vendor/autoload.php');
-
-$api_instance = new Swagger\Client\Api\OnapsoinfraserviceInstantiationApi();
-$version = version_example; // String | 
-$serviceInstanceId = serviceInstanceId_example; // String | 
-$body = body_example; // String | 
-
-try {
-    $api_instance->addRelationships($version, $serviceInstanceId, $body);
-} catch (Exception $e) {
-    echo 'Exception when calling OnapsoinfraserviceInstantiationApi->addRelationships: ', $e->getMessage(), PHP_EOL;
-}
-?>
-
- -
-
use Data::Dumper;
-use WWW::SwaggerClient::Configuration;
-use WWW::SwaggerClient::OnapsoinfraserviceInstantiationApi;
-
-my $api_instance = WWW::SwaggerClient::OnapsoinfraserviceInstantiationApi->new();
-my $version = version_example; # String | 
-my $serviceInstanceId = serviceInstanceId_example; # String | 
-my $body = WWW::SwaggerClient::Object::String->new(); # String | 
-
-eval { 
-    $api_instance->addRelationships(version => $version, serviceInstanceId => $serviceInstanceId, body => $body);
-};
-if ($@) {
-    warn "Exception when calling OnapsoinfraserviceInstantiationApi->addRelationships: $@\n";
-}
-
- -
-
from __future__ import print_statement
-import time
-import swagger_client
-from swagger_client.rest import ApiException
-from pprint import pprint
-
-# create an instance of the API class
-api_instance = swagger_client.OnapsoinfraserviceInstantiationApi()
-version = version_example # String | 
-serviceInstanceId = serviceInstanceId_example # String | 
-body = body_example # String |  (optional)
-
-try: 
-    # Add Relationships to a Service Instance
-    api_instance.add_relationships(version, serviceInstanceId, body=body)
-except ApiException as e:
-    print("Exception when calling OnapsoinfraserviceInstantiationApi->addRelationships: %s\n" % e)
-
-
- -

Parameters

- -
Path parameters
- - - - - - - - - - - - - -
NameDescription
version* - - -
-
-
- - String - - -
-
- Required -
-
-
-
serviceInstanceId* - - -
-
-
- - String - - -
-
- Required -
-
-
-
- - -
Body parameters
- - - - - - - - - -
NameDescription
body - - - -
-
- - - -

Responses

-

Status: default - successful operation

- - - -
-
- -
-
-
-
-
-
-

applyUpdatedConfig

-

Apply updated configuration

-
-
-
-

-

-

-
-
/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/vnfs/{vnfInstanceId}/applyUpdatedConfig
-

-

Usage and SDK Samples

-

- - -
-
-
curl -X POST "https://localhost/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/vnfs/{vnfInstanceId}/applyUpdatedConfig"
-
-
-
import io.swagger.client.*;
-import io.swagger.client.auth.*;
-import io.swagger.client.model.*;
-import io.swagger.client.api.OnapsoinfraserviceInstantiationApi;
-
-import java.io.File;
-import java.util.*;
-
-public class OnapsoinfraserviceInstantiationApiExample {
-
-    public static void main(String[] args) {
-        
-        OnapsoinfraserviceInstantiationApi apiInstance = new OnapsoinfraserviceInstantiationApi();
-        String version = version_example; // String | 
-        String serviceInstanceId = serviceInstanceId_example; // String | 
-        String vnfInstanceId = vnfInstanceId_example; // String | 
-        String body = body_example; // String | 
-        try {
-            apiInstance.applyUpdatedConfig(version, serviceInstanceId, vnfInstanceId, body);
-        } catch (ApiException e) {
-            System.err.println("Exception when calling OnapsoinfraserviceInstantiationApi#applyUpdatedConfig");
-            e.printStackTrace();
-        }
-    }
-}
-
- -
-
import io.swagger.client.api.OnapsoinfraserviceInstantiationApi;
-
-public class OnapsoinfraserviceInstantiationApiExample {
-
-    public static void main(String[] args) {
-        OnapsoinfraserviceInstantiationApi apiInstance = new OnapsoinfraserviceInstantiationApi();
-        String version = version_example; // String | 
-        String serviceInstanceId = serviceInstanceId_example; // String | 
-        String vnfInstanceId = vnfInstanceId_example; // String | 
-        String body = body_example; // String | 
-        try {
-            apiInstance.applyUpdatedConfig(version, serviceInstanceId, vnfInstanceId, body);
-        } catch (ApiException e) {
-            System.err.println("Exception when calling OnapsoinfraserviceInstantiationApi#applyUpdatedConfig");
-            e.printStackTrace();
-        }
-    }
-}
-
- -
-
String *version = version_example; // 
-String *serviceInstanceId = serviceInstanceId_example; // 
-String *vnfInstanceId = vnfInstanceId_example; // 
-String *body = body_example; //  (optional)
-
-OnapsoinfraserviceInstantiationApi *apiInstance = [[OnapsoinfraserviceInstantiationApi alloc] init];
-
-// Apply updated configuration
-[apiInstance applyUpdatedConfigWith:version
-    serviceInstanceId:serviceInstanceId
-    vnfInstanceId:vnfInstanceId
-    body:body
-              completionHandler: ^(NSError* error) {
-                            if (error) {
-                                NSLog(@"Error: %@", error);
-                            }
-                        }];
-
-
- -
-
var SoCasablancaApIs = require('so_casablanca_ap_is');
-
-var api = new SoCasablancaApIs.OnapsoinfraserviceInstantiationApi()
-
-var version = version_example; // {String} 
-
-var serviceInstanceId = serviceInstanceId_example; // {String} 
-
-var vnfInstanceId = vnfInstanceId_example; // {String} 
-
-var opts = { 
-  'body': body_example // {String} 
-};
-
-var callback = function(error, data, response) {
-  if (error) {
-    console.error(error);
-  } else {
-    console.log('API called successfully.');
-  }
-};
-api.applyUpdatedConfig(version, serviceInstanceId, vnfInstanceId, opts, callback);
-
-
- - -
-
using System;
-using System.Diagnostics;
-using IO.Swagger.Api;
-using IO.Swagger.Client;
-using IO.Swagger.Model;
-
-namespace Example
-{
-    public class applyUpdatedConfigExample
-    {
-        public void main()
-        {
-            
-            var apiInstance = new OnapsoinfraserviceInstantiationApi();
-            var version = version_example;  // String | 
-            var serviceInstanceId = serviceInstanceId_example;  // String | 
-            var vnfInstanceId = vnfInstanceId_example;  // String | 
-            var body = body_example;  // String |  (optional) 
-
-            try
-            {
-                // Apply updated configuration
-                apiInstance.applyUpdatedConfig(version, serviceInstanceId, vnfInstanceId, body);
-            }
-            catch (Exception e)
-            {
-                Debug.Print("Exception when calling OnapsoinfraserviceInstantiationApi.applyUpdatedConfig: " + e.Message );
-            }
-        }
-    }
-}
-
-
- -
-
<?php
-require_once(__DIR__ . '/vendor/autoload.php');
-
-$api_instance = new Swagger\Client\Api\OnapsoinfraserviceInstantiationApi();
-$version = version_example; // String | 
-$serviceInstanceId = serviceInstanceId_example; // String | 
-$vnfInstanceId = vnfInstanceId_example; // String | 
-$body = body_example; // String | 
-
-try {
-    $api_instance->applyUpdatedConfig($version, $serviceInstanceId, $vnfInstanceId, $body);
-} catch (Exception $e) {
-    echo 'Exception when calling OnapsoinfraserviceInstantiationApi->applyUpdatedConfig: ', $e->getMessage(), PHP_EOL;
-}
-?>
-
- -
-
use Data::Dumper;
-use WWW::SwaggerClient::Configuration;
-use WWW::SwaggerClient::OnapsoinfraserviceInstantiationApi;
-
-my $api_instance = WWW::SwaggerClient::OnapsoinfraserviceInstantiationApi->new();
-my $version = version_example; # String | 
-my $serviceInstanceId = serviceInstanceId_example; # String | 
-my $vnfInstanceId = vnfInstanceId_example; # String | 
-my $body = WWW::SwaggerClient::Object::String->new(); # String | 
-
-eval { 
-    $api_instance->applyUpdatedConfig(version => $version, serviceInstanceId => $serviceInstanceId, vnfInstanceId => $vnfInstanceId, body => $body);
-};
-if ($@) {
-    warn "Exception when calling OnapsoinfraserviceInstantiationApi->applyUpdatedConfig: $@\n";
-}
-
- -
-
from __future__ import print_statement
-import time
-import swagger_client
-from swagger_client.rest import ApiException
-from pprint import pprint
-
-# create an instance of the API class
-api_instance = swagger_client.OnapsoinfraserviceInstantiationApi()
-version = version_example # String | 
-serviceInstanceId = serviceInstanceId_example # String | 
-vnfInstanceId = vnfInstanceId_example # String | 
-body = body_example # String |  (optional)
-
-try: 
-    # Apply updated configuration
-    api_instance.apply_updated_config(version, serviceInstanceId, vnfInstanceId, body=body)
-except ApiException as e:
-    print("Exception when calling OnapsoinfraserviceInstantiationApi->applyUpdatedConfig: %s\n" % e)
-
-
- -

Parameters

- -
Path parameters
- - - - - - - - - - - - - - - - - -
NameDescription
version* - - -
-
-
- - String - - -
-
- Required -
-
-
-
serviceInstanceId* - - -
-
-
- - String - - -
-
- Required -
-
-
-
vnfInstanceId* - - -
-
-
- - String - - -
-
- Required -
-
-
-
- - -
Body parameters
- - - - - - - - - -
NameDescription
body - - - -
-
- - - -

Responses

-

Status: default - successful operation

- - - -
-
- -
-
-
-
-
-
-

assignServiceInstance

-

Assign Service Instance

-
-
-
-

-

-

-
-
/onap/so/infra/serviceInstantiation/{version}/serviceInstances/assign
-

-

Usage and SDK Samples

-

- - -
-
-
curl -X POST "https://localhost/onap/so/infra/serviceInstantiation/{version}/serviceInstances/assign"
-
-
-
import io.swagger.client.*;
-import io.swagger.client.auth.*;
-import io.swagger.client.model.*;
-import io.swagger.client.api.OnapsoinfraserviceInstantiationApi;
-
-import java.io.File;
-import java.util.*;
-
-public class OnapsoinfraserviceInstantiationApiExample {
-
-    public static void main(String[] args) {
-        
-        OnapsoinfraserviceInstantiationApi apiInstance = new OnapsoinfraserviceInstantiationApi();
-        String version = version_example; // String | 
-        String body = body_example; // String | 
-        try {
-            apiInstance.assignServiceInstance(version, body);
-        } catch (ApiException e) {
-            System.err.println("Exception when calling OnapsoinfraserviceInstantiationApi#assignServiceInstance");
-            e.printStackTrace();
-        }
-    }
-}
-
- -
-
import io.swagger.client.api.OnapsoinfraserviceInstantiationApi;
-
-public class OnapsoinfraserviceInstantiationApiExample {
-
-    public static void main(String[] args) {
-        OnapsoinfraserviceInstantiationApi apiInstance = new OnapsoinfraserviceInstantiationApi();
-        String version = version_example; // String | 
-        String body = body_example; // String | 
-        try {
-            apiInstance.assignServiceInstance(version, body);
-        } catch (ApiException e) {
-            System.err.println("Exception when calling OnapsoinfraserviceInstantiationApi#assignServiceInstance");
-            e.printStackTrace();
-        }
-    }
-}
-
- -
-
String *version = version_example; // 
-String *body = body_example; //  (optional)
-
-OnapsoinfraserviceInstantiationApi *apiInstance = [[OnapsoinfraserviceInstantiationApi alloc] init];
-
-// Assign Service Instance
-[apiInstance assignServiceInstanceWith:version
-    body:body
-              completionHandler: ^(NSError* error) {
-                            if (error) {
-                                NSLog(@"Error: %@", error);
-                            }
-                        }];
-
-
- -
-
var SoCasablancaApIs = require('so_casablanca_ap_is');
-
-var api = new SoCasablancaApIs.OnapsoinfraserviceInstantiationApi()
-
-var version = version_example; // {String} 
-
-var opts = { 
-  'body': body_example // {String} 
-};
-
-var callback = function(error, data, response) {
-  if (error) {
-    console.error(error);
-  } else {
-    console.log('API called successfully.');
-  }
-};
-api.assignServiceInstance(version, opts, callback);
-
-
- - -
-
using System;
-using System.Diagnostics;
-using IO.Swagger.Api;
-using IO.Swagger.Client;
-using IO.Swagger.Model;
-
-namespace Example
-{
-    public class assignServiceInstanceExample
-    {
-        public void main()
-        {
-            
-            var apiInstance = new OnapsoinfraserviceInstantiationApi();
-            var version = version_example;  // String | 
-            var body = body_example;  // String |  (optional) 
-
-            try
-            {
-                // Assign Service Instance
-                apiInstance.assignServiceInstance(version, body);
-            }
-            catch (Exception e)
-            {
-                Debug.Print("Exception when calling OnapsoinfraserviceInstantiationApi.assignServiceInstance: " + e.Message );
-            }
-        }
-    }
-}
-
-
- -
-
<?php
-require_once(__DIR__ . '/vendor/autoload.php');
-
-$api_instance = new Swagger\Client\Api\OnapsoinfraserviceInstantiationApi();
-$version = version_example; // String | 
-$body = body_example; // String | 
-
-try {
-    $api_instance->assignServiceInstance($version, $body);
-} catch (Exception $e) {
-    echo 'Exception when calling OnapsoinfraserviceInstantiationApi->assignServiceInstance: ', $e->getMessage(), PHP_EOL;
-}
-?>
-
- -
-
use Data::Dumper;
-use WWW::SwaggerClient::Configuration;
-use WWW::SwaggerClient::OnapsoinfraserviceInstantiationApi;
-
-my $api_instance = WWW::SwaggerClient::OnapsoinfraserviceInstantiationApi->new();
-my $version = version_example; # String | 
-my $body = WWW::SwaggerClient::Object::String->new(); # String | 
-
-eval { 
-    $api_instance->assignServiceInstance(version => $version, body => $body);
-};
-if ($@) {
-    warn "Exception when calling OnapsoinfraserviceInstantiationApi->assignServiceInstance: $@\n";
-}
-
- -
-
from __future__ import print_statement
-import time
-import swagger_client
-from swagger_client.rest import ApiException
-from pprint import pprint
-
-# create an instance of the API class
-api_instance = swagger_client.OnapsoinfraserviceInstantiationApi()
-version = version_example # String | 
-body = body_example # String |  (optional)
-
-try: 
-    # Assign Service Instance
-    api_instance.assign_service_instance(version, body=body)
-except ApiException as e:
-    print("Exception when calling OnapsoinfraserviceInstantiationApi->assignServiceInstance: %s\n" % e)
-
-
- -

Parameters

- -
Path parameters
- - - - - - - - - -
NameDescription
version* - - -
-
-
- - String - - -
-
- Required -
-
-
-
- - -
Body parameters
- - - - - - - - - -
NameDescription
body - - - -
-
- - - -

Responses

-

Status: default - successful operation

- - - -
-
- -
-
-
-
-
-
-

createNetworkInstance

-

Create NetworkInstance on a specified version and serviceInstance

-
-
-
-

-

-

-
-
/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/networks
-

-

Usage and SDK Samples

-

- - -
-
-
curl -X POST "https://localhost/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/networks"
-
-
-
import io.swagger.client.*;
-import io.swagger.client.auth.*;
-import io.swagger.client.model.*;
-import io.swagger.client.api.OnapsoinfraserviceInstantiationApi;
-
-import java.io.File;
-import java.util.*;
-
-public class OnapsoinfraserviceInstantiationApiExample {
-
-    public static void main(String[] args) {
-        
-        OnapsoinfraserviceInstantiationApi apiInstance = new OnapsoinfraserviceInstantiationApi();
-        String version = version_example; // String | 
-        String serviceInstanceId = serviceInstanceId_example; // String | 
-        String body = body_example; // String | 
-        try {
-            apiInstance.createNetworkInstance(version, serviceInstanceId, body);
-        } catch (ApiException e) {
-            System.err.println("Exception when calling OnapsoinfraserviceInstantiationApi#createNetworkInstance");
-            e.printStackTrace();
-        }
-    }
-}
-
- -
-
import io.swagger.client.api.OnapsoinfraserviceInstantiationApi;
-
-public class OnapsoinfraserviceInstantiationApiExample {
-
-    public static void main(String[] args) {
-        OnapsoinfraserviceInstantiationApi apiInstance = new OnapsoinfraserviceInstantiationApi();
-        String version = version_example; // String | 
-        String serviceInstanceId = serviceInstanceId_example; // String | 
-        String body = body_example; // String | 
-        try {
-            apiInstance.createNetworkInstance(version, serviceInstanceId, body);
-        } catch (ApiException e) {
-            System.err.println("Exception when calling OnapsoinfraserviceInstantiationApi#createNetworkInstance");
-            e.printStackTrace();
-        }
-    }
-}
-
- -
-
String *version = version_example; // 
-String *serviceInstanceId = serviceInstanceId_example; // 
-String *body = body_example; //  (optional)
-
-OnapsoinfraserviceInstantiationApi *apiInstance = [[OnapsoinfraserviceInstantiationApi alloc] init];
-
-// Create NetworkInstance on a specified version and serviceInstance 
-[apiInstance createNetworkInstanceWith:version
-    serviceInstanceId:serviceInstanceId
-    body:body
-              completionHandler: ^(NSError* error) {
-                            if (error) {
-                                NSLog(@"Error: %@", error);
-                            }
-                        }];
-
-
- -
-
var SoCasablancaApIs = require('so_casablanca_ap_is');
-
-var api = new SoCasablancaApIs.OnapsoinfraserviceInstantiationApi()
-
-var version = version_example; // {String} 
-
-var serviceInstanceId = serviceInstanceId_example; // {String} 
-
-var opts = { 
-  'body': body_example // {String} 
-};
-
-var callback = function(error, data, response) {
-  if (error) {
-    console.error(error);
-  } else {
-    console.log('API called successfully.');
-  }
-};
-api.createNetworkInstance(version, serviceInstanceId, opts, callback);
-
-
- - -
-
using System;
-using System.Diagnostics;
-using IO.Swagger.Api;
-using IO.Swagger.Client;
-using IO.Swagger.Model;
-
-namespace Example
-{
-    public class createNetworkInstanceExample
-    {
-        public void main()
-        {
-            
-            var apiInstance = new OnapsoinfraserviceInstantiationApi();
-            var version = version_example;  // String | 
-            var serviceInstanceId = serviceInstanceId_example;  // String | 
-            var body = body_example;  // String |  (optional) 
-
-            try
-            {
-                // Create NetworkInstance on a specified version and serviceInstance 
-                apiInstance.createNetworkInstance(version, serviceInstanceId, body);
-            }
-            catch (Exception e)
-            {
-                Debug.Print("Exception when calling OnapsoinfraserviceInstantiationApi.createNetworkInstance: " + e.Message );
-            }
-        }
-    }
-}
-
-
- -
-
<?php
-require_once(__DIR__ . '/vendor/autoload.php');
-
-$api_instance = new Swagger\Client\Api\OnapsoinfraserviceInstantiationApi();
-$version = version_example; // String | 
-$serviceInstanceId = serviceInstanceId_example; // String | 
-$body = body_example; // String | 
-
-try {
-    $api_instance->createNetworkInstance($version, $serviceInstanceId, $body);
-} catch (Exception $e) {
-    echo 'Exception when calling OnapsoinfraserviceInstantiationApi->createNetworkInstance: ', $e->getMessage(), PHP_EOL;
-}
-?>
-
- -
-
use Data::Dumper;
-use WWW::SwaggerClient::Configuration;
-use WWW::SwaggerClient::OnapsoinfraserviceInstantiationApi;
-
-my $api_instance = WWW::SwaggerClient::OnapsoinfraserviceInstantiationApi->new();
-my $version = version_example; # String | 
-my $serviceInstanceId = serviceInstanceId_example; # String | 
-my $body = WWW::SwaggerClient::Object::String->new(); # String | 
-
-eval { 
-    $api_instance->createNetworkInstance(version => $version, serviceInstanceId => $serviceInstanceId, body => $body);
-};
-if ($@) {
-    warn "Exception when calling OnapsoinfraserviceInstantiationApi->createNetworkInstance: $@\n";
-}
-
- -
-
from __future__ import print_statement
-import time
-import swagger_client
-from swagger_client.rest import ApiException
-from pprint import pprint
-
-# create an instance of the API class
-api_instance = swagger_client.OnapsoinfraserviceInstantiationApi()
-version = version_example # String | 
-serviceInstanceId = serviceInstanceId_example # String | 
-body = body_example # String |  (optional)
-
-try: 
-    # Create NetworkInstance on a specified version and serviceInstance 
-    api_instance.create_network_instance(version, serviceInstanceId, body=body)
-except ApiException as e:
-    print("Exception when calling OnapsoinfraserviceInstantiationApi->createNetworkInstance: %s\n" % e)
-
-
- -

Parameters

- -
Path parameters
- - - - - - - - - - - - - -
NameDescription
version* - - -
-
-
- - String - - -
-
- Required -
-
-
-
serviceInstanceId* - - -
-
-
- - String - - -
-
- Required -
-
-
-
- - -
Body parameters
- - - - - - - - - -
NameDescription
body - - - -
-
- - - -

Responses

-

Status: default - successful operation

- - - -
-
- -
-
-
-
-
-
-

createPortConfiguration

-

Create Port Mirroring Configuration

-
-
-
-

-

-

-
-
/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/configurations
-

-

Usage and SDK Samples

-

- - -
-
-
curl -X POST "https://localhost/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/configurations"
-
-
-
import io.swagger.client.*;
-import io.swagger.client.auth.*;
-import io.swagger.client.model.*;
-import io.swagger.client.api.OnapsoinfraserviceInstantiationApi;
-
-import java.io.File;
-import java.util.*;
-
-public class OnapsoinfraserviceInstantiationApiExample {
-
-    public static void main(String[] args) {
-        
-        OnapsoinfraserviceInstantiationApi apiInstance = new OnapsoinfraserviceInstantiationApi();
-        String version = version_example; // String | 
-        String serviceInstanceId = serviceInstanceId_example; // String | 
-        String body = body_example; // String | 
-        try {
-            apiInstance.createPortConfiguration(version, serviceInstanceId, body);
-        } catch (ApiException e) {
-            System.err.println("Exception when calling OnapsoinfraserviceInstantiationApi#createPortConfiguration");
-            e.printStackTrace();
-        }
-    }
-}
-
- -
-
import io.swagger.client.api.OnapsoinfraserviceInstantiationApi;
-
-public class OnapsoinfraserviceInstantiationApiExample {
-
-    public static void main(String[] args) {
-        OnapsoinfraserviceInstantiationApi apiInstance = new OnapsoinfraserviceInstantiationApi();
-        String version = version_example; // String | 
-        String serviceInstanceId = serviceInstanceId_example; // String | 
-        String body = body_example; // String | 
-        try {
-            apiInstance.createPortConfiguration(version, serviceInstanceId, body);
-        } catch (ApiException e) {
-            System.err.println("Exception when calling OnapsoinfraserviceInstantiationApi#createPortConfiguration");
-            e.printStackTrace();
-        }
-    }
-}
-
- -
-
String *version = version_example; // 
-String *serviceInstanceId = serviceInstanceId_example; // 
-String *body = body_example; //  (optional)
-
-OnapsoinfraserviceInstantiationApi *apiInstance = [[OnapsoinfraserviceInstantiationApi alloc] init];
-
-// Create Port Mirroring Configuration
-[apiInstance createPortConfigurationWith:version
-    serviceInstanceId:serviceInstanceId
-    body:body
-              completionHandler: ^(NSError* error) {
-                            if (error) {
-                                NSLog(@"Error: %@", error);
-                            }
-                        }];
-
-
- -
-
var SoCasablancaApIs = require('so_casablanca_ap_is');
-
-var api = new SoCasablancaApIs.OnapsoinfraserviceInstantiationApi()
-
-var version = version_example; // {String} 
-
-var serviceInstanceId = serviceInstanceId_example; // {String} 
-
-var opts = { 
-  'body': body_example // {String} 
-};
-
-var callback = function(error, data, response) {
-  if (error) {
-    console.error(error);
-  } else {
-    console.log('API called successfully.');
-  }
-};
-api.createPortConfiguration(version, serviceInstanceId, opts, callback);
-
-
- - -
-
using System;
-using System.Diagnostics;
-using IO.Swagger.Api;
-using IO.Swagger.Client;
-using IO.Swagger.Model;
-
-namespace Example
-{
-    public class createPortConfigurationExample
-    {
-        public void main()
-        {
-            
-            var apiInstance = new OnapsoinfraserviceInstantiationApi();
-            var version = version_example;  // String | 
-            var serviceInstanceId = serviceInstanceId_example;  // String | 
-            var body = body_example;  // String |  (optional) 
-
-            try
-            {
-                // Create Port Mirroring Configuration
-                apiInstance.createPortConfiguration(version, serviceInstanceId, body);
-            }
-            catch (Exception e)
-            {
-                Debug.Print("Exception when calling OnapsoinfraserviceInstantiationApi.createPortConfiguration: " + e.Message );
-            }
-        }
-    }
-}
-
-
- -
-
<?php
-require_once(__DIR__ . '/vendor/autoload.php');
-
-$api_instance = new Swagger\Client\Api\OnapsoinfraserviceInstantiationApi();
-$version = version_example; // String | 
-$serviceInstanceId = serviceInstanceId_example; // String | 
-$body = body_example; // String | 
-
-try {
-    $api_instance->createPortConfiguration($version, $serviceInstanceId, $body);
-} catch (Exception $e) {
-    echo 'Exception when calling OnapsoinfraserviceInstantiationApi->createPortConfiguration: ', $e->getMessage(), PHP_EOL;
-}
-?>
-
- -
-
use Data::Dumper;
-use WWW::SwaggerClient::Configuration;
-use WWW::SwaggerClient::OnapsoinfraserviceInstantiationApi;
-
-my $api_instance = WWW::SwaggerClient::OnapsoinfraserviceInstantiationApi->new();
-my $version = version_example; # String | 
-my $serviceInstanceId = serviceInstanceId_example; # String | 
-my $body = WWW::SwaggerClient::Object::String->new(); # String | 
-
-eval { 
-    $api_instance->createPortConfiguration(version => $version, serviceInstanceId => $serviceInstanceId, body => $body);
-};
-if ($@) {
-    warn "Exception when calling OnapsoinfraserviceInstantiationApi->createPortConfiguration: $@\n";
-}
-
- -
-
from __future__ import print_statement
-import time
-import swagger_client
-from swagger_client.rest import ApiException
-from pprint import pprint
-
-# create an instance of the API class
-api_instance = swagger_client.OnapsoinfraserviceInstantiationApi()
-version = version_example # String | 
-serviceInstanceId = serviceInstanceId_example # String | 
-body = body_example # String |  (optional)
-
-try: 
-    # Create Port Mirroring Configuration
-    api_instance.create_port_configuration(version, serviceInstanceId, body=body)
-except ApiException as e:
-    print("Exception when calling OnapsoinfraserviceInstantiationApi->createPortConfiguration: %s\n" % e)
-
-
- -

Parameters

- -
Path parameters
- - - - - - - - - - - - - -
NameDescription
version* - - -
-
-
- - String - - -
-
- Required -
-
-
-
serviceInstanceId* - - -
-
-
- - String - - -
-
- Required -
-
-
-
- - -
Body parameters
- - - - - - - - - -
NameDescription
body - - - -
-
- - - -

Responses

-

Status: default - successful operation

- - - -
-
- -
-
-
-
-
-
-

createServiceInstance

-

Create a Service Instance on a version provided

-
-
-
-

-

-

-
-
/onap/so/infra/serviceInstantiation/{version}/serviceInstances
-

-

Usage and SDK Samples

-

- - -
-
-
curl -X POST "https://localhost/onap/so/infra/serviceInstantiation/{version}/serviceInstances"
-
-
-
import io.swagger.client.*;
-import io.swagger.client.auth.*;
-import io.swagger.client.model.*;
-import io.swagger.client.api.OnapsoinfraserviceInstantiationApi;
-
-import java.io.File;
-import java.util.*;
-
-public class OnapsoinfraserviceInstantiationApiExample {
-
-    public static void main(String[] args) {
-        
-        OnapsoinfraserviceInstantiationApi apiInstance = new OnapsoinfraserviceInstantiationApi();
-        String version = version_example; // String | 
-        String body = body_example; // String | 
-        try {
-            apiInstance.createServiceInstance(version, body);
-        } catch (ApiException e) {
-            System.err.println("Exception when calling OnapsoinfraserviceInstantiationApi#createServiceInstance");
-            e.printStackTrace();
-        }
-    }
-}
-
- -
-
import io.swagger.client.api.OnapsoinfraserviceInstantiationApi;
-
-public class OnapsoinfraserviceInstantiationApiExample {
-
-    public static void main(String[] args) {
-        OnapsoinfraserviceInstantiationApi apiInstance = new OnapsoinfraserviceInstantiationApi();
-        String version = version_example; // String | 
-        String body = body_example; // String | 
-        try {
-            apiInstance.createServiceInstance(version, body);
-        } catch (ApiException e) {
-            System.err.println("Exception when calling OnapsoinfraserviceInstantiationApi#createServiceInstance");
-            e.printStackTrace();
-        }
-    }
-}
-
- -
-
String *version = version_example; // 
-String *body = body_example; //  (optional)
-
-OnapsoinfraserviceInstantiationApi *apiInstance = [[OnapsoinfraserviceInstantiationApi alloc] init];
-
-// Create a Service Instance on a version provided
-[apiInstance createServiceInstanceWith:version
-    body:body
-              completionHandler: ^(NSError* error) {
-                            if (error) {
-                                NSLog(@"Error: %@", error);
-                            }
-                        }];
-
-
- -
-
var SoCasablancaApIs = require('so_casablanca_ap_is');
-
-var api = new SoCasablancaApIs.OnapsoinfraserviceInstantiationApi()
-
-var version = version_example; // {String} 
-
-var opts = { 
-  'body': body_example // {String} 
-};
-
-var callback = function(error, data, response) {
-  if (error) {
-    console.error(error);
-  } else {
-    console.log('API called successfully.');
-  }
-};
-api.createServiceInstance(version, opts, callback);
-
-
- - -
-
using System;
-using System.Diagnostics;
-using IO.Swagger.Api;
-using IO.Swagger.Client;
-using IO.Swagger.Model;
-
-namespace Example
-{
-    public class createServiceInstanceExample
-    {
-        public void main()
-        {
-            
-            var apiInstance = new OnapsoinfraserviceInstantiationApi();
-            var version = version_example;  // String | 
-            var body = body_example;  // String |  (optional) 
-
-            try
-            {
-                // Create a Service Instance on a version provided
-                apiInstance.createServiceInstance(version, body);
-            }
-            catch (Exception e)
-            {
-                Debug.Print("Exception when calling OnapsoinfraserviceInstantiationApi.createServiceInstance: " + e.Message );
-            }
-        }
-    }
-}
-
-
- -
-
<?php
-require_once(__DIR__ . '/vendor/autoload.php');
-
-$api_instance = new Swagger\Client\Api\OnapsoinfraserviceInstantiationApi();
-$version = version_example; // String | 
-$body = body_example; // String | 
-
-try {
-    $api_instance->createServiceInstance($version, $body);
-} catch (Exception $e) {
-    echo 'Exception when calling OnapsoinfraserviceInstantiationApi->createServiceInstance: ', $e->getMessage(), PHP_EOL;
-}
-?>
-
- -
-
use Data::Dumper;
-use WWW::SwaggerClient::Configuration;
-use WWW::SwaggerClient::OnapsoinfraserviceInstantiationApi;
-
-my $api_instance = WWW::SwaggerClient::OnapsoinfraserviceInstantiationApi->new();
-my $version = version_example; # String | 
-my $body = WWW::SwaggerClient::Object::String->new(); # String | 
-
-eval { 
-    $api_instance->createServiceInstance(version => $version, body => $body);
-};
-if ($@) {
-    warn "Exception when calling OnapsoinfraserviceInstantiationApi->createServiceInstance: $@\n";
-}
-
- -
-
from __future__ import print_statement
-import time
-import swagger_client
-from swagger_client.rest import ApiException
-from pprint import pprint
-
-# create an instance of the API class
-api_instance = swagger_client.OnapsoinfraserviceInstantiationApi()
-version = version_example # String | 
-body = body_example # String |  (optional)
-
-try: 
-    # Create a Service Instance on a version provided
-    api_instance.create_service_instance(version, body=body)
-except ApiException as e:
-    print("Exception when calling OnapsoinfraserviceInstantiationApi->createServiceInstance: %s\n" % e)
-
-
- -

Parameters

- -
Path parameters
- - - - - - - - - -
NameDescription
version* - - -
-
-
- - String - - -
-
- Required -
-
-
-
- - -
Body parameters
- - - - - - - - - -
NameDescription
body - - - -
-
- - - -

Responses

-

Status: default - successful operation

- - - -
-
- -
-
-
-
-
-
-

createVfModuleInstance

-

Create VfModule on a specified version, serviceInstance and vnfInstance

-
-
-
-

-

-

-
-
/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/vnfs/{vnfInstanceId}/vfModules
-

-

Usage and SDK Samples

-

- - -
-
-
curl -X POST "https://localhost/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/vnfs/{vnfInstanceId}/vfModules"
-
-
-
import io.swagger.client.*;
-import io.swagger.client.auth.*;
-import io.swagger.client.model.*;
-import io.swagger.client.api.OnapsoinfraserviceInstantiationApi;
-
-import java.io.File;
-import java.util.*;
-
-public class OnapsoinfraserviceInstantiationApiExample {
-
-    public static void main(String[] args) {
-        
-        OnapsoinfraserviceInstantiationApi apiInstance = new OnapsoinfraserviceInstantiationApi();
-        String version = version_example; // String | 
-        String serviceInstanceId = serviceInstanceId_example; // String | 
-        String vnfInstanceId = vnfInstanceId_example; // String | 
-        String body = body_example; // String | 
-        try {
-            apiInstance.createVfModuleInstance(version, serviceInstanceId, vnfInstanceId, body);
-        } catch (ApiException e) {
-            System.err.println("Exception when calling OnapsoinfraserviceInstantiationApi#createVfModuleInstance");
-            e.printStackTrace();
-        }
-    }
-}
-
- -
-
import io.swagger.client.api.OnapsoinfraserviceInstantiationApi;
-
-public class OnapsoinfraserviceInstantiationApiExample {
-
-    public static void main(String[] args) {
-        OnapsoinfraserviceInstantiationApi apiInstance = new OnapsoinfraserviceInstantiationApi();
-        String version = version_example; // String | 
-        String serviceInstanceId = serviceInstanceId_example; // String | 
-        String vnfInstanceId = vnfInstanceId_example; // String | 
-        String body = body_example; // String | 
-        try {
-            apiInstance.createVfModuleInstance(version, serviceInstanceId, vnfInstanceId, body);
-        } catch (ApiException e) {
-            System.err.println("Exception when calling OnapsoinfraserviceInstantiationApi#createVfModuleInstance");
-            e.printStackTrace();
-        }
-    }
-}
-
- -
-
String *version = version_example; // 
-String *serviceInstanceId = serviceInstanceId_example; // 
-String *vnfInstanceId = vnfInstanceId_example; // 
-String *body = body_example; //  (optional)
-
-OnapsoinfraserviceInstantiationApi *apiInstance = [[OnapsoinfraserviceInstantiationApi alloc] init];
-
-// Create VfModule on a specified version, serviceInstance and vnfInstance
-[apiInstance createVfModuleInstanceWith:version
-    serviceInstanceId:serviceInstanceId
-    vnfInstanceId:vnfInstanceId
-    body:body
-              completionHandler: ^(NSError* error) {
-                            if (error) {
-                                NSLog(@"Error: %@", error);
-                            }
-                        }];
-
-
- -
-
var SoCasablancaApIs = require('so_casablanca_ap_is');
-
-var api = new SoCasablancaApIs.OnapsoinfraserviceInstantiationApi()
-
-var version = version_example; // {String} 
-
-var serviceInstanceId = serviceInstanceId_example; // {String} 
-
-var vnfInstanceId = vnfInstanceId_example; // {String} 
-
-var opts = { 
-  'body': body_example // {String} 
-};
-
-var callback = function(error, data, response) {
-  if (error) {
-    console.error(error);
-  } else {
-    console.log('API called successfully.');
-  }
-};
-api.createVfModuleInstance(version, serviceInstanceId, vnfInstanceId, opts, callback);
-
-
- - -
-
using System;
-using System.Diagnostics;
-using IO.Swagger.Api;
-using IO.Swagger.Client;
-using IO.Swagger.Model;
-
-namespace Example
-{
-    public class createVfModuleInstanceExample
-    {
-        public void main()
-        {
-            
-            var apiInstance = new OnapsoinfraserviceInstantiationApi();
-            var version = version_example;  // String | 
-            var serviceInstanceId = serviceInstanceId_example;  // String | 
-            var vnfInstanceId = vnfInstanceId_example;  // String | 
-            var body = body_example;  // String |  (optional) 
-
-            try
-            {
-                // Create VfModule on a specified version, serviceInstance and vnfInstance
-                apiInstance.createVfModuleInstance(version, serviceInstanceId, vnfInstanceId, body);
-            }
-            catch (Exception e)
-            {
-                Debug.Print("Exception when calling OnapsoinfraserviceInstantiationApi.createVfModuleInstance: " + e.Message );
-            }
-        }
-    }
-}
-
-
- -
-
<?php
-require_once(__DIR__ . '/vendor/autoload.php');
-
-$api_instance = new Swagger\Client\Api\OnapsoinfraserviceInstantiationApi();
-$version = version_example; // String | 
-$serviceInstanceId = serviceInstanceId_example; // String | 
-$vnfInstanceId = vnfInstanceId_example; // String | 
-$body = body_example; // String | 
-
-try {
-    $api_instance->createVfModuleInstance($version, $serviceInstanceId, $vnfInstanceId, $body);
-} catch (Exception $e) {
-    echo 'Exception when calling OnapsoinfraserviceInstantiationApi->createVfModuleInstance: ', $e->getMessage(), PHP_EOL;
-}
-?>
-
- -
-
use Data::Dumper;
-use WWW::SwaggerClient::Configuration;
-use WWW::SwaggerClient::OnapsoinfraserviceInstantiationApi;
-
-my $api_instance = WWW::SwaggerClient::OnapsoinfraserviceInstantiationApi->new();
-my $version = version_example; # String | 
-my $serviceInstanceId = serviceInstanceId_example; # String | 
-my $vnfInstanceId = vnfInstanceId_example; # String | 
-my $body = WWW::SwaggerClient::Object::String->new(); # String | 
-
-eval { 
-    $api_instance->createVfModuleInstance(version => $version, serviceInstanceId => $serviceInstanceId, vnfInstanceId => $vnfInstanceId, body => $body);
-};
-if ($@) {
-    warn "Exception when calling OnapsoinfraserviceInstantiationApi->createVfModuleInstance: $@\n";
-}
-
- -
-
from __future__ import print_statement
-import time
-import swagger_client
-from swagger_client.rest import ApiException
-from pprint import pprint
-
-# create an instance of the API class
-api_instance = swagger_client.OnapsoinfraserviceInstantiationApi()
-version = version_example # String | 
-serviceInstanceId = serviceInstanceId_example # String | 
-vnfInstanceId = vnfInstanceId_example # String | 
-body = body_example # String |  (optional)
-
-try: 
-    # Create VfModule on a specified version, serviceInstance and vnfInstance
-    api_instance.create_vf_module_instance(version, serviceInstanceId, vnfInstanceId, body=body)
-except ApiException as e:
-    print("Exception when calling OnapsoinfraserviceInstantiationApi->createVfModuleInstance: %s\n" % e)
-
-
- -

Parameters

- -
Path parameters
- - - - - - - - - - - - - - - - - -
NameDescription
version* - - -
-
-
- - String - - -
-
- Required -
-
-
-
serviceInstanceId* - - -
-
-
- - String - - -
-
- Required -
-
-
-
vnfInstanceId* - - -
-
-
- - String - - -
-
- Required -
-
-
-
- - -
Body parameters
- - - - - - - - - -
NameDescription
body - - - -
-
- - - -

Responses

-

Status: default - successful operation

- - - -
-
- -
-
-
-
-
-
-

createVnfInstance

-

Create VNF on a specified version and serviceInstance

-
-
-
-

-

-

-
-
/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/vnfs
-

-

Usage and SDK Samples

-

- - -
-
-
curl -X POST "https://localhost/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/vnfs"
-
-
-
import io.swagger.client.*;
-import io.swagger.client.auth.*;
-import io.swagger.client.model.*;
-import io.swagger.client.api.OnapsoinfraserviceInstantiationApi;
-
-import java.io.File;
-import java.util.*;
-
-public class OnapsoinfraserviceInstantiationApiExample {
-
-    public static void main(String[] args) {
-        
-        OnapsoinfraserviceInstantiationApi apiInstance = new OnapsoinfraserviceInstantiationApi();
-        String version = version_example; // String | 
-        String serviceInstanceId = serviceInstanceId_example; // String | 
-        String body = body_example; // String | 
-        try {
-            apiInstance.createVnfInstance(version, serviceInstanceId, body);
-        } catch (ApiException e) {
-            System.err.println("Exception when calling OnapsoinfraserviceInstantiationApi#createVnfInstance");
-            e.printStackTrace();
-        }
-    }
-}
-
- -
-
import io.swagger.client.api.OnapsoinfraserviceInstantiationApi;
-
-public class OnapsoinfraserviceInstantiationApiExample {
-
-    public static void main(String[] args) {
-        OnapsoinfraserviceInstantiationApi apiInstance = new OnapsoinfraserviceInstantiationApi();
-        String version = version_example; // String | 
-        String serviceInstanceId = serviceInstanceId_example; // String | 
-        String body = body_example; // String | 
-        try {
-            apiInstance.createVnfInstance(version, serviceInstanceId, body);
-        } catch (ApiException e) {
-            System.err.println("Exception when calling OnapsoinfraserviceInstantiationApi#createVnfInstance");
-            e.printStackTrace();
-        }
-    }
-}
-
- -
-
String *version = version_example; // 
-String *serviceInstanceId = serviceInstanceId_example; // 
-String *body = body_example; //  (optional)
-
-OnapsoinfraserviceInstantiationApi *apiInstance = [[OnapsoinfraserviceInstantiationApi alloc] init];
-
-// Create VNF on a specified version and serviceInstance
-[apiInstance createVnfInstanceWith:version
-    serviceInstanceId:serviceInstanceId
-    body:body
-              completionHandler: ^(NSError* error) {
-                            if (error) {
-                                NSLog(@"Error: %@", error);
-                            }
-                        }];
-
-
- -
-
var SoCasablancaApIs = require('so_casablanca_ap_is');
-
-var api = new SoCasablancaApIs.OnapsoinfraserviceInstantiationApi()
-
-var version = version_example; // {String} 
-
-var serviceInstanceId = serviceInstanceId_example; // {String} 
-
-var opts = { 
-  'body': body_example // {String} 
-};
-
-var callback = function(error, data, response) {
-  if (error) {
-    console.error(error);
-  } else {
-    console.log('API called successfully.');
-  }
-};
-api.createVnfInstance(version, serviceInstanceId, opts, callback);
-
-
- - -
-
using System;
-using System.Diagnostics;
-using IO.Swagger.Api;
-using IO.Swagger.Client;
-using IO.Swagger.Model;
-
-namespace Example
-{
-    public class createVnfInstanceExample
-    {
-        public void main()
-        {
-            
-            var apiInstance = new OnapsoinfraserviceInstantiationApi();
-            var version = version_example;  // String | 
-            var serviceInstanceId = serviceInstanceId_example;  // String | 
-            var body = body_example;  // String |  (optional) 
-
-            try
-            {
-                // Create VNF on a specified version and serviceInstance
-                apiInstance.createVnfInstance(version, serviceInstanceId, body);
-            }
-            catch (Exception e)
-            {
-                Debug.Print("Exception when calling OnapsoinfraserviceInstantiationApi.createVnfInstance: " + e.Message );
-            }
-        }
-    }
-}
-
-
- -
-
<?php
-require_once(__DIR__ . '/vendor/autoload.php');
-
-$api_instance = new Swagger\Client\Api\OnapsoinfraserviceInstantiationApi();
-$version = version_example; // String | 
-$serviceInstanceId = serviceInstanceId_example; // String | 
-$body = body_example; // String | 
-
-try {
-    $api_instance->createVnfInstance($version, $serviceInstanceId, $body);
-} catch (Exception $e) {
-    echo 'Exception when calling OnapsoinfraserviceInstantiationApi->createVnfInstance: ', $e->getMessage(), PHP_EOL;
-}
-?>
-
- -
-
use Data::Dumper;
-use WWW::SwaggerClient::Configuration;
-use WWW::SwaggerClient::OnapsoinfraserviceInstantiationApi;
-
-my $api_instance = WWW::SwaggerClient::OnapsoinfraserviceInstantiationApi->new();
-my $version = version_example; # String | 
-my $serviceInstanceId = serviceInstanceId_example; # String | 
-my $body = WWW::SwaggerClient::Object::String->new(); # String | 
-
-eval { 
-    $api_instance->createVnfInstance(version => $version, serviceInstanceId => $serviceInstanceId, body => $body);
-};
-if ($@) {
-    warn "Exception when calling OnapsoinfraserviceInstantiationApi->createVnfInstance: $@\n";
-}
-
- -
-
from __future__ import print_statement
-import time
-import swagger_client
-from swagger_client.rest import ApiException
-from pprint import pprint
-
-# create an instance of the API class
-api_instance = swagger_client.OnapsoinfraserviceInstantiationApi()
-version = version_example # String | 
-serviceInstanceId = serviceInstanceId_example # String | 
-body = body_example # String |  (optional)
-
-try: 
-    # Create VNF on a specified version and serviceInstance
-    api_instance.create_vnf_instance(version, serviceInstanceId, body=body)
-except ApiException as e:
-    print("Exception when calling OnapsoinfraserviceInstantiationApi->createVnfInstance: %s\n" % e)
-
-
- -

Parameters

- -
Path parameters
- - - - - - - - - - - - - -
NameDescription
version* - - -
-
-
- - String - - -
-
- Required -
-
-
-
serviceInstanceId* - - -
-
-
- - String - - -
-
- Required -
-
-
-
- - -
Body parameters
- - - - - - - - - -
NameDescription
body - - - -
-
- - - -

Responses

-

Status: default - successful operation

- - - -
-
- -
-
-
-
-
-
-

createVolumeGroupInstance

-

Create VolumeGroup on a specified version, serviceInstance, vnfInstance

-
-
-
-

-

-

-
-
/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/vnfs/{vnfInstanceId}/volumeGroups
-

-

Usage and SDK Samples

-

- - -
-
-
curl -X POST "https://localhost/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/vnfs/{vnfInstanceId}/volumeGroups"
-
-
-
import io.swagger.client.*;
-import io.swagger.client.auth.*;
-import io.swagger.client.model.*;
-import io.swagger.client.api.OnapsoinfraserviceInstantiationApi;
-
-import java.io.File;
-import java.util.*;
-
-public class OnapsoinfraserviceInstantiationApiExample {
-
-    public static void main(String[] args) {
-        
-        OnapsoinfraserviceInstantiationApi apiInstance = new OnapsoinfraserviceInstantiationApi();
-        String version = version_example; // String | 
-        String serviceInstanceId = serviceInstanceId_example; // String | 
-        String vnfInstanceId = vnfInstanceId_example; // String | 
-        String body = body_example; // String | 
-        try {
-            apiInstance.createVolumeGroupInstance(version, serviceInstanceId, vnfInstanceId, body);
-        } catch (ApiException e) {
-            System.err.println("Exception when calling OnapsoinfraserviceInstantiationApi#createVolumeGroupInstance");
-            e.printStackTrace();
-        }
-    }
-}
-
- -
-
import io.swagger.client.api.OnapsoinfraserviceInstantiationApi;
-
-public class OnapsoinfraserviceInstantiationApiExample {
-
-    public static void main(String[] args) {
-        OnapsoinfraserviceInstantiationApi apiInstance = new OnapsoinfraserviceInstantiationApi();
-        String version = version_example; // String | 
-        String serviceInstanceId = serviceInstanceId_example; // String | 
-        String vnfInstanceId = vnfInstanceId_example; // String | 
-        String body = body_example; // String | 
-        try {
-            apiInstance.createVolumeGroupInstance(version, serviceInstanceId, vnfInstanceId, body);
-        } catch (ApiException e) {
-            System.err.println("Exception when calling OnapsoinfraserviceInstantiationApi#createVolumeGroupInstance");
-            e.printStackTrace();
-        }
-    }
-}
-
- -
-
String *version = version_example; // 
-String *serviceInstanceId = serviceInstanceId_example; // 
-String *vnfInstanceId = vnfInstanceId_example; // 
-String *body = body_example; //  (optional)
-
-OnapsoinfraserviceInstantiationApi *apiInstance = [[OnapsoinfraserviceInstantiationApi alloc] init];
-
-// Create VolumeGroup on a specified version, serviceInstance, vnfInstance
-[apiInstance createVolumeGroupInstanceWith:version
-    serviceInstanceId:serviceInstanceId
-    vnfInstanceId:vnfInstanceId
-    body:body
-              completionHandler: ^(NSError* error) {
-                            if (error) {
-                                NSLog(@"Error: %@", error);
-                            }
-                        }];
-
-
- -
-
var SoCasablancaApIs = require('so_casablanca_ap_is');
-
-var api = new SoCasablancaApIs.OnapsoinfraserviceInstantiationApi()
-
-var version = version_example; // {String} 
-
-var serviceInstanceId = serviceInstanceId_example; // {String} 
-
-var vnfInstanceId = vnfInstanceId_example; // {String} 
-
-var opts = { 
-  'body': body_example // {String} 
-};
-
-var callback = function(error, data, response) {
-  if (error) {
-    console.error(error);
-  } else {
-    console.log('API called successfully.');
-  }
-};
-api.createVolumeGroupInstance(version, serviceInstanceId, vnfInstanceId, opts, callback);
-
-
- - -
-
using System;
-using System.Diagnostics;
-using IO.Swagger.Api;
-using IO.Swagger.Client;
-using IO.Swagger.Model;
-
-namespace Example
-{
-    public class createVolumeGroupInstanceExample
-    {
-        public void main()
-        {
-            
-            var apiInstance = new OnapsoinfraserviceInstantiationApi();
-            var version = version_example;  // String | 
-            var serviceInstanceId = serviceInstanceId_example;  // String | 
-            var vnfInstanceId = vnfInstanceId_example;  // String | 
-            var body = body_example;  // String |  (optional) 
-
-            try
-            {
-                // Create VolumeGroup on a specified version, serviceInstance, vnfInstance
-                apiInstance.createVolumeGroupInstance(version, serviceInstanceId, vnfInstanceId, body);
-            }
-            catch (Exception e)
-            {
-                Debug.Print("Exception when calling OnapsoinfraserviceInstantiationApi.createVolumeGroupInstance: " + e.Message );
-            }
-        }
-    }
-}
-
-
- -
-
<?php
-require_once(__DIR__ . '/vendor/autoload.php');
-
-$api_instance = new Swagger\Client\Api\OnapsoinfraserviceInstantiationApi();
-$version = version_example; // String | 
-$serviceInstanceId = serviceInstanceId_example; // String | 
-$vnfInstanceId = vnfInstanceId_example; // String | 
-$body = body_example; // String | 
-
-try {
-    $api_instance->createVolumeGroupInstance($version, $serviceInstanceId, $vnfInstanceId, $body);
-} catch (Exception $e) {
-    echo 'Exception when calling OnapsoinfraserviceInstantiationApi->createVolumeGroupInstance: ', $e->getMessage(), PHP_EOL;
-}
-?>
-
- -
-
use Data::Dumper;
-use WWW::SwaggerClient::Configuration;
-use WWW::SwaggerClient::OnapsoinfraserviceInstantiationApi;
-
-my $api_instance = WWW::SwaggerClient::OnapsoinfraserviceInstantiationApi->new();
-my $version = version_example; # String | 
-my $serviceInstanceId = serviceInstanceId_example; # String | 
-my $vnfInstanceId = vnfInstanceId_example; # String | 
-my $body = WWW::SwaggerClient::Object::String->new(); # String | 
-
-eval { 
-    $api_instance->createVolumeGroupInstance(version => $version, serviceInstanceId => $serviceInstanceId, vnfInstanceId => $vnfInstanceId, body => $body);
-};
-if ($@) {
-    warn "Exception when calling OnapsoinfraserviceInstantiationApi->createVolumeGroupInstance: $@\n";
-}
-
- -
-
from __future__ import print_statement
-import time
-import swagger_client
-from swagger_client.rest import ApiException
-from pprint import pprint
-
-# create an instance of the API class
-api_instance = swagger_client.OnapsoinfraserviceInstantiationApi()
-version = version_example # String | 
-serviceInstanceId = serviceInstanceId_example # String | 
-vnfInstanceId = vnfInstanceId_example # String | 
-body = body_example # String |  (optional)
-
-try: 
-    # Create VolumeGroup on a specified version, serviceInstance, vnfInstance
-    api_instance.create_volume_group_instance(version, serviceInstanceId, vnfInstanceId, body=body)
-except ApiException as e:
-    print("Exception when calling OnapsoinfraserviceInstantiationApi->createVolumeGroupInstance: %s\n" % e)
-
-
- -

Parameters

- -
Path parameters
- - - - - - - - - - - - - - - - - -
NameDescription
version* - - -
-
-
- - String - - -
-
- Required -
-
-
-
serviceInstanceId* - - -
-
-
- - String - - -
-
- Required -
-
-
-
vnfInstanceId* - - -
-
-
- - String - - -
-
- Required -
-
-
-
- - -
Body parameters
- - - - - - - - - -
NameDescription
body - - - -
-
- - - -

Responses

-

Status: default - successful operation

- - - -
-
- -
-
-
-
-
-
-

deactivateAndCloudDeleteVfModuleInstance

-

Deactivate and Cloud Delete VfModule instance

-
-
-
-

-

-

-
-
/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/vnfs/{vnfInstanceId}/vfModules/{vfmoduleInstanceId}/deactivateAndCloudDelete
-

-

Usage and SDK Samples

-

- - -
-
-
curl -X POST "https://localhost/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/vnfs/{vnfInstanceId}/vfModules/{vfmoduleInstanceId}/deactivateAndCloudDelete"
-
-
-
import io.swagger.client.*;
-import io.swagger.client.auth.*;
-import io.swagger.client.model.*;
-import io.swagger.client.api.OnapsoinfraserviceInstantiationApi;
-
-import java.io.File;
-import java.util.*;
-
-public class OnapsoinfraserviceInstantiationApiExample {
-
-    public static void main(String[] args) {
-        
-        OnapsoinfraserviceInstantiationApi apiInstance = new OnapsoinfraserviceInstantiationApi();
-        String version = version_example; // String | 
-        String serviceInstanceId = serviceInstanceId_example; // String | 
-        String vnfInstanceId = vnfInstanceId_example; // String | 
-        String vfmoduleInstanceId = vfmoduleInstanceId_example; // String | 
-        String body = body_example; // String | 
-        try {
-            apiInstance.deactivateAndCloudDeleteVfModuleInstance(version, serviceInstanceId, vnfInstanceId, vfmoduleInstanceId, body);
-        } catch (ApiException e) {
-            System.err.println("Exception when calling OnapsoinfraserviceInstantiationApi#deactivateAndCloudDeleteVfModuleInstance");
-            e.printStackTrace();
-        }
-    }
-}
-
- -
-
import io.swagger.client.api.OnapsoinfraserviceInstantiationApi;
-
-public class OnapsoinfraserviceInstantiationApiExample {
-
-    public static void main(String[] args) {
-        OnapsoinfraserviceInstantiationApi apiInstance = new OnapsoinfraserviceInstantiationApi();
-        String version = version_example; // String | 
-        String serviceInstanceId = serviceInstanceId_example; // String | 
-        String vnfInstanceId = vnfInstanceId_example; // String | 
-        String vfmoduleInstanceId = vfmoduleInstanceId_example; // String | 
-        String body = body_example; // String | 
-        try {
-            apiInstance.deactivateAndCloudDeleteVfModuleInstance(version, serviceInstanceId, vnfInstanceId, vfmoduleInstanceId, body);
-        } catch (ApiException e) {
-            System.err.println("Exception when calling OnapsoinfraserviceInstantiationApi#deactivateAndCloudDeleteVfModuleInstance");
-            e.printStackTrace();
-        }
-    }
-}
-
- -
-
String *version = version_example; // 
-String *serviceInstanceId = serviceInstanceId_example; // 
-String *vnfInstanceId = vnfInstanceId_example; // 
-String *vfmoduleInstanceId = vfmoduleInstanceId_example; // 
-String *body = body_example; //  (optional)
-
-OnapsoinfraserviceInstantiationApi *apiInstance = [[OnapsoinfraserviceInstantiationApi alloc] init];
-
-// Deactivate and Cloud Delete VfModule instance
-[apiInstance deactivateAndCloudDeleteVfModuleInstanceWith:version
-    serviceInstanceId:serviceInstanceId
-    vnfInstanceId:vnfInstanceId
-    vfmoduleInstanceId:vfmoduleInstanceId
-    body:body
-              completionHandler: ^(NSError* error) {
-                            if (error) {
-                                NSLog(@"Error: %@", error);
-                            }
-                        }];
-
-
- -
-
var SoCasablancaApIs = require('so_casablanca_ap_is');
-
-var api = new SoCasablancaApIs.OnapsoinfraserviceInstantiationApi()
-
-var version = version_example; // {String} 
-
-var serviceInstanceId = serviceInstanceId_example; // {String} 
-
-var vnfInstanceId = vnfInstanceId_example; // {String} 
-
-var vfmoduleInstanceId = vfmoduleInstanceId_example; // {String} 
-
-var opts = { 
-  'body': body_example // {String} 
-};
-
-var callback = function(error, data, response) {
-  if (error) {
-    console.error(error);
-  } else {
-    console.log('API called successfully.');
-  }
-};
-api.deactivateAndCloudDeleteVfModuleInstance(version, serviceInstanceId, vnfInstanceId, vfmoduleInstanceId, opts, callback);
-
-
- - -
-
using System;
-using System.Diagnostics;
-using IO.Swagger.Api;
-using IO.Swagger.Client;
-using IO.Swagger.Model;
-
-namespace Example
-{
-    public class deactivateAndCloudDeleteVfModuleInstanceExample
-    {
-        public void main()
-        {
-            
-            var apiInstance = new OnapsoinfraserviceInstantiationApi();
-            var version = version_example;  // String | 
-            var serviceInstanceId = serviceInstanceId_example;  // String | 
-            var vnfInstanceId = vnfInstanceId_example;  // String | 
-            var vfmoduleInstanceId = vfmoduleInstanceId_example;  // String | 
-            var body = body_example;  // String |  (optional) 
-
-            try
-            {
-                // Deactivate and Cloud Delete VfModule instance
-                apiInstance.deactivateAndCloudDeleteVfModuleInstance(version, serviceInstanceId, vnfInstanceId, vfmoduleInstanceId, body);
-            }
-            catch (Exception e)
-            {
-                Debug.Print("Exception when calling OnapsoinfraserviceInstantiationApi.deactivateAndCloudDeleteVfModuleInstance: " + e.Message );
-            }
-        }
-    }
-}
-
-
- -
-
<?php
-require_once(__DIR__ . '/vendor/autoload.php');
-
-$api_instance = new Swagger\Client\Api\OnapsoinfraserviceInstantiationApi();
-$version = version_example; // String | 
-$serviceInstanceId = serviceInstanceId_example; // String | 
-$vnfInstanceId = vnfInstanceId_example; // String | 
-$vfmoduleInstanceId = vfmoduleInstanceId_example; // String | 
-$body = body_example; // String | 
-
-try {
-    $api_instance->deactivateAndCloudDeleteVfModuleInstance($version, $serviceInstanceId, $vnfInstanceId, $vfmoduleInstanceId, $body);
-} catch (Exception $e) {
-    echo 'Exception when calling OnapsoinfraserviceInstantiationApi->deactivateAndCloudDeleteVfModuleInstance: ', $e->getMessage(), PHP_EOL;
-}
-?>
-
- -
-
use Data::Dumper;
-use WWW::SwaggerClient::Configuration;
-use WWW::SwaggerClient::OnapsoinfraserviceInstantiationApi;
-
-my $api_instance = WWW::SwaggerClient::OnapsoinfraserviceInstantiationApi->new();
-my $version = version_example; # String | 
-my $serviceInstanceId = serviceInstanceId_example; # String | 
-my $vnfInstanceId = vnfInstanceId_example; # String | 
-my $vfmoduleInstanceId = vfmoduleInstanceId_example; # String | 
-my $body = WWW::SwaggerClient::Object::String->new(); # String | 
-
-eval { 
-    $api_instance->deactivateAndCloudDeleteVfModuleInstance(version => $version, serviceInstanceId => $serviceInstanceId, vnfInstanceId => $vnfInstanceId, vfmoduleInstanceId => $vfmoduleInstanceId, body => $body);
-};
-if ($@) {
-    warn "Exception when calling OnapsoinfraserviceInstantiationApi->deactivateAndCloudDeleteVfModuleInstance: $@\n";
-}
-
- -
-
from __future__ import print_statement
-import time
-import swagger_client
-from swagger_client.rest import ApiException
-from pprint import pprint
-
-# create an instance of the API class
-api_instance = swagger_client.OnapsoinfraserviceInstantiationApi()
-version = version_example # String | 
-serviceInstanceId = serviceInstanceId_example # String | 
-vnfInstanceId = vnfInstanceId_example # String | 
-vfmoduleInstanceId = vfmoduleInstanceId_example # String | 
-body = body_example # String |  (optional)
-
-try: 
-    # Deactivate and Cloud Delete VfModule instance
-    api_instance.deactivate_and_cloud_delete_vf_module_instance(version, serviceInstanceId, vnfInstanceId, vfmoduleInstanceId, body=body)
-except ApiException as e:
-    print("Exception when calling OnapsoinfraserviceInstantiationApi->deactivateAndCloudDeleteVfModuleInstance: %s\n" % e)
-
-
- -

Parameters

- -
Path parameters
- - - - - - - - - - - - - - - - - - - - - -
NameDescription
version* - - -
-
-
- - String - - -
-
- Required -
-
-
-
serviceInstanceId* - - -
-
-
- - String - - -
-
- Required -
-
-
-
vnfInstanceId* - - -
-
-
- - String - - -
-
- Required -
-
-
-
vfmoduleInstanceId* - - -
-
-
- - String - - -
-
- Required -
-
-
-
- - -
Body parameters
- - - - - - - - - -
NameDescription
body - - - -
-
- - - -

Responses

-

Status: default - successful operation

- - - -
-
- -
-
-
-
-
-
-

deactivatePort

-

Deactivate Port Mirroring

-
-
-
-

-

-

-
-
/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/configurations/{configurationInstanceId}/deactivate
-

-

Usage and SDK Samples

-

- - -
-
-
curl -X POST "https://localhost/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/configurations/{configurationInstanceId}/deactivate"
-
-
-
import io.swagger.client.*;
-import io.swagger.client.auth.*;
-import io.swagger.client.model.*;
-import io.swagger.client.api.OnapsoinfraserviceInstantiationApi;
-
-import java.io.File;
-import java.util.*;
-
-public class OnapsoinfraserviceInstantiationApiExample {
-
-    public static void main(String[] args) {
-        
-        OnapsoinfraserviceInstantiationApi apiInstance = new OnapsoinfraserviceInstantiationApi();
-        String version = version_example; // String | 
-        String serviceInstanceId = serviceInstanceId_example; // String | 
-        String configurationInstanceId = configurationInstanceId_example; // String | 
-        String body = body_example; // String | 
-        try {
-            apiInstance.deactivatePort(version, serviceInstanceId, configurationInstanceId, body);
-        } catch (ApiException e) {
-            System.err.println("Exception when calling OnapsoinfraserviceInstantiationApi#deactivatePort");
-            e.printStackTrace();
-        }
-    }
-}
-
- -
-
import io.swagger.client.api.OnapsoinfraserviceInstantiationApi;
-
-public class OnapsoinfraserviceInstantiationApiExample {
-
-    public static void main(String[] args) {
-        OnapsoinfraserviceInstantiationApi apiInstance = new OnapsoinfraserviceInstantiationApi();
-        String version = version_example; // String | 
-        String serviceInstanceId = serviceInstanceId_example; // String | 
-        String configurationInstanceId = configurationInstanceId_example; // String | 
-        String body = body_example; // String | 
-        try {
-            apiInstance.deactivatePort(version, serviceInstanceId, configurationInstanceId, body);
-        } catch (ApiException e) {
-            System.err.println("Exception when calling OnapsoinfraserviceInstantiationApi#deactivatePort");
-            e.printStackTrace();
-        }
-    }
-}
-
- -
-
String *version = version_example; // 
-String *serviceInstanceId = serviceInstanceId_example; // 
-String *configurationInstanceId = configurationInstanceId_example; // 
-String *body = body_example; //  (optional)
-
-OnapsoinfraserviceInstantiationApi *apiInstance = [[OnapsoinfraserviceInstantiationApi alloc] init];
-
-// Deactivate Port Mirroring
-[apiInstance deactivatePortWith:version
-    serviceInstanceId:serviceInstanceId
-    configurationInstanceId:configurationInstanceId
-    body:body
-              completionHandler: ^(NSError* error) {
-                            if (error) {
-                                NSLog(@"Error: %@", error);
-                            }
-                        }];
-
-
- -
-
var SoCasablancaApIs = require('so_casablanca_ap_is');
-
-var api = new SoCasablancaApIs.OnapsoinfraserviceInstantiationApi()
-
-var version = version_example; // {String} 
-
-var serviceInstanceId = serviceInstanceId_example; // {String} 
-
-var configurationInstanceId = configurationInstanceId_example; // {String} 
-
-var opts = { 
-  'body': body_example // {String} 
-};
-
-var callback = function(error, data, response) {
-  if (error) {
-    console.error(error);
-  } else {
-    console.log('API called successfully.');
-  }
-};
-api.deactivatePort(version, serviceInstanceId, configurationInstanceId, opts, callback);
-
-
- - -
-
using System;
-using System.Diagnostics;
-using IO.Swagger.Api;
-using IO.Swagger.Client;
-using IO.Swagger.Model;
-
-namespace Example
-{
-    public class deactivatePortExample
-    {
-        public void main()
-        {
-            
-            var apiInstance = new OnapsoinfraserviceInstantiationApi();
-            var version = version_example;  // String | 
-            var serviceInstanceId = serviceInstanceId_example;  // String | 
-            var configurationInstanceId = configurationInstanceId_example;  // String | 
-            var body = body_example;  // String |  (optional) 
-
-            try
-            {
-                // Deactivate Port Mirroring
-                apiInstance.deactivatePort(version, serviceInstanceId, configurationInstanceId, body);
-            }
-            catch (Exception e)
-            {
-                Debug.Print("Exception when calling OnapsoinfraserviceInstantiationApi.deactivatePort: " + e.Message );
-            }
-        }
-    }
-}
-
-
- -
-
<?php
-require_once(__DIR__ . '/vendor/autoload.php');
-
-$api_instance = new Swagger\Client\Api\OnapsoinfraserviceInstantiationApi();
-$version = version_example; // String | 
-$serviceInstanceId = serviceInstanceId_example; // String | 
-$configurationInstanceId = configurationInstanceId_example; // String | 
-$body = body_example; // String | 
-
-try {
-    $api_instance->deactivatePort($version, $serviceInstanceId, $configurationInstanceId, $body);
-} catch (Exception $e) {
-    echo 'Exception when calling OnapsoinfraserviceInstantiationApi->deactivatePort: ', $e->getMessage(), PHP_EOL;
-}
-?>
-
- -
-
use Data::Dumper;
-use WWW::SwaggerClient::Configuration;
-use WWW::SwaggerClient::OnapsoinfraserviceInstantiationApi;
-
-my $api_instance = WWW::SwaggerClient::OnapsoinfraserviceInstantiationApi->new();
-my $version = version_example; # String | 
-my $serviceInstanceId = serviceInstanceId_example; # String | 
-my $configurationInstanceId = configurationInstanceId_example; # String | 
-my $body = WWW::SwaggerClient::Object::String->new(); # String | 
-
-eval { 
-    $api_instance->deactivatePort(version => $version, serviceInstanceId => $serviceInstanceId, configurationInstanceId => $configurationInstanceId, body => $body);
-};
-if ($@) {
-    warn "Exception when calling OnapsoinfraserviceInstantiationApi->deactivatePort: $@\n";
-}
-
- -
-
from __future__ import print_statement
-import time
-import swagger_client
-from swagger_client.rest import ApiException
-from pprint import pprint
-
-# create an instance of the API class
-api_instance = swagger_client.OnapsoinfraserviceInstantiationApi()
-version = version_example # String | 
-serviceInstanceId = serviceInstanceId_example # String | 
-configurationInstanceId = configurationInstanceId_example # String | 
-body = body_example # String |  (optional)
-
-try: 
-    # Deactivate Port Mirroring
-    api_instance.deactivate_port(version, serviceInstanceId, configurationInstanceId, body=body)
-except ApiException as e:
-    print("Exception when calling OnapsoinfraserviceInstantiationApi->deactivatePort: %s\n" % e)
-
-
- -

Parameters

- -
Path parameters
- - - - - - - - - - - - - - - - - -
NameDescription
version* - - -
-
-
- - String - - -
-
- Required -
-
-
-
serviceInstanceId* - - -
-
-
- - String - - -
-
- Required -
-
-
-
configurationInstanceId* - - -
-
-
- - String - - -
-
- Required -
-
-
-
- - -
Body parameters
- - - - - - - - - -
NameDescription
body - - - -
-
- - - -

Responses

-

Status: default - successful operation

- - - -
-
- -
-
-
-
-
-
-

deactivateServiceInstance

-

Deactivate provided Service Instance

-
-
-
-

-

-

-
-
/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/deactivate
-

-

Usage and SDK Samples

-

- - -
-
-
curl -X POST "https://localhost/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/deactivate"
-
-
-
import io.swagger.client.*;
-import io.swagger.client.auth.*;
-import io.swagger.client.model.*;
-import io.swagger.client.api.OnapsoinfraserviceInstantiationApi;
-
-import java.io.File;
-import java.util.*;
-
-public class OnapsoinfraserviceInstantiationApiExample {
-
-    public static void main(String[] args) {
-        
-        OnapsoinfraserviceInstantiationApi apiInstance = new OnapsoinfraserviceInstantiationApi();
-        String version = version_example; // String | 
-        String serviceInstanceId = serviceInstanceId_example; // String | 
-        String body = body_example; // String | 
-        try {
-            apiInstance.deactivateServiceInstance(version, serviceInstanceId, body);
-        } catch (ApiException e) {
-            System.err.println("Exception when calling OnapsoinfraserviceInstantiationApi#deactivateServiceInstance");
-            e.printStackTrace();
-        }
-    }
-}
-
- -
-
import io.swagger.client.api.OnapsoinfraserviceInstantiationApi;
-
-public class OnapsoinfraserviceInstantiationApiExample {
-
-    public static void main(String[] args) {
-        OnapsoinfraserviceInstantiationApi apiInstance = new OnapsoinfraserviceInstantiationApi();
-        String version = version_example; // String | 
-        String serviceInstanceId = serviceInstanceId_example; // String | 
-        String body = body_example; // String | 
-        try {
-            apiInstance.deactivateServiceInstance(version, serviceInstanceId, body);
-        } catch (ApiException e) {
-            System.err.println("Exception when calling OnapsoinfraserviceInstantiationApi#deactivateServiceInstance");
-            e.printStackTrace();
-        }
-    }
-}
-
- -
-
String *version = version_example; // 
-String *serviceInstanceId = serviceInstanceId_example; // 
-String *body = body_example; //  (optional)
-
-OnapsoinfraserviceInstantiationApi *apiInstance = [[OnapsoinfraserviceInstantiationApi alloc] init];
-
-// Deactivate provided Service Instance
-[apiInstance deactivateServiceInstanceWith:version
-    serviceInstanceId:serviceInstanceId
-    body:body
-              completionHandler: ^(NSError* error) {
-                            if (error) {
-                                NSLog(@"Error: %@", error);
-                            }
-                        }];
-
-
- -
-
var SoCasablancaApIs = require('so_casablanca_ap_is');
-
-var api = new SoCasablancaApIs.OnapsoinfraserviceInstantiationApi()
-
-var version = version_example; // {String} 
-
-var serviceInstanceId = serviceInstanceId_example; // {String} 
-
-var opts = { 
-  'body': body_example // {String} 
-};
-
-var callback = function(error, data, response) {
-  if (error) {
-    console.error(error);
-  } else {
-    console.log('API called successfully.');
-  }
-};
-api.deactivateServiceInstance(version, serviceInstanceId, opts, callback);
-
-
- - -
-
using System;
-using System.Diagnostics;
-using IO.Swagger.Api;
-using IO.Swagger.Client;
-using IO.Swagger.Model;
-
-namespace Example
-{
-    public class deactivateServiceInstanceExample
-    {
-        public void main()
-        {
-            
-            var apiInstance = new OnapsoinfraserviceInstantiationApi();
-            var version = version_example;  // String | 
-            var serviceInstanceId = serviceInstanceId_example;  // String | 
-            var body = body_example;  // String |  (optional) 
-
-            try
-            {
-                // Deactivate provided Service Instance
-                apiInstance.deactivateServiceInstance(version, serviceInstanceId, body);
-            }
-            catch (Exception e)
-            {
-                Debug.Print("Exception when calling OnapsoinfraserviceInstantiationApi.deactivateServiceInstance: " + e.Message );
-            }
-        }
-    }
-}
-
-
- -
-
<?php
-require_once(__DIR__ . '/vendor/autoload.php');
-
-$api_instance = new Swagger\Client\Api\OnapsoinfraserviceInstantiationApi();
-$version = version_example; // String | 
-$serviceInstanceId = serviceInstanceId_example; // String | 
-$body = body_example; // String | 
-
-try {
-    $api_instance->deactivateServiceInstance($version, $serviceInstanceId, $body);
-} catch (Exception $e) {
-    echo 'Exception when calling OnapsoinfraserviceInstantiationApi->deactivateServiceInstance: ', $e->getMessage(), PHP_EOL;
-}
-?>
-
- -
-
use Data::Dumper;
-use WWW::SwaggerClient::Configuration;
-use WWW::SwaggerClient::OnapsoinfraserviceInstantiationApi;
-
-my $api_instance = WWW::SwaggerClient::OnapsoinfraserviceInstantiationApi->new();
-my $version = version_example; # String | 
-my $serviceInstanceId = serviceInstanceId_example; # String | 
-my $body = WWW::SwaggerClient::Object::String->new(); # String | 
-
-eval { 
-    $api_instance->deactivateServiceInstance(version => $version, serviceInstanceId => $serviceInstanceId, body => $body);
-};
-if ($@) {
-    warn "Exception when calling OnapsoinfraserviceInstantiationApi->deactivateServiceInstance: $@\n";
-}
-
- -
-
from __future__ import print_statement
-import time
-import swagger_client
-from swagger_client.rest import ApiException
-from pprint import pprint
-
-# create an instance of the API class
-api_instance = swagger_client.OnapsoinfraserviceInstantiationApi()
-version = version_example # String | 
-serviceInstanceId = serviceInstanceId_example # String | 
-body = body_example # String |  (optional)
-
-try: 
-    # Deactivate provided Service Instance
-    api_instance.deactivate_service_instance(version, serviceInstanceId, body=body)
-except ApiException as e:
-    print("Exception when calling OnapsoinfraserviceInstantiationApi->deactivateServiceInstance: %s\n" % e)
-
-
- -

Parameters

- -
Path parameters
- - - - - - - - - - - - - -
NameDescription
version* - - -
-
-
- - String - - -
-
- Required -
-
-
-
serviceInstanceId* - - -
-
-
- - String - - -
-
- Required -
-
-
-
- - -
Body parameters
- - - - - - - - - -
NameDescription
body - - - -
-
- - - -

Responses

-

Status: default - successful operation

- - - -
-
- -
-
-
-
-
-
-

deleteNetworkInstance

-

Delete provided Network instance

-
-
-
-

-

-

-
-
/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/networks/{networkInstanceId}
-

-

Usage and SDK Samples

-

- - -
-
-
curl -X DELETE "https://localhost/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/networks/{networkInstanceId}"
-
-
-
import io.swagger.client.*;
-import io.swagger.client.auth.*;
-import io.swagger.client.model.*;
-import io.swagger.client.api.OnapsoinfraserviceInstantiationApi;
-
-import java.io.File;
-import java.util.*;
-
-public class OnapsoinfraserviceInstantiationApiExample {
-
-    public static void main(String[] args) {
-        
-        OnapsoinfraserviceInstantiationApi apiInstance = new OnapsoinfraserviceInstantiationApi();
-        String version = version_example; // String | 
-        String serviceInstanceId = serviceInstanceId_example; // String | 
-        String networkInstanceId = networkInstanceId_example; // String | 
-        String body = body_example; // String | 
-        try {
-            apiInstance.deleteNetworkInstance(version, serviceInstanceId, networkInstanceId, body);
-        } catch (ApiException e) {
-            System.err.println("Exception when calling OnapsoinfraserviceInstantiationApi#deleteNetworkInstance");
-            e.printStackTrace();
-        }
-    }
-}
-
- -
-
import io.swagger.client.api.OnapsoinfraserviceInstantiationApi;
-
-public class OnapsoinfraserviceInstantiationApiExample {
-
-    public static void main(String[] args) {
-        OnapsoinfraserviceInstantiationApi apiInstance = new OnapsoinfraserviceInstantiationApi();
-        String version = version_example; // String | 
-        String serviceInstanceId = serviceInstanceId_example; // String | 
-        String networkInstanceId = networkInstanceId_example; // String | 
-        String body = body_example; // String | 
-        try {
-            apiInstance.deleteNetworkInstance(version, serviceInstanceId, networkInstanceId, body);
-        } catch (ApiException e) {
-            System.err.println("Exception when calling OnapsoinfraserviceInstantiationApi#deleteNetworkInstance");
-            e.printStackTrace();
-        }
-    }
-}
-
- -
-
String *version = version_example; // 
-String *serviceInstanceId = serviceInstanceId_example; // 
-String *networkInstanceId = networkInstanceId_example; // 
-String *body = body_example; //  (optional)
-
-OnapsoinfraserviceInstantiationApi *apiInstance = [[OnapsoinfraserviceInstantiationApi alloc] init];
-
-// Delete provided Network instance
-[apiInstance deleteNetworkInstanceWith:version
-    serviceInstanceId:serviceInstanceId
-    networkInstanceId:networkInstanceId
-    body:body
-              completionHandler: ^(NSError* error) {
-                            if (error) {
-                                NSLog(@"Error: %@", error);
-                            }
-                        }];
-
-
- -
-
var SoCasablancaApIs = require('so_casablanca_ap_is');
-
-var api = new SoCasablancaApIs.OnapsoinfraserviceInstantiationApi()
-
-var version = version_example; // {String} 
-
-var serviceInstanceId = serviceInstanceId_example; // {String} 
-
-var networkInstanceId = networkInstanceId_example; // {String} 
-
-var opts = { 
-  'body': body_example // {String} 
-};
-
-var callback = function(error, data, response) {
-  if (error) {
-    console.error(error);
-  } else {
-    console.log('API called successfully.');
-  }
-};
-api.deleteNetworkInstance(version, serviceInstanceId, networkInstanceId, opts, callback);
-
-
- - -
-
using System;
-using System.Diagnostics;
-using IO.Swagger.Api;
-using IO.Swagger.Client;
-using IO.Swagger.Model;
-
-namespace Example
-{
-    public class deleteNetworkInstanceExample
-    {
-        public void main()
-        {
-            
-            var apiInstance = new OnapsoinfraserviceInstantiationApi();
-            var version = version_example;  // String | 
-            var serviceInstanceId = serviceInstanceId_example;  // String | 
-            var networkInstanceId = networkInstanceId_example;  // String | 
-            var body = body_example;  // String |  (optional) 
-
-            try
-            {
-                // Delete provided Network instance
-                apiInstance.deleteNetworkInstance(version, serviceInstanceId, networkInstanceId, body);
-            }
-            catch (Exception e)
-            {
-                Debug.Print("Exception when calling OnapsoinfraserviceInstantiationApi.deleteNetworkInstance: " + e.Message );
-            }
-        }
-    }
-}
-
-
- -
-
<?php
-require_once(__DIR__ . '/vendor/autoload.php');
-
-$api_instance = new Swagger\Client\Api\OnapsoinfraserviceInstantiationApi();
-$version = version_example; // String | 
-$serviceInstanceId = serviceInstanceId_example; // String | 
-$networkInstanceId = networkInstanceId_example; // String | 
-$body = body_example; // String | 
-
-try {
-    $api_instance->deleteNetworkInstance($version, $serviceInstanceId, $networkInstanceId, $body);
-} catch (Exception $e) {
-    echo 'Exception when calling OnapsoinfraserviceInstantiationApi->deleteNetworkInstance: ', $e->getMessage(), PHP_EOL;
-}
-?>
-
- -
-
use Data::Dumper;
-use WWW::SwaggerClient::Configuration;
-use WWW::SwaggerClient::OnapsoinfraserviceInstantiationApi;
-
-my $api_instance = WWW::SwaggerClient::OnapsoinfraserviceInstantiationApi->new();
-my $version = version_example; # String | 
-my $serviceInstanceId = serviceInstanceId_example; # String | 
-my $networkInstanceId = networkInstanceId_example; # String | 
-my $body = WWW::SwaggerClient::Object::String->new(); # String | 
-
-eval { 
-    $api_instance->deleteNetworkInstance(version => $version, serviceInstanceId => $serviceInstanceId, networkInstanceId => $networkInstanceId, body => $body);
-};
-if ($@) {
-    warn "Exception when calling OnapsoinfraserviceInstantiationApi->deleteNetworkInstance: $@\n";
-}
-
- -
-
from __future__ import print_statement
-import time
-import swagger_client
-from swagger_client.rest import ApiException
-from pprint import pprint
-
-# create an instance of the API class
-api_instance = swagger_client.OnapsoinfraserviceInstantiationApi()
-version = version_example # String | 
-serviceInstanceId = serviceInstanceId_example # String | 
-networkInstanceId = networkInstanceId_example # String | 
-body = body_example # String |  (optional)
-
-try: 
-    # Delete provided Network instance
-    api_instance.delete_network_instance(version, serviceInstanceId, networkInstanceId, body=body)
-except ApiException as e:
-    print("Exception when calling OnapsoinfraserviceInstantiationApi->deleteNetworkInstance: %s\n" % e)
-
-
- -

Parameters

- -
Path parameters
- - - - - - - - - - - - - - - - - -
NameDescription
version* - - -
-
-
- - String - - -
-
- Required -
-
-
-
serviceInstanceId* - - -
-
-
- - String - - -
-
- Required -
-
-
-
networkInstanceId* - - -
-
-
- - String - - -
-
- Required -
-
-
-
- - -
Body parameters
- - - - - - - - - -
NameDescription
body - - - -
-
- - - -

Responses

-

Status: default - successful operation

- - - -
-
- -
-
-
-
-
-
-

deletePortConfiguration

-

Delete provided Port

-
-
-
-

-

-

-
-
/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/configurations/{configurationInstanceId}
-

-

Usage and SDK Samples

-

- - -
-
-
curl -X DELETE "https://localhost/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/configurations/{configurationInstanceId}"
-
-
-
import io.swagger.client.*;
-import io.swagger.client.auth.*;
-import io.swagger.client.model.*;
-import io.swagger.client.api.OnapsoinfraserviceInstantiationApi;
-
-import java.io.File;
-import java.util.*;
-
-public class OnapsoinfraserviceInstantiationApiExample {
-
-    public static void main(String[] args) {
-        
-        OnapsoinfraserviceInstantiationApi apiInstance = new OnapsoinfraserviceInstantiationApi();
-        String version = version_example; // String | 
-        String serviceInstanceId = serviceInstanceId_example; // String | 
-        String configurationInstanceId = configurationInstanceId_example; // String | 
-        String body = body_example; // String | 
-        try {
-            apiInstance.deletePortConfiguration(version, serviceInstanceId, configurationInstanceId, body);
-        } catch (ApiException e) {
-            System.err.println("Exception when calling OnapsoinfraserviceInstantiationApi#deletePortConfiguration");
-            e.printStackTrace();
-        }
-    }
-}
-
- -
-
import io.swagger.client.api.OnapsoinfraserviceInstantiationApi;
-
-public class OnapsoinfraserviceInstantiationApiExample {
-
-    public static void main(String[] args) {
-        OnapsoinfraserviceInstantiationApi apiInstance = new OnapsoinfraserviceInstantiationApi();
-        String version = version_example; // String | 
-        String serviceInstanceId = serviceInstanceId_example; // String | 
-        String configurationInstanceId = configurationInstanceId_example; // String | 
-        String body = body_example; // String | 
-        try {
-            apiInstance.deletePortConfiguration(version, serviceInstanceId, configurationInstanceId, body);
-        } catch (ApiException e) {
-            System.err.println("Exception when calling OnapsoinfraserviceInstantiationApi#deletePortConfiguration");
-            e.printStackTrace();
-        }
-    }
-}
-
- -
-
String *version = version_example; // 
-String *serviceInstanceId = serviceInstanceId_example; // 
-String *configurationInstanceId = configurationInstanceId_example; // 
-String *body = body_example; //  (optional)
-
-OnapsoinfraserviceInstantiationApi *apiInstance = [[OnapsoinfraserviceInstantiationApi alloc] init];
-
-// Delete provided Port
-[apiInstance deletePortConfigurationWith:version
-    serviceInstanceId:serviceInstanceId
-    configurationInstanceId:configurationInstanceId
-    body:body
-              completionHandler: ^(NSError* error) {
-                            if (error) {
-                                NSLog(@"Error: %@", error);
-                            }
-                        }];
-
-
- -
-
var SoCasablancaApIs = require('so_casablanca_ap_is');
-
-var api = new SoCasablancaApIs.OnapsoinfraserviceInstantiationApi()
-
-var version = version_example; // {String} 
-
-var serviceInstanceId = serviceInstanceId_example; // {String} 
-
-var configurationInstanceId = configurationInstanceId_example; // {String} 
-
-var opts = { 
-  'body': body_example // {String} 
-};
-
-var callback = function(error, data, response) {
-  if (error) {
-    console.error(error);
-  } else {
-    console.log('API called successfully.');
-  }
-};
-api.deletePortConfiguration(version, serviceInstanceId, configurationInstanceId, opts, callback);
-
-
- - -
-
using System;
-using System.Diagnostics;
-using IO.Swagger.Api;
-using IO.Swagger.Client;
-using IO.Swagger.Model;
-
-namespace Example
-{
-    public class deletePortConfigurationExample
-    {
-        public void main()
-        {
-            
-            var apiInstance = new OnapsoinfraserviceInstantiationApi();
-            var version = version_example;  // String | 
-            var serviceInstanceId = serviceInstanceId_example;  // String | 
-            var configurationInstanceId = configurationInstanceId_example;  // String | 
-            var body = body_example;  // String |  (optional) 
-
-            try
-            {
-                // Delete provided Port
-                apiInstance.deletePortConfiguration(version, serviceInstanceId, configurationInstanceId, body);
-            }
-            catch (Exception e)
-            {
-                Debug.Print("Exception when calling OnapsoinfraserviceInstantiationApi.deletePortConfiguration: " + e.Message );
-            }
-        }
-    }
-}
-
-
- -
-
<?php
-require_once(__DIR__ . '/vendor/autoload.php');
-
-$api_instance = new Swagger\Client\Api\OnapsoinfraserviceInstantiationApi();
-$version = version_example; // String | 
-$serviceInstanceId = serviceInstanceId_example; // String | 
-$configurationInstanceId = configurationInstanceId_example; // String | 
-$body = body_example; // String | 
-
-try {
-    $api_instance->deletePortConfiguration($version, $serviceInstanceId, $configurationInstanceId, $body);
-} catch (Exception $e) {
-    echo 'Exception when calling OnapsoinfraserviceInstantiationApi->deletePortConfiguration: ', $e->getMessage(), PHP_EOL;
-}
-?>
-
- -
-
use Data::Dumper;
-use WWW::SwaggerClient::Configuration;
-use WWW::SwaggerClient::OnapsoinfraserviceInstantiationApi;
-
-my $api_instance = WWW::SwaggerClient::OnapsoinfraserviceInstantiationApi->new();
-my $version = version_example; # String | 
-my $serviceInstanceId = serviceInstanceId_example; # String | 
-my $configurationInstanceId = configurationInstanceId_example; # String | 
-my $body = WWW::SwaggerClient::Object::String->new(); # String | 
-
-eval { 
-    $api_instance->deletePortConfiguration(version => $version, serviceInstanceId => $serviceInstanceId, configurationInstanceId => $configurationInstanceId, body => $body);
-};
-if ($@) {
-    warn "Exception when calling OnapsoinfraserviceInstantiationApi->deletePortConfiguration: $@\n";
-}
-
- -
-
from __future__ import print_statement
-import time
-import swagger_client
-from swagger_client.rest import ApiException
-from pprint import pprint
-
-# create an instance of the API class
-api_instance = swagger_client.OnapsoinfraserviceInstantiationApi()
-version = version_example # String | 
-serviceInstanceId = serviceInstanceId_example # String | 
-configurationInstanceId = configurationInstanceId_example # String | 
-body = body_example # String |  (optional)
-
-try: 
-    # Delete provided Port
-    api_instance.delete_port_configuration(version, serviceInstanceId, configurationInstanceId, body=body)
-except ApiException as e:
-    print("Exception when calling OnapsoinfraserviceInstantiationApi->deletePortConfiguration: %s\n" % e)
-
-
- -

Parameters

- -
Path parameters
- - - - - - - - - - - - - - - - - -
NameDescription
version* - - -
-
-
- - String - - -
-
- Required -
-
-
-
serviceInstanceId* - - -
-
-
- - String - - -
-
- Required -
-
-
-
configurationInstanceId* - - -
-
-
- - String - - -
-
- Required -
-
-
-
- - -
Body parameters
- - - - - - - - - -
NameDescription
body - - - -
-
- - - -

Responses

-

Status: default - successful operation

- - - -
-
- -
-
-
-
-
-
-

deleteServiceInstance

-

Delete provided Service Instance

-
-
-
-

-

-

-
-
/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}
-

-

Usage and SDK Samples

-

- - -
-
-
curl -X DELETE "https://localhost/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}"
-
-
-
import io.swagger.client.*;
-import io.swagger.client.auth.*;
-import io.swagger.client.model.*;
-import io.swagger.client.api.OnapsoinfraserviceInstantiationApi;
-
-import java.io.File;
-import java.util.*;
-
-public class OnapsoinfraserviceInstantiationApiExample {
-
-    public static void main(String[] args) {
-        
-        OnapsoinfraserviceInstantiationApi apiInstance = new OnapsoinfraserviceInstantiationApi();
-        String version = version_example; // String | 
-        String serviceInstanceId = serviceInstanceId_example; // String | 
-        String body = body_example; // String | 
-        try {
-            apiInstance.deleteServiceInstance(version, serviceInstanceId, body);
-        } catch (ApiException e) {
-            System.err.println("Exception when calling OnapsoinfraserviceInstantiationApi#deleteServiceInstance");
-            e.printStackTrace();
-        }
-    }
-}
-
- -
-
import io.swagger.client.api.OnapsoinfraserviceInstantiationApi;
-
-public class OnapsoinfraserviceInstantiationApiExample {
-
-    public static void main(String[] args) {
-        OnapsoinfraserviceInstantiationApi apiInstance = new OnapsoinfraserviceInstantiationApi();
-        String version = version_example; // String | 
-        String serviceInstanceId = serviceInstanceId_example; // String | 
-        String body = body_example; // String | 
-        try {
-            apiInstance.deleteServiceInstance(version, serviceInstanceId, body);
-        } catch (ApiException e) {
-            System.err.println("Exception when calling OnapsoinfraserviceInstantiationApi#deleteServiceInstance");
-            e.printStackTrace();
-        }
-    }
-}
-
- -
-
String *version = version_example; // 
-String *serviceInstanceId = serviceInstanceId_example; // 
-String *body = body_example; //  (optional)
-
-OnapsoinfraserviceInstantiationApi *apiInstance = [[OnapsoinfraserviceInstantiationApi alloc] init];
-
-// Delete provided Service Instance
-[apiInstance deleteServiceInstanceWith:version
-    serviceInstanceId:serviceInstanceId
-    body:body
-              completionHandler: ^(NSError* error) {
-                            if (error) {
-                                NSLog(@"Error: %@", error);
-                            }
-                        }];
-
-
- -
-
var SoCasablancaApIs = require('so_casablanca_ap_is');
-
-var api = new SoCasablancaApIs.OnapsoinfraserviceInstantiationApi()
-
-var version = version_example; // {String} 
-
-var serviceInstanceId = serviceInstanceId_example; // {String} 
-
-var opts = { 
-  'body': body_example // {String} 
-};
-
-var callback = function(error, data, response) {
-  if (error) {
-    console.error(error);
-  } else {
-    console.log('API called successfully.');
-  }
-};
-api.deleteServiceInstance(version, serviceInstanceId, opts, callback);
-
-
- - -
-
using System;
-using System.Diagnostics;
-using IO.Swagger.Api;
-using IO.Swagger.Client;
-using IO.Swagger.Model;
-
-namespace Example
-{
-    public class deleteServiceInstanceExample
-    {
-        public void main()
-        {
-            
-            var apiInstance = new OnapsoinfraserviceInstantiationApi();
-            var version = version_example;  // String | 
-            var serviceInstanceId = serviceInstanceId_example;  // String | 
-            var body = body_example;  // String |  (optional) 
-
-            try
-            {
-                // Delete provided Service Instance
-                apiInstance.deleteServiceInstance(version, serviceInstanceId, body);
-            }
-            catch (Exception e)
-            {
-                Debug.Print("Exception when calling OnapsoinfraserviceInstantiationApi.deleteServiceInstance: " + e.Message );
-            }
-        }
-    }
-}
-
-
- -
-
<?php
-require_once(__DIR__ . '/vendor/autoload.php');
-
-$api_instance = new Swagger\Client\Api\OnapsoinfraserviceInstantiationApi();
-$version = version_example; // String | 
-$serviceInstanceId = serviceInstanceId_example; // String | 
-$body = body_example; // String | 
-
-try {
-    $api_instance->deleteServiceInstance($version, $serviceInstanceId, $body);
-} catch (Exception $e) {
-    echo 'Exception when calling OnapsoinfraserviceInstantiationApi->deleteServiceInstance: ', $e->getMessage(), PHP_EOL;
-}
-?>
-
- -
-
use Data::Dumper;
-use WWW::SwaggerClient::Configuration;
-use WWW::SwaggerClient::OnapsoinfraserviceInstantiationApi;
-
-my $api_instance = WWW::SwaggerClient::OnapsoinfraserviceInstantiationApi->new();
-my $version = version_example; # String | 
-my $serviceInstanceId = serviceInstanceId_example; # String | 
-my $body = WWW::SwaggerClient::Object::String->new(); # String | 
-
-eval { 
-    $api_instance->deleteServiceInstance(version => $version, serviceInstanceId => $serviceInstanceId, body => $body);
-};
-if ($@) {
-    warn "Exception when calling OnapsoinfraserviceInstantiationApi->deleteServiceInstance: $@\n";
-}
-
- -
-
from __future__ import print_statement
-import time
-import swagger_client
-from swagger_client.rest import ApiException
-from pprint import pprint
-
-# create an instance of the API class
-api_instance = swagger_client.OnapsoinfraserviceInstantiationApi()
-version = version_example # String | 
-serviceInstanceId = serviceInstanceId_example # String | 
-body = body_example # String |  (optional)
-
-try: 
-    # Delete provided Service Instance
-    api_instance.delete_service_instance(version, serviceInstanceId, body=body)
-except ApiException as e:
-    print("Exception when calling OnapsoinfraserviceInstantiationApi->deleteServiceInstance: %s\n" % e)
-
-
- -

Parameters

- -
Path parameters
- - - - - - - - - - - - - -
NameDescription
version* - - -
-
-
- - String - - -
-
- Required -
-
-
-
serviceInstanceId* - - -
-
-
- - String - - -
-
- Required -
-
-
-
- - -
Body parameters
- - - - - - - - - -
NameDescription
body - - - -
-
- - - -

Responses

-

Status: default - successful operation

- - - -
-
- -
-
-
-
-
-
-

deleteVfModuleInstance

-

Delete provided VfModule instance

-
-
-
-

-

-

-
-
/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/vnfs/{vnfInstanceId}/vfModules/{vfmoduleInstanceId}
-

-

Usage and SDK Samples

-

- - -
-
-
curl -X DELETE "https://localhost/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/vnfs/{vnfInstanceId}/vfModules/{vfmoduleInstanceId}"
-
-
-
import io.swagger.client.*;
-import io.swagger.client.auth.*;
-import io.swagger.client.model.*;
-import io.swagger.client.api.OnapsoinfraserviceInstantiationApi;
-
-import java.io.File;
-import java.util.*;
-
-public class OnapsoinfraserviceInstantiationApiExample {
-
-    public static void main(String[] args) {
-        
-        OnapsoinfraserviceInstantiationApi apiInstance = new OnapsoinfraserviceInstantiationApi();
-        String version = version_example; // String | 
-        String serviceInstanceId = serviceInstanceId_example; // String | 
-        String vnfInstanceId = vnfInstanceId_example; // String | 
-        String vfmoduleInstanceId = vfmoduleInstanceId_example; // String | 
-        String body = body_example; // String | 
-        try {
-            apiInstance.deleteVfModuleInstance(version, serviceInstanceId, vnfInstanceId, vfmoduleInstanceId, body);
-        } catch (ApiException e) {
-            System.err.println("Exception when calling OnapsoinfraserviceInstantiationApi#deleteVfModuleInstance");
-            e.printStackTrace();
-        }
-    }
-}
-
- -
-
import io.swagger.client.api.OnapsoinfraserviceInstantiationApi;
-
-public class OnapsoinfraserviceInstantiationApiExample {
-
-    public static void main(String[] args) {
-        OnapsoinfraserviceInstantiationApi apiInstance = new OnapsoinfraserviceInstantiationApi();
-        String version = version_example; // String | 
-        String serviceInstanceId = serviceInstanceId_example; // String | 
-        String vnfInstanceId = vnfInstanceId_example; // String | 
-        String vfmoduleInstanceId = vfmoduleInstanceId_example; // String | 
-        String body = body_example; // String | 
-        try {
-            apiInstance.deleteVfModuleInstance(version, serviceInstanceId, vnfInstanceId, vfmoduleInstanceId, body);
-        } catch (ApiException e) {
-            System.err.println("Exception when calling OnapsoinfraserviceInstantiationApi#deleteVfModuleInstance");
-            e.printStackTrace();
-        }
-    }
-}
-
- -
-
String *version = version_example; // 
-String *serviceInstanceId = serviceInstanceId_example; // 
-String *vnfInstanceId = vnfInstanceId_example; // 
-String *vfmoduleInstanceId = vfmoduleInstanceId_example; // 
-String *body = body_example; //  (optional)
-
-OnapsoinfraserviceInstantiationApi *apiInstance = [[OnapsoinfraserviceInstantiationApi alloc] init];
-
-// Delete provided VfModule instance
-[apiInstance deleteVfModuleInstanceWith:version
-    serviceInstanceId:serviceInstanceId
-    vnfInstanceId:vnfInstanceId
-    vfmoduleInstanceId:vfmoduleInstanceId
-    body:body
-              completionHandler: ^(NSError* error) {
-                            if (error) {
-                                NSLog(@"Error: %@", error);
-                            }
-                        }];
-
-
- -
-
var SoCasablancaApIs = require('so_casablanca_ap_is');
-
-var api = new SoCasablancaApIs.OnapsoinfraserviceInstantiationApi()
-
-var version = version_example; // {String} 
-
-var serviceInstanceId = serviceInstanceId_example; // {String} 
-
-var vnfInstanceId = vnfInstanceId_example; // {String} 
-
-var vfmoduleInstanceId = vfmoduleInstanceId_example; // {String} 
-
-var opts = { 
-  'body': body_example // {String} 
-};
-
-var callback = function(error, data, response) {
-  if (error) {
-    console.error(error);
-  } else {
-    console.log('API called successfully.');
-  }
-};
-api.deleteVfModuleInstance(version, serviceInstanceId, vnfInstanceId, vfmoduleInstanceId, opts, callback);
-
-
- - -
-
using System;
-using System.Diagnostics;
-using IO.Swagger.Api;
-using IO.Swagger.Client;
-using IO.Swagger.Model;
-
-namespace Example
-{
-    public class deleteVfModuleInstanceExample
-    {
-        public void main()
-        {
-            
-            var apiInstance = new OnapsoinfraserviceInstantiationApi();
-            var version = version_example;  // String | 
-            var serviceInstanceId = serviceInstanceId_example;  // String | 
-            var vnfInstanceId = vnfInstanceId_example;  // String | 
-            var vfmoduleInstanceId = vfmoduleInstanceId_example;  // String | 
-            var body = body_example;  // String |  (optional) 
-
-            try
-            {
-                // Delete provided VfModule instance
-                apiInstance.deleteVfModuleInstance(version, serviceInstanceId, vnfInstanceId, vfmoduleInstanceId, body);
-            }
-            catch (Exception e)
-            {
-                Debug.Print("Exception when calling OnapsoinfraserviceInstantiationApi.deleteVfModuleInstance: " + e.Message );
-            }
-        }
-    }
-}
-
-
- -
-
<?php
-require_once(__DIR__ . '/vendor/autoload.php');
-
-$api_instance = new Swagger\Client\Api\OnapsoinfraserviceInstantiationApi();
-$version = version_example; // String | 
-$serviceInstanceId = serviceInstanceId_example; // String | 
-$vnfInstanceId = vnfInstanceId_example; // String | 
-$vfmoduleInstanceId = vfmoduleInstanceId_example; // String | 
-$body = body_example; // String | 
-
-try {
-    $api_instance->deleteVfModuleInstance($version, $serviceInstanceId, $vnfInstanceId, $vfmoduleInstanceId, $body);
-} catch (Exception $e) {
-    echo 'Exception when calling OnapsoinfraserviceInstantiationApi->deleteVfModuleInstance: ', $e->getMessage(), PHP_EOL;
-}
-?>
-
- -
-
use Data::Dumper;
-use WWW::SwaggerClient::Configuration;
-use WWW::SwaggerClient::OnapsoinfraserviceInstantiationApi;
-
-my $api_instance = WWW::SwaggerClient::OnapsoinfraserviceInstantiationApi->new();
-my $version = version_example; # String | 
-my $serviceInstanceId = serviceInstanceId_example; # String | 
-my $vnfInstanceId = vnfInstanceId_example; # String | 
-my $vfmoduleInstanceId = vfmoduleInstanceId_example; # String | 
-my $body = WWW::SwaggerClient::Object::String->new(); # String | 
-
-eval { 
-    $api_instance->deleteVfModuleInstance(version => $version, serviceInstanceId => $serviceInstanceId, vnfInstanceId => $vnfInstanceId, vfmoduleInstanceId => $vfmoduleInstanceId, body => $body);
-};
-if ($@) {
-    warn "Exception when calling OnapsoinfraserviceInstantiationApi->deleteVfModuleInstance: $@\n";
-}
-
- -
-
from __future__ import print_statement
-import time
-import swagger_client
-from swagger_client.rest import ApiException
-from pprint import pprint
-
-# create an instance of the API class
-api_instance = swagger_client.OnapsoinfraserviceInstantiationApi()
-version = version_example # String | 
-serviceInstanceId = serviceInstanceId_example # String | 
-vnfInstanceId = vnfInstanceId_example # String | 
-vfmoduleInstanceId = vfmoduleInstanceId_example # String | 
-body = body_example # String |  (optional)
-
-try: 
-    # Delete provided VfModule instance
-    api_instance.delete_vf_module_instance(version, serviceInstanceId, vnfInstanceId, vfmoduleInstanceId, body=body)
-except ApiException as e:
-    print("Exception when calling OnapsoinfraserviceInstantiationApi->deleteVfModuleInstance: %s\n" % e)
-
-
- -

Parameters

- -
Path parameters
- - - - - - - - - - - - - - - - - - - - - -
NameDescription
version* - - -
-
-
- - String - - -
-
- Required -
-
-
-
serviceInstanceId* - - -
-
-
- - String - - -
-
- Required -
-
-
-
vnfInstanceId* - - -
-
-
- - String - - -
-
- Required -
-
-
-
vfmoduleInstanceId* - - -
-
-
- - String - - -
-
- Required -
-
-
-
- - -
Body parameters
- - - - - - - - - -
NameDescription
body - - - -
-
- - - -

Responses

-

Status: default - successful operation

- - - -
-
- -
-
-
-
-
-
-

deleteVnfInstance

-

Delete provided VNF instance

-
-
-
-

-

-

-
-
/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/vnfs/{vnfInstanceId}
-

-

Usage and SDK Samples

-

- - -
-
-
curl -X DELETE "https://localhost/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/vnfs/{vnfInstanceId}"
-
-
-
import io.swagger.client.*;
-import io.swagger.client.auth.*;
-import io.swagger.client.model.*;
-import io.swagger.client.api.OnapsoinfraserviceInstantiationApi;
-
-import java.io.File;
-import java.util.*;
-
-public class OnapsoinfraserviceInstantiationApiExample {
-
-    public static void main(String[] args) {
-        
-        OnapsoinfraserviceInstantiationApi apiInstance = new OnapsoinfraserviceInstantiationApi();
-        String version = version_example; // String | 
-        String serviceInstanceId = serviceInstanceId_example; // String | 
-        String vnfInstanceId = vnfInstanceId_example; // String | 
-        String body = body_example; // String | 
-        try {
-            apiInstance.deleteVnfInstance(version, serviceInstanceId, vnfInstanceId, body);
-        } catch (ApiException e) {
-            System.err.println("Exception when calling OnapsoinfraserviceInstantiationApi#deleteVnfInstance");
-            e.printStackTrace();
-        }
-    }
-}
-
- -
-
import io.swagger.client.api.OnapsoinfraserviceInstantiationApi;
-
-public class OnapsoinfraserviceInstantiationApiExample {
-
-    public static void main(String[] args) {
-        OnapsoinfraserviceInstantiationApi apiInstance = new OnapsoinfraserviceInstantiationApi();
-        String version = version_example; // String | 
-        String serviceInstanceId = serviceInstanceId_example; // String | 
-        String vnfInstanceId = vnfInstanceId_example; // String | 
-        String body = body_example; // String | 
-        try {
-            apiInstance.deleteVnfInstance(version, serviceInstanceId, vnfInstanceId, body);
-        } catch (ApiException e) {
-            System.err.println("Exception when calling OnapsoinfraserviceInstantiationApi#deleteVnfInstance");
-            e.printStackTrace();
-        }
-    }
-}
-
- -
-
String *version = version_example; // 
-String *serviceInstanceId = serviceInstanceId_example; // 
-String *vnfInstanceId = vnfInstanceId_example; // 
-String *body = body_example; //  (optional)
-
-OnapsoinfraserviceInstantiationApi *apiInstance = [[OnapsoinfraserviceInstantiationApi alloc] init];
-
-// Delete provided VNF instance
-[apiInstance deleteVnfInstanceWith:version
-    serviceInstanceId:serviceInstanceId
-    vnfInstanceId:vnfInstanceId
-    body:body
-              completionHandler: ^(NSError* error) {
-                            if (error) {
-                                NSLog(@"Error: %@", error);
-                            }
-                        }];
-
-
- -
-
var SoCasablancaApIs = require('so_casablanca_ap_is');
-
-var api = new SoCasablancaApIs.OnapsoinfraserviceInstantiationApi()
-
-var version = version_example; // {String} 
-
-var serviceInstanceId = serviceInstanceId_example; // {String} 
-
-var vnfInstanceId = vnfInstanceId_example; // {String} 
-
-var opts = { 
-  'body': body_example // {String} 
-};
-
-var callback = function(error, data, response) {
-  if (error) {
-    console.error(error);
-  } else {
-    console.log('API called successfully.');
-  }
-};
-api.deleteVnfInstance(version, serviceInstanceId, vnfInstanceId, opts, callback);
-
-
- - -
-
using System;
-using System.Diagnostics;
-using IO.Swagger.Api;
-using IO.Swagger.Client;
-using IO.Swagger.Model;
-
-namespace Example
-{
-    public class deleteVnfInstanceExample
-    {
-        public void main()
-        {
-            
-            var apiInstance = new OnapsoinfraserviceInstantiationApi();
-            var version = version_example;  // String | 
-            var serviceInstanceId = serviceInstanceId_example;  // String | 
-            var vnfInstanceId = vnfInstanceId_example;  // String | 
-            var body = body_example;  // String |  (optional) 
-
-            try
-            {
-                // Delete provided VNF instance
-                apiInstance.deleteVnfInstance(version, serviceInstanceId, vnfInstanceId, body);
-            }
-            catch (Exception e)
-            {
-                Debug.Print("Exception when calling OnapsoinfraserviceInstantiationApi.deleteVnfInstance: " + e.Message );
-            }
-        }
-    }
-}
-
-
- -
-
<?php
-require_once(__DIR__ . '/vendor/autoload.php');
-
-$api_instance = new Swagger\Client\Api\OnapsoinfraserviceInstantiationApi();
-$version = version_example; // String | 
-$serviceInstanceId = serviceInstanceId_example; // String | 
-$vnfInstanceId = vnfInstanceId_example; // String | 
-$body = body_example; // String | 
-
-try {
-    $api_instance->deleteVnfInstance($version, $serviceInstanceId, $vnfInstanceId, $body);
-} catch (Exception $e) {
-    echo 'Exception when calling OnapsoinfraserviceInstantiationApi->deleteVnfInstance: ', $e->getMessage(), PHP_EOL;
-}
-?>
-
- -
-
use Data::Dumper;
-use WWW::SwaggerClient::Configuration;
-use WWW::SwaggerClient::OnapsoinfraserviceInstantiationApi;
-
-my $api_instance = WWW::SwaggerClient::OnapsoinfraserviceInstantiationApi->new();
-my $version = version_example; # String | 
-my $serviceInstanceId = serviceInstanceId_example; # String | 
-my $vnfInstanceId = vnfInstanceId_example; # String | 
-my $body = WWW::SwaggerClient::Object::String->new(); # String | 
-
-eval { 
-    $api_instance->deleteVnfInstance(version => $version, serviceInstanceId => $serviceInstanceId, vnfInstanceId => $vnfInstanceId, body => $body);
-};
-if ($@) {
-    warn "Exception when calling OnapsoinfraserviceInstantiationApi->deleteVnfInstance: $@\n";
-}
-
- -
-
from __future__ import print_statement
-import time
-import swagger_client
-from swagger_client.rest import ApiException
-from pprint import pprint
-
-# create an instance of the API class
-api_instance = swagger_client.OnapsoinfraserviceInstantiationApi()
-version = version_example # String | 
-serviceInstanceId = serviceInstanceId_example # String | 
-vnfInstanceId = vnfInstanceId_example # String | 
-body = body_example # String |  (optional)
-
-try: 
-    # Delete provided VNF instance
-    api_instance.delete_vnf_instance(version, serviceInstanceId, vnfInstanceId, body=body)
-except ApiException as e:
-    print("Exception when calling OnapsoinfraserviceInstantiationApi->deleteVnfInstance: %s\n" % e)
-
-
- -

Parameters

- -
Path parameters
- - - - - - - - - - - - - - - - - -
NameDescription
version* - - -
-
-
- - String - - -
-
- Required -
-
-
-
serviceInstanceId* - - -
-
-
- - String - - -
-
- Required -
-
-
-
vnfInstanceId* - - -
-
-
- - String - - -
-
- Required -
-
-
-
- - -
Body parameters
- - - - - - - - - -
NameDescription
body - - - -
-
- - - -

Responses

-

Status: default - successful operation

- - - -
-
- -
-
-
-
-
-
-

deleteVolumeGroupInstance

-

Delete provided VolumeGroup instance

-
-
-
-

-

-

-
-
/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/vnfs/{vnfInstanceId}/volumeGroups/{volumeGroupInstanceId}
-

-

Usage and SDK Samples

-

- - -
-
-
curl -X DELETE "https://localhost/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/vnfs/{vnfInstanceId}/volumeGroups/{volumeGroupInstanceId}"
-
-
-
import io.swagger.client.*;
-import io.swagger.client.auth.*;
-import io.swagger.client.model.*;
-import io.swagger.client.api.OnapsoinfraserviceInstantiationApi;
-
-import java.io.File;
-import java.util.*;
-
-public class OnapsoinfraserviceInstantiationApiExample {
-
-    public static void main(String[] args) {
-        
-        OnapsoinfraserviceInstantiationApi apiInstance = new OnapsoinfraserviceInstantiationApi();
-        String version = version_example; // String | 
-        String serviceInstanceId = serviceInstanceId_example; // String | 
-        String vnfInstanceId = vnfInstanceId_example; // String | 
-        String volumeGroupInstanceId = volumeGroupInstanceId_example; // String | 
-        String body = body_example; // String | 
-        try {
-            apiInstance.deleteVolumeGroupInstance(version, serviceInstanceId, vnfInstanceId, volumeGroupInstanceId, body);
-        } catch (ApiException e) {
-            System.err.println("Exception when calling OnapsoinfraserviceInstantiationApi#deleteVolumeGroupInstance");
-            e.printStackTrace();
-        }
-    }
-}
-
- -
-
import io.swagger.client.api.OnapsoinfraserviceInstantiationApi;
-
-public class OnapsoinfraserviceInstantiationApiExample {
-
-    public static void main(String[] args) {
-        OnapsoinfraserviceInstantiationApi apiInstance = new OnapsoinfraserviceInstantiationApi();
-        String version = version_example; // String | 
-        String serviceInstanceId = serviceInstanceId_example; // String | 
-        String vnfInstanceId = vnfInstanceId_example; // String | 
-        String volumeGroupInstanceId = volumeGroupInstanceId_example; // String | 
-        String body = body_example; // String | 
-        try {
-            apiInstance.deleteVolumeGroupInstance(version, serviceInstanceId, vnfInstanceId, volumeGroupInstanceId, body);
-        } catch (ApiException e) {
-            System.err.println("Exception when calling OnapsoinfraserviceInstantiationApi#deleteVolumeGroupInstance");
-            e.printStackTrace();
-        }
-    }
-}
-
- -
-
String *version = version_example; // 
-String *serviceInstanceId = serviceInstanceId_example; // 
-String *vnfInstanceId = vnfInstanceId_example; // 
-String *volumeGroupInstanceId = volumeGroupInstanceId_example; // 
-String *body = body_example; //  (optional)
-
-OnapsoinfraserviceInstantiationApi *apiInstance = [[OnapsoinfraserviceInstantiationApi alloc] init];
-
-// Delete provided VolumeGroup instance
-[apiInstance deleteVolumeGroupInstanceWith:version
-    serviceInstanceId:serviceInstanceId
-    vnfInstanceId:vnfInstanceId
-    volumeGroupInstanceId:volumeGroupInstanceId
-    body:body
-              completionHandler: ^(NSError* error) {
-                            if (error) {
-                                NSLog(@"Error: %@", error);
-                            }
-                        }];
-
-
- -
-
var SoCasablancaApIs = require('so_casablanca_ap_is');
-
-var api = new SoCasablancaApIs.OnapsoinfraserviceInstantiationApi()
-
-var version = version_example; // {String} 
-
-var serviceInstanceId = serviceInstanceId_example; // {String} 
-
-var vnfInstanceId = vnfInstanceId_example; // {String} 
-
-var volumeGroupInstanceId = volumeGroupInstanceId_example; // {String} 
-
-var opts = { 
-  'body': body_example // {String} 
-};
-
-var callback = function(error, data, response) {
-  if (error) {
-    console.error(error);
-  } else {
-    console.log('API called successfully.');
-  }
-};
-api.deleteVolumeGroupInstance(version, serviceInstanceId, vnfInstanceId, volumeGroupInstanceId, opts, callback);
-
-
- - -
-
using System;
-using System.Diagnostics;
-using IO.Swagger.Api;
-using IO.Swagger.Client;
-using IO.Swagger.Model;
-
-namespace Example
-{
-    public class deleteVolumeGroupInstanceExample
-    {
-        public void main()
-        {
-            
-            var apiInstance = new OnapsoinfraserviceInstantiationApi();
-            var version = version_example;  // String | 
-            var serviceInstanceId = serviceInstanceId_example;  // String | 
-            var vnfInstanceId = vnfInstanceId_example;  // String | 
-            var volumeGroupInstanceId = volumeGroupInstanceId_example;  // String | 
-            var body = body_example;  // String |  (optional) 
-
-            try
-            {
-                // Delete provided VolumeGroup instance
-                apiInstance.deleteVolumeGroupInstance(version, serviceInstanceId, vnfInstanceId, volumeGroupInstanceId, body);
-            }
-            catch (Exception e)
-            {
-                Debug.Print("Exception when calling OnapsoinfraserviceInstantiationApi.deleteVolumeGroupInstance: " + e.Message );
-            }
-        }
-    }
-}
-
-
- -
-
<?php
-require_once(__DIR__ . '/vendor/autoload.php');
-
-$api_instance = new Swagger\Client\Api\OnapsoinfraserviceInstantiationApi();
-$version = version_example; // String | 
-$serviceInstanceId = serviceInstanceId_example; // String | 
-$vnfInstanceId = vnfInstanceId_example; // String | 
-$volumeGroupInstanceId = volumeGroupInstanceId_example; // String | 
-$body = body_example; // String | 
-
-try {
-    $api_instance->deleteVolumeGroupInstance($version, $serviceInstanceId, $vnfInstanceId, $volumeGroupInstanceId, $body);
-} catch (Exception $e) {
-    echo 'Exception when calling OnapsoinfraserviceInstantiationApi->deleteVolumeGroupInstance: ', $e->getMessage(), PHP_EOL;
-}
-?>
-
- -
-
use Data::Dumper;
-use WWW::SwaggerClient::Configuration;
-use WWW::SwaggerClient::OnapsoinfraserviceInstantiationApi;
-
-my $api_instance = WWW::SwaggerClient::OnapsoinfraserviceInstantiationApi->new();
-my $version = version_example; # String | 
-my $serviceInstanceId = serviceInstanceId_example; # String | 
-my $vnfInstanceId = vnfInstanceId_example; # String | 
-my $volumeGroupInstanceId = volumeGroupInstanceId_example; # String | 
-my $body = WWW::SwaggerClient::Object::String->new(); # String | 
-
-eval { 
-    $api_instance->deleteVolumeGroupInstance(version => $version, serviceInstanceId => $serviceInstanceId, vnfInstanceId => $vnfInstanceId, volumeGroupInstanceId => $volumeGroupInstanceId, body => $body);
-};
-if ($@) {
-    warn "Exception when calling OnapsoinfraserviceInstantiationApi->deleteVolumeGroupInstance: $@\n";
-}
-
- -
-
from __future__ import print_statement
-import time
-import swagger_client
-from swagger_client.rest import ApiException
-from pprint import pprint
-
-# create an instance of the API class
-api_instance = swagger_client.OnapsoinfraserviceInstantiationApi()
-version = version_example # String | 
-serviceInstanceId = serviceInstanceId_example # String | 
-vnfInstanceId = vnfInstanceId_example # String | 
-volumeGroupInstanceId = volumeGroupInstanceId_example # String | 
-body = body_example # String |  (optional)
-
-try: 
-    # Delete provided VolumeGroup instance
-    api_instance.delete_volume_group_instance(version, serviceInstanceId, vnfInstanceId, volumeGroupInstanceId, body=body)
-except ApiException as e:
-    print("Exception when calling OnapsoinfraserviceInstantiationApi->deleteVolumeGroupInstance: %s\n" % e)
-
-
- -

Parameters

- -
Path parameters
- - - - - - - - - - - - - - - - - - - - - -
NameDescription
version* - - -
-
-
- - String - - -
-
- Required -
-
-
-
serviceInstanceId* - - -
-
-
- - String - - -
-
- Required -
-
-
-
vnfInstanceId* - - -
-
-
- - String - - -
-
- Required -
-
-
-
volumeGroupInstanceId* - - -
-
-
- - String - - -
-
- Required -
-
-
-
- - -
Body parameters
- - - - - - - - - -
NameDescription
body - - - -
-
- - - -

Responses

-

Status: default - successful operation

- - - -
-
- -
-
-
-
-
-
-

disablePort

-

Disable Port Mirroring

-
-
-
-

-

-

-
-
/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/configurations/{configurationInstanceId}/disablePort
-

-

Usage and SDK Samples

-

- - -
-
-
curl -X POST "https://localhost/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/configurations/{configurationInstanceId}/disablePort"
-
-
-
import io.swagger.client.*;
-import io.swagger.client.auth.*;
-import io.swagger.client.model.*;
-import io.swagger.client.api.OnapsoinfraserviceInstantiationApi;
-
-import java.io.File;
-import java.util.*;
-
-public class OnapsoinfraserviceInstantiationApiExample {
-
-    public static void main(String[] args) {
-        
-        OnapsoinfraserviceInstantiationApi apiInstance = new OnapsoinfraserviceInstantiationApi();
-        String version = version_example; // String | 
-        String serviceInstanceId = serviceInstanceId_example; // String | 
-        String configurationInstanceId = configurationInstanceId_example; // String | 
-        String body = body_example; // String | 
-        try {
-            apiInstance.disablePort(version, serviceInstanceId, configurationInstanceId, body);
-        } catch (ApiException e) {
-            System.err.println("Exception when calling OnapsoinfraserviceInstantiationApi#disablePort");
-            e.printStackTrace();
-        }
-    }
-}
-
- -
-
import io.swagger.client.api.OnapsoinfraserviceInstantiationApi;
-
-public class OnapsoinfraserviceInstantiationApiExample {
-
-    public static void main(String[] args) {
-        OnapsoinfraserviceInstantiationApi apiInstance = new OnapsoinfraserviceInstantiationApi();
-        String version = version_example; // String | 
-        String serviceInstanceId = serviceInstanceId_example; // String | 
-        String configurationInstanceId = configurationInstanceId_example; // String | 
-        String body = body_example; // String | 
-        try {
-            apiInstance.disablePort(version, serviceInstanceId, configurationInstanceId, body);
-        } catch (ApiException e) {
-            System.err.println("Exception when calling OnapsoinfraserviceInstantiationApi#disablePort");
-            e.printStackTrace();
-        }
-    }
-}
-
- -
-
String *version = version_example; // 
-String *serviceInstanceId = serviceInstanceId_example; // 
-String *configurationInstanceId = configurationInstanceId_example; // 
-String *body = body_example; //  (optional)
-
-OnapsoinfraserviceInstantiationApi *apiInstance = [[OnapsoinfraserviceInstantiationApi alloc] init];
-
-// Disable Port Mirroring
-[apiInstance disablePortWith:version
-    serviceInstanceId:serviceInstanceId
-    configurationInstanceId:configurationInstanceId
-    body:body
-              completionHandler: ^(NSError* error) {
-                            if (error) {
-                                NSLog(@"Error: %@", error);
-                            }
-                        }];
-
-
- -
-
var SoCasablancaApIs = require('so_casablanca_ap_is');
-
-var api = new SoCasablancaApIs.OnapsoinfraserviceInstantiationApi()
-
-var version = version_example; // {String} 
-
-var serviceInstanceId = serviceInstanceId_example; // {String} 
-
-var configurationInstanceId = configurationInstanceId_example; // {String} 
-
-var opts = { 
-  'body': body_example // {String} 
-};
-
-var callback = function(error, data, response) {
-  if (error) {
-    console.error(error);
-  } else {
-    console.log('API called successfully.');
-  }
-};
-api.disablePort(version, serviceInstanceId, configurationInstanceId, opts, callback);
-
-
- - -
-
using System;
-using System.Diagnostics;
-using IO.Swagger.Api;
-using IO.Swagger.Client;
-using IO.Swagger.Model;
-
-namespace Example
-{
-    public class disablePortExample
-    {
-        public void main()
-        {
-            
-            var apiInstance = new OnapsoinfraserviceInstantiationApi();
-            var version = version_example;  // String | 
-            var serviceInstanceId = serviceInstanceId_example;  // String | 
-            var configurationInstanceId = configurationInstanceId_example;  // String | 
-            var body = body_example;  // String |  (optional) 
-
-            try
-            {
-                // Disable Port Mirroring
-                apiInstance.disablePort(version, serviceInstanceId, configurationInstanceId, body);
-            }
-            catch (Exception e)
-            {
-                Debug.Print("Exception when calling OnapsoinfraserviceInstantiationApi.disablePort: " + e.Message );
-            }
-        }
-    }
-}
-
-
- -
-
<?php
-require_once(__DIR__ . '/vendor/autoload.php');
-
-$api_instance = new Swagger\Client\Api\OnapsoinfraserviceInstantiationApi();
-$version = version_example; // String | 
-$serviceInstanceId = serviceInstanceId_example; // String | 
-$configurationInstanceId = configurationInstanceId_example; // String | 
-$body = body_example; // String | 
-
-try {
-    $api_instance->disablePort($version, $serviceInstanceId, $configurationInstanceId, $body);
-} catch (Exception $e) {
-    echo 'Exception when calling OnapsoinfraserviceInstantiationApi->disablePort: ', $e->getMessage(), PHP_EOL;
-}
-?>
-
- -
-
use Data::Dumper;
-use WWW::SwaggerClient::Configuration;
-use WWW::SwaggerClient::OnapsoinfraserviceInstantiationApi;
-
-my $api_instance = WWW::SwaggerClient::OnapsoinfraserviceInstantiationApi->new();
-my $version = version_example; # String | 
-my $serviceInstanceId = serviceInstanceId_example; # String | 
-my $configurationInstanceId = configurationInstanceId_example; # String | 
-my $body = WWW::SwaggerClient::Object::String->new(); # String | 
-
-eval { 
-    $api_instance->disablePort(version => $version, serviceInstanceId => $serviceInstanceId, configurationInstanceId => $configurationInstanceId, body => $body);
-};
-if ($@) {
-    warn "Exception when calling OnapsoinfraserviceInstantiationApi->disablePort: $@\n";
-}
-
- -
-
from __future__ import print_statement
-import time
-import swagger_client
-from swagger_client.rest import ApiException
-from pprint import pprint
-
-# create an instance of the API class
-api_instance = swagger_client.OnapsoinfraserviceInstantiationApi()
-version = version_example # String | 
-serviceInstanceId = serviceInstanceId_example # String | 
-configurationInstanceId = configurationInstanceId_example # String | 
-body = body_example # String |  (optional)
-
-try: 
-    # Disable Port Mirroring
-    api_instance.disable_port(version, serviceInstanceId, configurationInstanceId, body=body)
-except ApiException as e:
-    print("Exception when calling OnapsoinfraserviceInstantiationApi->disablePort: %s\n" % e)
-
-
- -

Parameters

- -
Path parameters
- - - - - - - - - - - - - - - - - -
NameDescription
version* - - -
-
-
- - String - - -
-
- Required -
-
-
-
serviceInstanceId* - - -
-
-
- - String - - -
-
- Required -
-
-
-
configurationInstanceId* - - -
-
-
- - String - - -
-
- Required -
-
-
-
- - -
Body parameters
- - - - - - - - - -
NameDescription
body - - - -
-
- - - -

Responses

-

Status: default - successful operation

- - - -
-
- -
-
-
-
-
-
-

enablePort

-

Enable Port Mirroring

-
-
-
-

-

-

-
-
/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/configurations/{configurationInstanceId}/enablePort
-

-

Usage and SDK Samples

-

- - -
-
-
curl -X POST "https://localhost/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/configurations/{configurationInstanceId}/enablePort"
-
-
-
import io.swagger.client.*;
-import io.swagger.client.auth.*;
-import io.swagger.client.model.*;
-import io.swagger.client.api.OnapsoinfraserviceInstantiationApi;
-
-import java.io.File;
-import java.util.*;
-
-public class OnapsoinfraserviceInstantiationApiExample {
-
-    public static void main(String[] args) {
-        
-        OnapsoinfraserviceInstantiationApi apiInstance = new OnapsoinfraserviceInstantiationApi();
-        String version = version_example; // String | 
-        String serviceInstanceId = serviceInstanceId_example; // String | 
-        String configurationInstanceId = configurationInstanceId_example; // String | 
-        String body = body_example; // String | 
-        try {
-            apiInstance.enablePort(version, serviceInstanceId, configurationInstanceId, body);
-        } catch (ApiException e) {
-            System.err.println("Exception when calling OnapsoinfraserviceInstantiationApi#enablePort");
-            e.printStackTrace();
-        }
-    }
-}
-
- -
-
import io.swagger.client.api.OnapsoinfraserviceInstantiationApi;
-
-public class OnapsoinfraserviceInstantiationApiExample {
-
-    public static void main(String[] args) {
-        OnapsoinfraserviceInstantiationApi apiInstance = new OnapsoinfraserviceInstantiationApi();
-        String version = version_example; // String | 
-        String serviceInstanceId = serviceInstanceId_example; // String | 
-        String configurationInstanceId = configurationInstanceId_example; // String | 
-        String body = body_example; // String | 
-        try {
-            apiInstance.enablePort(version, serviceInstanceId, configurationInstanceId, body);
-        } catch (ApiException e) {
-            System.err.println("Exception when calling OnapsoinfraserviceInstantiationApi#enablePort");
-            e.printStackTrace();
-        }
-    }
-}
-
- -
-
String *version = version_example; // 
-String *serviceInstanceId = serviceInstanceId_example; // 
-String *configurationInstanceId = configurationInstanceId_example; // 
-String *body = body_example; //  (optional)
-
-OnapsoinfraserviceInstantiationApi *apiInstance = [[OnapsoinfraserviceInstantiationApi alloc] init];
-
-// Enable Port Mirroring
-[apiInstance enablePortWith:version
-    serviceInstanceId:serviceInstanceId
-    configurationInstanceId:configurationInstanceId
-    body:body
-              completionHandler: ^(NSError* error) {
-                            if (error) {
-                                NSLog(@"Error: %@", error);
-                            }
-                        }];
-
-
- -
-
var SoCasablancaApIs = require('so_casablanca_ap_is');
-
-var api = new SoCasablancaApIs.OnapsoinfraserviceInstantiationApi()
-
-var version = version_example; // {String} 
-
-var serviceInstanceId = serviceInstanceId_example; // {String} 
-
-var configurationInstanceId = configurationInstanceId_example; // {String} 
-
-var opts = { 
-  'body': body_example // {String} 
-};
-
-var callback = function(error, data, response) {
-  if (error) {
-    console.error(error);
-  } else {
-    console.log('API called successfully.');
-  }
-};
-api.enablePort(version, serviceInstanceId, configurationInstanceId, opts, callback);
-
-
- - -
-
using System;
-using System.Diagnostics;
-using IO.Swagger.Api;
-using IO.Swagger.Client;
-using IO.Swagger.Model;
-
-namespace Example
-{
-    public class enablePortExample
-    {
-        public void main()
-        {
-            
-            var apiInstance = new OnapsoinfraserviceInstantiationApi();
-            var version = version_example;  // String | 
-            var serviceInstanceId = serviceInstanceId_example;  // String | 
-            var configurationInstanceId = configurationInstanceId_example;  // String | 
-            var body = body_example;  // String |  (optional) 
-
-            try
-            {
-                // Enable Port Mirroring
-                apiInstance.enablePort(version, serviceInstanceId, configurationInstanceId, body);
-            }
-            catch (Exception e)
-            {
-                Debug.Print("Exception when calling OnapsoinfraserviceInstantiationApi.enablePort: " + e.Message );
-            }
-        }
-    }
-}
-
-
- -
-
<?php
-require_once(__DIR__ . '/vendor/autoload.php');
-
-$api_instance = new Swagger\Client\Api\OnapsoinfraserviceInstantiationApi();
-$version = version_example; // String | 
-$serviceInstanceId = serviceInstanceId_example; // String | 
-$configurationInstanceId = configurationInstanceId_example; // String | 
-$body = body_example; // String | 
-
-try {
-    $api_instance->enablePort($version, $serviceInstanceId, $configurationInstanceId, $body);
-} catch (Exception $e) {
-    echo 'Exception when calling OnapsoinfraserviceInstantiationApi->enablePort: ', $e->getMessage(), PHP_EOL;
-}
-?>
-
- -
-
use Data::Dumper;
-use WWW::SwaggerClient::Configuration;
-use WWW::SwaggerClient::OnapsoinfraserviceInstantiationApi;
-
-my $api_instance = WWW::SwaggerClient::OnapsoinfraserviceInstantiationApi->new();
-my $version = version_example; # String | 
-my $serviceInstanceId = serviceInstanceId_example; # String | 
-my $configurationInstanceId = configurationInstanceId_example; # String | 
-my $body = WWW::SwaggerClient::Object::String->new(); # String | 
-
-eval { 
-    $api_instance->enablePort(version => $version, serviceInstanceId => $serviceInstanceId, configurationInstanceId => $configurationInstanceId, body => $body);
-};
-if ($@) {
-    warn "Exception when calling OnapsoinfraserviceInstantiationApi->enablePort: $@\n";
-}
-
- -
-
from __future__ import print_statement
-import time
-import swagger_client
-from swagger_client.rest import ApiException
-from pprint import pprint
-
-# create an instance of the API class
-api_instance = swagger_client.OnapsoinfraserviceInstantiationApi()
-version = version_example # String | 
-serviceInstanceId = serviceInstanceId_example # String | 
-configurationInstanceId = configurationInstanceId_example # String | 
-body = body_example # String |  (optional)
-
-try: 
-    # Enable Port Mirroring
-    api_instance.enable_port(version, serviceInstanceId, configurationInstanceId, body=body)
-except ApiException as e:
-    print("Exception when calling OnapsoinfraserviceInstantiationApi->enablePort: %s\n" % e)
-
-
- -

Parameters

- -
Path parameters
- - - - - - - - - - - - - - - - - -
NameDescription
version* - - -
-
-
- - String - - -
-
- Required -
-
-
-
serviceInstanceId* - - -
-
-
- - String - - -
-
- Required -
-
-
-
configurationInstanceId* - - -
-
-
- - String - - -
-
- Required -
-
-
-
- - -
Body parameters
- - - - - - - - - -
NameDescription
body - - - -
-
- - - -

Responses

-

Status: default - successful operation

- - - -
-
- -
-
-
-
-
-
-

inPlaceSoftwareUpdate

-

Perform VNF software update

-
-
-
-

-

-

-
-
/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/vnfs/{vnfInstanceId}/inPlaceSoftwareUpdate
-

-

Usage and SDK Samples

-

- - -
-
-
curl -X POST "https://localhost/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/vnfs/{vnfInstanceId}/inPlaceSoftwareUpdate"
-
-
-
import io.swagger.client.*;
-import io.swagger.client.auth.*;
-import io.swagger.client.model.*;
-import io.swagger.client.api.OnapsoinfraserviceInstantiationApi;
-
-import java.io.File;
-import java.util.*;
-
-public class OnapsoinfraserviceInstantiationApiExample {
-
-    public static void main(String[] args) {
-        
-        OnapsoinfraserviceInstantiationApi apiInstance = new OnapsoinfraserviceInstantiationApi();
-        String version = version_example; // String | 
-        String serviceInstanceId = serviceInstanceId_example; // String | 
-        String vnfInstanceId = vnfInstanceId_example; // String | 
-        String body = body_example; // String | 
-        try {
-            apiInstance.inPlaceSoftwareUpdate(version, serviceInstanceId, vnfInstanceId, body);
-        } catch (ApiException e) {
-            System.err.println("Exception when calling OnapsoinfraserviceInstantiationApi#inPlaceSoftwareUpdate");
-            e.printStackTrace();
-        }
-    }
-}
-
- -
-
import io.swagger.client.api.OnapsoinfraserviceInstantiationApi;
-
-public class OnapsoinfraserviceInstantiationApiExample {
-
-    public static void main(String[] args) {
-        OnapsoinfraserviceInstantiationApi apiInstance = new OnapsoinfraserviceInstantiationApi();
-        String version = version_example; // String | 
-        String serviceInstanceId = serviceInstanceId_example; // String | 
-        String vnfInstanceId = vnfInstanceId_example; // String | 
-        String body = body_example; // String | 
-        try {
-            apiInstance.inPlaceSoftwareUpdate(version, serviceInstanceId, vnfInstanceId, body);
-        } catch (ApiException e) {
-            System.err.println("Exception when calling OnapsoinfraserviceInstantiationApi#inPlaceSoftwareUpdate");
-            e.printStackTrace();
-        }
-    }
-}
-
- -
-
String *version = version_example; // 
-String *serviceInstanceId = serviceInstanceId_example; // 
-String *vnfInstanceId = vnfInstanceId_example; // 
-String *body = body_example; //  (optional)
-
-OnapsoinfraserviceInstantiationApi *apiInstance = [[OnapsoinfraserviceInstantiationApi alloc] init];
-
-// Perform VNF software update
-[apiInstance inPlaceSoftwareUpdateWith:version
-    serviceInstanceId:serviceInstanceId
-    vnfInstanceId:vnfInstanceId
-    body:body
-              completionHandler: ^(NSError* error) {
-                            if (error) {
-                                NSLog(@"Error: %@", error);
-                            }
-                        }];
-
-
- -
-
var SoCasablancaApIs = require('so_casablanca_ap_is');
-
-var api = new SoCasablancaApIs.OnapsoinfraserviceInstantiationApi()
-
-var version = version_example; // {String} 
-
-var serviceInstanceId = serviceInstanceId_example; // {String} 
-
-var vnfInstanceId = vnfInstanceId_example; // {String} 
-
-var opts = { 
-  'body': body_example // {String} 
-};
-
-var callback = function(error, data, response) {
-  if (error) {
-    console.error(error);
-  } else {
-    console.log('API called successfully.');
-  }
-};
-api.inPlaceSoftwareUpdate(version, serviceInstanceId, vnfInstanceId, opts, callback);
-
-
- - -
-
using System;
-using System.Diagnostics;
-using IO.Swagger.Api;
-using IO.Swagger.Client;
-using IO.Swagger.Model;
-
-namespace Example
-{
-    public class inPlaceSoftwareUpdateExample
-    {
-        public void main()
-        {
-            
-            var apiInstance = new OnapsoinfraserviceInstantiationApi();
-            var version = version_example;  // String | 
-            var serviceInstanceId = serviceInstanceId_example;  // String | 
-            var vnfInstanceId = vnfInstanceId_example;  // String | 
-            var body = body_example;  // String |  (optional) 
-
-            try
-            {
-                // Perform VNF software update
-                apiInstance.inPlaceSoftwareUpdate(version, serviceInstanceId, vnfInstanceId, body);
-            }
-            catch (Exception e)
-            {
-                Debug.Print("Exception when calling OnapsoinfraserviceInstantiationApi.inPlaceSoftwareUpdate: " + e.Message );
-            }
-        }
-    }
-}
-
-
- -
-
<?php
-require_once(__DIR__ . '/vendor/autoload.php');
-
-$api_instance = new Swagger\Client\Api\OnapsoinfraserviceInstantiationApi();
-$version = version_example; // String | 
-$serviceInstanceId = serviceInstanceId_example; // String | 
-$vnfInstanceId = vnfInstanceId_example; // String | 
-$body = body_example; // String | 
-
-try {
-    $api_instance->inPlaceSoftwareUpdate($version, $serviceInstanceId, $vnfInstanceId, $body);
-} catch (Exception $e) {
-    echo 'Exception when calling OnapsoinfraserviceInstantiationApi->inPlaceSoftwareUpdate: ', $e->getMessage(), PHP_EOL;
-}
-?>
-
- -
-
use Data::Dumper;
-use WWW::SwaggerClient::Configuration;
-use WWW::SwaggerClient::OnapsoinfraserviceInstantiationApi;
-
-my $api_instance = WWW::SwaggerClient::OnapsoinfraserviceInstantiationApi->new();
-my $version = version_example; # String | 
-my $serviceInstanceId = serviceInstanceId_example; # String | 
-my $vnfInstanceId = vnfInstanceId_example; # String | 
-my $body = WWW::SwaggerClient::Object::String->new(); # String | 
-
-eval { 
-    $api_instance->inPlaceSoftwareUpdate(version => $version, serviceInstanceId => $serviceInstanceId, vnfInstanceId => $vnfInstanceId, body => $body);
-};
-if ($@) {
-    warn "Exception when calling OnapsoinfraserviceInstantiationApi->inPlaceSoftwareUpdate: $@\n";
-}
-
- -
-
from __future__ import print_statement
-import time
-import swagger_client
-from swagger_client.rest import ApiException
-from pprint import pprint
-
-# create an instance of the API class
-api_instance = swagger_client.OnapsoinfraserviceInstantiationApi()
-version = version_example # String | 
-serviceInstanceId = serviceInstanceId_example # String | 
-vnfInstanceId = vnfInstanceId_example # String | 
-body = body_example # String |  (optional)
-
-try: 
-    # Perform VNF software update
-    api_instance.in_place_software_update(version, serviceInstanceId, vnfInstanceId, body=body)
-except ApiException as e:
-    print("Exception when calling OnapsoinfraserviceInstantiationApi->inPlaceSoftwareUpdate: %s\n" % e)
-
-
- -

Parameters

- -
Path parameters
- - - - - - - - - - - - - - - - - -
NameDescription
version* - - -
-
-
- - String - - -
-
- Required -
-
-
-
serviceInstanceId* - - -
-
-
- - String - - -
-
- Required -
-
-
-
vnfInstanceId* - - -
-
-
- - String - - -
-
- Required -
-
-
-
- - -
Body parameters
- - - - - - - - - -
NameDescription
body - - - -
-
- - - -

Responses

-

Status: default - successful operation

- - - -
-
- -
-
-
-
-
-
-

removeRelationships

-

Remove Relationships from Service Instance

-
-
-
-

-

-

-
-
/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/removeRelationships
-

-

Usage and SDK Samples

-

- - -
-
-
curl -X POST "https://localhost/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/removeRelationships"
-
-
-
import io.swagger.client.*;
-import io.swagger.client.auth.*;
-import io.swagger.client.model.*;
-import io.swagger.client.api.OnapsoinfraserviceInstantiationApi;
-
-import java.io.File;
-import java.util.*;
-
-public class OnapsoinfraserviceInstantiationApiExample {
-
-    public static void main(String[] args) {
-        
-        OnapsoinfraserviceInstantiationApi apiInstance = new OnapsoinfraserviceInstantiationApi();
-        String version = version_example; // String | 
-        String serviceInstanceId = serviceInstanceId_example; // String | 
-        String body = body_example; // String | 
-        try {
-            apiInstance.removeRelationships(version, serviceInstanceId, body);
-        } catch (ApiException e) {
-            System.err.println("Exception when calling OnapsoinfraserviceInstantiationApi#removeRelationships");
-            e.printStackTrace();
-        }
-    }
-}
-
- -
-
import io.swagger.client.api.OnapsoinfraserviceInstantiationApi;
-
-public class OnapsoinfraserviceInstantiationApiExample {
-
-    public static void main(String[] args) {
-        OnapsoinfraserviceInstantiationApi apiInstance = new OnapsoinfraserviceInstantiationApi();
-        String version = version_example; // String | 
-        String serviceInstanceId = serviceInstanceId_example; // String | 
-        String body = body_example; // String | 
-        try {
-            apiInstance.removeRelationships(version, serviceInstanceId, body);
-        } catch (ApiException e) {
-            System.err.println("Exception when calling OnapsoinfraserviceInstantiationApi#removeRelationships");
-            e.printStackTrace();
-        }
-    }
-}
-
- -
-
String *version = version_example; // 
-String *serviceInstanceId = serviceInstanceId_example; // 
-String *body = body_example; //  (optional)
-
-OnapsoinfraserviceInstantiationApi *apiInstance = [[OnapsoinfraserviceInstantiationApi alloc] init];
-
-// Remove Relationships from Service Instance
-[apiInstance removeRelationshipsWith:version
-    serviceInstanceId:serviceInstanceId
-    body:body
-              completionHandler: ^(NSError* error) {
-                            if (error) {
-                                NSLog(@"Error: %@", error);
-                            }
-                        }];
-
-
- -
-
var SoCasablancaApIs = require('so_casablanca_ap_is');
-
-var api = new SoCasablancaApIs.OnapsoinfraserviceInstantiationApi()
-
-var version = version_example; // {String} 
-
-var serviceInstanceId = serviceInstanceId_example; // {String} 
-
-var opts = { 
-  'body': body_example // {String} 
-};
-
-var callback = function(error, data, response) {
-  if (error) {
-    console.error(error);
-  } else {
-    console.log('API called successfully.');
-  }
-};
-api.removeRelationships(version, serviceInstanceId, opts, callback);
-
-
- - -
-
using System;
-using System.Diagnostics;
-using IO.Swagger.Api;
-using IO.Swagger.Client;
-using IO.Swagger.Model;
-
-namespace Example
-{
-    public class removeRelationshipsExample
-    {
-        public void main()
-        {
-            
-            var apiInstance = new OnapsoinfraserviceInstantiationApi();
-            var version = version_example;  // String | 
-            var serviceInstanceId = serviceInstanceId_example;  // String | 
-            var body = body_example;  // String |  (optional) 
-
-            try
-            {
-                // Remove Relationships from Service Instance
-                apiInstance.removeRelationships(version, serviceInstanceId, body);
-            }
-            catch (Exception e)
-            {
-                Debug.Print("Exception when calling OnapsoinfraserviceInstantiationApi.removeRelationships: " + e.Message );
-            }
-        }
-    }
-}
-
-
- -
-
<?php
-require_once(__DIR__ . '/vendor/autoload.php');
-
-$api_instance = new Swagger\Client\Api\OnapsoinfraserviceInstantiationApi();
-$version = version_example; // String | 
-$serviceInstanceId = serviceInstanceId_example; // String | 
-$body = body_example; // String | 
-
-try {
-    $api_instance->removeRelationships($version, $serviceInstanceId, $body);
-} catch (Exception $e) {
-    echo 'Exception when calling OnapsoinfraserviceInstantiationApi->removeRelationships: ', $e->getMessage(), PHP_EOL;
-}
-?>
-
- -
-
use Data::Dumper;
-use WWW::SwaggerClient::Configuration;
-use WWW::SwaggerClient::OnapsoinfraserviceInstantiationApi;
-
-my $api_instance = WWW::SwaggerClient::OnapsoinfraserviceInstantiationApi->new();
-my $version = version_example; # String | 
-my $serviceInstanceId = serviceInstanceId_example; # String | 
-my $body = WWW::SwaggerClient::Object::String->new(); # String | 
-
-eval { 
-    $api_instance->removeRelationships(version => $version, serviceInstanceId => $serviceInstanceId, body => $body);
-};
-if ($@) {
-    warn "Exception when calling OnapsoinfraserviceInstantiationApi->removeRelationships: $@\n";
-}
-
- -
-
from __future__ import print_statement
-import time
-import swagger_client
-from swagger_client.rest import ApiException
-from pprint import pprint
-
-# create an instance of the API class
-api_instance = swagger_client.OnapsoinfraserviceInstantiationApi()
-version = version_example # String | 
-serviceInstanceId = serviceInstanceId_example # String | 
-body = body_example # String |  (optional)
-
-try: 
-    # Remove Relationships from Service Instance
-    api_instance.remove_relationships(version, serviceInstanceId, body=body)
-except ApiException as e:
-    print("Exception when calling OnapsoinfraserviceInstantiationApi->removeRelationships: %s\n" % e)
-
-
- -

Parameters

- -
Path parameters
- - - - - - - - - - - - - -
NameDescription
version* - - -
-
-
- - String - - -
-
- Required -
-
-
-
serviceInstanceId* - - -
-
-
- - String - - -
-
- Required -
-
-
-
- - -
Body parameters
- - - - - - - - - -
NameDescription
body - - - -
-
- - - -

Responses

-

Status: default - successful operation

- - - -
-
- -
-
-
-
-
-
-

replaceVfModuleInstance

-

Create VfModule on a specified version, serviceInstance and vnfInstance

-
-
-
-

-

-

-
-
/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/vnfs/{vnfInstanceId}/vfModules/{vfmoduleInstanceId}/replace
-

-

Usage and SDK Samples

-

- - -
-
-
curl -X POST "https://localhost/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/vnfs/{vnfInstanceId}/vfModules/{vfmoduleInstanceId}/replace"
-
-
-
import io.swagger.client.*;
-import io.swagger.client.auth.*;
-import io.swagger.client.model.*;
-import io.swagger.client.api.OnapsoinfraserviceInstantiationApi;
-
-import java.io.File;
-import java.util.*;
-
-public class OnapsoinfraserviceInstantiationApiExample {
-
-    public static void main(String[] args) {
-        
-        OnapsoinfraserviceInstantiationApi apiInstance = new OnapsoinfraserviceInstantiationApi();
-        String version = version_example; // String | 
-        String serviceInstanceId = serviceInstanceId_example; // String | 
-        String vnfInstanceId = vnfInstanceId_example; // String | 
-        String vfmoduleInstanceId = vfmoduleInstanceId_example; // String | 
-        String body = body_example; // String | 
-        try {
-            apiInstance.replaceVfModuleInstance(version, serviceInstanceId, vnfInstanceId, vfmoduleInstanceId, body);
-        } catch (ApiException e) {
-            System.err.println("Exception when calling OnapsoinfraserviceInstantiationApi#replaceVfModuleInstance");
-            e.printStackTrace();
-        }
-    }
-}
-
- -
-
import io.swagger.client.api.OnapsoinfraserviceInstantiationApi;
-
-public class OnapsoinfraserviceInstantiationApiExample {
-
-    public static void main(String[] args) {
-        OnapsoinfraserviceInstantiationApi apiInstance = new OnapsoinfraserviceInstantiationApi();
-        String version = version_example; // String | 
-        String serviceInstanceId = serviceInstanceId_example; // String | 
-        String vnfInstanceId = vnfInstanceId_example; // String | 
-        String vfmoduleInstanceId = vfmoduleInstanceId_example; // String | 
-        String body = body_example; // String | 
-        try {
-            apiInstance.replaceVfModuleInstance(version, serviceInstanceId, vnfInstanceId, vfmoduleInstanceId, body);
-        } catch (ApiException e) {
-            System.err.println("Exception when calling OnapsoinfraserviceInstantiationApi#replaceVfModuleInstance");
-            e.printStackTrace();
-        }
-    }
-}
-
- -
-
String *version = version_example; // 
-String *serviceInstanceId = serviceInstanceId_example; // 
-String *vnfInstanceId = vnfInstanceId_example; // 
-String *vfmoduleInstanceId = vfmoduleInstanceId_example; // 
-String *body = body_example; //  (optional)
-
-OnapsoinfraserviceInstantiationApi *apiInstance = [[OnapsoinfraserviceInstantiationApi alloc] init];
-
-// Create VfModule on a specified version, serviceInstance and vnfInstance
-[apiInstance replaceVfModuleInstanceWith:version
-    serviceInstanceId:serviceInstanceId
-    vnfInstanceId:vnfInstanceId
-    vfmoduleInstanceId:vfmoduleInstanceId
-    body:body
-              completionHandler: ^(NSError* error) {
-                            if (error) {
-                                NSLog(@"Error: %@", error);
-                            }
-                        }];
-
-
- -
-
var SoCasablancaApIs = require('so_casablanca_ap_is');
-
-var api = new SoCasablancaApIs.OnapsoinfraserviceInstantiationApi()
-
-var version = version_example; // {String} 
-
-var serviceInstanceId = serviceInstanceId_example; // {String} 
-
-var vnfInstanceId = vnfInstanceId_example; // {String} 
-
-var vfmoduleInstanceId = vfmoduleInstanceId_example; // {String} 
-
-var opts = { 
-  'body': body_example // {String} 
-};
-
-var callback = function(error, data, response) {
-  if (error) {
-    console.error(error);
-  } else {
-    console.log('API called successfully.');
-  }
-};
-api.replaceVfModuleInstance(version, serviceInstanceId, vnfInstanceId, vfmoduleInstanceId, opts, callback);
-
-
- - -
-
using System;
-using System.Diagnostics;
-using IO.Swagger.Api;
-using IO.Swagger.Client;
-using IO.Swagger.Model;
-
-namespace Example
-{
-    public class replaceVfModuleInstanceExample
-    {
-        public void main()
-        {
-            
-            var apiInstance = new OnapsoinfraserviceInstantiationApi();
-            var version = version_example;  // String | 
-            var serviceInstanceId = serviceInstanceId_example;  // String | 
-            var vnfInstanceId = vnfInstanceId_example;  // String | 
-            var vfmoduleInstanceId = vfmoduleInstanceId_example;  // String | 
-            var body = body_example;  // String |  (optional) 
-
-            try
-            {
-                // Create VfModule on a specified version, serviceInstance and vnfInstance
-                apiInstance.replaceVfModuleInstance(version, serviceInstanceId, vnfInstanceId, vfmoduleInstanceId, body);
-            }
-            catch (Exception e)
-            {
-                Debug.Print("Exception when calling OnapsoinfraserviceInstantiationApi.replaceVfModuleInstance: " + e.Message );
-            }
-        }
-    }
-}
-
-
- -
-
<?php
-require_once(__DIR__ . '/vendor/autoload.php');
-
-$api_instance = new Swagger\Client\Api\OnapsoinfraserviceInstantiationApi();
-$version = version_example; // String | 
-$serviceInstanceId = serviceInstanceId_example; // String | 
-$vnfInstanceId = vnfInstanceId_example; // String | 
-$vfmoduleInstanceId = vfmoduleInstanceId_example; // String | 
-$body = body_example; // String | 
-
-try {
-    $api_instance->replaceVfModuleInstance($version, $serviceInstanceId, $vnfInstanceId, $vfmoduleInstanceId, $body);
-} catch (Exception $e) {
-    echo 'Exception when calling OnapsoinfraserviceInstantiationApi->replaceVfModuleInstance: ', $e->getMessage(), PHP_EOL;
-}
-?>
-
- -
-
use Data::Dumper;
-use WWW::SwaggerClient::Configuration;
-use WWW::SwaggerClient::OnapsoinfraserviceInstantiationApi;
-
-my $api_instance = WWW::SwaggerClient::OnapsoinfraserviceInstantiationApi->new();
-my $version = version_example; # String | 
-my $serviceInstanceId = serviceInstanceId_example; # String | 
-my $vnfInstanceId = vnfInstanceId_example; # String | 
-my $vfmoduleInstanceId = vfmoduleInstanceId_example; # String | 
-my $body = WWW::SwaggerClient::Object::String->new(); # String | 
-
-eval { 
-    $api_instance->replaceVfModuleInstance(version => $version, serviceInstanceId => $serviceInstanceId, vnfInstanceId => $vnfInstanceId, vfmoduleInstanceId => $vfmoduleInstanceId, body => $body);
-};
-if ($@) {
-    warn "Exception when calling OnapsoinfraserviceInstantiationApi->replaceVfModuleInstance: $@\n";
-}
-
- -
-
from __future__ import print_statement
-import time
-import swagger_client
-from swagger_client.rest import ApiException
-from pprint import pprint
-
-# create an instance of the API class
-api_instance = swagger_client.OnapsoinfraserviceInstantiationApi()
-version = version_example # String | 
-serviceInstanceId = serviceInstanceId_example # String | 
-vnfInstanceId = vnfInstanceId_example # String | 
-vfmoduleInstanceId = vfmoduleInstanceId_example # String | 
-body = body_example # String |  (optional)
-
-try: 
-    # Create VfModule on a specified version, serviceInstance and vnfInstance
-    api_instance.replace_vf_module_instance(version, serviceInstanceId, vnfInstanceId, vfmoduleInstanceId, body=body)
-except ApiException as e:
-    print("Exception when calling OnapsoinfraserviceInstantiationApi->replaceVfModuleInstance: %s\n" % e)
-
-
- -

Parameters

- -
Path parameters
- - - - - - - - - - - - - - - - - - - - - -
NameDescription
version* - - -
-
-
- - String - - -
-
- Required -
-
-
-
serviceInstanceId* - - -
-
-
- - String - - -
-
- Required -
-
-
-
vnfInstanceId* - - -
-
-
- - String - - -
-
- Required -
-
-
-
vfmoduleInstanceId* - - -
-
-
- - String - - -
-
- Required -
-
-
-
- - -
Body parameters
- - - - - - - - - -
NameDescription
body - - - -
-
- - - -

Responses

-

Status: default - successful operation

- - - -
-
- -
-
-
-
-
-
-

replaceVnfInstance

-

Replace provided VNF instance

-
-
-
-

-

-

-
-
/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/vnfs/{vnfInstanceId}/replace
-

-

Usage and SDK Samples

-

- - -
-
-
curl -X POST "https://localhost/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/vnfs/{vnfInstanceId}/replace"
-
-
-
import io.swagger.client.*;
-import io.swagger.client.auth.*;
-import io.swagger.client.model.*;
-import io.swagger.client.api.OnapsoinfraserviceInstantiationApi;
-
-import java.io.File;
-import java.util.*;
-
-public class OnapsoinfraserviceInstantiationApiExample {
-
-    public static void main(String[] args) {
-        
-        OnapsoinfraserviceInstantiationApi apiInstance = new OnapsoinfraserviceInstantiationApi();
-        String version = version_example; // String | 
-        String serviceInstanceId = serviceInstanceId_example; // String | 
-        String vnfInstanceId = vnfInstanceId_example; // String | 
-        String body = body_example; // String | 
-        try {
-            apiInstance.replaceVnfInstance(version, serviceInstanceId, vnfInstanceId, body);
-        } catch (ApiException e) {
-            System.err.println("Exception when calling OnapsoinfraserviceInstantiationApi#replaceVnfInstance");
-            e.printStackTrace();
-        }
-    }
-}
-
- -
-
import io.swagger.client.api.OnapsoinfraserviceInstantiationApi;
-
-public class OnapsoinfraserviceInstantiationApiExample {
-
-    public static void main(String[] args) {
-        OnapsoinfraserviceInstantiationApi apiInstance = new OnapsoinfraserviceInstantiationApi();
-        String version = version_example; // String | 
-        String serviceInstanceId = serviceInstanceId_example; // String | 
-        String vnfInstanceId = vnfInstanceId_example; // String | 
-        String body = body_example; // String | 
-        try {
-            apiInstance.replaceVnfInstance(version, serviceInstanceId, vnfInstanceId, body);
-        } catch (ApiException e) {
-            System.err.println("Exception when calling OnapsoinfraserviceInstantiationApi#replaceVnfInstance");
-            e.printStackTrace();
-        }
-    }
-}
-
- -
-
String *version = version_example; // 
-String *serviceInstanceId = serviceInstanceId_example; // 
-String *vnfInstanceId = vnfInstanceId_example; // 
-String *body = body_example; //  (optional)
-
-OnapsoinfraserviceInstantiationApi *apiInstance = [[OnapsoinfraserviceInstantiationApi alloc] init];
-
-// Replace provided VNF instance
-[apiInstance replaceVnfInstanceWith:version
-    serviceInstanceId:serviceInstanceId
-    vnfInstanceId:vnfInstanceId
-    body:body
-              completionHandler: ^(NSError* error) {
-                            if (error) {
-                                NSLog(@"Error: %@", error);
-                            }
-                        }];
-
-
- -
-
var SoCasablancaApIs = require('so_casablanca_ap_is');
-
-var api = new SoCasablancaApIs.OnapsoinfraserviceInstantiationApi()
-
-var version = version_example; // {String} 
-
-var serviceInstanceId = serviceInstanceId_example; // {String} 
-
-var vnfInstanceId = vnfInstanceId_example; // {String} 
-
-var opts = { 
-  'body': body_example // {String} 
-};
-
-var callback = function(error, data, response) {
-  if (error) {
-    console.error(error);
-  } else {
-    console.log('API called successfully.');
-  }
-};
-api.replaceVnfInstance(version, serviceInstanceId, vnfInstanceId, opts, callback);
-
-
- - -
-
using System;
-using System.Diagnostics;
-using IO.Swagger.Api;
-using IO.Swagger.Client;
-using IO.Swagger.Model;
-
-namespace Example
-{
-    public class replaceVnfInstanceExample
-    {
-        public void main()
-        {
-            
-            var apiInstance = new OnapsoinfraserviceInstantiationApi();
-            var version = version_example;  // String | 
-            var serviceInstanceId = serviceInstanceId_example;  // String | 
-            var vnfInstanceId = vnfInstanceId_example;  // String | 
-            var body = body_example;  // String |  (optional) 
-
-            try
-            {
-                // Replace provided VNF instance
-                apiInstance.replaceVnfInstance(version, serviceInstanceId, vnfInstanceId, body);
-            }
-            catch (Exception e)
-            {
-                Debug.Print("Exception when calling OnapsoinfraserviceInstantiationApi.replaceVnfInstance: " + e.Message );
-            }
-        }
-    }
-}
-
-
- -
-
<?php
-require_once(__DIR__ . '/vendor/autoload.php');
-
-$api_instance = new Swagger\Client\Api\OnapsoinfraserviceInstantiationApi();
-$version = version_example; // String | 
-$serviceInstanceId = serviceInstanceId_example; // String | 
-$vnfInstanceId = vnfInstanceId_example; // String | 
-$body = body_example; // String | 
-
-try {
-    $api_instance->replaceVnfInstance($version, $serviceInstanceId, $vnfInstanceId, $body);
-} catch (Exception $e) {
-    echo 'Exception when calling OnapsoinfraserviceInstantiationApi->replaceVnfInstance: ', $e->getMessage(), PHP_EOL;
-}
-?>
-
- -
-
use Data::Dumper;
-use WWW::SwaggerClient::Configuration;
-use WWW::SwaggerClient::OnapsoinfraserviceInstantiationApi;
-
-my $api_instance = WWW::SwaggerClient::OnapsoinfraserviceInstantiationApi->new();
-my $version = version_example; # String | 
-my $serviceInstanceId = serviceInstanceId_example; # String | 
-my $vnfInstanceId = vnfInstanceId_example; # String | 
-my $body = WWW::SwaggerClient::Object::String->new(); # String | 
-
-eval { 
-    $api_instance->replaceVnfInstance(version => $version, serviceInstanceId => $serviceInstanceId, vnfInstanceId => $vnfInstanceId, body => $body);
-};
-if ($@) {
-    warn "Exception when calling OnapsoinfraserviceInstantiationApi->replaceVnfInstance: $@\n";
-}
-
- -
-
from __future__ import print_statement
-import time
-import swagger_client
-from swagger_client.rest import ApiException
-from pprint import pprint
-
-# create an instance of the API class
-api_instance = swagger_client.OnapsoinfraserviceInstantiationApi()
-version = version_example # String | 
-serviceInstanceId = serviceInstanceId_example # String | 
-vnfInstanceId = vnfInstanceId_example # String | 
-body = body_example # String |  (optional)
-
-try: 
-    # Replace provided VNF instance
-    api_instance.replace_vnf_instance(version, serviceInstanceId, vnfInstanceId, body=body)
-except ApiException as e:
-    print("Exception when calling OnapsoinfraserviceInstantiationApi->replaceVnfInstance: %s\n" % e)
-
-
- -

Parameters

- -
Path parameters
- - - - - - - - - - - - - - - - - -
NameDescription
version* - - -
-
-
- - String - - -
-
- Required -
-
-
-
serviceInstanceId* - - -
-
-
- - String - - -
-
- Required -
-
-
-
vnfInstanceId* - - -
-
-
- - String - - -
-
- Required -
-
-
-
- - -
Body parameters
- - - - - - - - - -
NameDescription
body - - - -
-
- - - -

Responses

-

Status: default - successful operation

- - - -
-
- -
-
-
-
-
-
-

scaleOutVfModule

-

VF Auto Scale Out

-
-
-
-

-

-

-
-
/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/vnfs/{vnfInstanceId}/vfModules/scaleOut
-

-

Usage and SDK Samples

-

- - -
-
-
curl -X POST "https://localhost/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/vnfs/{vnfInstanceId}/vfModules/scaleOut"
-
-
-
import io.swagger.client.*;
-import io.swagger.client.auth.*;
-import io.swagger.client.model.*;
-import io.swagger.client.api.OnapsoinfraserviceInstantiationApi;
-
-import java.io.File;
-import java.util.*;
-
-public class OnapsoinfraserviceInstantiationApiExample {
-
-    public static void main(String[] args) {
-        
-        OnapsoinfraserviceInstantiationApi apiInstance = new OnapsoinfraserviceInstantiationApi();
-        String version = version_example; // String | 
-        String serviceInstanceId = serviceInstanceId_example; // String | 
-        String vnfInstanceId = vnfInstanceId_example; // String | 
-        String body = body_example; // String | 
-        try {
-            apiInstance.scaleOutVfModule(version, serviceInstanceId, vnfInstanceId, body);
-        } catch (ApiException e) {
-            System.err.println("Exception when calling OnapsoinfraserviceInstantiationApi#scaleOutVfModule");
-            e.printStackTrace();
-        }
-    }
-}
-
- -
-
import io.swagger.client.api.OnapsoinfraserviceInstantiationApi;
-
-public class OnapsoinfraserviceInstantiationApiExample {
-
-    public static void main(String[] args) {
-        OnapsoinfraserviceInstantiationApi apiInstance = new OnapsoinfraserviceInstantiationApi();
-        String version = version_example; // String | 
-        String serviceInstanceId = serviceInstanceId_example; // String | 
-        String vnfInstanceId = vnfInstanceId_example; // String | 
-        String body = body_example; // String | 
-        try {
-            apiInstance.scaleOutVfModule(version, serviceInstanceId, vnfInstanceId, body);
-        } catch (ApiException e) {
-            System.err.println("Exception when calling OnapsoinfraserviceInstantiationApi#scaleOutVfModule");
-            e.printStackTrace();
-        }
-    }
-}
-
- -
-
String *version = version_example; // 
-String *serviceInstanceId = serviceInstanceId_example; // 
-String *vnfInstanceId = vnfInstanceId_example; // 
-String *body = body_example; //  (optional)
-
-OnapsoinfraserviceInstantiationApi *apiInstance = [[OnapsoinfraserviceInstantiationApi alloc] init];
-
-// VF Auto Scale Out
-[apiInstance scaleOutVfModuleWith:version
-    serviceInstanceId:serviceInstanceId
-    vnfInstanceId:vnfInstanceId
-    body:body
-              completionHandler: ^(NSError* error) {
-                            if (error) {
-                                NSLog(@"Error: %@", error);
-                            }
-                        }];
-
-
- -
-
var SoCasablancaApIs = require('so_casablanca_ap_is');
-
-var api = new SoCasablancaApIs.OnapsoinfraserviceInstantiationApi()
-
-var version = version_example; // {String} 
-
-var serviceInstanceId = serviceInstanceId_example; // {String} 
-
-var vnfInstanceId = vnfInstanceId_example; // {String} 
-
-var opts = { 
-  'body': body_example // {String} 
-};
-
-var callback = function(error, data, response) {
-  if (error) {
-    console.error(error);
-  } else {
-    console.log('API called successfully.');
-  }
-};
-api.scaleOutVfModule(version, serviceInstanceId, vnfInstanceId, opts, callback);
-
-
- - -
-
using System;
-using System.Diagnostics;
-using IO.Swagger.Api;
-using IO.Swagger.Client;
-using IO.Swagger.Model;
-
-namespace Example
-{
-    public class scaleOutVfModuleExample
-    {
-        public void main()
-        {
-            
-            var apiInstance = new OnapsoinfraserviceInstantiationApi();
-            var version = version_example;  // String | 
-            var serviceInstanceId = serviceInstanceId_example;  // String | 
-            var vnfInstanceId = vnfInstanceId_example;  // String | 
-            var body = body_example;  // String |  (optional) 
-
-            try
-            {
-                // VF Auto Scale Out
-                apiInstance.scaleOutVfModule(version, serviceInstanceId, vnfInstanceId, body);
-            }
-            catch (Exception e)
-            {
-                Debug.Print("Exception when calling OnapsoinfraserviceInstantiationApi.scaleOutVfModule: " + e.Message );
-            }
-        }
-    }
-}
-
-
- -
-
<?php
-require_once(__DIR__ . '/vendor/autoload.php');
-
-$api_instance = new Swagger\Client\Api\OnapsoinfraserviceInstantiationApi();
-$version = version_example; // String | 
-$serviceInstanceId = serviceInstanceId_example; // String | 
-$vnfInstanceId = vnfInstanceId_example; // String | 
-$body = body_example; // String | 
-
-try {
-    $api_instance->scaleOutVfModule($version, $serviceInstanceId, $vnfInstanceId, $body);
-} catch (Exception $e) {
-    echo 'Exception when calling OnapsoinfraserviceInstantiationApi->scaleOutVfModule: ', $e->getMessage(), PHP_EOL;
-}
-?>
-
- -
-
use Data::Dumper;
-use WWW::SwaggerClient::Configuration;
-use WWW::SwaggerClient::OnapsoinfraserviceInstantiationApi;
-
-my $api_instance = WWW::SwaggerClient::OnapsoinfraserviceInstantiationApi->new();
-my $version = version_example; # String | 
-my $serviceInstanceId = serviceInstanceId_example; # String | 
-my $vnfInstanceId = vnfInstanceId_example; # String | 
-my $body = WWW::SwaggerClient::Object::String->new(); # String | 
-
-eval { 
-    $api_instance->scaleOutVfModule(version => $version, serviceInstanceId => $serviceInstanceId, vnfInstanceId => $vnfInstanceId, body => $body);
-};
-if ($@) {
-    warn "Exception when calling OnapsoinfraserviceInstantiationApi->scaleOutVfModule: $@\n";
-}
-
- -
-
from __future__ import print_statement
-import time
-import swagger_client
-from swagger_client.rest import ApiException
-from pprint import pprint
-
-# create an instance of the API class
-api_instance = swagger_client.OnapsoinfraserviceInstantiationApi()
-version = version_example # String | 
-serviceInstanceId = serviceInstanceId_example # String | 
-vnfInstanceId = vnfInstanceId_example # String | 
-body = body_example # String |  (optional)
-
-try: 
-    # VF Auto Scale Out
-    api_instance.scale_out_vf_module(version, serviceInstanceId, vnfInstanceId, body=body)
-except ApiException as e:
-    print("Exception when calling OnapsoinfraserviceInstantiationApi->scaleOutVfModule: %s\n" % e)
-
-
- -

Parameters

- -
Path parameters
- - - - - - - - - - - - - - - - - -
NameDescription
version* - - -
-
-
- - String - - -
-
- Required -
-
-
-
serviceInstanceId* - - -
-
-
- - String - - -
-
- Required -
-
-
-
vnfInstanceId* - - -
-
-
- - String - - -
-
- Required -
-
-
-
- - -
Body parameters
- - - - - - - - - -
NameDescription
body - - - -
-
- - - -

Responses

-

Status: default - successful operation

- - - -
-
- -
-
-
-
-
-
-

unassignServiceInstance

-

Unassign Service Instance

-
-
-
-

-

-

-
-
/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/unassign
-

-

Usage and SDK Samples

-

- - -
-
-
curl -X POST "https://localhost/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/unassign"
-
-
-
import io.swagger.client.*;
-import io.swagger.client.auth.*;
-import io.swagger.client.model.*;
-import io.swagger.client.api.OnapsoinfraserviceInstantiationApi;
-
-import java.io.File;
-import java.util.*;
-
-public class OnapsoinfraserviceInstantiationApiExample {
-
-    public static void main(String[] args) {
-        
-        OnapsoinfraserviceInstantiationApi apiInstance = new OnapsoinfraserviceInstantiationApi();
-        String version = version_example; // String | 
-        String serviceInstanceId = serviceInstanceId_example; // String | 
-        String body = body_example; // String | 
-        try {
-            apiInstance.unassignServiceInstance(version, serviceInstanceId, body);
-        } catch (ApiException e) {
-            System.err.println("Exception when calling OnapsoinfraserviceInstantiationApi#unassignServiceInstance");
-            e.printStackTrace();
-        }
-    }
-}
-
- -
-
import io.swagger.client.api.OnapsoinfraserviceInstantiationApi;
-
-public class OnapsoinfraserviceInstantiationApiExample {
-
-    public static void main(String[] args) {
-        OnapsoinfraserviceInstantiationApi apiInstance = new OnapsoinfraserviceInstantiationApi();
-        String version = version_example; // String | 
-        String serviceInstanceId = serviceInstanceId_example; // String | 
-        String body = body_example; // String | 
-        try {
-            apiInstance.unassignServiceInstance(version, serviceInstanceId, body);
-        } catch (ApiException e) {
-            System.err.println("Exception when calling OnapsoinfraserviceInstantiationApi#unassignServiceInstance");
-            e.printStackTrace();
-        }
-    }
-}
-
- -
-
String *version = version_example; // 
-String *serviceInstanceId = serviceInstanceId_example; // 
-String *body = body_example; //  (optional)
-
-OnapsoinfraserviceInstantiationApi *apiInstance = [[OnapsoinfraserviceInstantiationApi alloc] init];
-
-// Unassign Service Instance
-[apiInstance unassignServiceInstanceWith:version
-    serviceInstanceId:serviceInstanceId
-    body:body
-              completionHandler: ^(NSError* error) {
-                            if (error) {
-                                NSLog(@"Error: %@", error);
-                            }
-                        }];
-
-
- -
-
var SoCasablancaApIs = require('so_casablanca_ap_is');
-
-var api = new SoCasablancaApIs.OnapsoinfraserviceInstantiationApi()
-
-var version = version_example; // {String} 
-
-var serviceInstanceId = serviceInstanceId_example; // {String} 
-
-var opts = { 
-  'body': body_example // {String} 
-};
-
-var callback = function(error, data, response) {
-  if (error) {
-    console.error(error);
-  } else {
-    console.log('API called successfully.');
-  }
-};
-api.unassignServiceInstance(version, serviceInstanceId, opts, callback);
-
-
- - -
-
using System;
-using System.Diagnostics;
-using IO.Swagger.Api;
-using IO.Swagger.Client;
-using IO.Swagger.Model;
-
-namespace Example
-{
-    public class unassignServiceInstanceExample
-    {
-        public void main()
-        {
-            
-            var apiInstance = new OnapsoinfraserviceInstantiationApi();
-            var version = version_example;  // String | 
-            var serviceInstanceId = serviceInstanceId_example;  // String | 
-            var body = body_example;  // String |  (optional) 
-
-            try
-            {
-                // Unassign Service Instance
-                apiInstance.unassignServiceInstance(version, serviceInstanceId, body);
-            }
-            catch (Exception e)
-            {
-                Debug.Print("Exception when calling OnapsoinfraserviceInstantiationApi.unassignServiceInstance: " + e.Message );
-            }
-        }
-    }
-}
-
-
- -
-
<?php
-require_once(__DIR__ . '/vendor/autoload.php');
-
-$api_instance = new Swagger\Client\Api\OnapsoinfraserviceInstantiationApi();
-$version = version_example; // String | 
-$serviceInstanceId = serviceInstanceId_example; // String | 
-$body = body_example; // String | 
-
-try {
-    $api_instance->unassignServiceInstance($version, $serviceInstanceId, $body);
-} catch (Exception $e) {
-    echo 'Exception when calling OnapsoinfraserviceInstantiationApi->unassignServiceInstance: ', $e->getMessage(), PHP_EOL;
-}
-?>
-
- -
-
use Data::Dumper;
-use WWW::SwaggerClient::Configuration;
-use WWW::SwaggerClient::OnapsoinfraserviceInstantiationApi;
-
-my $api_instance = WWW::SwaggerClient::OnapsoinfraserviceInstantiationApi->new();
-my $version = version_example; # String | 
-my $serviceInstanceId = serviceInstanceId_example; # String | 
-my $body = WWW::SwaggerClient::Object::String->new(); # String | 
-
-eval { 
-    $api_instance->unassignServiceInstance(version => $version, serviceInstanceId => $serviceInstanceId, body => $body);
-};
-if ($@) {
-    warn "Exception when calling OnapsoinfraserviceInstantiationApi->unassignServiceInstance: $@\n";
-}
-
- -
-
from __future__ import print_statement
-import time
-import swagger_client
-from swagger_client.rest import ApiException
-from pprint import pprint
-
-# create an instance of the API class
-api_instance = swagger_client.OnapsoinfraserviceInstantiationApi()
-version = version_example # String | 
-serviceInstanceId = serviceInstanceId_example # String | 
-body = body_example # String |  (optional)
-
-try: 
-    # Unassign Service Instance
-    api_instance.unassign_service_instance(version, serviceInstanceId, body=body)
-except ApiException as e:
-    print("Exception when calling OnapsoinfraserviceInstantiationApi->unassignServiceInstance: %s\n" % e)
-
-
- -

Parameters

- -
Path parameters
- - - - - - - - - - - - - -
NameDescription
version* - - -
-
-
- - String - - -
-
- Required -
-
-
-
serviceInstanceId* - - -
-
-
- - String - - -
-
- Required -
-
-
-
- - -
Body parameters
- - - - - - - - - -
NameDescription
body - - - -
-
- - - -

Responses

-

Status: default - successful operation

- - - -
-
- -
-
-
-
-
-
-

updateNetworkInstance

-

Update VolumeGroup on a specified version, serviceInstance, networkInstance

-
-
-
-

-

-

-
-
/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/networks/{networkInstanceId}
-

-

Usage and SDK Samples

-

- - -
-
-
curl -X PUT "https://localhost/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/networks/{networkInstanceId}"
-
-
-
import io.swagger.client.*;
-import io.swagger.client.auth.*;
-import io.swagger.client.model.*;
-import io.swagger.client.api.OnapsoinfraserviceInstantiationApi;
-
-import java.io.File;
-import java.util.*;
-
-public class OnapsoinfraserviceInstantiationApiExample {
-
-    public static void main(String[] args) {
-        
-        OnapsoinfraserviceInstantiationApi apiInstance = new OnapsoinfraserviceInstantiationApi();
-        String version = version_example; // String | 
-        String serviceInstanceId = serviceInstanceId_example; // String | 
-        String networkInstanceId = networkInstanceId_example; // String | 
-        String body = body_example; // String | 
-        try {
-            apiInstance.updateNetworkInstance(version, serviceInstanceId, networkInstanceId, body);
-        } catch (ApiException e) {
-            System.err.println("Exception when calling OnapsoinfraserviceInstantiationApi#updateNetworkInstance");
-            e.printStackTrace();
-        }
-    }
-}
-
- -
-
import io.swagger.client.api.OnapsoinfraserviceInstantiationApi;
-
-public class OnapsoinfraserviceInstantiationApiExample {
-
-    public static void main(String[] args) {
-        OnapsoinfraserviceInstantiationApi apiInstance = new OnapsoinfraserviceInstantiationApi();
-        String version = version_example; // String | 
-        String serviceInstanceId = serviceInstanceId_example; // String | 
-        String networkInstanceId = networkInstanceId_example; // String | 
-        String body = body_example; // String | 
-        try {
-            apiInstance.updateNetworkInstance(version, serviceInstanceId, networkInstanceId, body);
-        } catch (ApiException e) {
-            System.err.println("Exception when calling OnapsoinfraserviceInstantiationApi#updateNetworkInstance");
-            e.printStackTrace();
-        }
-    }
-}
-
- -
-
String *version = version_example; // 
-String *serviceInstanceId = serviceInstanceId_example; // 
-String *networkInstanceId = networkInstanceId_example; // 
-String *body = body_example; //  (optional)
-
-OnapsoinfraserviceInstantiationApi *apiInstance = [[OnapsoinfraserviceInstantiationApi alloc] init];
-
-// Update VolumeGroup on a specified version, serviceInstance, networkInstance
-[apiInstance updateNetworkInstanceWith:version
-    serviceInstanceId:serviceInstanceId
-    networkInstanceId:networkInstanceId
-    body:body
-              completionHandler: ^(NSError* error) {
-                            if (error) {
-                                NSLog(@"Error: %@", error);
-                            }
-                        }];
-
-
- -
-
var SoCasablancaApIs = require('so_casablanca_ap_is');
-
-var api = new SoCasablancaApIs.OnapsoinfraserviceInstantiationApi()
-
-var version = version_example; // {String} 
-
-var serviceInstanceId = serviceInstanceId_example; // {String} 
-
-var networkInstanceId = networkInstanceId_example; // {String} 
-
-var opts = { 
-  'body': body_example // {String} 
-};
-
-var callback = function(error, data, response) {
-  if (error) {
-    console.error(error);
-  } else {
-    console.log('API called successfully.');
-  }
-};
-api.updateNetworkInstance(version, serviceInstanceId, networkInstanceId, opts, callback);
-
-
- - -
-
using System;
-using System.Diagnostics;
-using IO.Swagger.Api;
-using IO.Swagger.Client;
-using IO.Swagger.Model;
-
-namespace Example
-{
-    public class updateNetworkInstanceExample
-    {
-        public void main()
-        {
-            
-            var apiInstance = new OnapsoinfraserviceInstantiationApi();
-            var version = version_example;  // String | 
-            var serviceInstanceId = serviceInstanceId_example;  // String | 
-            var networkInstanceId = networkInstanceId_example;  // String | 
-            var body = body_example;  // String |  (optional) 
-
-            try
-            {
-                // Update VolumeGroup on a specified version, serviceInstance, networkInstance
-                apiInstance.updateNetworkInstance(version, serviceInstanceId, networkInstanceId, body);
-            }
-            catch (Exception e)
-            {
-                Debug.Print("Exception when calling OnapsoinfraserviceInstantiationApi.updateNetworkInstance: " + e.Message );
-            }
-        }
-    }
-}
-
-
- -
-
<?php
-require_once(__DIR__ . '/vendor/autoload.php');
-
-$api_instance = new Swagger\Client\Api\OnapsoinfraserviceInstantiationApi();
-$version = version_example; // String | 
-$serviceInstanceId = serviceInstanceId_example; // String | 
-$networkInstanceId = networkInstanceId_example; // String | 
-$body = body_example; // String | 
-
-try {
-    $api_instance->updateNetworkInstance($version, $serviceInstanceId, $networkInstanceId, $body);
-} catch (Exception $e) {
-    echo 'Exception when calling OnapsoinfraserviceInstantiationApi->updateNetworkInstance: ', $e->getMessage(), PHP_EOL;
-}
-?>
-
- -
-
use Data::Dumper;
-use WWW::SwaggerClient::Configuration;
-use WWW::SwaggerClient::OnapsoinfraserviceInstantiationApi;
-
-my $api_instance = WWW::SwaggerClient::OnapsoinfraserviceInstantiationApi->new();
-my $version = version_example; # String | 
-my $serviceInstanceId = serviceInstanceId_example; # String | 
-my $networkInstanceId = networkInstanceId_example; # String | 
-my $body = WWW::SwaggerClient::Object::String->new(); # String | 
-
-eval { 
-    $api_instance->updateNetworkInstance(version => $version, serviceInstanceId => $serviceInstanceId, networkInstanceId => $networkInstanceId, body => $body);
-};
-if ($@) {
-    warn "Exception when calling OnapsoinfraserviceInstantiationApi->updateNetworkInstance: $@\n";
-}
-
- -
-
from __future__ import print_statement
-import time
-import swagger_client
-from swagger_client.rest import ApiException
-from pprint import pprint
-
-# create an instance of the API class
-api_instance = swagger_client.OnapsoinfraserviceInstantiationApi()
-version = version_example # String | 
-serviceInstanceId = serviceInstanceId_example # String | 
-networkInstanceId = networkInstanceId_example # String | 
-body = body_example # String |  (optional)
-
-try: 
-    # Update VolumeGroup on a specified version, serviceInstance, networkInstance
-    api_instance.update_network_instance(version, serviceInstanceId, networkInstanceId, body=body)
-except ApiException as e:
-    print("Exception when calling OnapsoinfraserviceInstantiationApi->updateNetworkInstance: %s\n" % e)
-
-
- -

Parameters

- -
Path parameters
- - - - - - - - - - - - - - - - - -
NameDescription
version* - - -
-
-
- - String - - -
-
- Required -
-
-
-
serviceInstanceId* - - -
-
-
- - String - - -
-
- Required -
-
-
-
networkInstanceId* - - -
-
-
- - String - - -
-
- Required -
-
-
-
- - -
Body parameters
- - - - - - - - - -
NameDescription
body - - - -
-
- - - -

Responses

-

Status: default - successful operation

- - - -
-
- -
-
-
-
-
-
-

updateVfModuleInstance

-

Update VfModule on a specified version, serviceInstance, vnfInstance and vfModule

-
-
-
-

-

-

-
-
/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/vnfs/{vnfInstanceId}/vfModules/{vfmoduleInstanceId}
-

-

Usage and SDK Samples

-

- - -
-
-
curl -X PUT "https://localhost/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/vnfs/{vnfInstanceId}/vfModules/{vfmoduleInstanceId}"
-
-
-
import io.swagger.client.*;
-import io.swagger.client.auth.*;
-import io.swagger.client.model.*;
-import io.swagger.client.api.OnapsoinfraserviceInstantiationApi;
-
-import java.io.File;
-import java.util.*;
-
-public class OnapsoinfraserviceInstantiationApiExample {
-
-    public static void main(String[] args) {
-        
-        OnapsoinfraserviceInstantiationApi apiInstance = new OnapsoinfraserviceInstantiationApi();
-        String version = version_example; // String | 
-        String serviceInstanceId = serviceInstanceId_example; // String | 
-        String vnfInstanceId = vnfInstanceId_example; // String | 
-        String vfmoduleInstanceId = vfmoduleInstanceId_example; // String | 
-        String body = body_example; // String | 
-        try {
-            apiInstance.updateVfModuleInstance(version, serviceInstanceId, vnfInstanceId, vfmoduleInstanceId, body);
-        } catch (ApiException e) {
-            System.err.println("Exception when calling OnapsoinfraserviceInstantiationApi#updateVfModuleInstance");
-            e.printStackTrace();
-        }
-    }
-}
-
- -
-
import io.swagger.client.api.OnapsoinfraserviceInstantiationApi;
-
-public class OnapsoinfraserviceInstantiationApiExample {
-
-    public static void main(String[] args) {
-        OnapsoinfraserviceInstantiationApi apiInstance = new OnapsoinfraserviceInstantiationApi();
-        String version = version_example; // String | 
-        String serviceInstanceId = serviceInstanceId_example; // String | 
-        String vnfInstanceId = vnfInstanceId_example; // String | 
-        String vfmoduleInstanceId = vfmoduleInstanceId_example; // String | 
-        String body = body_example; // String | 
-        try {
-            apiInstance.updateVfModuleInstance(version, serviceInstanceId, vnfInstanceId, vfmoduleInstanceId, body);
-        } catch (ApiException e) {
-            System.err.println("Exception when calling OnapsoinfraserviceInstantiationApi#updateVfModuleInstance");
-            e.printStackTrace();
-        }
-    }
-}
-
- -
-
String *version = version_example; // 
-String *serviceInstanceId = serviceInstanceId_example; // 
-String *vnfInstanceId = vnfInstanceId_example; // 
-String *vfmoduleInstanceId = vfmoduleInstanceId_example; // 
-String *body = body_example; //  (optional)
-
-OnapsoinfraserviceInstantiationApi *apiInstance = [[OnapsoinfraserviceInstantiationApi alloc] init];
-
-// Update VfModule on a specified version, serviceInstance, vnfInstance and vfModule
-[apiInstance updateVfModuleInstanceWith:version
-    serviceInstanceId:serviceInstanceId
-    vnfInstanceId:vnfInstanceId
-    vfmoduleInstanceId:vfmoduleInstanceId
-    body:body
-              completionHandler: ^(NSError* error) {
-                            if (error) {
-                                NSLog(@"Error: %@", error);
-                            }
-                        }];
-
-
- -
-
var SoCasablancaApIs = require('so_casablanca_ap_is');
-
-var api = new SoCasablancaApIs.OnapsoinfraserviceInstantiationApi()
-
-var version = version_example; // {String} 
-
-var serviceInstanceId = serviceInstanceId_example; // {String} 
-
-var vnfInstanceId = vnfInstanceId_example; // {String} 
-
-var vfmoduleInstanceId = vfmoduleInstanceId_example; // {String} 
-
-var opts = { 
-  'body': body_example // {String} 
-};
-
-var callback = function(error, data, response) {
-  if (error) {
-    console.error(error);
-  } else {
-    console.log('API called successfully.');
-  }
-};
-api.updateVfModuleInstance(version, serviceInstanceId, vnfInstanceId, vfmoduleInstanceId, opts, callback);
-
-
- - -
-
using System;
-using System.Diagnostics;
-using IO.Swagger.Api;
-using IO.Swagger.Client;
-using IO.Swagger.Model;
-
-namespace Example
-{
-    public class updateVfModuleInstanceExample
-    {
-        public void main()
-        {
-            
-            var apiInstance = new OnapsoinfraserviceInstantiationApi();
-            var version = version_example;  // String | 
-            var serviceInstanceId = serviceInstanceId_example;  // String | 
-            var vnfInstanceId = vnfInstanceId_example;  // String | 
-            var vfmoduleInstanceId = vfmoduleInstanceId_example;  // String | 
-            var body = body_example;  // String |  (optional) 
-
-            try
-            {
-                // Update VfModule on a specified version, serviceInstance, vnfInstance and vfModule
-                apiInstance.updateVfModuleInstance(version, serviceInstanceId, vnfInstanceId, vfmoduleInstanceId, body);
-            }
-            catch (Exception e)
-            {
-                Debug.Print("Exception when calling OnapsoinfraserviceInstantiationApi.updateVfModuleInstance: " + e.Message );
-            }
-        }
-    }
-}
-
-
- -
-
<?php
-require_once(__DIR__ . '/vendor/autoload.php');
-
-$api_instance = new Swagger\Client\Api\OnapsoinfraserviceInstantiationApi();
-$version = version_example; // String | 
-$serviceInstanceId = serviceInstanceId_example; // String | 
-$vnfInstanceId = vnfInstanceId_example; // String | 
-$vfmoduleInstanceId = vfmoduleInstanceId_example; // String | 
-$body = body_example; // String | 
-
-try {
-    $api_instance->updateVfModuleInstance($version, $serviceInstanceId, $vnfInstanceId, $vfmoduleInstanceId, $body);
-} catch (Exception $e) {
-    echo 'Exception when calling OnapsoinfraserviceInstantiationApi->updateVfModuleInstance: ', $e->getMessage(), PHP_EOL;
-}
-?>
-
- -
-
use Data::Dumper;
-use WWW::SwaggerClient::Configuration;
-use WWW::SwaggerClient::OnapsoinfraserviceInstantiationApi;
-
-my $api_instance = WWW::SwaggerClient::OnapsoinfraserviceInstantiationApi->new();
-my $version = version_example; # String | 
-my $serviceInstanceId = serviceInstanceId_example; # String | 
-my $vnfInstanceId = vnfInstanceId_example; # String | 
-my $vfmoduleInstanceId = vfmoduleInstanceId_example; # String | 
-my $body = WWW::SwaggerClient::Object::String->new(); # String | 
-
-eval { 
-    $api_instance->updateVfModuleInstance(version => $version, serviceInstanceId => $serviceInstanceId, vnfInstanceId => $vnfInstanceId, vfmoduleInstanceId => $vfmoduleInstanceId, body => $body);
-};
-if ($@) {
-    warn "Exception when calling OnapsoinfraserviceInstantiationApi->updateVfModuleInstance: $@\n";
-}
-
- -
-
from __future__ import print_statement
-import time
-import swagger_client
-from swagger_client.rest import ApiException
-from pprint import pprint
-
-# create an instance of the API class
-api_instance = swagger_client.OnapsoinfraserviceInstantiationApi()
-version = version_example # String | 
-serviceInstanceId = serviceInstanceId_example # String | 
-vnfInstanceId = vnfInstanceId_example # String | 
-vfmoduleInstanceId = vfmoduleInstanceId_example # String | 
-body = body_example # String |  (optional)
-
-try: 
-    # Update VfModule on a specified version, serviceInstance, vnfInstance and vfModule
-    api_instance.update_vf_module_instance(version, serviceInstanceId, vnfInstanceId, vfmoduleInstanceId, body=body)
-except ApiException as e:
-    print("Exception when calling OnapsoinfraserviceInstantiationApi->updateVfModuleInstance: %s\n" % e)
-
-
- -

Parameters

- -
Path parameters
- - - - - - - - - - - - - - - - - - - - - -
NameDescription
version* - - -
-
-
- - String - - -
-
- Required -
-
-
-
serviceInstanceId* - - -
-
-
- - String - - -
-
- Required -
-
-
-
vnfInstanceId* - - -
-
-
- - String - - -
-
- Required -
-
-
-
vfmoduleInstanceId* - - -
-
-
- - String - - -
-
- Required -
-
-
-
- - -
Body parameters
- - - - - - - - - -
NameDescription
body - - - -
-
- - - -

Responses

-

Status: default - successful operation

- - - -
-
- -
-
-
-
-
-
-

updateVnfInstance

-

Update VNF on a specified version, serviceInstance and vnfInstance

-
-
-
-

-

-

-
-
/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/vnfs/{vnfInstanceId}
-

-

Usage and SDK Samples

-

- - -
-
-
curl -X PUT "https://localhost/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/vnfs/{vnfInstanceId}"
-
-
-
import io.swagger.client.*;
-import io.swagger.client.auth.*;
-import io.swagger.client.model.*;
-import io.swagger.client.api.OnapsoinfraserviceInstantiationApi;
-
-import java.io.File;
-import java.util.*;
-
-public class OnapsoinfraserviceInstantiationApiExample {
-
-    public static void main(String[] args) {
-        
-        OnapsoinfraserviceInstantiationApi apiInstance = new OnapsoinfraserviceInstantiationApi();
-        String version = version_example; // String | 
-        String serviceInstanceId = serviceInstanceId_example; // String | 
-        String vnfInstanceId = vnfInstanceId_example; // String | 
-        String body = body_example; // String | 
-        try {
-            apiInstance.updateVnfInstance(version, serviceInstanceId, vnfInstanceId, body);
-        } catch (ApiException e) {
-            System.err.println("Exception when calling OnapsoinfraserviceInstantiationApi#updateVnfInstance");
-            e.printStackTrace();
-        }
-    }
-}
-
- -
-
import io.swagger.client.api.OnapsoinfraserviceInstantiationApi;
-
-public class OnapsoinfraserviceInstantiationApiExample {
-
-    public static void main(String[] args) {
-        OnapsoinfraserviceInstantiationApi apiInstance = new OnapsoinfraserviceInstantiationApi();
-        String version = version_example; // String | 
-        String serviceInstanceId = serviceInstanceId_example; // String | 
-        String vnfInstanceId = vnfInstanceId_example; // String | 
-        String body = body_example; // String | 
-        try {
-            apiInstance.updateVnfInstance(version, serviceInstanceId, vnfInstanceId, body);
-        } catch (ApiException e) {
-            System.err.println("Exception when calling OnapsoinfraserviceInstantiationApi#updateVnfInstance");
-            e.printStackTrace();
-        }
-    }
-}
-
- -
-
String *version = version_example; // 
-String *serviceInstanceId = serviceInstanceId_example; // 
-String *vnfInstanceId = vnfInstanceId_example; // 
-String *body = body_example; //  (optional)
-
-OnapsoinfraserviceInstantiationApi *apiInstance = [[OnapsoinfraserviceInstantiationApi alloc] init];
-
-// Update VNF on a specified version, serviceInstance and vnfInstance
-[apiInstance updateVnfInstanceWith:version
-    serviceInstanceId:serviceInstanceId
-    vnfInstanceId:vnfInstanceId
-    body:body
-              completionHandler: ^(NSError* error) {
-                            if (error) {
-                                NSLog(@"Error: %@", error);
-                            }
-                        }];
-
-
- -
-
var SoCasablancaApIs = require('so_casablanca_ap_is');
-
-var api = new SoCasablancaApIs.OnapsoinfraserviceInstantiationApi()
-
-var version = version_example; // {String} 
-
-var serviceInstanceId = serviceInstanceId_example; // {String} 
-
-var vnfInstanceId = vnfInstanceId_example; // {String} 
-
-var opts = { 
-  'body': body_example // {String} 
-};
-
-var callback = function(error, data, response) {
-  if (error) {
-    console.error(error);
-  } else {
-    console.log('API called successfully.');
-  }
-};
-api.updateVnfInstance(version, serviceInstanceId, vnfInstanceId, opts, callback);
-
-
- - -
-
using System;
-using System.Diagnostics;
-using IO.Swagger.Api;
-using IO.Swagger.Client;
-using IO.Swagger.Model;
-
-namespace Example
-{
-    public class updateVnfInstanceExample
-    {
-        public void main()
-        {
-            
-            var apiInstance = new OnapsoinfraserviceInstantiationApi();
-            var version = version_example;  // String | 
-            var serviceInstanceId = serviceInstanceId_example;  // String | 
-            var vnfInstanceId = vnfInstanceId_example;  // String | 
-            var body = body_example;  // String |  (optional) 
-
-            try
-            {
-                // Update VNF on a specified version, serviceInstance and vnfInstance
-                apiInstance.updateVnfInstance(version, serviceInstanceId, vnfInstanceId, body);
-            }
-            catch (Exception e)
-            {
-                Debug.Print("Exception when calling OnapsoinfraserviceInstantiationApi.updateVnfInstance: " + e.Message );
-            }
-        }
-    }
-}
-
-
- -
-
<?php
-require_once(__DIR__ . '/vendor/autoload.php');
-
-$api_instance = new Swagger\Client\Api\OnapsoinfraserviceInstantiationApi();
-$version = version_example; // String | 
-$serviceInstanceId = serviceInstanceId_example; // String | 
-$vnfInstanceId = vnfInstanceId_example; // String | 
-$body = body_example; // String | 
-
-try {
-    $api_instance->updateVnfInstance($version, $serviceInstanceId, $vnfInstanceId, $body);
-} catch (Exception $e) {
-    echo 'Exception when calling OnapsoinfraserviceInstantiationApi->updateVnfInstance: ', $e->getMessage(), PHP_EOL;
-}
-?>
-
- -
-
use Data::Dumper;
-use WWW::SwaggerClient::Configuration;
-use WWW::SwaggerClient::OnapsoinfraserviceInstantiationApi;
-
-my $api_instance = WWW::SwaggerClient::OnapsoinfraserviceInstantiationApi->new();
-my $version = version_example; # String | 
-my $serviceInstanceId = serviceInstanceId_example; # String | 
-my $vnfInstanceId = vnfInstanceId_example; # String | 
-my $body = WWW::SwaggerClient::Object::String->new(); # String | 
-
-eval { 
-    $api_instance->updateVnfInstance(version => $version, serviceInstanceId => $serviceInstanceId, vnfInstanceId => $vnfInstanceId, body => $body);
-};
-if ($@) {
-    warn "Exception when calling OnapsoinfraserviceInstantiationApi->updateVnfInstance: $@\n";
-}
-
- -
-
from __future__ import print_statement
-import time
-import swagger_client
-from swagger_client.rest import ApiException
-from pprint import pprint
-
-# create an instance of the API class
-api_instance = swagger_client.OnapsoinfraserviceInstantiationApi()
-version = version_example # String | 
-serviceInstanceId = serviceInstanceId_example # String | 
-vnfInstanceId = vnfInstanceId_example # String | 
-body = body_example # String |  (optional)
-
-try: 
-    # Update VNF on a specified version, serviceInstance and vnfInstance
-    api_instance.update_vnf_instance(version, serviceInstanceId, vnfInstanceId, body=body)
-except ApiException as e:
-    print("Exception when calling OnapsoinfraserviceInstantiationApi->updateVnfInstance: %s\n" % e)
-
-
- -

Parameters

- -
Path parameters
- - - - - - - - - - - - - - - - - -
NameDescription
version* - - -
-
-
- - String - - -
-
- Required -
-
-
-
serviceInstanceId* - - -
-
-
- - String - - -
-
- Required -
-
-
-
vnfInstanceId* - - -
-
-
- - String - - -
-
- Required -
-
-
-
- - -
Body parameters
- - - - - - - - - -
NameDescription
body - - - -
-
- - - -

Responses

-

Status: default - successful operation

- - - -
-
- -
-
-
-
-
-
-

updateVolumeGroupInstance

-

Update VolumeGroup on a specified version, serviceInstance, vnfInstance and volumeGroup

-
-
-
-

-

-

-
-
/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/vnfs/{vnfInstanceId}/volumeGroups/{volumeGroupInstanceId}
-

-

Usage and SDK Samples

-

- - -
-
-
curl -X PUT "https://localhost/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/vnfs/{vnfInstanceId}/volumeGroups/{volumeGroupInstanceId}"
-
-
-
import io.swagger.client.*;
-import io.swagger.client.auth.*;
-import io.swagger.client.model.*;
-import io.swagger.client.api.OnapsoinfraserviceInstantiationApi;
-
-import java.io.File;
-import java.util.*;
-
-public class OnapsoinfraserviceInstantiationApiExample {
-
-    public static void main(String[] args) {
-        
-        OnapsoinfraserviceInstantiationApi apiInstance = new OnapsoinfraserviceInstantiationApi();
-        String version = version_example; // String | 
-        String serviceInstanceId = serviceInstanceId_example; // String | 
-        String vnfInstanceId = vnfInstanceId_example; // String | 
-        String volumeGroupInstanceId = volumeGroupInstanceId_example; // String | 
-        String body = body_example; // String | 
-        try {
-            apiInstance.updateVolumeGroupInstance(version, serviceInstanceId, vnfInstanceId, volumeGroupInstanceId, body);
-        } catch (ApiException e) {
-            System.err.println("Exception when calling OnapsoinfraserviceInstantiationApi#updateVolumeGroupInstance");
-            e.printStackTrace();
-        }
-    }
-}
-
- -
-
import io.swagger.client.api.OnapsoinfraserviceInstantiationApi;
-
-public class OnapsoinfraserviceInstantiationApiExample {
-
-    public static void main(String[] args) {
-        OnapsoinfraserviceInstantiationApi apiInstance = new OnapsoinfraserviceInstantiationApi();
-        String version = version_example; // String | 
-        String serviceInstanceId = serviceInstanceId_example; // String | 
-        String vnfInstanceId = vnfInstanceId_example; // String | 
-        String volumeGroupInstanceId = volumeGroupInstanceId_example; // String | 
-        String body = body_example; // String | 
-        try {
-            apiInstance.updateVolumeGroupInstance(version, serviceInstanceId, vnfInstanceId, volumeGroupInstanceId, body);
-        } catch (ApiException e) {
-            System.err.println("Exception when calling OnapsoinfraserviceInstantiationApi#updateVolumeGroupInstance");
-            e.printStackTrace();
-        }
-    }
-}
-
- -
-
String *version = version_example; // 
-String *serviceInstanceId = serviceInstanceId_example; // 
-String *vnfInstanceId = vnfInstanceId_example; // 
-String *volumeGroupInstanceId = volumeGroupInstanceId_example; // 
-String *body = body_example; //  (optional)
-
-OnapsoinfraserviceInstantiationApi *apiInstance = [[OnapsoinfraserviceInstantiationApi alloc] init];
-
-// Update VolumeGroup on a specified version, serviceInstance, vnfInstance and volumeGroup
-[apiInstance updateVolumeGroupInstanceWith:version
-    serviceInstanceId:serviceInstanceId
-    vnfInstanceId:vnfInstanceId
-    volumeGroupInstanceId:volumeGroupInstanceId
-    body:body
-              completionHandler: ^(NSError* error) {
-                            if (error) {
-                                NSLog(@"Error: %@", error);
-                            }
-                        }];
-
-
- -
-
var SoCasablancaApIs = require('so_casablanca_ap_is');
-
-var api = new SoCasablancaApIs.OnapsoinfraserviceInstantiationApi()
-
-var version = version_example; // {String} 
-
-var serviceInstanceId = serviceInstanceId_example; // {String} 
-
-var vnfInstanceId = vnfInstanceId_example; // {String} 
-
-var volumeGroupInstanceId = volumeGroupInstanceId_example; // {String} 
-
-var opts = { 
-  'body': body_example // {String} 
-};
-
-var callback = function(error, data, response) {
-  if (error) {
-    console.error(error);
-  } else {
-    console.log('API called successfully.');
-  }
-};
-api.updateVolumeGroupInstance(version, serviceInstanceId, vnfInstanceId, volumeGroupInstanceId, opts, callback);
-
-
- - -
-
using System;
-using System.Diagnostics;
-using IO.Swagger.Api;
-using IO.Swagger.Client;
-using IO.Swagger.Model;
-
-namespace Example
-{
-    public class updateVolumeGroupInstanceExample
-    {
-        public void main()
-        {
-            
-            var apiInstance = new OnapsoinfraserviceInstantiationApi();
-            var version = version_example;  // String | 
-            var serviceInstanceId = serviceInstanceId_example;  // String | 
-            var vnfInstanceId = vnfInstanceId_example;  // String | 
-            var volumeGroupInstanceId = volumeGroupInstanceId_example;  // String | 
-            var body = body_example;  // String |  (optional) 
-
-            try
-            {
-                // Update VolumeGroup on a specified version, serviceInstance, vnfInstance and volumeGroup
-                apiInstance.updateVolumeGroupInstance(version, serviceInstanceId, vnfInstanceId, volumeGroupInstanceId, body);
-            }
-            catch (Exception e)
-            {
-                Debug.Print("Exception when calling OnapsoinfraserviceInstantiationApi.updateVolumeGroupInstance: " + e.Message );
-            }
-        }
-    }
-}
-
-
- -
-
<?php
-require_once(__DIR__ . '/vendor/autoload.php');
-
-$api_instance = new Swagger\Client\Api\OnapsoinfraserviceInstantiationApi();
-$version = version_example; // String | 
-$serviceInstanceId = serviceInstanceId_example; // String | 
-$vnfInstanceId = vnfInstanceId_example; // String | 
-$volumeGroupInstanceId = volumeGroupInstanceId_example; // String | 
-$body = body_example; // String | 
-
-try {
-    $api_instance->updateVolumeGroupInstance($version, $serviceInstanceId, $vnfInstanceId, $volumeGroupInstanceId, $body);
-} catch (Exception $e) {
-    echo 'Exception when calling OnapsoinfraserviceInstantiationApi->updateVolumeGroupInstance: ', $e->getMessage(), PHP_EOL;
-}
-?>
-
- -
-
use Data::Dumper;
-use WWW::SwaggerClient::Configuration;
-use WWW::SwaggerClient::OnapsoinfraserviceInstantiationApi;
-
-my $api_instance = WWW::SwaggerClient::OnapsoinfraserviceInstantiationApi->new();
-my $version = version_example; # String | 
-my $serviceInstanceId = serviceInstanceId_example; # String | 
-my $vnfInstanceId = vnfInstanceId_example; # String | 
-my $volumeGroupInstanceId = volumeGroupInstanceId_example; # String | 
-my $body = WWW::SwaggerClient::Object::String->new(); # String | 
-
-eval { 
-    $api_instance->updateVolumeGroupInstance(version => $version, serviceInstanceId => $serviceInstanceId, vnfInstanceId => $vnfInstanceId, volumeGroupInstanceId => $volumeGroupInstanceId, body => $body);
-};
-if ($@) {
-    warn "Exception when calling OnapsoinfraserviceInstantiationApi->updateVolumeGroupInstance: $@\n";
-}
-
- -
-
from __future__ import print_statement
-import time
-import swagger_client
-from swagger_client.rest import ApiException
-from pprint import pprint
-
-# create an instance of the API class
-api_instance = swagger_client.OnapsoinfraserviceInstantiationApi()
-version = version_example # String | 
-serviceInstanceId = serviceInstanceId_example # String | 
-vnfInstanceId = vnfInstanceId_example # String | 
-volumeGroupInstanceId = volumeGroupInstanceId_example # String | 
-body = body_example # String |  (optional)
-
-try: 
-    # Update VolumeGroup on a specified version, serviceInstance, vnfInstance and volumeGroup
-    api_instance.update_volume_group_instance(version, serviceInstanceId, vnfInstanceId, volumeGroupInstanceId, body=body)
-except ApiException as e:
-    print("Exception when calling OnapsoinfraserviceInstantiationApi->updateVolumeGroupInstance: %s\n" % e)
-
-
- -

Parameters

- -
Path parameters
- - - - - - - - - - - - - - - - - - - - - -
NameDescription
version* - - -
-
-
- - String - - -
-
- Required -
-
-
-
serviceInstanceId* - - -
-
-
- - String - - -
-
- Required -
-
-
-
vnfInstanceId* - - -
-
-
- - String - - -
-
- Required -
-
-
-
volumeGroupInstanceId* - - -
-
-
- - String - - -
-
- Required -
-
-
-
- - -
Body parameters
- - - - - - - - - -
NameDescription
body - - - -
-
- - - -

Responses

-

Status: default - successful operation

- - - -
-
- -
-
-
-
-
-

Onapsoinfratasks

-
-
-
-

queryFilters

-

Finds Manual Tasks

-
-
-
-

-

-

-
-
/onap/so/infra/tasks/{version}
-

-

Usage and SDK Samples

-

- - -
-
-
curl -X GET "https://localhost/onap/so/infra/tasks/{version}?taskId=&originalRequestId=&subscriptionServiceType=&nfRole=&buildingBlockName=&originalRequestDate=&originalRequestorId="
-
-
-
import io.swagger.client.*;
-import io.swagger.client.auth.*;
-import io.swagger.client.model.*;
-import io.swagger.client.api.OnapsoinfratasksApi;
-
-import java.io.File;
-import java.util.*;
-
-public class OnapsoinfratasksApiExample {
-
-    public static void main(String[] args) {
-        
-        OnapsoinfratasksApi apiInstance = new OnapsoinfratasksApi();
-        String version = version_example; // String | 
-        String taskId = taskId_example; // String | 
-        String originalRequestId = originalRequestId_example; // String | 
-        String subscriptionServiceType = subscriptionServiceType_example; // String | 
-        String nfRole = nfRole_example; // String | 
-        String buildingBlockName = buildingBlockName_example; // String | 
-        String originalRequestDate = originalRequestDate_example; // String | 
-        String originalRequestorId = originalRequestorId_example; // String | 
-        try {
-            apiInstance.queryFilters(version, taskId, originalRequestId, subscriptionServiceType, nfRole, buildingBlockName, originalRequestDate, originalRequestorId);
-        } catch (ApiException e) {
-            System.err.println("Exception when calling OnapsoinfratasksApi#queryFilters");
-            e.printStackTrace();
-        }
-    }
-}
-
- -
-
import io.swagger.client.api.OnapsoinfratasksApi;
-
-public class OnapsoinfratasksApiExample {
-
-    public static void main(String[] args) {
-        OnapsoinfratasksApi apiInstance = new OnapsoinfratasksApi();
-        String version = version_example; // String | 
-        String taskId = taskId_example; // String | 
-        String originalRequestId = originalRequestId_example; // String | 
-        String subscriptionServiceType = subscriptionServiceType_example; // String | 
-        String nfRole = nfRole_example; // String | 
-        String buildingBlockName = buildingBlockName_example; // String | 
-        String originalRequestDate = originalRequestDate_example; // String | 
-        String originalRequestorId = originalRequestorId_example; // String | 
-        try {
-            apiInstance.queryFilters(version, taskId, originalRequestId, subscriptionServiceType, nfRole, buildingBlockName, originalRequestDate, originalRequestorId);
-        } catch (ApiException e) {
-            System.err.println("Exception when calling OnapsoinfratasksApi#queryFilters");
-            e.printStackTrace();
-        }
-    }
-}
-
- -
-
String *version = version_example; // 
-String *taskId = taskId_example; //  (optional)
-String *originalRequestId = originalRequestId_example; //  (optional)
-String *subscriptionServiceType = subscriptionServiceType_example; //  (optional)
-String *nfRole = nfRole_example; //  (optional)
-String *buildingBlockName = buildingBlockName_example; //  (optional)
-String *originalRequestDate = originalRequestDate_example; //  (optional)
-String *originalRequestorId = originalRequestorId_example; //  (optional)
-
-OnapsoinfratasksApi *apiInstance = [[OnapsoinfratasksApi alloc] init];
-
-// Finds Manual Tasks
-[apiInstance queryFiltersWith:version
-    taskId:taskId
-    originalRequestId:originalRequestId
-    subscriptionServiceType:subscriptionServiceType
-    nfRole:nfRole
-    buildingBlockName:buildingBlockName
-    originalRequestDate:originalRequestDate
-    originalRequestorId:originalRequestorId
-              completionHandler: ^(NSError* error) {
-                            if (error) {
-                                NSLog(@"Error: %@", error);
-                            }
-                        }];
-
-
- -
-
var SoCasablancaApIs = require('so_casablanca_ap_is');
-
-var api = new SoCasablancaApIs.OnapsoinfratasksApi()
-
-var version = version_example; // {String} 
-
-var opts = { 
-  'taskId': taskId_example, // {String} 
-  'originalRequestId': originalRequestId_example, // {String} 
-  'subscriptionServiceType': subscriptionServiceType_example, // {String} 
-  'nfRole': nfRole_example, // {String} 
-  'buildingBlockName': buildingBlockName_example, // {String} 
-  'originalRequestDate': originalRequestDate_example, // {String} 
-  'originalRequestorId': originalRequestorId_example // {String} 
-};
-
-var callback = function(error, data, response) {
-  if (error) {
-    console.error(error);
-  } else {
-    console.log('API called successfully.');
-  }
-};
-api.queryFilters(version, opts, callback);
-
-
- - -
-
using System;
-using System.Diagnostics;
-using IO.Swagger.Api;
-using IO.Swagger.Client;
-using IO.Swagger.Model;
-
-namespace Example
-{
-    public class queryFiltersExample
-    {
-        public void main()
-        {
-            
-            var apiInstance = new OnapsoinfratasksApi();
-            var version = version_example;  // String | 
-            var taskId = taskId_example;  // String |  (optional) 
-            var originalRequestId = originalRequestId_example;  // String |  (optional) 
-            var subscriptionServiceType = subscriptionServiceType_example;  // String |  (optional) 
-            var nfRole = nfRole_example;  // String |  (optional) 
-            var buildingBlockName = buildingBlockName_example;  // String |  (optional) 
-            var originalRequestDate = originalRequestDate_example;  // String |  (optional) 
-            var originalRequestorId = originalRequestorId_example;  // String |  (optional) 
-
-            try
-            {
-                // Finds Manual Tasks
-                apiInstance.queryFilters(version, taskId, originalRequestId, subscriptionServiceType, nfRole, buildingBlockName, originalRequestDate, originalRequestorId);
-            }
-            catch (Exception e)
-            {
-                Debug.Print("Exception when calling OnapsoinfratasksApi.queryFilters: " + e.Message );
-            }
-        }
-    }
-}
-
-
- -
-
<?php
-require_once(__DIR__ . '/vendor/autoload.php');
-
-$api_instance = new Swagger\Client\Api\OnapsoinfratasksApi();
-$version = version_example; // String | 
-$taskId = taskId_example; // String | 
-$originalRequestId = originalRequestId_example; // String | 
-$subscriptionServiceType = subscriptionServiceType_example; // String | 
-$nfRole = nfRole_example; // String | 
-$buildingBlockName = buildingBlockName_example; // String | 
-$originalRequestDate = originalRequestDate_example; // String | 
-$originalRequestorId = originalRequestorId_example; // String | 
-
-try {
-    $api_instance->queryFilters($version, $taskId, $originalRequestId, $subscriptionServiceType, $nfRole, $buildingBlockName, $originalRequestDate, $originalRequestorId);
-} catch (Exception $e) {
-    echo 'Exception when calling OnapsoinfratasksApi->queryFilters: ', $e->getMessage(), PHP_EOL;
-}
-?>
-
- -
-
use Data::Dumper;
-use WWW::SwaggerClient::Configuration;
-use WWW::SwaggerClient::OnapsoinfratasksApi;
-
-my $api_instance = WWW::SwaggerClient::OnapsoinfratasksApi->new();
-my $version = version_example; # String | 
-my $taskId = taskId_example; # String | 
-my $originalRequestId = originalRequestId_example; # String | 
-my $subscriptionServiceType = subscriptionServiceType_example; # String | 
-my $nfRole = nfRole_example; # String | 
-my $buildingBlockName = buildingBlockName_example; # String | 
-my $originalRequestDate = originalRequestDate_example; # String | 
-my $originalRequestorId = originalRequestorId_example; # String | 
-
-eval { 
-    $api_instance->queryFilters(version => $version, taskId => $taskId, originalRequestId => $originalRequestId, subscriptionServiceType => $subscriptionServiceType, nfRole => $nfRole, buildingBlockName => $buildingBlockName, originalRequestDate => $originalRequestDate, originalRequestorId => $originalRequestorId);
-};
-if ($@) {
-    warn "Exception when calling OnapsoinfratasksApi->queryFilters: $@\n";
-}
-
- -
-
from __future__ import print_statement
-import time
-import swagger_client
-from swagger_client.rest import ApiException
-from pprint import pprint
-
-# create an instance of the API class
-api_instance = swagger_client.OnapsoinfratasksApi()
-version = version_example # String | 
-taskId = taskId_example # String |  (optional)
-originalRequestId = originalRequestId_example # String |  (optional)
-subscriptionServiceType = subscriptionServiceType_example # String |  (optional)
-nfRole = nfRole_example # String |  (optional)
-buildingBlockName = buildingBlockName_example # String |  (optional)
-originalRequestDate = originalRequestDate_example # String |  (optional)
-originalRequestorId = originalRequestorId_example # String |  (optional)
-
-try: 
-    # Finds Manual Tasks
-    api_instance.query_filters(version, taskId=taskId, originalRequestId=originalRequestId, subscriptionServiceType=subscriptionServiceType, nfRole=nfRole, buildingBlockName=buildingBlockName, originalRequestDate=originalRequestDate, originalRequestorId=originalRequestorId)
-except ApiException as e:
-    print("Exception when calling OnapsoinfratasksApi->queryFilters: %s\n" % e)
-
-
- -

Parameters

- -
Path parameters
- - - - - - - - - -
NameDescription
version* - - -
-
-
- - String - - -
-
- Required -
-
-
-
- - - - -
Query parameters
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescription
taskId - - -
-
-
- - String - - -
-
-
-
originalRequestId - - -
-
-
- - String - - -
-
-
-
subscriptionServiceType - - -
-
-
- - String - - -
-
-
-
nfRole - - -
-
-
- - String - - -
-
-
-
buildingBlockName - - -
-
-
- - String - - -
-
-
-
originalRequestDate - - -
-
-
- - String - - -
-
-
-
originalRequestorId - - -
-
-
- - String - - -
-
-
-
- -

Responses

-

Status: default - successful operation

- - - -
-
- -
-
-
-
-
- -
-
- Generated 2018-09-26T06:32:35.799Z -
-
-
-
-
- - - - - - - - - - - - - - -- cgit 1.2.3-korg From 2bcd57ee0a9f580a4b5e7dddebfb2b4661fd498e Mon Sep 17 00:00:00 2001 From: seshukm Date: Mon, 19 Nov 2018 11:19:44 +0800 Subject: Fix for the API problem Change-Id: I50726946cfb425952c8947d8ec643fa753645399 Issue-ID: SO-1230 Signed-off-by: seshukm --- docs/api/offered_consumed_apis.rst | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) (limited to 'docs') diff --git a/docs/api/offered_consumed_apis.rst b/docs/api/offered_consumed_apis.rst index 0cf7e0f341..d6791d3437 100644 --- a/docs/api/offered_consumed_apis.rst +++ b/docs/api/offered_consumed_apis.rst @@ -5,7 +5,7 @@ SO Offered and Consumed APIs ===================================== -The list of APIs that SO offerers could be find in the following table: +The list of APIs that SO offerers could be found in the following table: .. |yml-icon| image:: swagger/images/yaml.png :width: 40px @@ -22,3 +22,13 @@ The list of APIs that SO offerers could be find in the following table: "swagger json file", "html doc", "yaml doc" ":download:`link `", ":download:`link `", ":download:`link `" + +The list of APIs that SO offerers for monitroing the BPMN flows could be found in the following table: + +.. csv-table:: + :header: "|Swagger-icon|", "|yml-icon|" + :widths: 60,60 + + "swagger json file", "yaml doc" + ":download:`link `", ":download:`link `" + \ No newline at end of file -- cgit 1.2.3-korg From 797178dec982ce8e85cf92a04ff62e36e816d621 Mon Sep 17 00:00:00 2001 From: seshukm Date: Mon, 19 Nov 2018 11:20:48 +0800 Subject: Fix the API issue Take 2 Change-Id: Ie26ff7540a1194cd36242c91858b1ed5961365d9 Issue-ID: SO-1230 Signed-off-by: seshukm --- docs/api/swagger/swagger.html | 102 +++++++++++++++++++++--------------------- docs/api/swagger/swagger.json | 12 ++--- docs/api/swagger/swagger.yaml | 2 +- 3 files changed, 58 insertions(+), 58 deletions(-) (limited to 'docs') diff --git a/docs/api/swagger/swagger.html b/docs/api/swagger/swagger.html index dc6064bb80..3c577b7c07 100644 --- a/docs/api/swagger/swagger.html +++ b/docs/api/swagger/swagger.html @@ -924,7 +924,7 @@ margin-bottom: 20px;
-
curl -X POST "https://localhost/onap/so/infra/e2eServiceInstances/{version}/{serviceId}/modeldifferences"
+
curl -X POST "http://localhost/onap/so/infra/e2eServiceInstances/{version}/{serviceId}/modeldifferences"
import io.swagger.client.*;
@@ -1251,7 +1251,7 @@ $(document).ready(function() {
 
                         
-
curl -X POST "https://localhost/onap/so/infra/e2eServiceInstances/{version}"
+
curl -X POST "http://localhost/onap/so/infra/e2eServiceInstances/{version}"
import io.swagger.client.*;
@@ -1548,7 +1548,7 @@ $(document).ready(function() {
 
                         
-
curl -X DELETE "https://localhost/onap/so/infra/e2eServiceInstances/{version}/{serviceId}"
+
curl -X DELETE "http://localhost/onap/so/infra/e2eServiceInstances/{version}/{serviceId}"
import io.swagger.client.*;
@@ -1875,7 +1875,7 @@ $(document).ready(function() {
 
                         
-
curl -X GET "https://localhost/onap/so/infra/e2eServiceInstances/{version}/{serviceId}/operations/{operationId}"
+
curl -X GET "http://localhost/onap/so/infra/e2eServiceInstances/{version}/{serviceId}/operations/{operationId}"
import io.swagger.client.*;
@@ -2180,7 +2180,7 @@ except ApiException as e:
 
                         
-
curl -X POST "https://localhost/onap/so/infra/e2eServiceInstances/{version}/{serviceId}/scale"
+
curl -X POST "http://localhost/onap/so/infra/e2eServiceInstances/{version}/{serviceId}/scale"
import io.swagger.client.*;
@@ -2507,7 +2507,7 @@ $(document).ready(function() {
 
                         
-
curl -X PUT "https://localhost/onap/so/infra/e2eServiceInstances/{version}/{serviceId}"
+
curl -X PUT "http://localhost/onap/so/infra/e2eServiceInstances/{version}/{serviceId}"
import io.swagger.client.*;
@@ -2837,7 +2837,7 @@ $(document).ready(function() {
 
                         
-
curl -X GET "https://localhost/globalhealthcheck?enableBpmn="
+
curl -X GET "http://localhost/globalhealthcheck?enableBpmn="
import io.swagger.client.*;
@@ -3083,7 +3083,7 @@ except ApiException as e:
 
                         
-
curl -X GET "https://localhost/nodehealthcheck"
+
curl -X GET "http://localhost/nodehealthcheck"
import io.swagger.client.*;
@@ -3294,7 +3294,7 @@ except ApiException as e:
 
                         
-
curl -X POST "https://localhost/onap/so/infra/cloudResources/{version}/operationalEnvironments/{operationalEnvironmentId}/activate"
+
curl -X POST "http://localhost/onap/so/infra/cloudResources/{version}/operationalEnvironments/{operationalEnvironmentId}/activate"
import io.swagger.client.*;
@@ -3621,7 +3621,7 @@ $(document).ready(function() {
 
                         
-
curl -X POST "https://localhost/onap/so/infra/cloudResources/{version}/operationalEnvironments"
+
curl -X POST "http://localhost/onap/so/infra/cloudResources/{version}/operationalEnvironments"
import io.swagger.client.*;
@@ -3918,7 +3918,7 @@ $(document).ready(function() {
 
                         
-
curl -X POST "https://localhost/onap/so/infra/cloudResources/{version}/operationalEnvironments/{operationalEnvironmentId}/deactivate"
+
curl -X POST "http://localhost/onap/so/infra/cloudResources/{version}/operationalEnvironments/{operationalEnvironmentId}/deactivate"
import io.swagger.client.*;
@@ -4248,7 +4248,7 @@ $(document).ready(function() {
 
                         
-
curl -X GET "https://localhost/onap/so/infra/cloudResourcesRequests/{version}"
+
curl -X GET "http://localhost/onap/so/infra/cloudResourcesRequests/{version}"
import io.swagger.client.*;
@@ -4493,7 +4493,7 @@ except ApiException as e:
 
                         
-
curl -X POST "https://localhost/onap/so/infra/cloudResourcesRequests/{version}/{requestId}/unlock"
+
curl -X POST "http://localhost/onap/so/infra/cloudResourcesRequests/{version}/{requestId}/unlock"
import io.swagger.client.*;
@@ -4823,7 +4823,7 @@ $(document).ready(function() {
 
                         
-
curl -X POST "https://localhost/onap/so/infra/modelDistributions/{version}/distributions/{distributionId}"
+
curl -X POST "http://localhost/onap/so/infra/modelDistributions/{version}/distributions/{distributionId}"
import io.swagger.client.*;
@@ -5153,7 +5153,7 @@ $(document).ready(function() {
 
                         
-
curl -X GET "https://localhost/onap/so/infra/orchestrationRequests/{version}"
+
curl -X GET "http://localhost/onap/so/infra/orchestrationRequests/{version}"
import io.swagger.client.*;
@@ -5398,7 +5398,7 @@ except ApiException as e:
 
                         
-
curl -X GET "https://localhost/onap/so/infra/orchestrationRequests/{version}/{requestId}"
+
curl -X GET "http://localhost/onap/so/infra/orchestrationRequests/{version}/{requestId}"
import io.swagger.client.*;
@@ -5673,7 +5673,7 @@ except ApiException as e:
 
                         
-
curl -X POST "https://localhost/onap/so/infra/orchestrationRequests/{version}/{requestId}/unlock"
+
curl -X POST "http://localhost/onap/so/infra/orchestrationRequests/{version}/{requestId}/unlock"
import io.swagger.client.*;
@@ -6003,7 +6003,7 @@ $(document).ready(function() {
 
                         
-
curl -X POST "https://localhost/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/configurations/{configurationInstanceId}/activate"
+
curl -X POST "http://localhost/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/configurations/{configurationInstanceId}/activate"
import io.swagger.client.*;
@@ -6360,7 +6360,7 @@ $(document).ready(function() {
 
                         
-
curl -X POST "https://localhost/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/activate"
+
curl -X POST "http://localhost/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/activate"
import io.swagger.client.*;
@@ -6687,7 +6687,7 @@ $(document).ready(function() {
 
                         
-
curl -X POST "https://localhost/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/addRelationships"
+
curl -X POST "http://localhost/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/addRelationships"
import io.swagger.client.*;
@@ -7014,7 +7014,7 @@ $(document).ready(function() {
 
                         
-
curl -X POST "https://localhost/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/vnfs/{vnfInstanceId}/applyUpdatedConfig"
+
curl -X POST "http://localhost/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/vnfs/{vnfInstanceId}/applyUpdatedConfig"
import io.swagger.client.*;
@@ -7371,7 +7371,7 @@ $(document).ready(function() {
 
                         
-
curl -X POST "https://localhost/onap/so/infra/serviceInstantiation/{version}/serviceInstances/assign"
+
curl -X POST "http://localhost/onap/so/infra/serviceInstantiation/{version}/serviceInstances/assign"
import io.swagger.client.*;
@@ -7668,7 +7668,7 @@ $(document).ready(function() {
 
                         
-
curl -X POST "https://localhost/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/networks"
+
curl -X POST "http://localhost/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/networks"
import io.swagger.client.*;
@@ -7995,7 +7995,7 @@ $(document).ready(function() {
 
                         
-
curl -X POST "https://localhost/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/configurations"
+
curl -X POST "http://localhost/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/configurations"
import io.swagger.client.*;
@@ -8322,7 +8322,7 @@ $(document).ready(function() {
 
                         
-
curl -X POST "https://localhost/onap/so/infra/serviceInstantiation/{version}/serviceInstances"
+
curl -X POST "http://localhost/onap/so/infra/serviceInstantiation/{version}/serviceInstances"
import io.swagger.client.*;
@@ -8619,7 +8619,7 @@ $(document).ready(function() {
 
                         
-
curl -X POST "https://localhost/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/vnfs/{vnfInstanceId}/vfModules"
+
curl -X POST "http://localhost/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/vnfs/{vnfInstanceId}/vfModules"
import io.swagger.client.*;
@@ -8976,7 +8976,7 @@ $(document).ready(function() {
 
                         
-
curl -X POST "https://localhost/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/vnfs"
+
curl -X POST "http://localhost/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/vnfs"
import io.swagger.client.*;
@@ -9303,7 +9303,7 @@ $(document).ready(function() {
 
                         
-
curl -X POST "https://localhost/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/vnfs/{vnfInstanceId}/volumeGroups"
+
curl -X POST "http://localhost/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/vnfs/{vnfInstanceId}/volumeGroups"
import io.swagger.client.*;
@@ -9660,7 +9660,7 @@ $(document).ready(function() {
 
                         
-
curl -X POST "https://localhost/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/vnfs/{vnfInstanceId}/vfModules/{vfmoduleInstanceId}/deactivateAndCloudDelete"
+
curl -X POST "http://localhost/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/vnfs/{vnfInstanceId}/vfModules/{vfmoduleInstanceId}/deactivateAndCloudDelete"
import io.swagger.client.*;
@@ -10047,7 +10047,7 @@ $(document).ready(function() {
 
                         
-
curl -X POST "https://localhost/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/configurations/{configurationInstanceId}/deactivate"
+
curl -X POST "http://localhost/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/configurations/{configurationInstanceId}/deactivate"
import io.swagger.client.*;
@@ -10404,7 +10404,7 @@ $(document).ready(function() {
 
                         
-
curl -X POST "https://localhost/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/deactivate"
+
curl -X POST "http://localhost/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/deactivate"
import io.swagger.client.*;
@@ -10731,7 +10731,7 @@ $(document).ready(function() {
 
                         
-
curl -X DELETE "https://localhost/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/networks/{networkInstanceId}"
+
curl -X DELETE "http://localhost/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/networks/{networkInstanceId}"
import io.swagger.client.*;
@@ -11088,7 +11088,7 @@ $(document).ready(function() {
 
                         
-
curl -X DELETE "https://localhost/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/configurations/{configurationInstanceId}"
+
curl -X DELETE "http://localhost/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/configurations/{configurationInstanceId}"
import io.swagger.client.*;
@@ -11445,7 +11445,7 @@ $(document).ready(function() {
 
                         
-
curl -X DELETE "https://localhost/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}"
+
curl -X DELETE "http://localhost/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}"
import io.swagger.client.*;
@@ -11772,7 +11772,7 @@ $(document).ready(function() {
 
                         
-
curl -X DELETE "https://localhost/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/vnfs/{vnfInstanceId}/vfModules/{vfmoduleInstanceId}"
+
curl -X DELETE "http://localhost/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/vnfs/{vnfInstanceId}/vfModules/{vfmoduleInstanceId}"
import io.swagger.client.*;
@@ -12159,7 +12159,7 @@ $(document).ready(function() {
 
                         
-
curl -X DELETE "https://localhost/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/vnfs/{vnfInstanceId}"
+
curl -X DELETE "http://localhost/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/vnfs/{vnfInstanceId}"
import io.swagger.client.*;
@@ -12516,7 +12516,7 @@ $(document).ready(function() {
 
                         
-
curl -X DELETE "https://localhost/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/vnfs/{vnfInstanceId}/volumeGroups/{volumeGroupInstanceId}"
+
curl -X DELETE "http://localhost/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/vnfs/{vnfInstanceId}/volumeGroups/{volumeGroupInstanceId}"
import io.swagger.client.*;
@@ -12903,7 +12903,7 @@ $(document).ready(function() {
 
                         
-
curl -X POST "https://localhost/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/configurations/{configurationInstanceId}/disablePort"
+
curl -X POST "http://localhost/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/configurations/{configurationInstanceId}/disablePort"
import io.swagger.client.*;
@@ -13260,7 +13260,7 @@ $(document).ready(function() {
 
                         
-
curl -X POST "https://localhost/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/configurations/{configurationInstanceId}/enablePort"
+
curl -X POST "http://localhost/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/configurations/{configurationInstanceId}/enablePort"
import io.swagger.client.*;
@@ -13617,7 +13617,7 @@ $(document).ready(function() {
 
                         
-
curl -X POST "https://localhost/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/vnfs/{vnfInstanceId}/inPlaceSoftwareUpdate"
+
curl -X POST "http://localhost/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/vnfs/{vnfInstanceId}/inPlaceSoftwareUpdate"
import io.swagger.client.*;
@@ -13974,7 +13974,7 @@ $(document).ready(function() {
 
                         
-
curl -X POST "https://localhost/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/removeRelationships"
+
curl -X POST "http://localhost/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/removeRelationships"
import io.swagger.client.*;
@@ -14301,7 +14301,7 @@ $(document).ready(function() {
 
                         
-
curl -X POST "https://localhost/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/vnfs/{vnfInstanceId}/vfModules/{vfmoduleInstanceId}/replace"
+
curl -X POST "http://localhost/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/vnfs/{vnfInstanceId}/vfModules/{vfmoduleInstanceId}/replace"
import io.swagger.client.*;
@@ -14688,7 +14688,7 @@ $(document).ready(function() {
 
                         
-
curl -X POST "https://localhost/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/vnfs/{vnfInstanceId}/replace"
+
curl -X POST "http://localhost/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/vnfs/{vnfInstanceId}/replace"
import io.swagger.client.*;
@@ -15045,7 +15045,7 @@ $(document).ready(function() {
 
                         
-
curl -X POST "https://localhost/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/vnfs/{vnfInstanceId}/vfModules/scaleOut"
+
curl -X POST "http://localhost/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/vnfs/{vnfInstanceId}/vfModules/scaleOut"
import io.swagger.client.*;
@@ -15402,7 +15402,7 @@ $(document).ready(function() {
 
                         
-
curl -X POST "https://localhost/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/unassign"
+
curl -X POST "http://localhost/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/unassign"
import io.swagger.client.*;
@@ -15729,7 +15729,7 @@ $(document).ready(function() {
 
                         
-
curl -X PUT "https://localhost/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/networks/{networkInstanceId}"
+
curl -X PUT "http://localhost/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/networks/{networkInstanceId}"
import io.swagger.client.*;
@@ -16086,7 +16086,7 @@ $(document).ready(function() {
 
                         
-
curl -X PUT "https://localhost/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/vnfs/{vnfInstanceId}/vfModules/{vfmoduleInstanceId}"
+
curl -X PUT "http://localhost/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/vnfs/{vnfInstanceId}/vfModules/{vfmoduleInstanceId}"
import io.swagger.client.*;
@@ -16473,7 +16473,7 @@ $(document).ready(function() {
 
                         
-
curl -X PUT "https://localhost/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/vnfs/{vnfInstanceId}"
+
curl -X PUT "http://localhost/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/vnfs/{vnfInstanceId}"
import io.swagger.client.*;
@@ -16830,7 +16830,7 @@ $(document).ready(function() {
 
                         
-
curl -X PUT "https://localhost/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/vnfs/{vnfInstanceId}/volumeGroups/{volumeGroupInstanceId}"
+
curl -X PUT "http://localhost/onap/so/infra/serviceInstantiation/{version}/serviceInstances/{serviceInstanceId}/vnfs/{vnfInstanceId}/volumeGroups/{volumeGroupInstanceId}"
import io.swagger.client.*;
@@ -17220,7 +17220,7 @@ $(document).ready(function() {
 
                         
-
curl -X GET "https://localhost/onap/so/infra/tasks/{version}?taskId=&originalRequestId=&subscriptionServiceType=&nfRole=&buildingBlockName=&originalRequestDate=&originalRequestorId="
+
curl -X GET "http://localhost/onap/so/infra/tasks/{version}?taskId=&originalRequestId=&subscriptionServiceType=&nfRole=&buildingBlockName=&originalRequestDate=&originalRequestorId="
import io.swagger.client.*;
@@ -17638,7 +17638,7 @@ except ApiException as e:
           
- Generated 2018-09-26T06:32:35.799Z + Generated 2018-11-19T03:11:19.743Z
diff --git a/docs/api/swagger/swagger.json b/docs/api/swagger/swagger.json index 65d7ff0d11..6ba8380a5f 100644 --- a/docs/api/swagger/swagger.json +++ b/docs/api/swagger/swagger.json @@ -34,10 +34,10 @@ } ], "schemes": [ - "https" + "http" ], "paths": { - "/e2eServiceInstances/{version}": { + "/onap/so/infra/e2eServiceInstances/{version}": { "post": { "tags": [ "e2eServiceInstances" @@ -75,7 +75,7 @@ } } }, - "/e2eServiceInstances/{version}/{serviceId}": { + "/onap/so/infra/e2eServiceInstances/{version}/{serviceId}": { "put": { "tags": [ "e2eServiceInstances" @@ -161,7 +161,7 @@ } } }, - "/e2eServiceInstances/{version}/{serviceId}/operations/{operationId}": { + "/onap/so/infra/e2eServiceInstances/{version}/{serviceId}/operations/{operationId}": { "get": { "tags": [ "e2eServiceInstances" @@ -200,7 +200,7 @@ } } }, - "/e2eServiceInstances/{version}/{serviceId}/scale": { + "/onap/so/infra/e2eServiceInstances/{version}/{serviceId}/scale": { "post": { "tags": [ "e2eServiceInstances" @@ -244,7 +244,7 @@ } } }, - "/e2eServiceInstances/{version}/{serviceId}/modeldifferences": { + "/onap/so/infra/e2eServiceInstances/{version}/{serviceId}/modeldifferences": { "post": { "tags": [ "e2eServiceInstances" diff --git a/docs/api/swagger/swagger.yaml b/docs/api/swagger/swagger.yaml index 86f8e4c64e..11c72b612c 100644 --- a/docs/api/swagger/swagger.yaml +++ b/docs/api/swagger/swagger.yaml @@ -13,7 +13,7 @@ tags: - name: onapsoinfracloudResourcesRequests - name: onapsoinframodelDistributions schemes: - - https + - http paths: '/onap/so/infra/e2eServiceInstances/{version}': post: -- cgit 1.2.3-korg From b2946076ba214add3d1e316f165595846aa91ecc Mon Sep 17 00:00:00 2001 From: seshukm Date: Mon, 19 Nov 2018 11:25:28 +0800 Subject: Add Monitoring feature details Change-Id: Ib4e591bfc4176e8a9786a161a8f403ac47efe982 Issue-ID: SO-1230 Signed-off-by: seshukm --- docs/api/swagger/SO_MONITORING_SWAGGER.html | 4650 +++++++++++++++++++++++++++ 1 file changed, 4650 insertions(+) create mode 100644 docs/api/swagger/SO_MONITORING_SWAGGER.html (limited to 'docs') diff --git a/docs/api/swagger/SO_MONITORING_SWAGGER.html b/docs/api/swagger/SO_MONITORING_SWAGGER.html new file mode 100644 index 0000000000..fe85ab6bd1 --- /dev/null +++ b/docs/api/swagger/SO_MONITORING_SWAGGER.html @@ -0,0 +1,4650 @@ + + + + + SO Monitoring APIs + + + + + + + + + + + + + + + + + +
+
+ +
+
+
+

SO Monitoring APIs

+
+
+
+ +
+
+

GetActivityInstanceDetail

+
+
+
+

getActivityInstanceDetail

+

Get activity instance details for given process instance ID

+
+
+
+

+

+

+
+
/so/monitoring/activity-instance/{processInstanceId}
+

+

Usage and SDK Samples

+

+ + +
+
+
curl -X GET "http://localhost/so/monitoring/activity-instance/{processInstanceId}"
+
+
+
import io.swagger.client.*;
+import io.swagger.client.auth.*;
+import io.swagger.client.model.*;
+import io.swagger.client.api.GetActivityInstanceDetailApi;
+
+import java.io.File;
+import java.util.*;
+
+public class GetActivityInstanceDetailApiExample {
+
+    public static void main(String[] args) {
+        
+        GetActivityInstanceDetailApi apiInstance = new GetActivityInstanceDetailApi();
+        String processInstanceId = processInstanceId_example; // String | 
+        try {
+            array[inline_response_200_3] result = apiInstance.getActivityInstanceDetail(processInstanceId);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling GetActivityInstanceDetailApi#getActivityInstanceDetail");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+
import io.swagger.client.api.GetActivityInstanceDetailApi;
+
+public class GetActivityInstanceDetailApiExample {
+
+    public static void main(String[] args) {
+        GetActivityInstanceDetailApi apiInstance = new GetActivityInstanceDetailApi();
+        String processInstanceId = processInstanceId_example; // String | 
+        try {
+            array[inline_response_200_3] result = apiInstance.getActivityInstanceDetail(processInstanceId);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling GetActivityInstanceDetailApi#getActivityInstanceDetail");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+
String *processInstanceId = processInstanceId_example; // 
+
+GetActivityInstanceDetailApi *apiInstance = [[GetActivityInstanceDetailApi alloc] init];
+
+// Get activity instance details for given process instance ID
+[apiInstance getActivityInstanceDetailWith:processInstanceId
+              completionHandler: ^(array[inline_response_200_3] output, NSError* error) {
+                            if (output) {
+                                NSLog(@"%@", output);
+                            }
+                            if (error) {
+                                NSLog(@"Error: %@", error);
+                            }
+                        }];
+
+
+ +
+
var SoMonitoringApIs = require('so_monitoring_ap_is');
+
+var api = new SoMonitoringApIs.GetActivityInstanceDetailApi()
+
+var processInstanceId = processInstanceId_example; // {String} 
+
+
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+};
+api.getActivityInstanceDetail(processInstanceId, callback);
+
+
+ + +
+
using System;
+using System.Diagnostics;
+using IO.Swagger.Api;
+using IO.Swagger.Client;
+using IO.Swagger.Model;
+
+namespace Example
+{
+    public class getActivityInstanceDetailExample
+    {
+        public void main()
+        {
+            
+            var apiInstance = new GetActivityInstanceDetailApi();
+            var processInstanceId = processInstanceId_example;  // String | 
+
+            try
+            {
+                // Get activity instance details for given process instance ID
+                array[inline_response_200_3] result = apiInstance.getActivityInstanceDetail(processInstanceId);
+                Debug.WriteLine(result);
+            }
+            catch (Exception e)
+            {
+                Debug.Print("Exception when calling GetActivityInstanceDetailApi.getActivityInstanceDetail: " + e.Message );
+            }
+        }
+    }
+}
+
+
+ +
+
<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+$api_instance = new Swagger\Client\Api\GetActivityInstanceDetailApi();
+$processInstanceId = processInstanceId_example; // String | 
+
+try {
+    $result = $api_instance->getActivityInstanceDetail($processInstanceId);
+    print_r($result);
+} catch (Exception $e) {
+    echo 'Exception when calling GetActivityInstanceDetailApi->getActivityInstanceDetail: ', $e->getMessage(), PHP_EOL;
+}
+?>
+
+ +
+
use Data::Dumper;
+use WWW::SwaggerClient::Configuration;
+use WWW::SwaggerClient::GetActivityInstanceDetailApi;
+
+my $api_instance = WWW::SwaggerClient::GetActivityInstanceDetailApi->new();
+my $processInstanceId = processInstanceId_example; # String | 
+
+eval { 
+    my $result = $api_instance->getActivityInstanceDetail(processInstanceId => $processInstanceId);
+    print Dumper($result);
+};
+if ($@) {
+    warn "Exception when calling GetActivityInstanceDetailApi->getActivityInstanceDetail: $@\n";
+}
+
+ +
+
from __future__ import print_statement
+import time
+import swagger_client
+from swagger_client.rest import ApiException
+from pprint import pprint
+
+# create an instance of the API class
+api_instance = swagger_client.GetActivityInstanceDetailApi()
+processInstanceId = processInstanceId_example # String | 
+
+try: 
+    # Get activity instance details for given process instance ID
+    api_response = api_instance.get_activity_instance_detail(processInstanceId)
+    pprint(api_response)
+except ApiException as e:
+    print("Exception when calling GetActivityInstanceDetailApi->getActivityInstanceDetail: %s\n" % e)
+
+
+ +

Parameters

+ +
Path parameters
+ + + + + + + + + +
NameDescription
processInstanceId* + + +
+
+
+ + String + + +
+
+ Required +
+
+
+
+ + + + + +

Responses

+

Status: 200 - A ActivityInstanceDetail object

+ + + +
+
+
+ +
+ +
+
+ +

Status: 204 - Unable to find process instance variables for given process instance ID.

+ + + +
+
+ +

Status: 400 - Unable to find process instance variables for given process instance ID.

+ + + +
+
+ +

Status: 500 - Unable to find process instance variables for given process instance ID.

+ + + +
+
+ +
+
+
+
+
+

GetInfraActiveRequests

+
+
+
+

getInfraActiveRequests

+

Search infra active request for given parameter map and parameters

+
+
+
+

+

+

+
+
/so/monitoring/v1/search
+

+

Usage and SDK Samples

+

+ + +
+
+
curl -X POST "http://localhost/so/monitoring/v1/search?from=&to=&maxResult="
+
+
+
import io.swagger.client.*;
+import io.swagger.client.auth.*;
+import io.swagger.client.model.*;
+import io.swagger.client.api.GetInfraActiveRequestsApi;
+
+import java.io.File;
+import java.util.*;
+
+public class GetInfraActiveRequestsApiExample {
+
+    public static void main(String[] args) {
+        
+        GetInfraActiveRequestsApi apiInstance = new GetInfraActiveRequestsApi();
+        Object filters = ; // Object | 
+        BigDecimal from = 8.14; // BigDecimal | 
+        BigDecimal to = 8.14; // BigDecimal | 
+        BigDecimal maxResult = 8.14; // BigDecimal | 
+        try {
+            array[inline_response_200_5] result = apiInstance.getInfraActiveRequests(filters, from, to, maxResult);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling GetInfraActiveRequestsApi#getInfraActiveRequests");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+
import io.swagger.client.api.GetInfraActiveRequestsApi;
+
+public class GetInfraActiveRequestsApiExample {
+
+    public static void main(String[] args) {
+        GetInfraActiveRequestsApi apiInstance = new GetInfraActiveRequestsApi();
+        Object filters = ; // Object | 
+        BigDecimal from = 8.14; // BigDecimal | 
+        BigDecimal to = 8.14; // BigDecimal | 
+        BigDecimal maxResult = 8.14; // BigDecimal | 
+        try {
+            array[inline_response_200_5] result = apiInstance.getInfraActiveRequests(filters, from, to, maxResult);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling GetInfraActiveRequestsApi#getInfraActiveRequests");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+
Object *filters = ; // 
+BigDecimal *from = 8.14; // 
+BigDecimal *to = 8.14; // 
+BigDecimal *maxResult = 8.14; //  (optional)
+
+GetInfraActiveRequestsApi *apiInstance = [[GetInfraActiveRequestsApi alloc] init];
+
+// Search infra active request for given parameter map and parameters
+[apiInstance getInfraActiveRequestsWith:filters
+    from:from
+    to:to
+    maxResult:maxResult
+              completionHandler: ^(array[inline_response_200_5] output, NSError* error) {
+                            if (output) {
+                                NSLog(@"%@", output);
+                            }
+                            if (error) {
+                                NSLog(@"Error: %@", error);
+                            }
+                        }];
+
+
+ +
+
var SoMonitoringApIs = require('so_monitoring_ap_is');
+
+var api = new SoMonitoringApIs.GetInfraActiveRequestsApi()
+
+var filters = ; // {Object} 
+
+var from = 8.14; // {BigDecimal} 
+
+var to = 8.14; // {BigDecimal} 
+
+var opts = { 
+  'maxResult': 8.14 // {BigDecimal} 
+};
+
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+};
+api.getInfraActiveRequests(filters, from, to, opts, callback);
+
+
+ + +
+
using System;
+using System.Diagnostics;
+using IO.Swagger.Api;
+using IO.Swagger.Client;
+using IO.Swagger.Model;
+
+namespace Example
+{
+    public class getInfraActiveRequestsExample
+    {
+        public void main()
+        {
+            
+            var apiInstance = new GetInfraActiveRequestsApi();
+            var filters = new Object(); // Object | 
+            var from = 8.14;  // BigDecimal | 
+            var to = 8.14;  // BigDecimal | 
+            var maxResult = 8.14;  // BigDecimal |  (optional) 
+
+            try
+            {
+                // Search infra active request for given parameter map and parameters
+                array[inline_response_200_5] result = apiInstance.getInfraActiveRequests(filters, from, to, maxResult);
+                Debug.WriteLine(result);
+            }
+            catch (Exception e)
+            {
+                Debug.Print("Exception when calling GetInfraActiveRequestsApi.getInfraActiveRequests: " + e.Message );
+            }
+        }
+    }
+}
+
+
+ +
+
<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+$api_instance = new Swagger\Client\Api\GetInfraActiveRequestsApi();
+$filters = ; // Object | 
+$from = 8.14; // BigDecimal | 
+$to = 8.14; // BigDecimal | 
+$maxResult = 8.14; // BigDecimal | 
+
+try {
+    $result = $api_instance->getInfraActiveRequests($filters, $from, $to, $maxResult);
+    print_r($result);
+} catch (Exception $e) {
+    echo 'Exception when calling GetInfraActiveRequestsApi->getInfraActiveRequests: ', $e->getMessage(), PHP_EOL;
+}
+?>
+
+ +
+
use Data::Dumper;
+use WWW::SwaggerClient::Configuration;
+use WWW::SwaggerClient::GetInfraActiveRequestsApi;
+
+my $api_instance = WWW::SwaggerClient::GetInfraActiveRequestsApi->new();
+my $filters = WWW::SwaggerClient::Object::Object->new(); # Object | 
+my $from = 8.14; # BigDecimal | 
+my $to = 8.14; # BigDecimal | 
+my $maxResult = 8.14; # BigDecimal | 
+
+eval { 
+    my $result = $api_instance->getInfraActiveRequests(filters => $filters, from => $from, to => $to, maxResult => $maxResult);
+    print Dumper($result);
+};
+if ($@) {
+    warn "Exception when calling GetInfraActiveRequestsApi->getInfraActiveRequests: $@\n";
+}
+
+ +
+
from __future__ import print_statement
+import time
+import swagger_client
+from swagger_client.rest import ApiException
+from pprint import pprint
+
+# create an instance of the API class
+api_instance = swagger_client.GetInfraActiveRequestsApi()
+filters =  # Object | 
+from = 8.14 # BigDecimal | 
+to = 8.14 # BigDecimal | 
+maxResult = 8.14 # BigDecimal |  (optional)
+
+try: 
+    # Search infra active request for given parameter map and parameters
+    api_response = api_instance.get_infra_active_requests(filters, from, to, maxResult=maxResult)
+    pprint(api_response)
+except ApiException as e:
+    print("Exception when calling GetInfraActiveRequestsApi->getInfraActiveRequests: %s\n" % e)
+
+
+ +

Parameters

+ + + +
Body parameters
+ + + + + + + + + +
NameDescription
filters * + + + +
+
+ + +
Query parameters
+ + + + + + + + + + + + + + + + + +
NameDescription
from* + + +
+
+
+ + BigDecimal + + +
+
+ Required +
+
+
+
to* + + +
+
+
+ + BigDecimal + + +
+
+ Required +
+
+
+
maxResult + + +
+
+
+ + BigDecimal + + +
+
+
+
+ +

Responses

+

Status: 200 - A SoInfraRequest object

+ + + +
+
+
+ +
+ +
+
+ +

Status: 204 - Unable to find search request for given filter and parameters.

+ + + +
+
+ +

Status: 400 - Unable to find search request for given filter and parameters

+ + + +
+
+ +

Status: 500 - Unable to find search request for given filter and parameters

+ + + +
+
+ +
+
+
+
+
+

GetProcessDefinitionXml

+
+
+
+

getProcessDefinitionXml

+

Get process definition for given process definition ID

+
+
+
+

+

+

+
+
/so/monitoring/process-definition/{processDefinitionId}
+

+

Usage and SDK Samples

+

+ + +
+
+
curl -X GET "http://localhost/so/monitoring/process-definition/{processDefinitionId}"
+
+
+
import io.swagger.client.*;
+import io.swagger.client.auth.*;
+import io.swagger.client.model.*;
+import io.swagger.client.api.GetProcessDefinitionXmlApi;
+
+import java.io.File;
+import java.util.*;
+
+public class GetProcessDefinitionXmlApiExample {
+
+    public static void main(String[] args) {
+        
+        GetProcessDefinitionXmlApi apiInstance = new GetProcessDefinitionXmlApi();
+        String processDefinitionId = processDefinitionId_example; // String | 
+        try {
+            inline_response_200_2 result = apiInstance.getProcessDefinitionXml(processDefinitionId);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling GetProcessDefinitionXmlApi#getProcessDefinitionXml");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+
import io.swagger.client.api.GetProcessDefinitionXmlApi;
+
+public class GetProcessDefinitionXmlApiExample {
+
+    public static void main(String[] args) {
+        GetProcessDefinitionXmlApi apiInstance = new GetProcessDefinitionXmlApi();
+        String processDefinitionId = processDefinitionId_example; // String | 
+        try {
+            inline_response_200_2 result = apiInstance.getProcessDefinitionXml(processDefinitionId);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling GetProcessDefinitionXmlApi#getProcessDefinitionXml");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+
String *processDefinitionId = processDefinitionId_example; // 
+
+GetProcessDefinitionXmlApi *apiInstance = [[GetProcessDefinitionXmlApi alloc] init];
+
+// Get process definition for given process definition ID
+[apiInstance getProcessDefinitionXmlWith:processDefinitionId
+              completionHandler: ^(inline_response_200_2 output, NSError* error) {
+                            if (output) {
+                                NSLog(@"%@", output);
+                            }
+                            if (error) {
+                                NSLog(@"Error: %@", error);
+                            }
+                        }];
+
+
+ +
+
var SoMonitoringApIs = require('so_monitoring_ap_is');
+
+var api = new SoMonitoringApIs.GetProcessDefinitionXmlApi()
+
+var processDefinitionId = processDefinitionId_example; // {String} 
+
+
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+};
+api.getProcessDefinitionXml(processDefinitionId, callback);
+
+
+ + +
+
using System;
+using System.Diagnostics;
+using IO.Swagger.Api;
+using IO.Swagger.Client;
+using IO.Swagger.Model;
+
+namespace Example
+{
+    public class getProcessDefinitionXmlExample
+    {
+        public void main()
+        {
+            
+            var apiInstance = new GetProcessDefinitionXmlApi();
+            var processDefinitionId = processDefinitionId_example;  // String | 
+
+            try
+            {
+                // Get process definition for given process definition ID
+                inline_response_200_2 result = apiInstance.getProcessDefinitionXml(processDefinitionId);
+                Debug.WriteLine(result);
+            }
+            catch (Exception e)
+            {
+                Debug.Print("Exception when calling GetProcessDefinitionXmlApi.getProcessDefinitionXml: " + e.Message );
+            }
+        }
+    }
+}
+
+
+ +
+
<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+$api_instance = new Swagger\Client\Api\GetProcessDefinitionXmlApi();
+$processDefinitionId = processDefinitionId_example; // String | 
+
+try {
+    $result = $api_instance->getProcessDefinitionXml($processDefinitionId);
+    print_r($result);
+} catch (Exception $e) {
+    echo 'Exception when calling GetProcessDefinitionXmlApi->getProcessDefinitionXml: ', $e->getMessage(), PHP_EOL;
+}
+?>
+
+ +
+
use Data::Dumper;
+use WWW::SwaggerClient::Configuration;
+use WWW::SwaggerClient::GetProcessDefinitionXmlApi;
+
+my $api_instance = WWW::SwaggerClient::GetProcessDefinitionXmlApi->new();
+my $processDefinitionId = processDefinitionId_example; # String | 
+
+eval { 
+    my $result = $api_instance->getProcessDefinitionXml(processDefinitionId => $processDefinitionId);
+    print Dumper($result);
+};
+if ($@) {
+    warn "Exception when calling GetProcessDefinitionXmlApi->getProcessDefinitionXml: $@\n";
+}
+
+ +
+
from __future__ import print_statement
+import time
+import swagger_client
+from swagger_client.rest import ApiException
+from pprint import pprint
+
+# create an instance of the API class
+api_instance = swagger_client.GetProcessDefinitionXmlApi()
+processDefinitionId = processDefinitionId_example # String | 
+
+try: 
+    # Get process definition for given process definition ID
+    api_response = api_instance.get_process_definition_xml(processDefinitionId)
+    pprint(api_response)
+except ApiException as e:
+    print("Exception when calling GetProcessDefinitionXmlApi->getProcessDefinitionXml: %s\n" % e)
+
+
+ +

Parameters

+ +
Path parameters
+ + + + + + + + + +
NameDescription
processDefinitionId* + + +
+
+
+ + String + + +
+
+ Required +
+
+
+
+ + + + + +

Responses

+

Status: 200 - A ProcessDefinitionDetail object

+ + + +
+
+
+ +
+ +
+
+ +

Status: 204 - Unable to find process definition xml for given process definition ID.

+ + + +
+
+ +

Status: 400 - Unable to find process definition xml for given process definition ID.

+ + + +
+
+ +

Status: 500 - Unable to find process definition xml for given process definition ID.

+ + + +
+
+ +
+
+
+
+
+

GetProcessInstanceId

+
+
+
+

getProcessInstanceId

+

Get process instance ID for given request ID

+
+
+
+

+

+

+
+
/so/monitoring/process-instance-id/{requestId}
+

+

Usage and SDK Samples

+

+ + +
+
+
curl -X GET "http://localhost/so/monitoring/process-instance-id/{requestId}"
+
+
+
import io.swagger.client.*;
+import io.swagger.client.auth.*;
+import io.swagger.client.model.*;
+import io.swagger.client.api.GetProcessInstanceIdApi;
+
+import java.io.File;
+import java.util.*;
+
+public class GetProcessInstanceIdApiExample {
+
+    public static void main(String[] args) {
+        
+        GetProcessInstanceIdApi apiInstance = new GetProcessInstanceIdApi();
+        String requestId = requestId_example; // String | 
+        try {
+            inline_response_200 result = apiInstance.getProcessInstanceId(requestId);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling GetProcessInstanceIdApi#getProcessInstanceId");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+
import io.swagger.client.api.GetProcessInstanceIdApi;
+
+public class GetProcessInstanceIdApiExample {
+
+    public static void main(String[] args) {
+        GetProcessInstanceIdApi apiInstance = new GetProcessInstanceIdApi();
+        String requestId = requestId_example; // String | 
+        try {
+            inline_response_200 result = apiInstance.getProcessInstanceId(requestId);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling GetProcessInstanceIdApi#getProcessInstanceId");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+
String *requestId = requestId_example; // 
+
+GetProcessInstanceIdApi *apiInstance = [[GetProcessInstanceIdApi alloc] init];
+
+// Get process instance ID for given request ID
+[apiInstance getProcessInstanceIdWith:requestId
+              completionHandler: ^(inline_response_200 output, NSError* error) {
+                            if (output) {
+                                NSLog(@"%@", output);
+                            }
+                            if (error) {
+                                NSLog(@"Error: %@", error);
+                            }
+                        }];
+
+
+ +
+
var SoMonitoringApIs = require('so_monitoring_ap_is');
+
+var api = new SoMonitoringApIs.GetProcessInstanceIdApi()
+
+var requestId = requestId_example; // {String} 
+
+
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+};
+api.getProcessInstanceId(requestId, callback);
+
+
+ + +
+
using System;
+using System.Diagnostics;
+using IO.Swagger.Api;
+using IO.Swagger.Client;
+using IO.Swagger.Model;
+
+namespace Example
+{
+    public class getProcessInstanceIdExample
+    {
+        public void main()
+        {
+            
+            var apiInstance = new GetProcessInstanceIdApi();
+            var requestId = requestId_example;  // String | 
+
+            try
+            {
+                // Get process instance ID for given request ID
+                inline_response_200 result = apiInstance.getProcessInstanceId(requestId);
+                Debug.WriteLine(result);
+            }
+            catch (Exception e)
+            {
+                Debug.Print("Exception when calling GetProcessInstanceIdApi.getProcessInstanceId: " + e.Message );
+            }
+        }
+    }
+}
+
+
+ +
+
<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+$api_instance = new Swagger\Client\Api\GetProcessInstanceIdApi();
+$requestId = requestId_example; // String | 
+
+try {
+    $result = $api_instance->getProcessInstanceId($requestId);
+    print_r($result);
+} catch (Exception $e) {
+    echo 'Exception when calling GetProcessInstanceIdApi->getProcessInstanceId: ', $e->getMessage(), PHP_EOL;
+}
+?>
+
+ +
+
use Data::Dumper;
+use WWW::SwaggerClient::Configuration;
+use WWW::SwaggerClient::GetProcessInstanceIdApi;
+
+my $api_instance = WWW::SwaggerClient::GetProcessInstanceIdApi->new();
+my $requestId = requestId_example; # String | 
+
+eval { 
+    my $result = $api_instance->getProcessInstanceId(requestId => $requestId);
+    print Dumper($result);
+};
+if ($@) {
+    warn "Exception when calling GetProcessInstanceIdApi->getProcessInstanceId: $@\n";
+}
+
+ +
+
from __future__ import print_statement
+import time
+import swagger_client
+from swagger_client.rest import ApiException
+from pprint import pprint
+
+# create an instance of the API class
+api_instance = swagger_client.GetProcessInstanceIdApi()
+requestId = requestId_example # String | 
+
+try: 
+    # Get process instance ID for given request ID
+    api_response = api_instance.get_process_instance_id(requestId)
+    pprint(api_response)
+except ApiException as e:
+    print("Exception when calling GetProcessInstanceIdApi->getProcessInstanceId: %s\n" % e)
+
+
+ +

Parameters

+ +
Path parameters
+ + + + + + + + + +
NameDescription
requestId* + + +
+
+
+ + String + + +
+
+ Required +
+
+
+
+ + + + + +

Responses

+

Status: 200 - A ProcessInstanceIdDetail object

+ + + +
+
+
+ +
+ +
+
+ +

Status: 204 - Unable to find process instance id for given request ID.

+ + + +
+
+ +

Status: 400 - Unable to find process instance id for given request ID.

+ + + +
+
+ +

Status: 500 - Unable to find process instance id for given request ID.

+ + + +
+
+ +
+
+
+
+
+

GetProcessInstanceVariables

+
+
+
+

getProcessInstanceVariables

+

Get process instance variables for given process instance ID

+
+
+
+

+

+

+
+
/so/monitoring/variable-instance/{processInstanceId}
+

+

Usage and SDK Samples

+

+ + +
+
+
curl -X GET "http://localhost/so/monitoring/variable-instance/{processInstanceId}"
+
+
+
import io.swagger.client.*;
+import io.swagger.client.auth.*;
+import io.swagger.client.model.*;
+import io.swagger.client.api.GetProcessInstanceVariablesApi;
+
+import java.io.File;
+import java.util.*;
+
+public class GetProcessInstanceVariablesApiExample {
+
+    public static void main(String[] args) {
+        
+        GetProcessInstanceVariablesApi apiInstance = new GetProcessInstanceVariablesApi();
+        String processInstanceId = processInstanceId_example; // String | 
+        try {
+            inline_response_200_4 result = apiInstance.getProcessInstanceVariables(processInstanceId);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling GetProcessInstanceVariablesApi#getProcessInstanceVariables");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+
import io.swagger.client.api.GetProcessInstanceVariablesApi;
+
+public class GetProcessInstanceVariablesApiExample {
+
+    public static void main(String[] args) {
+        GetProcessInstanceVariablesApi apiInstance = new GetProcessInstanceVariablesApi();
+        String processInstanceId = processInstanceId_example; // String | 
+        try {
+            inline_response_200_4 result = apiInstance.getProcessInstanceVariables(processInstanceId);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling GetProcessInstanceVariablesApi#getProcessInstanceVariables");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+
String *processInstanceId = processInstanceId_example; // 
+
+GetProcessInstanceVariablesApi *apiInstance = [[GetProcessInstanceVariablesApi alloc] init];
+
+// Get process instance variables for given process instance ID
+[apiInstance getProcessInstanceVariablesWith:processInstanceId
+              completionHandler: ^(inline_response_200_4 output, NSError* error) {
+                            if (output) {
+                                NSLog(@"%@", output);
+                            }
+                            if (error) {
+                                NSLog(@"Error: %@", error);
+                            }
+                        }];
+
+
+ +
+
var SoMonitoringApIs = require('so_monitoring_ap_is');
+
+var api = new SoMonitoringApIs.GetProcessInstanceVariablesApi()
+
+var processInstanceId = processInstanceId_example; // {String} 
+
+
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+};
+api.getProcessInstanceVariables(processInstanceId, callback);
+
+
+ + +
+
using System;
+using System.Diagnostics;
+using IO.Swagger.Api;
+using IO.Swagger.Client;
+using IO.Swagger.Model;
+
+namespace Example
+{
+    public class getProcessInstanceVariablesExample
+    {
+        public void main()
+        {
+            
+            var apiInstance = new GetProcessInstanceVariablesApi();
+            var processInstanceId = processInstanceId_example;  // String | 
+
+            try
+            {
+                // Get process instance variables for given process instance ID
+                inline_response_200_4 result = apiInstance.getProcessInstanceVariables(processInstanceId);
+                Debug.WriteLine(result);
+            }
+            catch (Exception e)
+            {
+                Debug.Print("Exception when calling GetProcessInstanceVariablesApi.getProcessInstanceVariables: " + e.Message );
+            }
+        }
+    }
+}
+
+
+ +
+
<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+$api_instance = new Swagger\Client\Api\GetProcessInstanceVariablesApi();
+$processInstanceId = processInstanceId_example; // String | 
+
+try {
+    $result = $api_instance->getProcessInstanceVariables($processInstanceId);
+    print_r($result);
+} catch (Exception $e) {
+    echo 'Exception when calling GetProcessInstanceVariablesApi->getProcessInstanceVariables: ', $e->getMessage(), PHP_EOL;
+}
+?>
+
+ +
+
use Data::Dumper;
+use WWW::SwaggerClient::Configuration;
+use WWW::SwaggerClient::GetProcessInstanceVariablesApi;
+
+my $api_instance = WWW::SwaggerClient::GetProcessInstanceVariablesApi->new();
+my $processInstanceId = processInstanceId_example; # String | 
+
+eval { 
+    my $result = $api_instance->getProcessInstanceVariables(processInstanceId => $processInstanceId);
+    print Dumper($result);
+};
+if ($@) {
+    warn "Exception when calling GetProcessInstanceVariablesApi->getProcessInstanceVariables: $@\n";
+}
+
+ +
+
from __future__ import print_statement
+import time
+import swagger_client
+from swagger_client.rest import ApiException
+from pprint import pprint
+
+# create an instance of the API class
+api_instance = swagger_client.GetProcessInstanceVariablesApi()
+processInstanceId = processInstanceId_example # String | 
+
+try: 
+    # Get process instance variables for given process instance ID
+    api_response = api_instance.get_process_instance_variables(processInstanceId)
+    pprint(api_response)
+except ApiException as e:
+    print("Exception when calling GetProcessInstanceVariablesApi->getProcessInstanceVariables: %s\n" % e)
+
+
+ +

Parameters

+ +
Path parameters
+ + + + + + + + + +
NameDescription
processInstanceId* + + +
+
+
+ + String + + +
+
+ Required +
+
+
+
+ + + + + +

Responses

+

Status: 200 - A ProcessInstanceVariableDetail object

+ + + +
+
+
+ +
+ +
+
+ +

Status: 204 - Unable to find activity instance for given process instance ID.

+ + + +
+
+ +

Status: 400 - Unable to find activity instance for given process instance ID.

+ + + +
+
+ +

Status: 500 - Unable to find activity instance for given process instance ID.

+ + + +
+
+ +
+
+
+
+
+

GetSingleProcessInstance

+
+
+
+

getSingleProcessInstance

+

Get process instance for given process instance ID

+
+
+
+

+

+

+
+
/so/monitoring/process-instance/{processInstanceId}
+

+

Usage and SDK Samples

+

+ + +
+
+
curl -X GET "http://localhost/so/monitoring/process-instance/{processInstanceId}"
+
+
+
import io.swagger.client.*;
+import io.swagger.client.auth.*;
+import io.swagger.client.model.*;
+import io.swagger.client.api.GetSingleProcessInstanceApi;
+
+import java.io.File;
+import java.util.*;
+
+public class GetSingleProcessInstanceApiExample {
+
+    public static void main(String[] args) {
+        
+        GetSingleProcessInstanceApi apiInstance = new GetSingleProcessInstanceApi();
+        String processInstanceId = processInstanceId_example; // String | 
+        try {
+            inline_response_200_1 result = apiInstance.getSingleProcessInstance(processInstanceId);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling GetSingleProcessInstanceApi#getSingleProcessInstance");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+
import io.swagger.client.api.GetSingleProcessInstanceApi;
+
+public class GetSingleProcessInstanceApiExample {
+
+    public static void main(String[] args) {
+        GetSingleProcessInstanceApi apiInstance = new GetSingleProcessInstanceApi();
+        String processInstanceId = processInstanceId_example; // String | 
+        try {
+            inline_response_200_1 result = apiInstance.getSingleProcessInstance(processInstanceId);
+            System.out.println(result);
+        } catch (ApiException e) {
+            System.err.println("Exception when calling GetSingleProcessInstanceApi#getSingleProcessInstance");
+            e.printStackTrace();
+        }
+    }
+}
+
+ +
+
String *processInstanceId = processInstanceId_example; // 
+
+GetSingleProcessInstanceApi *apiInstance = [[GetSingleProcessInstanceApi alloc] init];
+
+// Get process instance for given process instance ID
+[apiInstance getSingleProcessInstanceWith:processInstanceId
+              completionHandler: ^(inline_response_200_1 output, NSError* error) {
+                            if (output) {
+                                NSLog(@"%@", output);
+                            }
+                            if (error) {
+                                NSLog(@"Error: %@", error);
+                            }
+                        }];
+
+
+ +
+
var SoMonitoringApIs = require('so_monitoring_ap_is');
+
+var api = new SoMonitoringApIs.GetSingleProcessInstanceApi()
+
+var processInstanceId = processInstanceId_example; // {String} 
+
+
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+};
+api.getSingleProcessInstance(processInstanceId, callback);
+
+
+ + +
+
using System;
+using System.Diagnostics;
+using IO.Swagger.Api;
+using IO.Swagger.Client;
+using IO.Swagger.Model;
+
+namespace Example
+{
+    public class getSingleProcessInstanceExample
+    {
+        public void main()
+        {
+            
+            var apiInstance = new GetSingleProcessInstanceApi();
+            var processInstanceId = processInstanceId_example;  // String | 
+
+            try
+            {
+                // Get process instance for given process instance ID
+                inline_response_200_1 result = apiInstance.getSingleProcessInstance(processInstanceId);
+                Debug.WriteLine(result);
+            }
+            catch (Exception e)
+            {
+                Debug.Print("Exception when calling GetSingleProcessInstanceApi.getSingleProcessInstance: " + e.Message );
+            }
+        }
+    }
+}
+
+
+ +
+
<?php
+require_once(__DIR__ . '/vendor/autoload.php');
+
+$api_instance = new Swagger\Client\Api\GetSingleProcessInstanceApi();
+$processInstanceId = processInstanceId_example; // String | 
+
+try {
+    $result = $api_instance->getSingleProcessInstance($processInstanceId);
+    print_r($result);
+} catch (Exception $e) {
+    echo 'Exception when calling GetSingleProcessInstanceApi->getSingleProcessInstance: ', $e->getMessage(), PHP_EOL;
+}
+?>
+
+ +
+
use Data::Dumper;
+use WWW::SwaggerClient::Configuration;
+use WWW::SwaggerClient::GetSingleProcessInstanceApi;
+
+my $api_instance = WWW::SwaggerClient::GetSingleProcessInstanceApi->new();
+my $processInstanceId = processInstanceId_example; # String | 
+
+eval { 
+    my $result = $api_instance->getSingleProcessInstance(processInstanceId => $processInstanceId);
+    print Dumper($result);
+};
+if ($@) {
+    warn "Exception when calling GetSingleProcessInstanceApi->getSingleProcessInstance: $@\n";
+}
+
+ +
+
from __future__ import print_statement
+import time
+import swagger_client
+from swagger_client.rest import ApiException
+from pprint import pprint
+
+# create an instance of the API class
+api_instance = swagger_client.GetSingleProcessInstanceApi()
+processInstanceId = processInstanceId_example # String | 
+
+try: 
+    # Get process instance for given process instance ID
+    api_response = api_instance.get_single_process_instance(processInstanceId)
+    pprint(api_response)
+except ApiException as e:
+    print("Exception when calling GetSingleProcessInstanceApi->getSingleProcessInstance: %s\n" % e)
+
+
+ +

Parameters

+ +
Path parameters
+ + + + + + + + + +
NameDescription
processInstanceId* + + +
+
+
+ + String + + +
+
+ Required +
+
+
+
+ + + + + +

Responses

+

Status: 200 - A ProcessInstanceDetail object

+ + + +
+
+
+ +
+ +
+
+ +

Status: 204 - Unable to find process instance for given process instance ID.

+ + + +
+
+ +

Status: 400 - Unable to find process instance for given process instance ID.

+ + + +
+
+ +

Status: 500 - Unable to find process instance for given process instance ID.

+ + + +
+
+ +
+
+
+
+
+ +
+
+ Generated 2018-11-19T03:21:44.307Z +
+
+
+
+
+ + + + + + + + + + + + + + -- cgit 1.2.3-korg From 5a1de7b9e5099b6c14c520932bfb07cdc93a3802 Mon Sep 17 00:00:00 2001 From: seshukm Date: Mon, 19 Nov 2018 11:45:55 +0800 Subject: Add deployment view of SO Issue-ID: SO-1230 Change-Id: If22f26eb3628125789733dd4b3282c7cfd40c5c1 Signed-off-by: seshukm --- docs/architecture/architecture.rst | 10 +++++++++- docs/images/SO_Architecture_Internal.png | Bin 0 -> 33832 bytes 2 files changed, 9 insertions(+), 1 deletion(-) create mode 100644 docs/images/SO_Architecture_Internal.png (limited to 'docs') diff --git a/docs/architecture/architecture.rst b/docs/architecture/architecture.rst index 6ca11cd6b3..681e9dbfe5 100644 --- a/docs/architecture/architecture.rst +++ b/docs/architecture/architecture.rst @@ -5,8 +5,16 @@ SO - Architecture =============== +SO Functional View +-------------------- + .. image:: ../images/SO_Architecture_1.png +SO Deployment View +-------------------- + +.. image:: ../images/SO_Architecture_Internal.png + SO Sub-Components ------------------ @@ -47,7 +55,7 @@ SO Sub-Components **Resource Adapters** Interfaces to lower level controllers and other ONAP components - * Platform Orchestrator, SDN-Controller, APP-Controller, VFC-Controllers + * Platform Orchestrator, SDN-Controller, APP-Controller, VFC-Controllers, Multi-Cloud * Hides the details of complex interfaces (e.g. OpenStack APIs) * Expose interfaces to BPMN flows as SOAP or REST APIs * Support synchronous and asynchronous operations diff --git a/docs/images/SO_Architecture_Internal.png b/docs/images/SO_Architecture_Internal.png new file mode 100644 index 0000000000..9c30c4d7b5 Binary files /dev/null and b/docs/images/SO_Architecture_Internal.png differ -- cgit 1.2.3-korg From bb4591264f2e4e74b6f326ca007a2cf034297480 Mon Sep 17 00:00:00 2001 From: seshukm Date: Wed, 28 Nov 2018 20:41:09 +0800 Subject: Draft release notes Issue-ID: SO-1259 Change-Id: I81adcdddd52ff28629b73a6d61c5d9ad00e38ceb Signed-off-by: seshukm --- docs/release_notes/release-notes.rst | 38 ++++++++++++++++++++++++++++++++++++ 1 file changed, 38 insertions(+) (limited to 'docs') diff --git a/docs/release_notes/release-notes.rst b/docs/release_notes/release-notes.rst index 4ca1a01953..45daa9f82e 100644 --- a/docs/release_notes/release-notes.rst +++ b/docs/release_notes/release-notes.rst @@ -8,6 +8,44 @@ Service Orchestrator Release Notes The SO provides the highest level of service orchestration in the ONAP architecture. +Version: 1.3.3 +-------------- + +:Release Date: 2018-11-30 + +This is the official release package that was tested against the 72 hour stability test in integration environment. + +Casablanca Release branch +*New Features** + +Below features are delivered in this release: +* Support PNF resource type. +* Extend the support of homing to vFW, vCPE usecases. +* Workflow Designer Integration. +* Monitoring BPMN worflow capabilities through UI. +* Support to the CCVPN Usecase. +* SO internal architecture improvements. + +**Bug Fixes** + + The defects fixed in this release could be found `here `_. + +**Known Issues** + + There are some issues around the HPA and CCVPN that have been resolved in the patch release of 1.3.4. + SO-1249 + + The other open issues are + SO-1257 + SO-1248 + SO-1219 + These will be addressed in the next release. + +**Security Notes** + + SO code has been formally scanned during build time using NexusIQ and all Critical vulnerabilities have been addressed, items that remain open have been assessed for risk and determined to be false positive. The SO open Critical security vulnerabilities and their risk assessment have been documented as part of the `project `_. + + Version: 1.3.1 -------------- -- cgit 1.2.3-korg From 2dcb061270c02633f2221ae3aeff4396b9a58543 Mon Sep 17 00:00:00 2001 From: seshukm Date: Thu, 29 Nov 2018 10:47:31 +0800 Subject: Refactor the release notes Issue-ID: SO-1259 Change-Id: Ice9fc46f3d4a6bd416c93e8ac3ad51ee17330034 Signed-off-by: seshukm --- docs/release-notes.rst | 173 +++++++++++++++++++++++++++++++++++ docs/release_notes/release-notes.rst | 172 ---------------------------------- 2 files changed, 173 insertions(+), 172 deletions(-) create mode 100644 docs/release-notes.rst delete mode 100644 docs/release_notes/release-notes.rst (limited to 'docs') diff --git a/docs/release-notes.rst b/docs/release-notes.rst new file mode 100644 index 0000000000..b857ef9959 --- /dev/null +++ b/docs/release-notes.rst @@ -0,0 +1,173 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. Copyright 2018 Huawei Intellectual Property. All rights reserved. + + +Service Orchestrator Release Notes +================================== + +The SO provides the highest level of service orchestration in the ONAP architecture. + +Version: 1.3.3 +-------------- + +:Release Date: 2018-11-30 + +This is the official release package that was tested against the 72 hour stability test in integration environment. + +Casablanca Release branch +*New Features** + +Below features are delivered in this release: +* Support PNF resource type. +* Extend the support of homing to vFW, vCPE usecases. +* Workflow Designer Integration. +* Monitoring BPMN workflow capabilities through UI. +* Support to the CCVPN Usecase. +* SO internal architecture improvements. +* Auto scale out of VNFs. + +**Bug Fixes** + + The defects fixed in this release could be found `here `_. + +**Known Issues** + + There are some issues around the HPA and CCVPN that have been resolved in the patch release of 1.3.4. + SO-1249 + + The other open issues are + SO-1257 + SO-1248 + SO-1219 + These will be addressed in the next release. + +**Security Notes** + + SO code has been formally scanned during build time using NexusIQ and all Critical vulnerabilities have been addressed, items that remain open have been assessed for risk and determined to be false positive. The SO open Critical security vulnerabilities and their risk assessment have been documented as part of the `project `_. + + +Version: 1.3.1 +-------------- + +:Release Date: 2018-10-24 + +Branch cut for Casablanca post M4 for integration test. +**New Features** + +Below features are under test: +* Support PNF resource type. +* Extend the support of homing to vFW, VDNS usecases. +* Workflow Designer Integration. +* Monitoring BPMN worflow capabilities through UI. +* Support to the CCVPN Usecase. +* SO internal architecture improvements + +Version: 1.3.0 +-------------- + +:Release Date: 2018-08-22 + +New release over master branch for Casablanca development + +Version: 1.2.2 +-------------- + +:Release Date: 2018-06-07 + +The Beijing release is the second release of the Service Orchestrator (SO) project. + +**New Features** + +* Enhance Platform maturity by improving SO maturity matrix see `Wiki `_. +* Manual scaling of network services and VNFs. +* Homing and placement capabilities through OOF interaction. +* Ability to perform change management. +* Integrated to APPC +* Integrated to OOF +* Integrated to OOM + +**Bug Fixes** + + The defects fixed in this release could be found `here `_. + +**Known Issues** + + SO docker image is still on ecmop and not onap in the repository. + This will be addressed in the next release. + +**Security Notes** + + SO code has been formally scanned during build time using NexusIQ and all Critical vulnerabilities have been addressed, items that remain open have been assessed for risk and determined to be false positive. The SO open Critical security vulnerabilities and their risk assessment have been documented as part of the `project `_. + +Quick Links: + +- `SO project page `_ +- `Passing Badge information for SO `_ +- `Project Vulnerability Review Table for SO `_ + +**Upgrade Notes** + NA + +**Deprecation Notes** + NA + +Version: 1.1.2 +-------------- + +:Release Date: 2018-01-18 + +Bug Fixes +--------- +The key defects fixed in this release : + +- `SO-344 `_ + Only pass one VNF to DoCreateVnfAndModules. + +- `SO-348 `_ + Json Analyze Exception in PreProcessRequest. + +- `SO-352 `_ + SO failed to create VNF - with error message: Internal Error Occurred in CreateVnfInfra QueryCatalogDB Process. + +- `SO-354 `_ + Change the Service Type And Service Role + + +Version: 1.1.1 +-------------- + +:Release Date: 2017-11-16 + + +**New Features** + +The SO provides the highest level of service orchestration in the ONAP architecture. +It executes end-to-end service activities by processing workflows and business logic and coordinating other ONAP and external component activities. + +The orchestration engine is a reusable service. Any component of the architecture can execute SO orchestration capabilities. + +* Orchestration services will process workflows based on defined models and recipe. +* The service model maintains consistency and re-usability across all orchestration activities and ensures consistent methods, structure and version of the workflow execution environment. +* Orchestration processes interact with other platform components or external systems via standard and well-defined APIs. + + +**Deprecation Notes** + +There is a MSO 1.0.0 SO implementation existing in the pre-R1 ONAP Gerrit system. +The MSO1.0.0 is deprecated by the R1 release and the current release is built over this release. +The Gerrit repos of mso/* are voided and already locked as read-only. +Following are the deprecated SO projects in gerrit repo: + +- mso +- mso/chef-repo +- mso/docker-config +- mso/libs +- mso/mso-config + +**Other** + NA + +=========== + +End of Release Notes diff --git a/docs/release_notes/release-notes.rst b/docs/release_notes/release-notes.rst deleted file mode 100644 index 45daa9f82e..0000000000 --- a/docs/release_notes/release-notes.rst +++ /dev/null @@ -1,172 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 -.. Copyright 2018 Huawei Intellectual Property. All rights reserved. - - -Service Orchestrator Release Notes -================================== - -The SO provides the highest level of service orchestration in the ONAP architecture. - -Version: 1.3.3 --------------- - -:Release Date: 2018-11-30 - -This is the official release package that was tested against the 72 hour stability test in integration environment. - -Casablanca Release branch -*New Features** - -Below features are delivered in this release: -* Support PNF resource type. -* Extend the support of homing to vFW, vCPE usecases. -* Workflow Designer Integration. -* Monitoring BPMN worflow capabilities through UI. -* Support to the CCVPN Usecase. -* SO internal architecture improvements. - -**Bug Fixes** - - The defects fixed in this release could be found `here `_. - -**Known Issues** - - There are some issues around the HPA and CCVPN that have been resolved in the patch release of 1.3.4. - SO-1249 - - The other open issues are - SO-1257 - SO-1248 - SO-1219 - These will be addressed in the next release. - -**Security Notes** - - SO code has been formally scanned during build time using NexusIQ and all Critical vulnerabilities have been addressed, items that remain open have been assessed for risk and determined to be false positive. The SO open Critical security vulnerabilities and their risk assessment have been documented as part of the `project `_. - - -Version: 1.3.1 --------------- - -:Release Date: 2018-10-24 - -Branch cut for Casablanca post M4 for integration test. -**New Features** - -Below features are under test: -* Support PNF resource type. -* Extend the support of homing to vFW, VDNS usecases. -* Workflow Designer Integration. -* Monitoring BPMN worflow capabilities through UI. -* Support to the CCVPN Usecase. -* SO internal architecture improvements - -Version: 1.3.0 --------------- - -:Release Date: 2018-08-22 - -New release over master branch for Casablanca development - -Version: 1.2.2 --------------- - -:Release Date: 2018-06-07 - -The Beijing release is the second release of the Service Orchestrator (SO) project. - -**New Features** - -* Enhance Platform maturity by improving SO maturity matrix see `Wiki `_. -* Manual scaling of network services and VNFs. -* Homing and placement capabilities through OOF interaction. -* Ability to perform change management. -* Integrated to APPC -* Integrated to OOF -* Integrated to OOM - -**Bug Fixes** - - The defects fixed in this release could be found `here `_. - -**Known Issues** - - SO docker image is still on ecmop and not onap in the repository. - This will be addressed in the next release. - -**Security Notes** - - SO code has been formally scanned during build time using NexusIQ and all Critical vulnerabilities have been addressed, items that remain open have been assessed for risk and determined to be false positive. The SO open Critical security vulnerabilities and their risk assessment have been documented as part of the `project `_. - -Quick Links: - -- `SO project page `_ -- `Passing Badge information for SO `_ -- `Project Vulnerability Review Table for SO `_ - -**Upgrade Notes** - NA - -**Deprecation Notes** - NA - -Version: 1.1.2 --------------- - -:Release Date: 2018-01-18 - -Bug Fixes ---------- -The key defects fixed in this release : - -- `SO-344 `_ - Only pass one VNF to DoCreateVnfAndModules. - -- `SO-348 `_ - Json Analyze Exception in PreProcessRequest. - -- `SO-352 `_ - SO failed to create VNF - with error message: Internal Error Occurred in CreateVnfInfra QueryCatalogDB Process. - -- `SO-354 `_ - Change the Service Type And Service Role - - -Version: 1.1.1 --------------- - -:Release Date: 2017-11-16 - - -**New Features** - -The SO provides the highest level of service orchestration in the ONAP architecture. -It executes end-to-end service activities by processing workflows and business logic and coordinating other ONAP and external component activities. - -The orchestration engine is a reusable service. Any component of the architecture can execute SO orchestration capabilities. - -* Orchestration services will process workflows based on defined models and recipe. -* The service model maintains consistency and re-usability across all orchestration activities and ensures consistent methods, structure and version of the workflow execution environment. -* Orchestration processes interact with other platform components or external systems via standard and well-defined APIs. - - -**Deprecation Notes** - -There is a MSO 1.0.0 SO implementation existing in the pre-R1 ONAP Gerrit system. -The MSO1.0.0 is deprecated by the R1 release and the current release is built over this release. -The Gerrit repos of mso/* are voided and already locked as read-only. -Following are the deprecated SO projects in gerrit repo: - -- mso -- mso/chef-repo -- mso/docker-config -- mso/libs -- mso/mso-config - -**Other** - NA - -=========== - -End of Release Notes -- cgit 1.2.3-korg From ab8afeacffc8e147ec7bb378c26d4ed61db2338e Mon Sep 17 00:00:00 2001 From: seshukm Date: Thu, 29 Nov 2018 11:22:10 +0800 Subject: Correction of the links Issue-ID: SO-1259 Change-Id: I0ac6d0ea371c62be119e49e830c3cbb865a9c239 Signed-off-by: seshukm --- docs/release-notes.rst | 27 +++++++++++++++------------ 1 file changed, 15 insertions(+), 12 deletions(-) (limited to 'docs') diff --git a/docs/release-notes.rst b/docs/release-notes.rst index b857ef9959..51516fd51b 100644 --- a/docs/release-notes.rst +++ b/docs/release-notes.rst @@ -19,33 +19,36 @@ Casablanca Release branch *New Features** Below features are delivered in this release: -* Support PNF resource type. -* Extend the support of homing to vFW, vCPE usecases. -* Workflow Designer Integration. +* Automatic scale out of VNFs. +* Extend the support of homing to vFW, vCPE usecases through HPA. * Monitoring BPMN workflow capabilities through UI. -* Support to the CCVPN Usecase. * SO internal architecture improvements. -* Auto scale out of VNFs. +* Support PNF resource type. +* Support to the CCVPN Usecase. +* Workflow Designer Integration. -**Bug Fixes** - The defects fixed in this release could be found `here `_. **Known Issues** There are some issues around the HPA and CCVPN that have been resolved in the patch release of 1.3.4. - SO-1249 + https://jira.onap.org/browse/SO-1249 The other open issues are - SO-1257 - SO-1248 - SO-1219 + https://jira.onap.org/browse/SO-1257 + https://jira.onap.org/browse/SO-1248 + https://jira.onap.org/browse/SO-1219 These will be addressed in the next release. **Security Notes** - SO code has been formally scanned during build time using NexusIQ and all Critical vulnerabilities have been addressed, items that remain open have been assessed for risk and determined to be false positive. The SO open Critical security vulnerabilities and their risk assessment have been documented as part of the `project `_. + SO code has been formally scanned during build time using NexusIQ and all Critical vulnerabilities have been addressed, items that remain open have been assessed for risk and determined to be false positive. The SO open Critical security vulnerabilities and their risk assessment have been documented as part of the `project `_. + +Quick Links: +- `SO project page `_ +- `Passing Badge information for SO `_ +- `Project Vulnerability Review Table for SO `_ Version: 1.3.1 -------------- -- cgit 1.2.3-korg From 15fbc33801d2831339ab772d4ba5972b2684c217 Mon Sep 17 00:00:00 2001 From: seshukm Date: Thu, 29 Nov 2018 11:46:03 +0800 Subject: Correction of the links Issue-ID: SO-1259 Change-Id: Ie7b333bbb7b009e35456bbd2a48216f0f10c83e9 Signed-off-by: seshukm --- docs/release-notes.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) (limited to 'docs') diff --git a/docs/release-notes.rst b/docs/release-notes.rst index 51516fd51b..8ed5766b93 100644 --- a/docs/release-notes.rst +++ b/docs/release-notes.rst @@ -32,12 +32,12 @@ Below features are delivered in this release: **Known Issues** There are some issues around the HPA and CCVPN that have been resolved in the patch release of 1.3.4. - https://jira.onap.org/browse/SO-1249 + - `SO-1249 https://jira.onap.org/browse/SO-1249>`_ The other open issues are - https://jira.onap.org/browse/SO-1257 - https://jira.onap.org/browse/SO-1248 - https://jira.onap.org/browse/SO-1219 + - `SO-1259 `_ + - `SO-1248 `_ + - `SO-1219 `_ These will be addressed in the next release. **Security Notes** -- cgit 1.2.3-korg From a3c07c4c9595d7c1f87343f9606b15fd3082c4d8 Mon Sep 17 00:00:00 2001 From: seshukm Date: Thu, 29 Nov 2018 13:00:50 +0800 Subject: Alignment correction Issue-ID: SO-1259 Change-Id: I2d759f101fd04117a58cab9d82e44abf2adc62fc Signed-off-by: seshukm --- docs/release-notes.rst | 37 ++++++++++++++++++++----------------- 1 file changed, 20 insertions(+), 17 deletions(-) (limited to 'docs') diff --git a/docs/release-notes.rst b/docs/release-notes.rst index 8ed5766b93..88d16bbce3 100644 --- a/docs/release-notes.rst +++ b/docs/release-notes.rst @@ -16,35 +16,38 @@ Version: 1.3.3 This is the official release package that was tested against the 72 hour stability test in integration environment. Casablanca Release branch -*New Features** -Below features are delivered in this release: -* Automatic scale out of VNFs. -* Extend the support of homing to vFW, vCPE usecases through HPA. -* Monitoring BPMN workflow capabilities through UI. -* SO internal architecture improvements. -* Support PNF resource type. -* Support to the CCVPN Usecase. -* Workflow Designer Integration. +**New Features** + +Features are delivered in this release: + +- Automatic scale out of VNFs. +- Extend the support of homing to vFW, vCPE usecases through HPA. +- Monitoring BPMN workflow capabilities through UI. +- SO internal architecture improvements. +- Support PNF resource type. +- Support to the CCVPN Usecase. +- Workflow Designer Integration. **Known Issues** - There are some issues around the HPA and CCVPN that have been resolved in the patch release of 1.3.4. - - `SO-1249 https://jira.onap.org/browse/SO-1249>`_ +There are some issues around the HPA and CCVPN that have been resolved in the patch release of 1.3.4 +- `SO-1249 `_ - The other open issues are - - `SO-1259 `_ - - `SO-1248 `_ - - `SO-1219 `_ - These will be addressed in the next release. +Below issues will be resolved in the next release: + +- `SO-1259 `_ +- `SO-1248 `_ +- `SO-1219 `_ + **Security Notes** SO code has been formally scanned during build time using NexusIQ and all Critical vulnerabilities have been addressed, items that remain open have been assessed for risk and determined to be false positive. The SO open Critical security vulnerabilities and their risk assessment have been documented as part of the `project `_. -Quick Links: + Quick Links: - `SO project page `_ - `Passing Badge information for SO `_ -- cgit 1.2.3-korg From 19224c2a128208b170f45a2471795233f1511982 Mon Sep 17 00:00:00 2001 From: seshukm Date: Thu, 29 Nov 2018 13:13:57 +0800 Subject: Add Docker info Issue-ID: SO-1259 Change-Id: Iec30c7f366427fbd05ca51f350992e958db93100 Signed-off-by: seshukm --- docs/release-notes.rst | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) (limited to 'docs') diff --git a/docs/release-notes.rst b/docs/release-notes.rst index 88d16bbce3..8fab2f36d6 100644 --- a/docs/release-notes.rst +++ b/docs/release-notes.rst @@ -29,7 +29,19 @@ Features are delivered in this release: - Support to the CCVPN Usecase. - Workflow Designer Integration. - +**Docker Images** + +Dockers released for SO: + +- onap/so/api-handler-infra,1.3.3 +- onap/so/bpmn-infra,1.3.3 +- onap/so/catalog-db-adapter,1.3.3 +- onap/so/openstack-adapter,1.3.3 +- onap/so/request-db-adapter,1.3.3 +- onap/so/sdc-controller,1.3.3 +- onap/so/sdnc-adapter,1.3.3 +- onap/so/so-monitoring,1.3.3 +- onap/so/vfc-adapter,1.3.3 **Known Issues** -- cgit 1.2.3-korg From d41562d3f432a81930ccc6cc4c16f74cce238314 Mon Sep 17 00:00:00 2001 From: seshukm Date: Thu, 29 Nov 2018 16:00:40 +0800 Subject: Update the known issues Issue-ID: SO-1259 Change-Id: I0d216c244784fbf558f35302e6b5e8540f6cb58b Signed-off-by: seshukm --- docs/release-notes.rst | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) (limited to 'docs') diff --git a/docs/release-notes.rst b/docs/release-notes.rst index 8fab2f36d6..b7c9888d4d 100644 --- a/docs/release-notes.rst +++ b/docs/release-notes.rst @@ -50,9 +50,10 @@ There are some issues around the HPA and CCVPN that have been resolved in the pa Below issues will be resolved in the next release: -- `SO-1259 `_ +- `SO-1258 `_ +- `SO-1257 `_ +- `SO-1256 `_ - `SO-1248 `_ -- `SO-1219 `_ **Security Notes** -- cgit 1.2.3-korg From 97c73c11671660477960f6242359e54a7bec3d3a Mon Sep 17 00:00:00 2001 From: seshukm Date: Thu, 29 Nov 2018 21:12:42 +0800 Subject: Fix the alignment issues Issue-ID: SO-1259 Change-Id: I485b96b0ae3c6f4b39826db1272e5a73dbad784b Signed-off-by: seshukm --- docs/release-notes.rst | 40 ++++++++++++++++++++-------------------- 1 file changed, 20 insertions(+), 20 deletions(-) (limited to 'docs') diff --git a/docs/release-notes.rst b/docs/release-notes.rst index b7c9888d4d..2b79f26b78 100644 --- a/docs/release-notes.rst +++ b/docs/release-notes.rst @@ -19,29 +19,29 @@ Casablanca Release branch **New Features** -Features are delivered in this release: +Features delivered in this release: -- Automatic scale out of VNFs. -- Extend the support of homing to vFW, vCPE usecases through HPA. -- Monitoring BPMN workflow capabilities through UI. -- SO internal architecture improvements. -- Support PNF resource type. -- Support to the CCVPN Usecase. -- Workflow Designer Integration. + - Automatic scale out of VNFs. + - Extend the support of homing to vFW, vCPE usecases through HPA. + - Monitoring BPMN workflow capabilities through UI. + - SO internal architecture improvements. + - Support PNF resource type. + - Support to the CCVPN Usecase. + - Workflow Designer Integration. **Docker Images** Dockers released for SO: -- onap/so/api-handler-infra,1.3.3 -- onap/so/bpmn-infra,1.3.3 -- onap/so/catalog-db-adapter,1.3.3 -- onap/so/openstack-adapter,1.3.3 -- onap/so/request-db-adapter,1.3.3 -- onap/so/sdc-controller,1.3.3 -- onap/so/sdnc-adapter,1.3.3 -- onap/so/so-monitoring,1.3.3 -- onap/so/vfc-adapter,1.3.3 + - onap/so/api-handler-infra,1.3.3 + - onap/so/bpmn-infra,1.3.3 + - onap/so/catalog-db-adapter,1.3.3 + - onap/so/openstack-adapter,1.3.3 + - onap/so/request-db-adapter,1.3.3 + - onap/so/sdc-controller,1.3.3 + - onap/so/sdnc-adapter,1.3.3 + - onap/so/so-monitoring,1.3.3 + - onap/so/vfc-adapter,1.3.3 **Known Issues** @@ -62,9 +62,9 @@ Below issues will be resolved in the next release: Quick Links: -- `SO project page `_ -- `Passing Badge information for SO `_ -- `Project Vulnerability Review Table for SO `_ + - `SO project page `_ + - `Passing Badge information for SO `_ + - `Project Vulnerability Review Table for SO `_ Version: 1.3.1 -------------- -- cgit 1.2.3-korg From afa0eaee73a5ee9b19553d04cf685f9a29fbbd6d Mon Sep 17 00:00:00 2001 From: seshukm Date: Thu, 29 Nov 2018 21:38:10 +0800 Subject: Fix the 1.3.1 alignment Issue-ID: SO-1259 Change-Id: Icc2041b5e38ed8f979e13eb0cca78c696d6b9df4 Signed-off-by: seshukm --- docs/release-notes.rst | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) (limited to 'docs') diff --git a/docs/release-notes.rst b/docs/release-notes.rst index 2b79f26b78..ee558f9a73 100644 --- a/docs/release-notes.rst +++ b/docs/release-notes.rst @@ -75,12 +75,14 @@ Branch cut for Casablanca post M4 for integration test. **New Features** Below features are under test: -* Support PNF resource type. -* Extend the support of homing to vFW, VDNS usecases. -* Workflow Designer Integration. -* Monitoring BPMN worflow capabilities through UI. -* Support to the CCVPN Usecase. -* SO internal architecture improvements + - Automatic scale out of VNFs. + - Extend the support of homing to vFW, vCPE usecases through HPA. + - Monitoring BPMN workflow capabilities through UI. + - SO internal architecture improvements. + - Support PNF resource type. + - Support to the CCVPN Usecase. + - Workflow Designer Integration. + Version: 1.3.0 -------------- -- cgit 1.2.3-korg From f8e7af7517c6a825ec252ec38475a7e08bdeb41f Mon Sep 17 00:00:00 2001 From: seshukm Date: Thu, 29 Nov 2018 22:36:25 +0800 Subject: Update the defect for the 1.3.5 Issue-ID: SO-1259 Change-Id: Ib1139e634be7192b9399a920c308331b90b4dab8 Signed-off-by: seshukm --- docs/release-notes.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) (limited to 'docs') diff --git a/docs/release-notes.rst b/docs/release-notes.rst index ee558f9a73..655c313b3f 100644 --- a/docs/release-notes.rst +++ b/docs/release-notes.rst @@ -45,8 +45,9 @@ Dockers released for SO: **Known Issues** -There are some issues around the HPA and CCVPN that have been resolved in the patch release of 1.3.4 +There are some issues around the HPA and CCVPN that have been resolved in the patch release of 1.3.5 - `SO-1249 `_ +- `SO-1257 `_ Below issues will be resolved in the next release: -- cgit 1.2.3-korg From e2d6619da40b62f80ab3e3278fc67ea60160bcc9 Mon Sep 17 00:00:00 2001 From: seshukm Date: Fri, 30 Nov 2018 11:56:28 +0800 Subject: update the 1.3.5 issue list Issue-ID: SO-1259 Change-Id: If391e140873dc4fece29726ada6ab58cf126f830 Signed-off-by: seshukm --- docs/release-notes.rst | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) (limited to 'docs') diff --git a/docs/release-notes.rst b/docs/release-notes.rst index 655c313b3f..1cb4ba1778 100644 --- a/docs/release-notes.rst +++ b/docs/release-notes.rst @@ -48,14 +48,13 @@ Dockers released for SO: There are some issues around the HPA and CCVPN that have been resolved in the patch release of 1.3.5 - `SO-1249 `_ - `SO-1257 `_ - -Below issues will be resolved in the next release: - - `SO-1258 `_ -- `SO-1257 `_ - `SO-1256 `_ +- `SO-1194 `_ + +Below issues will be resolved in the next release: - `SO-1248 `_ - +- `SO-1184 `_ **Security Notes** -- cgit 1.2.3-korg From a0f26d934ed91a68553b3d9991ac9126ddb08735 Mon Sep 17 00:00:00 2001 From: seshukm Date: Fri, 30 Nov 2018 13:20:49 +0800 Subject: to correct the incorrect Issue-ID: SO-1259 Change-Id: I1acd1165ca20c5616236bbec74d684fb8ee7acf9 Signed-off-by: seshukm --- docs/api/offered_consumed_apis.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs') diff --git a/docs/api/offered_consumed_apis.rst b/docs/api/offered_consumed_apis.rst index d6791d3437..4521604a0d 100644 --- a/docs/api/offered_consumed_apis.rst +++ b/docs/api/offered_consumed_apis.rst @@ -5,7 +5,7 @@ SO Offered and Consumed APIs ===================================== -The list of APIs that SO offerers could be found in the following table: +The list of APIs that SO offers can be found in following table: .. |yml-icon| image:: swagger/images/yaml.png :width: 40px -- cgit 1.2.3-korg From 8a98627029dc451f3511182b5a56c5321f3b9b89 Mon Sep 17 00:00:00 2001 From: seshukm Date: Thu, 3 Jan 2019 09:28:29 +0800 Subject: update the SO detailed api Issue-ID: SO-1337 Change-Id: Ic18a2119aea7dcfa1c41724f5c8db1f6a44dc703 Signed-off-by: seshukm --- docs/api/offered_consumed_apis.rst | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) (limited to 'docs') diff --git a/docs/api/offered_consumed_apis.rst b/docs/api/offered_consumed_apis.rst index 4521604a0d..f6b593a84d 100644 --- a/docs/api/offered_consumed_apis.rst +++ b/docs/api/offered_consumed_apis.rst @@ -31,4 +31,6 @@ The list of APIs that SO offerers for monitroing the BPMN flows could be found i "swagger json file", "yaml doc" ":download:`link `", ":download:`link `" - \ No newline at end of file + +Detailed documentation can be found here: + SO_Interface.rst \ No newline at end of file -- cgit 1.2.3-korg From a72f6235bdb396763950fc1cd8251a2338f9018b Mon Sep 17 00:00:00 2001 From: seshukm Date: Sat, 5 Jan 2019 04:22:05 -0800 Subject: Update the api content Issue-ID: SO-1337 Change-Id: Ibecfd3d4d065af95b1e3287e8d2063443a75f86b Signed-off-by: seshukm --- docs/api/SO_Interface.rst | 4479 ------------------------------------ docs/api/apis/SO_Interface.rst | 4479 ++++++++++++++++++++++++++++++++++++ docs/api/offered_consumed_apis.rst | 6 +- 3 files changed, 4484 insertions(+), 4480 deletions(-) delete mode 100644 docs/api/SO_Interface.rst create mode 100644 docs/api/apis/SO_Interface.rst (limited to 'docs') diff --git a/docs/api/SO_Interface.rst b/docs/api/SO_Interface.rst deleted file mode 100644 index 4f3d9146e4..0000000000 --- a/docs/api/SO_Interface.rst +++ /dev/null @@ -1,4479 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 -.. Copyright 2018 Huawei Technologies Co., Ltd. - -SO Interfaces -================================ - -.. image:: ../images/SO_1.png - -SO APIs ----------------- - -North Bound APIs ----------------- -Create service instance -++++++++++++++++++++++++ - -+--------------------+-------------------------------------+ -|Interface Definition|Description | -+====================+=====================================+ -|URI |/onap/so/infra/serviceInstantiation/serviceInstances/v6 | -+--------------------+-------------------------------------+ -|Operation Type |POST | -+--------------------+-------------------------------------+ -|Content-Type |application/json | -+--------------------+-------------------------------------+ - -Request Body: - -+----------------+---------+-----------+--------------------------+-------------------------------------------+ -|Attribute |Qualifier|Cardinality|Content |Description | -+================+=========+===========+==========================+===========================================+ -|requestDetails |M |1 |requestDetails Object |Content of requestDetails object. | -+----------------+---------+-----------+--------------------------+-------------------------------------------+ - -RequestDetails Object - -+-------------------+--------------------------+-------------------------------------------------+ -|Attribute |Content |Description | -+===================+==========================+=================================================+ -|modelInfo |modelInfo Object |Content of modelInfo object. | -+-------------------+--------------------------+-------------------------------------------------+ -|subscriberInfo |subscriberInfo Object |Content of subscriberInfo object. | -+-------------------+--------------------------+-------------------------------------------------+ -|requestInfo |requestInfo Object |Content of requestInfo object. | -+-------------------+--------------------------+-------------------------------------------------+ -|requestParameters |requestParameters Object |Content of requestParameters object. | -+-------------------+--------------------------+-------------------------------------------------+ -|relatedInstanceList|relatedInstanceList Object|Content of relatedInstanceList object. | -+-------------------+--------------------------+-------------------------------------------------+ -|cloudConfiguration |cloudConfiguration Object |Content of cloudConfiguration object. | -+-------------------+--------------------------+-------------------------------------------------+ -|project |project Object |Content of project object. | -+-------------------+--------------------------+-------------------------------------------------+ -|owningEntity |owningEntity Object |Content of owningEntity object. | -+-------------------+--------------------------+-------------------------------------------------+ -|platform |platform Object |Content of platform object. | -+-------------------+--------------------------+-------------------------------------------------+ -|lineOfBusiness |lineOfBusiness Object |Content of lineOfBusiness object. | -+-------------------+--------------------------+-------------------------------------------------+ - -ModelInfo Object - -+-------------------------+------------------+-------------------------------------------------+ -|Attribute |Content |Description | -+=========================+==================+=================================================+ -|ModelType |String |Type of model | -+-------------------------+------------------+-------------------------------------------------+ -|ModelInvariantId |String |The Model Invariant Id. | -+-------------------------+------------------+-------------------------------------------------+ -|ModelNameVersionId |String |The modelname Version Id | -+-------------------------+------------------+-------------------------------------------------+ -|ModelName |String |Name of the Model | -+-------------------------+------------------+-------------------------------------------------+ -|ModelVersion |String |Version of the model | -+-------------------------+------------------+-------------------------------------------------+ -|ModelCustomization Name |String |The Model Customization name | -+-------------------------+------------------+-------------------------------------------------+ -|modelCustomizationUuid |String |The Model Customization UUid | -+-------------------------+------------------+-------------------------------------------------+ -|modelVersionId |String |The Model version id | -+-------------------------+------------------+-------------------------------------------------+ -|modelUuid |String |The Model UUid | -+-------------------------+------------------+-------------------------------------------------+ -|modelInvariantUuid |String |The Model Invariant UUid | -+-------------------------+------------------+-------------------------------------------------+ -|modelInstanceName |String |The Model Instance name | -+-------------------------+------------------+-------------------------------------------------+ - - -SubscriberInfo Object - -+-------------------------+------------------+-------------------------------------------------+ -|Attribute |Content |Description | -+=========================+==================+=================================================+ -|GlobalSubscriberId |String |Global customer Id (in A&AI) | -+-------------------------+------------------+-------------------------------------------------+ -|SubscriberName |String |Name of the Subscriber | -+-------------------------+------------------+-------------------------------------------------+ - -RequestInfo Object - -+-------------------------+------------------+-------------------------------------------------+ -|Attribute |Content |Description | -+=========================+==================+=================================================+ -|Source |String |source of the request | -+-------------------------+------------------+-------------------------------------------------+ -|billingAccountNumber |String |billingAccountNumber of the request | -+-------------------------+------------------+-------------------------------------------------+ -|callbackUrl |String |callbackUrl of the request | -+-------------------------+------------------+-------------------------------------------------+ -|correlator |String |correlator of the request | -+-------------------------+------------------+-------------------------------------------------+ -|orderNumber |String |orderNumber of the request | -+-------------------------+------------------+-------------------------------------------------+ -|productFamilyId |String |productFamilyId of the request | -+-------------------------+------------------+-------------------------------------------------+ -|orderVersion |String |orderVersion of the request | -+-------------------------+------------------+-------------------------------------------------+ -|instanceName |String |instanceName of the request | -+-------------------------+------------------+-------------------------------------------------+ -|suppressRollback |String |suppressRollback of the request | -+-------------------------+------------------+-------------------------------------------------+ -|requestorId |String |requestorId of the request | -+-------------------------+------------------+-------------------------------------------------+ - -RequestParameters Object - -+-------------------------+------------------+-------------------------------------------------+ -|Attribute |Content |Description | -+=========================+==================+=================================================+ -|SubscriptionServiceType |String |The service type of the Subscription | -+-------------------------+------------------+-------------------------------------------------+ -|UserParams |Array |The product family Id. | -+-------------------------+------------------+-------------------------------------------------+ -|aLaCarte |Boolean | aLaCarte | -+-------------------------+------------------+-------------------------------------------------+ -|autoBuildVfModules |Boolean |autoBuildVfModules | -+-------------------------+------------------+-------------------------------------------------+ -|cascadeDelete |Boolean |cascadeDelete | -+-------------------------+------------------+-------------------------------------------------+ -|usePreload |Boolean |usePreload | -+-------------------------+------------------+-------------------------------------------------+ -|rebuildVolumeGroups |Boolean |rebuildVolumeGroups | -+-------------------------+------------------+-------------------------------------------------+ -|payload |String |payload | -+-------------------------+------------------+-------------------------------------------------+ -|controllerType |String |controllerType | -+-------------------------+------------------+-------------------------------------------------+ - -UserParams Object - -+-------------------------+------------------+-------------------------------------------------+ -|Attribute |Content |Description | -+=========================+==================+=================================================+ -|name |String |Tag name of attribute | -+-------------------------+------------------+-------------------------------------------------+ -|value |String |Value of the tag | -+-------------------------+------------------+-------------------------------------------------+ - -CloudConfiguration Object - -+-------------------------+------------------+-------------------------------------------------+ -|Attribute |Content |Description | -+=========================+==================+=================================================+ -|lcpCloudRegionId |String |CloudRegion Id (in A&AI) | -+-------------------------+------------------+-------------------------------------------------+ -|tenantId |String |Name of the Subscriber | -+-------------------------+------------------+-------------------------------------------------+ -|aicNodeClli |String |aicNodeClli property | -+-------------------------+------------------+-------------------------------------------------+ - -Project Object - -+-------------------------+------------------+-------------------------------------------------+ -|Attribute |Content |Description | -+=========================+==================+=================================================+ -|projectName |String |Name of the project | -+-------------------------+------------------+-------------------------------------------------+ - -OwningEntity Object - -+-------------------------+------------------+-------------------------------------------------+ -|Attribute |Content |Description | -+=========================+==================+=================================================+ -|owningEntityId |String |owningEntityId of the owingEntity | -+-------------------------+------------------+-------------------------------------------------+ -|owningEntityName |String |owningEntityName of the owingEntity | -+-------------------------+------------------+-------------------------------------------------+ - -Platform Object - -+-------------------------+------------------+-------------------------------------------------+ -|Attribute |Content |Description | -+=========================+==================+=================================================+ -|platformName |String |Platform Name | -+-------------------------+------------------+-------------------------------------------------+ - -LineOfBusiness Object - -+-------------------------+------------------+-------------------------------------------------+ -|Attribute |Content |Description | -+=========================+==================+=================================================+ -|lineOfBusinessName |String |Line Of Business Name | -+-------------------------+------------------+-------------------------------------------------+ - -Delete service instance -++++++++++++++++++++++++ - -+--------------------+---------------------------------------------------------+ -|Interface Definition|Description | -+====================+=========================================================+ -|URI |/onap/so/infra/serviceInstantiation/serviceInstances/v6/{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 |/onap/so/infra/serviceInstantiation/serviceInstances/v6/{serviceInstanceId}/vnfs/{vnfInstanceId}/volumeGroups | -+--------------------+-------------------------------------------------------------------------------------------+ -|Operation Type |POST | -+--------------------+-------------------------------------------------------------------------------------------+ -|Content-Type |application/json | -+--------------------+-------------------------------------------------------------------------------------------+ - -Request Body: - -+----------------+---------+-----------+--------------------------+-------------------------------------------+ -|Attribute |Qualifier|Cardinality|Content |Description | -+================+=========+===========+==========================+===========================================+ -|requestDetails |M |1 |requestDetails Object |Content of requestDetails object. | -+----------------+---------+-----------+--------------------------+-------------------------------------------+ - -RequestDetails Object - -+-------------------+--------------------------+-------------------------------------------------+ -|Attribute |Content |Description | -+===================+==========================+=================================================+ -|modelInfo |modelInfo Object |Content of modelInfo object. | -+-------------------+--------------------------+-------------------------------------------------+ -|subscriberInfo |subscriberInfo Object |Content of subscriberInfo object. | -+-------------------+--------------------------+-------------------------------------------------+ -|requestInfo |requestInfo Object |Content of requestInfo object. | -+-------------------+--------------------------+-------------------------------------------------+ -|requestParameters |requestParameters Object |Content of requestParameters object. | -+-------------------+--------------------------+-------------------------------------------------+ -|relatedInstanceList|relatedInstanceList Object|Content of relatedInstanceList object. | -+-------------------+--------------------------+-------------------------------------------------+ -|cloudConfiguration |cloudConfiguration Object |Content of cloudConfiguration object. | -+-------------------+--------------------------+-------------------------------------------------+ -|project |project Object |Content of project object. | -+-------------------+--------------------------+-------------------------------------------------+ -|owningEntity |owningEntity Object |Content of owningEntity object. | -+-------------------+--------------------------+-------------------------------------------------+ -|platform |platform Object |Content of platform object. | -+-------------------+--------------------------+-------------------------------------------------+ -|lineOfBusiness |lineOfBusiness Object |Content of lineOfBusiness object. | -+-------------------+--------------------------+-------------------------------------------------+ - -ModelInfo Object - -+-------------------------+------------------+-------------------------------------------------+ -|Attribute |Content |Description | -+=========================+==================+=================================================+ -|ModelType |String |Type of model | -+-------------------------+------------------+-------------------------------------------------+ -|ModelInvariantId |String |The Model Invariant Id. | -+-------------------------+------------------+-------------------------------------------------+ -|ModelNameVersionId |String |The modelname Version Id | -+-------------------------+------------------+-------------------------------------------------+ -|ModelName |String |Name of the Model | -+-------------------------+------------------+-------------------------------------------------+ -|ModelVersion |String |Version of the model | -+-------------------------+------------------+-------------------------------------------------+ -|ModelCustomization Name |String |The Model Customization name | -+-------------------------+------------------+-------------------------------------------------+ -|modelCustomizationUuid |String |The Model Customization UUid | -+-------------------------+------------------+-------------------------------------------------+ -|modelVersionId |String |The Model version id | -+-------------------------+------------------+-------------------------------------------------+ -|modelUuid |String |The Model UUid | -+-------------------------+------------------+-------------------------------------------------+ -|modelInvariantUuid |String |The Model Invariant UUid | -+-------------------------+------------------+-------------------------------------------------+ -|modelInstanceName |String |The Model Instance name | -+-------------------------+------------------+-------------------------------------------------+ - -CloudConfiguration Object - -+-------------------------+------------------+-------------------------------------------------+ -|Attribute |Content |Description | -+=========================+==================+=================================================+ -|lcpCloudRegionId |String |CloudRegion Id (in A&AI) | -+-------------------------+------------------+-------------------------------------------------+ -|tenantId |String |Name of the Subscriber | -+-------------------------+------------------+-------------------------------------------------+ -|aicNodeClli |String |aicNodeClli property | -+-------------------------+------------------+-------------------------------------------------+ - -RequestInfo Object - -+-------------------------+------------------+-------------------------------------------------+ -|Attribute |Content |Description | -+=========================+==================+=================================================+ -|Source |String |source of the request | -+-------------------------+------------------+-------------------------------------------------+ -|billingAccountNumber |String |billingAccountNumber of the request | -+-------------------------+------------------+-------------------------------------------------+ -|callbackUrl |String |callbackUrl of the request | -+-------------------------+------------------+-------------------------------------------------+ -|correlator |String |correlator of the request | -+-------------------------+------------------+-------------------------------------------------+ -|orderNumber |String |orderNumber of the request | -+-------------------------+------------------+-------------------------------------------------+ -|productFamilyId |String |productFamilyId of the request | -+-------------------------+------------------+-------------------------------------------------+ -|orderVersion |String |orderVersion of the request | -+-------------------------+------------------+-------------------------------------------------+ -|instanceName |String |instanceName of the request | -+-------------------------+------------------+-------------------------------------------------+ -|suppressRollback |String |suppressRollback of the request | -+-------------------------+------------------+-------------------------------------------------+ -|requestorId |String |requestorId of the request | -+-------------------------+------------------+-------------------------------------------------+ - -relatedInstance List - -+-------------------------+------------------+-------------------------------------------------+ -|Attribute |Content |Description | -+=========================+==================+=================================================+ -|relatedInstance |Object |relatedInstance Object | -+-------------------------+------------------+-------------------------------------------------+ - -relatedInstance List - -+-------------------------+------------------+-------------------------------------------------+ -|Attribute |Content |Description | -+=========================+==================+=================================================+ -|instanceId |String |instanceId | -+-------------------------+------------------+-------------------------------------------------+ -|modelInfo |Object |Content of modelInfo object. | -+-------------------------+------------------+-------------------------------------------------+ - -Delete Volume Group -++++++++++++++++++++++++ - -+--------------------+---------------------------------------------------------------------------------------------------------------------+ -|Interface Definition|Description | -+====================+=====================================================================================================================+ -|URI |/onap/so/infra/serviceInstantiation/serviceInstances/v6/{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 |/onap/so/infra/serviceInstantiation/serviceInstances/v6/{serviceInstanceId}/vnfs/{vnfInstanceId}/vfModules | -+--------------------+----------------------------------------------------------------------------------------+ -|Operation Type |POST | -+--------------------+----------------------------------------------------------------------------------------+ -|Content-Type |application/json | -+--------------------+----------------------------------------------------------------------------------------+ - -Request Body: - -+----------------+---------+-----------+--------------------------+-------------------------------------------+ -|Attribute |Qualifier|Cardinality|Content |Description | -+================+=========+===========+==========================+===========================================+ -|requestDetails |M |1 |requestDetails Object |Content of requestDetails object. | -+----------------+---------+-----------+--------------------------+-------------------------------------------+ - -RequestDetails Object - -+---------------------+-------------------------+-------------------------------------------------+ -|Attribute |Content |Description | -+=====================+=========================+=================================================+ -|modelInfo |modelInfo Object |Content of modelInfo object. | -+---------------------+-------------------------+-------------------------------------------------+ -|cloudConfiguration |cloudConfiguration Object|Content of cloudConfiguration object. | -+---------------------+-------------------------+-------------------------------------------------+ -|requestInfo |requestInfo Object |Content of requestInfo object. | -+---------------------+-------------------------+-------------------------------------------------+ -|relatedInstanceList |List |Content of relatedInstanceList. | -+---------------------+-------------------------+-------------------------------------------------+ - -ModelInfo Object - -+-------------------------+------------------+-------------------------------------------------+ -|Attribute |Content |Description | -+=========================+==================+=================================================+ -|ModelType |String |Type of model | -+-------------------------+------------------+-------------------------------------------------+ -|ModelInvariantId |String |The Model Invariant Id. | -+-------------------------+------------------+-------------------------------------------------+ -|ModelNameVersionId |String |The modelname Version Id | -+-------------------------+------------------+-------------------------------------------------+ -|ModelName |String |Name of the Model | -+-------------------------+------------------+-------------------------------------------------+ -|ModelVersion |String |Version of the model | -+-------------------------+------------------+-------------------------------------------------+ -|ModelCustomization Name |String |The Model Customization name | -+-------------------------+------------------+-------------------------------------------------+ - -CloudConfiguration Object - -+-------------------------+------------------+-------------------------------------------------+ -|Attribute |Content |Description | -+=========================+==================+=================================================+ -|lcpCloudRegionId |String |CloudRegion Id (in A&AI) | -+-------------------------+------------------+-------------------------------------------------+ -|tenantId |String |Name of the Subscriber | -+-------------------------+------------------+-------------------------------------------------+ - -RequestInfo Object - -+-------------------------+------------------+-------------------------------------------------+ -|Attribute |Content |Description | -+=========================+==================+=================================================+ -|InstanceName |String |The instance Name | -+-------------------------+------------------+-------------------------------------------------+ -|Source |String |source of the request | -+-------------------------+------------------+-------------------------------------------------+ -|SuppressRollback |Boolean |SuppressRollback | -+-------------------------+------------------+-------------------------------------------------+ - -relatedInstance List - -+-------------------------+------------------+-------------------------------------------------+ -|Attribute |Content |Description | -+=========================+==================+=================================================+ -|relatedInstance |Object |relatedInstance Object | -+-------------------------+------------------+-------------------------------------------------+ - -relatedInstance List - -+-------------------------+------------------+-------------------------------------------------+ -|Attribute |Content |Description | -+=========================+==================+=================================================+ -|instanceId |String |instanceId | -+-------------------------+------------------+-------------------------------------------------+ -|modelInfo |Object |Content of modelInfo object. | -+-------------------------+------------------+-------------------------------------------------+ -|instanceName |String |Name of the instance | -+-------------------------+------------------+-------------------------------------------------+ - -Delete VF Module -++++++++++++++++++++++++ - -+--------------------+--------------------------------------------------------------------------------------------------------------+ -|Interface Definition|Description | -+====================+==============================================================================================================+ -|URI |/onap/so/infra/serviceInstantiation/serviceInstances/v6/{serviceInstanceId}/vnfs/{vnfInstanceId}/vfModules/{vfmoduleinstance-id} | -+--------------------+--------------------------------------------------------------------------------------------------------------+ -|Operation Type |DELETE | -+--------------------+--------------------------------------------------------------------------------------------------------------+ -|Content-Type |application/json | -+--------------------+--------------------------------------------------------------------------------------------------------------+ - -Request Body: - -+----------------+---------+-----------+--------------------------+-------------------------------------------+ -|Attribute |Qualifier|Cardinality|Content |Description | -+================+=========+===========+==========================+===========================================+ -|requestDetails |M |1 |requestDetails Object |Content of requestDetails object. | -+----------------+---------+-----------+--------------------------+-------------------------------------------+ - -RequestDetails Object - -+---------------------+-------------------------+-------------------------------------------------+ -|Attribute |Content |Description | -+=====================+=========================+=================================================+ -|modelInfo |modelInfo Object |Content of modelInfo object. | -+---------------------+-------------------------+-------------------------------------------------+ -|cloudConfiguration |cloudConfiguration Object|Content of cloudConfiguration object. | -+---------------------+-------------------------+-------------------------------------------------+ -|requestInfo |requestInfo Object |Content of requestInfo object. | -+---------------------+-------------------------+-------------------------------------------------+ - -ModelInfo Object - -+-------------------------+------------------+-------------------------------------------------+ -|Attribute |Content |Description | -+=========================+==================+=================================================+ -|ModelType |String |Type of model | -+-------------------------+------------------+-------------------------------------------------+ -|ModelInvariantId |String |The Model Invariant Id. | -+-------------------------+------------------+-------------------------------------------------+ -|ModelNameVersionId |String |The modelname Version Id | -+-------------------------+------------------+-------------------------------------------------+ -|ModelName |String |Name of the Model | -+-------------------------+------------------+-------------------------------------------------+ -|ModelVersion |String |Version of the model | -+-------------------------+------------------+-------------------------------------------------+ -|ModelCustomization Name |String |The Model Customization name | -+-------------------------+------------------+-------------------------------------------------+ - -CloudConfiguration Object - -+-------------------------+------------------+-------------------------------------------------+ -|Attribute |Content |Description | -+=========================+==================+=================================================+ -|lcpCloudRegionId |String |CloudRegion Id (in A&AI) | -+-------------------------+------------------+-------------------------------------------------+ -|tenantId |String |Name of the Subscriber | -+-------------------------+------------------+-------------------------------------------------+ - -RequestInfo Object - -+-------------------------+------------------+-------------------------------------------------+ -|Attribute |Content |Description | -+=========================+==================+=================================================+ -|Source |String |source of the request | -+-------------------------+------------------+-------------------------------------------------+ - -Create VNF -+++++++++++++++ - -+--------------------+--------------------------------------------------------------+ -|Interface Definition|Description | -+====================+==============================================================+ -|URI |/onap/so/infra/serviceInstantiation/serviceInstances/v6/{serviceInstanceId}/vnfs | -+--------------------+--------------------------------------------------------------+ -|Operation Type |POST | -+--------------------+--------------------------------------------------------------+ -|Content-Type |application/json | -+--------------------+--------------------------------------------------------------+ - -Request Body: - -+----------------+---------+-----------+--------------------------+-------------------------------------------+ -|Attribute |Qualifier|Cardinality|Content |Description | -+================+=========+===========+==========================+===========================================+ -|requestDetails |M |1 |requestDetails Object |Content of requestDetails object. | -+----------------+---------+-----------+--------------------------+-------------------------------------------+ - -RequestDetails Object - -+-------------------+--------------------------+-------------------------------------------------+ -|Attribute |Content |Description | -+===================+==========================+=================================================+ -|modelInfo |modelInfo Object |Content of modelInfo object. | -+-------------------+--------------------------+-------------------------------------------------+ -|subscriberInfo |subscriberInfo Object |Content of subscriberInfo object. | -+-------------------+--------------------------+-------------------------------------------------+ -|requestInfo |requestInfo Object |Content of requestInfo object. | -+-------------------+--------------------------+-------------------------------------------------+ -|requestParameters |requestParameters Object |Content of requestParameters object. | -+-------------------+--------------------------+-------------------------------------------------+ -|relatedInstanceList|relatedInstanceList Object|Content of relatedInstanceList object. | -+-------------------+--------------------------+-------------------------------------------------+ -|cloudConfiguration |cloudConfiguration Object |Content of cloudConfiguration object. | -+-------------------+--------------------------+-------------------------------------------------+ -|project |project Object |Content of project object. | -+-------------------+--------------------------+-------------------------------------------------+ -|owningEntity |owningEntity Object |Content of owningEntity object. | -+-------------------+--------------------------+-------------------------------------------------+ -|platform |platform Object |Content of platform object. | -+-------------------+--------------------------+-------------------------------------------------+ -|lineOfBusiness |lineOfBusiness Object |Content of lineOfBusiness object. | -+-------------------+--------------------------+-------------------------------------------------+ - -ModelInfo Object - -+-------------------------+------------------+-------------------------------------------------+ -|Attribute |Content |Description | -+=========================+==================+=================================================+ -|ModelType |String |Type of model | -+-------------------------+------------------+-------------------------------------------------+ -|ModelInvariantId |String |The Model Invariant Id. | -+-------------------------+------------------+-------------------------------------------------+ -|ModelNameVersionId |String |The modelname Version Id | -+-------------------------+------------------+-------------------------------------------------+ -|ModelName |String |Name of the Model | -+-------------------------+------------------+-------------------------------------------------+ -|ModelVersion |String |Version of the model | -+-------------------------+------------------+-------------------------------------------------+ -|ModelCustomization Name |String |The Model Customization name | -+-------------------------+------------------+-------------------------------------------------+ -|modelCustomizationUuid |String |The Model Customization UUid | -+-------------------------+------------------+-------------------------------------------------+ -|modelVersionId |String |The Model version id | -+-------------------------+------------------+-------------------------------------------------+ -|modelUuid |String |The Model UUid | -+-------------------------+------------------+-------------------------------------------------+ -|modelInvariantUuid |String |The Model Invariant UUid | -+-------------------------+------------------+-------------------------------------------------+ -|modelInstanceName |String |The Model Instance name | -+-------------------------+------------------+-------------------------------------------------+ - -CloudConfiguration Object - -+-------------------------+------------------+-------------------------------------------------+ -|Attribute |Content |Description | -+=========================+==================+=================================================+ -|lcpCloudRegionId |String |CloudRegion Id (in A&AI) | -+-------------------------+------------------+-------------------------------------------------+ -|tenantId |String |Name of the Subscriber | -+-------------------------+------------------+-------------------------------------------------+ - -RequestInfo Object - -+-------------------------+------------------+-------------------------------------------------+ -|Attribute |Content |Description | -+=========================+==================+=================================================+ -|Source |String |source of the request | -+-------------------------+------------------+-------------------------------------------------+ -|billingAccountNumber |String |billingAccountNumber of the request | -+-------------------------+------------------+-------------------------------------------------+ -|callbackUrl |String |callbackUrl of the request | -+-------------------------+------------------+-------------------------------------------------+ -|correlator |String |correlator of the request | -+-------------------------+------------------+-------------------------------------------------+ -|orderNumber |String |orderNumber of the request | -+-------------------------+------------------+-------------------------------------------------+ -|productFamilyId |String |productFamilyId of the request | -+-------------------------+------------------+-------------------------------------------------+ -|orderVersion |String |orderVersion of the request | -+-------------------------+------------------+-------------------------------------------------+ -|instanceName |String |instanceName of the request | -+-------------------------+------------------+-------------------------------------------------+ -|suppressRollback |String |suppressRollback of the request | -+-------------------------+------------------+-------------------------------------------------+ -|requestorId |String |requestorId of the request | -+-------------------------+------------------+-------------------------------------------------+ - -relatedInstance List - -+-------------------------+------------------+-------------------------------------------------+ -|Attribute |Content |Description | -+=========================+==================+=================================================+ -|relatedInstance |Object |relatedInstance Object | -+-------------------------+------------------+-------------------------------------------------+ - -relatedInstance List - -+-------------------------+------------------+-------------------------------------------------+ -|Attribute |Content |Description | -+=========================+==================+=================================================+ -|instanceId |String |instanceId | -+-------------------------+------------------+-------------------------------------------------+ -|modelInfo |Object |Content of modelInfo object. | -+-------------------------+------------------+-------------------------------------------------+ - -RequestParameters Object - -+-------------------------+------------------+-------------------------------------------------+ -|Attribute |Content |Description | -+=========================+==================+=================================================+ -|UserParams |Array |The product family Id. | -+-------------------------+------------------+-------------------------------------------------+ - -UserParams Object - -+-------------------------+------------------+-------------------------------------------------+ -|Attribute |Content |Description | -+=========================+==================+=================================================+ -|name |String |Tag name of attribute | -+-------------------------+------------------+-------------------------------------------------+ -|value |String |Value of the tag | -+-------------------------+------------------+-------------------------------------------------+ - -Delete VNF -+++++++++++++++ - -+--------------------+------------------------------------------------------------------------------+ -|Interface Definition|Description | -+====================+==============================================================================+ -|URI |/onap/so/infra/serviceInstantiation/serviceInstances/v6/{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 |/onap/so/infra/serviceInstantiation/orchestrationRequests/v6/{request-id} | -+--------------------+--------------------------------------------------------------+ -|Operation Type |GET | -+--------------------+--------------------------------------------------------------+ -|Content-Type |application/json | -+--------------------+--------------------------------------------------------------+ - -Response Body: - -+----------------+---------+-----------+--------------------------+-------------------------------------------+ -|Attribute |Qualifier|Cardinality|Content |Description | -+================+=========+===========+==========================+===========================================+ -|request |M |1 |request Object |Content of request object. | -+----------------+---------+-----------+--------------------------+-------------------------------------------+ - -Request Object - -+-------------------+---------+-----------+--------------------------+-------------------------------------------+ -|Attribute |Qualifier|Cardinality|Content |Description | -+===================+=========+===========+==========================+===========================================+ -|requestId |M |1 |String |Request Id | -+-------------------+---------+-----------+--------------------------+-------------------------------------------+ -|startTime |M |1 |request Object |Start time. | -+-------------------+---------+-----------+--------------------------+-------------------------------------------+ -|requestScope |M |1 |request Object |Scope of the request. | -+-------------------+---------+-----------+--------------------------+-------------------------------------------+ -|requestType |M |1 |request Object |Type of the request. | -+-------------------+---------+-----------+--------------------------+-------------------------------------------+ -|requestDetails |M |1 |requestDetails Object |Type of the request. | -+-------------------+---------+-----------+--------------------------+-------------------------------------------+ -|requestStatus |M |1 |requestStatus Object |Type of the request. | -+-------------------+---------+-----------+--------------------------+-------------------------------------------+ - -RequestDetails Object - -+-------------------+--------------------------+-------------------------------------------------+ -|Attribute |Content |Description | -+===================+==========================+=================================================+ -|modelInfo |modelInfo Object |Content of modelInfo object. | -+-------------------+--------------------------+-------------------------------------------------+ -|subscriberInfo |subscriberInfo Object |Content of subscriberInfo object. | -+-------------------+--------------------------+-------------------------------------------------+ -|requestInfo |requestInfo Object |Content of requestInfo object. | -+-------------------+--------------------------+-------------------------------------------------+ -|requestParameters |requestParameters Object |Content of requestParameters object. | -+-------------------+--------------------------+-------------------------------------------------+ -|relatedInstanceList|relatedInstanceList Object|Content of relatedInstanceList object. | -+-------------------+--------------------------+-------------------------------------------------+ -|cloudConfiguration |cloudConfiguration Object |Content of cloudConfiguration object. | -+-------------------+--------------------------+-------------------------------------------------+ -|project |project Object |Content of project object. | -+-------------------+--------------------------+-------------------------------------------------+ -|owningEntity |owningEntity Object |Content of owningEntity object. | -+-------------------+--------------------------+-------------------------------------------------+ -|platform |platform Object |Content of platform object. | -+-------------------+--------------------------+-------------------------------------------------+ -|lineOfBusiness |lineOfBusiness Object |Content of lineOfBusiness object. | -+-------------------+--------------------------+-------------------------------------------------+ - -ModelInfo Object - -+-------------------------+------------------+-------------------------------------------------+ -|Attribute |Content |Description | -+=========================+==================+=================================================+ -|ModelType |String |Type of model | -+-------------------------+------------------+-------------------------------------------------+ -|ModelInvariantId |String |The Model Invariant Id. | -+-------------------------+------------------+-------------------------------------------------+ -|ModelNameVersionId |String |The modelname Version Id | -+-------------------------+------------------+-------------------------------------------------+ -|ModelName |String |Name of the Model | -+-------------------------+------------------+-------------------------------------------------+ -|ModelVersion |String |Version of the model | -+-------------------------+------------------+-------------------------------------------------+ -|ModelCustomization Name |String |The Model Customization name | -+-------------------------+------------------+-------------------------------------------------+ -|modelCustomizationUuid |String |The Model Customization UUid | -+-------------------------+------------------+-------------------------------------------------+ -|modelVersionId |String |The Model version id | -+-------------------------+------------------+-------------------------------------------------+ -|modelUuid |String |The Model UUid | -+-------------------------+------------------+-------------------------------------------------+ -|modelInvariantUuid |String |The Model Invariant UUid | -+-------------------------+------------------+-------------------------------------------------+ -|modelInstanceName |String |The Model Instance name | -+-------------------------+------------------+-------------------------------------------------+ - -SubscriberInfo Object - -+-------------------------+------------------+-------------------------------------------------+ -|Attribute |Content |Description | -+=========================+==================+=================================================+ -|GlobalSubscriberId |String |Global customer Id (in A&AI) | -+-------------------------+------------------+-------------------------------------------------+ -|SubscriberName |String |Name of the Subscriber | -+-------------------------+------------------+-------------------------------------------------+ - -RequestInfo Object - -+-------------------------+------------------+-------------------------------------------------+ -|Attribute |Content |Description | -+=========================+==================+=================================================+ -|Source |String |source of the request | -+-------------------------+------------------+-------------------------------------------------+ -|billingAccountNumber |String |billingAccountNumber of the request | -+-------------------------+------------------+-------------------------------------------------+ -|callbackUrl |String |callbackUrl of the request | -+-------------------------+------------------+-------------------------------------------------+ -|correlator |String |correlator of the request | -+-------------------------+------------------+-------------------------------------------------+ -|orderNumber |String |orderNumber of the request | -+-------------------------+------------------+-------------------------------------------------+ -|productFamilyId |String |productFamilyId of the request | -+-------------------------+------------------+-------------------------------------------------+ -|orderVersion |String |orderVersion of the request | -+-------------------------+------------------+-------------------------------------------------+ -|instanceName |String |instanceName of the request | -+-------------------------+------------------+-------------------------------------------------+ -|suppressRollback |String |suppressRollback of the request | -+-------------------------+------------------+-------------------------------------------------+ -|requestorId |String |requestorId of the request | -+-------------------------+------------------+-------------------------------------------------+ - -RequestParameters Object - -+-------------------------+------------------+-------------------------------------------------+ -|Attribute |Content |Description | -+=========================+==================+=================================================+ -|SubscriptionServiceType |String |The service type of the Subscription | -+-------------------------+------------------+-------------------------------------------------+ - -RequestStatus Object - -+-------------------------+------------------+-------------------------------------------------+ -|Attribute |Content |Description | -+=========================+==================+=================================================+ -|finishTime |String |Time | -+-------------------------+------------------+-------------------------------------------------+ -|requestState |String |state of the request | -+-------------------------+------------------+-------------------------------------------------+ -|statusMessage |String |statusMessage | -+-------------------------+------------------+-------------------------------------------------+ -|percentProgress |String |percentage of progress | -+-------------------------+------------------+-------------------------------------------------+ - -GET Orchestration Requests -++++++++++++++++++++++++++ - -+--------------------+--------------------------------------------------------------+ -|Interface Definition|Description | -+====================+==============================================================+ -|URI |/onap/so/infra/serviceInstantiation/orchestrationRequests/v6 | -+--------------------+--------------------------------------------------------------+ -|Operation Type |GET | -+--------------------+--------------------------------------------------------------+ -|Content-Type |application/json | -+--------------------+--------------------------------------------------------------+ - -Response Body: - -+----------------+---------+-----------+--------------------------+-------------------------------------------+ -|Attribute |Qualifier|Cardinality|Content |Description | -+================+=========+===========+==========================+===========================================+ -|requestList |M |1 |Array |Content of request List. | -+----------------+---------+-----------+--------------------------+-------------------------------------------+ - -RequestList : - -+----------------+---------+-----------+--------------------------+-------------------------------------------+ -|Attribute |Qualifier|Cardinality|Content |Description | -+================+=========+===========+==========================+===========================================+ -|request |M |1 |request Object |Content of request object. | -+----------------+---------+-----------+--------------------------+-------------------------------------------+ - -Request Object - -+-------------------+---------+-----------+--------------------------+-------------------------------------------+ -|Attribute |Qualifier|Cardinality|Content |Description | -+===================+=========+===========+==========================+===========================================+ -|requestId |M |1 |String |Request Id. | -+-------------------+---------+-----------+--------------------------+-------------------------------------------+ -|startTime |M |1 |request Object |Start time. | -+-------------------+---------+-----------+--------------------------+-------------------------------------------+ -|requestScope |M |1 |request Object |Scope of the request. | -+-------------------+---------+-----------+--------------------------+-------------------------------------------+ -|requestType |M |1 |request Object |Type of the request. | -+-------------------+---------+-----------+--------------------------+-------------------------------------------+ -|requestDetails |M |1 |requestDetails Object |Type of the request. | -+-------------------+---------+-----------+--------------------------+-------------------------------------------+ -|requestStatus |M |1 |requestStatus Object |Type of the request. | -+-------------------+---------+-----------+--------------------------+-------------------------------------------+ - -RequestDetails Object - -+-------------------+--------------------------+-------------------------------------------------+ -|Attribute |Content |Description | -+===================+==========================+=================================================+ -|modelInfo |modelInfo Object |Content of modelInfo object. | -+-------------------+--------------------------+-------------------------------------------------+ -|subscriberInfo |subscriberInfo Object |Content of subscriberInfo object. | -+-------------------+--------------------------+-------------------------------------------------+ -|requestInfo |requestInfo Object |Content of requestInfo object. | -+-------------------+--------------------------+-------------------------------------------------+ -|requestParameters |requestParameters Object |Content of requestParameters object. | -+-------------------+--------------------------+-------------------------------------------------+ -|relatedInstanceList|relatedInstanceList Object|Content of relatedInstanceList object. | -+-------------------+--------------------------+-------------------------------------------------+ -|cloudConfiguration |cloudConfiguration Object |Content of cloudConfiguration object. | -+-------------------+--------------------------+-------------------------------------------------+ -|project |project Object |Content of project object. | -+-------------------+--------------------------+-------------------------------------------------+ -|owningEntity |owningEntity Object |Content of owningEntity object. | -+-------------------+--------------------------+-------------------------------------------------+ -|platform |platform Object |Content of platform object. | -+-------------------+--------------------------+-------------------------------------------------+ -|lineOfBusiness |lineOfBusiness Object |Content of lineOfBusiness object. | -+-------------------+--------------------------+-------------------------------------------------+ - -ModelInfo Object - -+-------------------------+------------------+-------------------------------------------------+ -|Attribute |Content |Description | -+=========================+==================+=================================================+ -|ModelType |String |Type of model | -+-------------------------+------------------+-------------------------------------------------+ -|ModelInvariantId |String |The Model Invariant Id. | -+-------------------------+------------------+-------------------------------------------------+ -|ModelNameVersionId |String |The modelname Version Id | -+-------------------------+------------------+-------------------------------------------------+ -|ModelName |String |Name of the Model | -+-------------------------+------------------+-------------------------------------------------+ -|ModelVersion |String |Version of the model | -+-------------------------+------------------+-------------------------------------------------+ -|ModelCustomization Name |String |The Model Customization name | -+-------------------------+------------------+-------------------------------------------------+ -|modelCustomizationUuid |String |The Model Customization UUid | -+-------------------------+------------------+-------------------------------------------------+ -|modelVersionId |String |The Model version id | -+-------------------------+------------------+-------------------------------------------------+ -|modelUuid |String |The Model UUid | -+-------------------------+------------------+-------------------------------------------------+ -|modelInvariantUuid |String |The Model Invariant UUid | -+-------------------------+------------------+-------------------------------------------------+ -|modelInstanceName |String |The Model Instance name | -+-------------------------+------------------+-------------------------------------------------+ - -SubscriberInfo Object - -+-------------------------+------------------+-------------------------------------------------+ -|Attribute |Content |Description | -+=========================+==================+=================================================+ -|GlobalSubscriberId |String |Global customer Id (in A&AI) | -+-------------------------+------------------+-------------------------------------------------+ -|SubscriberName |String |Name of the Subscriber | -+-------------------------+------------------+-------------------------------------------------+ - -RequestInfo Object - -+-------------------------+------------------+-------------------------------------------------+ -|Attribute |Content |Description | -+=========================+==================+=================================================+ -|Source |String |source of the request | -+-------------------------+------------------+-------------------------------------------------+ -|billingAccountNumber |String |billingAccountNumber of the request | -+-------------------------+------------------+-------------------------------------------------+ -|callbackUrl |String |callbackUrl of the request | -+-------------------------+------------------+-------------------------------------------------+ -|correlator |String |correlator of the request | -+-------------------------+------------------+-------------------------------------------------+ -|orderNumber |String |orderNumber of the request | -+-------------------------+------------------+-------------------------------------------------+ -|productFamilyId |String |productFamilyId of the request | -+-------------------------+------------------+-------------------------------------------------+ -|orderVersion |String |orderVersion of the request | -+-------------------------+------------------+-------------------------------------------------+ -|instanceName |String |instanceName of the request | -+-------------------------+------------------+-------------------------------------------------+ -|suppressRollback |String |suppressRollback of the request | -+-------------------------+------------------+-------------------------------------------------+ -|requestorId |String |requestorId of the request | -+-------------------------+------------------+-------------------------------------------------+ - -RequestParameters Object - -+-------------------------+------------------+-------------------------------------------------+ -|Attribute |Content |Description | -+=========================+==================+=================================================+ -|SubscriptionServiceType |String |The service type of the Subscription | -+-------------------------+------------------+-------------------------------------------------+ - -RequestStatus Object - -+-------------------------+------------------+-------------------------------------------------+ -|Attribute |Content |Description | -+=========================+==================+=================================================+ -|finishTime |String |Time | -+-------------------------+------------------+-------------------------------------------------+ -|requestState |String |state of the request | -+-------------------------+------------------+-------------------------------------------------+ -|statusMessage |String |statusMessage | -+-------------------------+------------------+-------------------------------------------------+ -|percentProgress |String |percentage of progress | -+-------------------------+------------------+-------------------------------------------------+ - -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 |/onap/so/infra/serviceInstantiation/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 | -+------------------------------+-----------------+------------------------------------+ -|serviceUuid |String |Model UUID | -+------------------------------+-----------------+------------------------------------+ -|serviceInvariantUuid |String |Model Invariant UUID | -+------------------------------+-----------------+------------------------------------+ -|gloabalSubscriberId |String |Customer Id | -+------------------------------+-----------------+------------------------------------+ -|serviceType |String |service Type | -+------------------------------+-----------------+------------------------------------+ -|parameters |Object |Parameter Object | -+------------------------------+-----------------+------------------------------------+ - -Parameter Object - -+------------------------------+-----------------+------------------------------------+ -|Attribute |Content |Description | -+==============================+=================+====================================+ -|locationConstraints |List of object |location infor for each vnf | -+------------------------------+-----------------+------------------------------------+ -|resource |List of Resource |resource of service/resource | -+------------------------------+-----------------+------------------------------------+ -|requestInputs |key-value map |input of service/resource -+------------------------------+-----------------+------------------------------------+ - -LocationConstraint Object - -+------------------------------+-----------------+------------------------------------+ -|Attribute |Content |Description | -+==============================+=================+====================================+ -|vnfProfileId |String |Customization id for VNF | -+------------------------------+-----------------+------------------------------------+ -|locationConstraints |Object |DC location info of VNF | -+------------------------------+-----------------+------------------------------------+ - -VnfLocationConstraint Object - -+------------------------------+-----------------+------------------------------------+ -|Attribute |Content |Description | -+==============================+=================+====================================+ -|vimId |String |VIM id from ESR definition | -+------------------------------+-----------------+------------------------------------+ - -Resource Object - -+------------------------------+-----------------+------------------------------------+ -|Attribute |Content |Description | -+==============================+=================+====================================+ -|resourceName |String |The resource name | -+------------------------------+-----------------+------------------------------------+ -|resourceInvariantUuid |String |The resource invariant UUID. | -+------------------------------+-----------------+------------------------------------+ -|resourceUuid |String |The resource UUID. | -+------------------------------+-----------------+------------------------------------+ -|resourceCustomizationUuid |String |The resource customization UUID. | -+------------------------------+-----------------+------------------------------------+ -|parameters |Object |Parameter of 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 |/onap/so/infra/serviceInstantiation/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 |/onap/so/infra/serviceInstantiation/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 | -+-------------------+---------+-----------+-------+-----------------------+ -|subscriber-name |O |1 |String |Subscriber name | -+-------------------+---------+-----------+-------+-----------------------+ -|subscriber-type |O |1 |String |Subscriber 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.37/{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 | -+=========================+==================+==============================================================================+ -|Location |String |The location URL of the server. | -+-------------------------+------------------+------------------------------------------------------------------------------+ -|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. | -+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+ -|is_default |O |1 |boolean |The network is default or not. | -+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+ -|availability_zone_hints |O |1 |array |The availability zone candidate for the network. | -+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+ - -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. | -+-----------------------------+------------------+------------------------------------------------------------------------------+ -|created_at |String |Time at which the resource has been created (in UTC ISO8601 format). | -+-----------------------------+------------------+------------------------------------------------------------------------------+ -|dns_domain |String |A valid DNS domain. | -+-----------------------------+------------------+------------------------------------------------------------------------------+ -|id |String |The ID of the network. | -+-----------------------------+------------------+------------------------------------------------------------------------------+ -|ipv4_address_scope |String |The ID of the IPv4 address scope that the network is associated with. | -+-----------------------------+------------------+------------------------------------------------------------------------------+ -|ipv6_address_scope |String |The ID of the IPv6 address scope that the network is associated with. | -+-----------------------------+------------------+------------------------------------------------------------------------------+ -|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. | -+-----------------------------+------------------+------------------------------------------------------------------------------+ -|updated_at |String |Time at which the resource has been updated (in UTC ISO8601 format). | -+-----------------------------+------------------+------------------------------------------------------------------------------+ -|vlan_transparent |boolean |Indicates the VLAN transparency mode of the network. | -+-----------------------------+------------------+------------------------------------------------------------------------------+ -|description |String |A human-readable description for the resource. | -+-----------------------------+------------------+------------------------------------------------------------------------------+ -|is_default |boolean |The network is default pool or not. | -+-----------------------------+------------------+------------------------------------------------------------------------------+ - -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 |String |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. | -+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+ -|service_types |O |1 |array |The service types associated with the subnet. | -+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+ - -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. | -+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+ -|qos_policy_id |O |1 |string |QoS policy associated with the port. | -+----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+ -|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. | -+-----------------------------+------------------+------------------------------------------------------------------------------+ -|ip_allocation |string |Indicates when ports use either deferred, immediate or no IP allocation (none)| -+-----------------------------+------------------+------------------------------------------------------------------------------+ -|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. | -+-----------------------------+------------------+------------------------------------------------------------------------------+ -|qos_policy_id |string |The ID of the QoS policy associated with the port. | -+-----------------------------+------------------+------------------------------------------------------------------------------+ -|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. | -+-----------------------------+------------------+------------------------------------------------------------------------------+ -|created_at |string |Time at which the resource has been created (in UTC ISO8601 format). | -+-----------------------------+------------------+------------------------------------------------------------------------------+ -|updated_at |string |Time at which the resource has been updated (in UTC ISO8601 format). | -+-----------------------------+------------------+------------------------------------------------------------------------------+ -|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 | -+------------------+---------------------+ - - -OOF/HAS create update API -+++++++++++++++++++++++++ - -+--------------------+--------------------------+ -|Interface Definition|Description | -+====================+==========================+ -|URI |/api/oof/v1/placement | -+--------------------+--------------------------+ -|Operation Type |POST | -+--------------------+--------------------------+ - - -Request Parameters: - -+-------------------+---------+-----------+-------+-------------------------------------------------------------+ -|Attribute |Required |Cardinality|Content|Description | -+===================+=========+===========+=======+=============================================================+ -|requestInfo |Y |1 |Object |The content of the RequestInfo object. | -+-------------------+---------+-----------+-------+-------------------------------------------------------------+ -|placementInfo |Y |1 |Object |The Content of the PlacementInfo object. | -+-------------------+---------+-----------+-------+-------------------------------------------------------------+ -|licenseInfo |N |1 |Object |The Content of the LicenseInfo object. | -+-------------------+---------+-----------+-------+-------------------------------------------------------------+ -|serviceInfo |Y |1 |Object |The Content of the ServiceInfo object. | -+-------------------+---------+-----------+-------+-------------------------------------------------------------+ - - -+-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ -|Attribute |Required |Cardinality|Content|Description | -+===================+=========+===========+=======+=======================================================================+ -|transactionId |Y |1 |String |A unique ID to track an ONAP transaction. | -+-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ -|requestId |Y |1 |String |A unique ID to track multiple requests. | -+-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ -|callbackUrl |Y |1 |String |The end point of a callback service where recommendations are posted. | -+-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ -|callbackHeader |N |1 |String |The header information a client expecting in a async callback. | -+-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ -|sourceId |Y |1 |String |The unique ID of a client making an optimization call. | -+-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ -|requestType |Y |1 |String |The type of a request | -+-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ -|numSolutions |N |1 |Integer|Expected number of solutions. | -+-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ -|optimizers |Y |1..N |List of Strings|A list of optimization services. | -+-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ -|timeout |N |1 |Integer|A tolerance window (in secs) for expecting solutions. Default is 600 secs.| -+-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ - - -PlacementInfo Object - -+-------------------+---------+-----------+-------+-------------------------------------------------------------+ -|Attribute |Required |Cardinality|Content|Description | -+===================+=========+===========+=======+=============================================================+ -|requestParameters |C |1 |String |A JSON object conaining service and customer-specific data. A client or service designer is required to specify the parameters of interest for a given service and their location in the JSON blob through optimization query policies. This attribute is only required if a request contains service or customer-specific information.| -+-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ -|placementDemands |Y |1..N |List of PlacementDemand Object|The resource information for a placement service.| -+-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ -|subscriberInfo |N |1 |Object |The information of a service subscriber. | -+-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ - -PlacementDemand Object - -+-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ -|Attribute |Required |Cardinality|Content|Description | -+===================+=========+===========+=======+=======================================================================+ -|resourceModuleName |Y |1 |String |A resource name as defined in a service model. | -+-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ -|serviceResourceId |Y |1 |String |A unique resource Id with a local scope between client and OOF. | -+-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ -|tenantId |N |1 |String |A tenant Id as defined in the ordering system. | -+-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ -|resourceModelInfo |Y |1 |Object |Resource model information as defined in SDC. | -+-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ -|existingCandidates |N |1..N |List of Candidates Objects | The existing placement information of a resource. | -+-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ -|excludedCandidates |N |1..N |List of Candidates Objects |Candidates that need to be excluded from solutions.| -+-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ -|requiredCandidates |N |1..N |List of Candidates Objects |Candidates that must be included in solutions. | -+-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ - - -SubscriberInfo Object - -+-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ -|Attribute |Required |Cardinality|Content|Description | -+===================+=========+===========+=======+=======================================================================+ -|globalSubscriberId |Y |1 |String |An ID of a subscriber. | -+-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ -|subscriberName |Y |1.N |String |The name of a subscriber. If the name is not known, the value must be 'unknown'.| -+-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ -|subscriberCommonSiteId |N |1 |String |Id representing a subscriber location. | -+-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ - -ModelMetaData Object - -+-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ -|Attribute |Required |Cardinality|Content|Description | -+===================+=========+===========+=======+=======================================================================+ -|modelInvariantId |Y |1 |String |A model invariant Id as defined in a service model. | -+-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ -|modelVersionId |Y |1 |String |A unique model Id as defined in a service model. | -+-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ -|modelName |N |1 |String |A model name as defined in a service model. | -+-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ -|modelType |N |1 |String |A model type as defined in a service model. | -+-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ -|modelVersion |N |1 |String |A model version as defined in a service model. | -+-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ -|modelCustomizationName |N |1 |String |A model customization name as defined in a service model. | -+-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ - - -Candidates Object - -+-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ -|Attribute |Required |Cardinality|Content|Description | -+===================+=========+===========+=======+=======================================================================+ -|identifierType |Y |1 |String |The type of a candidate. | -+-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ -|identifiers |Y |1..N |List |A list of identifiers. | -+-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ -|cloudOwner |C |1 |String |The name of a cloud owner. Only required if identifierType is cloud_region_id.| -+-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ - - -ServiceInfo Object - -+-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ -|Attribute |Required |Cardinality|Content|Description | -+===================+=========+===========+=======+=======================================================================+ -|serviceInstanceId |Y |1 |String |A service instance id associated with a request. | -+-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ -|modelInfo |Y |1 |ModelMetaData Object |A list of identifiers. | -+-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ -|serviceName |Y |1 |String |The name of a service | -+-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ - -LicenseInfo Object - -+-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ -|Attribute |Required |Cardinality|Content|Description | -+===================+=========+===========+=======+=======================================================================+ -|licenseDemands |Y |1..N |List of LicenseDemands Object |A list of resources for license selection. | -+-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ - -LicenseDemand Object - -+-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ -|Attribute |Required |Cardinality|Content|Description | -+===================+=========+===========+=======+=======================================================================+ -|resourceModuleName |Y |1 |String |A resource name as defined in a service model. | -+-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ -|serviceResourceId |Y |1 |String |A unique resource Id with a local scope between client and OOF. | -+-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ -|resourceModelInfo |Y |1 |ModelMetaData Object |Resource model information as defined in a service model.| -+-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ -|existingLicenses |N |1 |LicenseModel Object |Existing license information assigned to a resource. | -+-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ - -LicenseModel Object - -+-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ -|Attribute |Required |Cardinality|Content|Description | -+===================+=========+===========+=======+=======================================================================+ -|entitlementPoolUUID|Y |1..N |List |Entitlement pool UUIDs associated with a resource. | -+-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ -|licenseKeyGroupUUID|Y |1..N |List |License key groups associated with a resource. | -+-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ - - -Response Body - -+-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ -|Attribute |Required |Cardinality|Content|Description | -+===================+=========+===========+=======+=======================================================================+ -|requestId |Y |1 |String |A unique Id for an ONAP transaction. | -+-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ -|transactionId |Y |1 |String |A unique ID to track multiple requests associated with a transaction. | -+-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ -|statusMessage |N |1 |String |Reasoning if a requestStatus is failed. | -+-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ -|requestStatus |Y |1 |String |The status of a request. | -+-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ \ No newline at end of file diff --git a/docs/api/apis/SO_Interface.rst b/docs/api/apis/SO_Interface.rst new file mode 100644 index 0000000000..4f3d9146e4 --- /dev/null +++ b/docs/api/apis/SO_Interface.rst @@ -0,0 +1,4479 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. Copyright 2018 Huawei Technologies Co., Ltd. + +SO Interfaces +================================ + +.. image:: ../images/SO_1.png + +SO APIs +---------------- + +North Bound APIs +---------------- +Create service instance +++++++++++++++++++++++++ + ++--------------------+-------------------------------------+ +|Interface Definition|Description | ++====================+=====================================+ +|URI |/onap/so/infra/serviceInstantiation/serviceInstances/v6 | ++--------------------+-------------------------------------+ +|Operation Type |POST | ++--------------------+-------------------------------------+ +|Content-Type |application/json | ++--------------------+-------------------------------------+ + +Request Body: + ++----------------+---------+-----------+--------------------------+-------------------------------------------+ +|Attribute |Qualifier|Cardinality|Content |Description | ++================+=========+===========+==========================+===========================================+ +|requestDetails |M |1 |requestDetails Object |Content of requestDetails object. | ++----------------+---------+-----------+--------------------------+-------------------------------------------+ + +RequestDetails Object + ++-------------------+--------------------------+-------------------------------------------------+ +|Attribute |Content |Description | ++===================+==========================+=================================================+ +|modelInfo |modelInfo Object |Content of modelInfo object. | ++-------------------+--------------------------+-------------------------------------------------+ +|subscriberInfo |subscriberInfo Object |Content of subscriberInfo object. | ++-------------------+--------------------------+-------------------------------------------------+ +|requestInfo |requestInfo Object |Content of requestInfo object. | ++-------------------+--------------------------+-------------------------------------------------+ +|requestParameters |requestParameters Object |Content of requestParameters object. | ++-------------------+--------------------------+-------------------------------------------------+ +|relatedInstanceList|relatedInstanceList Object|Content of relatedInstanceList object. | ++-------------------+--------------------------+-------------------------------------------------+ +|cloudConfiguration |cloudConfiguration Object |Content of cloudConfiguration object. | ++-------------------+--------------------------+-------------------------------------------------+ +|project |project Object |Content of project object. | ++-------------------+--------------------------+-------------------------------------------------+ +|owningEntity |owningEntity Object |Content of owningEntity object. | ++-------------------+--------------------------+-------------------------------------------------+ +|platform |platform Object |Content of platform object. | ++-------------------+--------------------------+-------------------------------------------------+ +|lineOfBusiness |lineOfBusiness Object |Content of lineOfBusiness object. | ++-------------------+--------------------------+-------------------------------------------------+ + +ModelInfo Object + ++-------------------------+------------------+-------------------------------------------------+ +|Attribute |Content |Description | ++=========================+==================+=================================================+ +|ModelType |String |Type of model | ++-------------------------+------------------+-------------------------------------------------+ +|ModelInvariantId |String |The Model Invariant Id. | ++-------------------------+------------------+-------------------------------------------------+ +|ModelNameVersionId |String |The modelname Version Id | ++-------------------------+------------------+-------------------------------------------------+ +|ModelName |String |Name of the Model | ++-------------------------+------------------+-------------------------------------------------+ +|ModelVersion |String |Version of the model | ++-------------------------+------------------+-------------------------------------------------+ +|ModelCustomization Name |String |The Model Customization name | ++-------------------------+------------------+-------------------------------------------------+ +|modelCustomizationUuid |String |The Model Customization UUid | ++-------------------------+------------------+-------------------------------------------------+ +|modelVersionId |String |The Model version id | ++-------------------------+------------------+-------------------------------------------------+ +|modelUuid |String |The Model UUid | ++-------------------------+------------------+-------------------------------------------------+ +|modelInvariantUuid |String |The Model Invariant UUid | ++-------------------------+------------------+-------------------------------------------------+ +|modelInstanceName |String |The Model Instance name | ++-------------------------+------------------+-------------------------------------------------+ + + +SubscriberInfo Object + ++-------------------------+------------------+-------------------------------------------------+ +|Attribute |Content |Description | ++=========================+==================+=================================================+ +|GlobalSubscriberId |String |Global customer Id (in A&AI) | ++-------------------------+------------------+-------------------------------------------------+ +|SubscriberName |String |Name of the Subscriber | ++-------------------------+------------------+-------------------------------------------------+ + +RequestInfo Object + ++-------------------------+------------------+-------------------------------------------------+ +|Attribute |Content |Description | ++=========================+==================+=================================================+ +|Source |String |source of the request | ++-------------------------+------------------+-------------------------------------------------+ +|billingAccountNumber |String |billingAccountNumber of the request | ++-------------------------+------------------+-------------------------------------------------+ +|callbackUrl |String |callbackUrl of the request | ++-------------------------+------------------+-------------------------------------------------+ +|correlator |String |correlator of the request | ++-------------------------+------------------+-------------------------------------------------+ +|orderNumber |String |orderNumber of the request | ++-------------------------+------------------+-------------------------------------------------+ +|productFamilyId |String |productFamilyId of the request | ++-------------------------+------------------+-------------------------------------------------+ +|orderVersion |String |orderVersion of the request | ++-------------------------+------------------+-------------------------------------------------+ +|instanceName |String |instanceName of the request | ++-------------------------+------------------+-------------------------------------------------+ +|suppressRollback |String |suppressRollback of the request | ++-------------------------+------------------+-------------------------------------------------+ +|requestorId |String |requestorId of the request | ++-------------------------+------------------+-------------------------------------------------+ + +RequestParameters Object + ++-------------------------+------------------+-------------------------------------------------+ +|Attribute |Content |Description | ++=========================+==================+=================================================+ +|SubscriptionServiceType |String |The service type of the Subscription | ++-------------------------+------------------+-------------------------------------------------+ +|UserParams |Array |The product family Id. | ++-------------------------+------------------+-------------------------------------------------+ +|aLaCarte |Boolean | aLaCarte | ++-------------------------+------------------+-------------------------------------------------+ +|autoBuildVfModules |Boolean |autoBuildVfModules | ++-------------------------+------------------+-------------------------------------------------+ +|cascadeDelete |Boolean |cascadeDelete | ++-------------------------+------------------+-------------------------------------------------+ +|usePreload |Boolean |usePreload | ++-------------------------+------------------+-------------------------------------------------+ +|rebuildVolumeGroups |Boolean |rebuildVolumeGroups | ++-------------------------+------------------+-------------------------------------------------+ +|payload |String |payload | ++-------------------------+------------------+-------------------------------------------------+ +|controllerType |String |controllerType | ++-------------------------+------------------+-------------------------------------------------+ + +UserParams Object + ++-------------------------+------------------+-------------------------------------------------+ +|Attribute |Content |Description | ++=========================+==================+=================================================+ +|name |String |Tag name of attribute | ++-------------------------+------------------+-------------------------------------------------+ +|value |String |Value of the tag | ++-------------------------+------------------+-------------------------------------------------+ + +CloudConfiguration Object + ++-------------------------+------------------+-------------------------------------------------+ +|Attribute |Content |Description | ++=========================+==================+=================================================+ +|lcpCloudRegionId |String |CloudRegion Id (in A&AI) | ++-------------------------+------------------+-------------------------------------------------+ +|tenantId |String |Name of the Subscriber | ++-------------------------+------------------+-------------------------------------------------+ +|aicNodeClli |String |aicNodeClli property | ++-------------------------+------------------+-------------------------------------------------+ + +Project Object + ++-------------------------+------------------+-------------------------------------------------+ +|Attribute |Content |Description | ++=========================+==================+=================================================+ +|projectName |String |Name of the project | ++-------------------------+------------------+-------------------------------------------------+ + +OwningEntity Object + ++-------------------------+------------------+-------------------------------------------------+ +|Attribute |Content |Description | ++=========================+==================+=================================================+ +|owningEntityId |String |owningEntityId of the owingEntity | ++-------------------------+------------------+-------------------------------------------------+ +|owningEntityName |String |owningEntityName of the owingEntity | ++-------------------------+------------------+-------------------------------------------------+ + +Platform Object + ++-------------------------+------------------+-------------------------------------------------+ +|Attribute |Content |Description | ++=========================+==================+=================================================+ +|platformName |String |Platform Name | ++-------------------------+------------------+-------------------------------------------------+ + +LineOfBusiness Object + ++-------------------------+------------------+-------------------------------------------------+ +|Attribute |Content |Description | ++=========================+==================+=================================================+ +|lineOfBusinessName |String |Line Of Business Name | ++-------------------------+------------------+-------------------------------------------------+ + +Delete service instance +++++++++++++++++++++++++ + ++--------------------+---------------------------------------------------------+ +|Interface Definition|Description | ++====================+=========================================================+ +|URI |/onap/so/infra/serviceInstantiation/serviceInstances/v6/{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 |/onap/so/infra/serviceInstantiation/serviceInstances/v6/{serviceInstanceId}/vnfs/{vnfInstanceId}/volumeGroups | ++--------------------+-------------------------------------------------------------------------------------------+ +|Operation Type |POST | ++--------------------+-------------------------------------------------------------------------------------------+ +|Content-Type |application/json | ++--------------------+-------------------------------------------------------------------------------------------+ + +Request Body: + ++----------------+---------+-----------+--------------------------+-------------------------------------------+ +|Attribute |Qualifier|Cardinality|Content |Description | ++================+=========+===========+==========================+===========================================+ +|requestDetails |M |1 |requestDetails Object |Content of requestDetails object. | ++----------------+---------+-----------+--------------------------+-------------------------------------------+ + +RequestDetails Object + ++-------------------+--------------------------+-------------------------------------------------+ +|Attribute |Content |Description | ++===================+==========================+=================================================+ +|modelInfo |modelInfo Object |Content of modelInfo object. | ++-------------------+--------------------------+-------------------------------------------------+ +|subscriberInfo |subscriberInfo Object |Content of subscriberInfo object. | ++-------------------+--------------------------+-------------------------------------------------+ +|requestInfo |requestInfo Object |Content of requestInfo object. | ++-------------------+--------------------------+-------------------------------------------------+ +|requestParameters |requestParameters Object |Content of requestParameters object. | ++-------------------+--------------------------+-------------------------------------------------+ +|relatedInstanceList|relatedInstanceList Object|Content of relatedInstanceList object. | ++-------------------+--------------------------+-------------------------------------------------+ +|cloudConfiguration |cloudConfiguration Object |Content of cloudConfiguration object. | ++-------------------+--------------------------+-------------------------------------------------+ +|project |project Object |Content of project object. | ++-------------------+--------------------------+-------------------------------------------------+ +|owningEntity |owningEntity Object |Content of owningEntity object. | ++-------------------+--------------------------+-------------------------------------------------+ +|platform |platform Object |Content of platform object. | ++-------------------+--------------------------+-------------------------------------------------+ +|lineOfBusiness |lineOfBusiness Object |Content of lineOfBusiness object. | ++-------------------+--------------------------+-------------------------------------------------+ + +ModelInfo Object + ++-------------------------+------------------+-------------------------------------------------+ +|Attribute |Content |Description | ++=========================+==================+=================================================+ +|ModelType |String |Type of model | ++-------------------------+------------------+-------------------------------------------------+ +|ModelInvariantId |String |The Model Invariant Id. | ++-------------------------+------------------+-------------------------------------------------+ +|ModelNameVersionId |String |The modelname Version Id | ++-------------------------+------------------+-------------------------------------------------+ +|ModelName |String |Name of the Model | ++-------------------------+------------------+-------------------------------------------------+ +|ModelVersion |String |Version of the model | ++-------------------------+------------------+-------------------------------------------------+ +|ModelCustomization Name |String |The Model Customization name | ++-------------------------+------------------+-------------------------------------------------+ +|modelCustomizationUuid |String |The Model Customization UUid | ++-------------------------+------------------+-------------------------------------------------+ +|modelVersionId |String |The Model version id | ++-------------------------+------------------+-------------------------------------------------+ +|modelUuid |String |The Model UUid | ++-------------------------+------------------+-------------------------------------------------+ +|modelInvariantUuid |String |The Model Invariant UUid | ++-------------------------+------------------+-------------------------------------------------+ +|modelInstanceName |String |The Model Instance name | ++-------------------------+------------------+-------------------------------------------------+ + +CloudConfiguration Object + ++-------------------------+------------------+-------------------------------------------------+ +|Attribute |Content |Description | ++=========================+==================+=================================================+ +|lcpCloudRegionId |String |CloudRegion Id (in A&AI) | ++-------------------------+------------------+-------------------------------------------------+ +|tenantId |String |Name of the Subscriber | ++-------------------------+------------------+-------------------------------------------------+ +|aicNodeClli |String |aicNodeClli property | ++-------------------------+------------------+-------------------------------------------------+ + +RequestInfo Object + ++-------------------------+------------------+-------------------------------------------------+ +|Attribute |Content |Description | ++=========================+==================+=================================================+ +|Source |String |source of the request | ++-------------------------+------------------+-------------------------------------------------+ +|billingAccountNumber |String |billingAccountNumber of the request | ++-------------------------+------------------+-------------------------------------------------+ +|callbackUrl |String |callbackUrl of the request | ++-------------------------+------------------+-------------------------------------------------+ +|correlator |String |correlator of the request | ++-------------------------+------------------+-------------------------------------------------+ +|orderNumber |String |orderNumber of the request | ++-------------------------+------------------+-------------------------------------------------+ +|productFamilyId |String |productFamilyId of the request | ++-------------------------+------------------+-------------------------------------------------+ +|orderVersion |String |orderVersion of the request | ++-------------------------+------------------+-------------------------------------------------+ +|instanceName |String |instanceName of the request | ++-------------------------+------------------+-------------------------------------------------+ +|suppressRollback |String |suppressRollback of the request | ++-------------------------+------------------+-------------------------------------------------+ +|requestorId |String |requestorId of the request | ++-------------------------+------------------+-------------------------------------------------+ + +relatedInstance List + ++-------------------------+------------------+-------------------------------------------------+ +|Attribute |Content |Description | ++=========================+==================+=================================================+ +|relatedInstance |Object |relatedInstance Object | ++-------------------------+------------------+-------------------------------------------------+ + +relatedInstance List + ++-------------------------+------------------+-------------------------------------------------+ +|Attribute |Content |Description | ++=========================+==================+=================================================+ +|instanceId |String |instanceId | ++-------------------------+------------------+-------------------------------------------------+ +|modelInfo |Object |Content of modelInfo object. | ++-------------------------+------------------+-------------------------------------------------+ + +Delete Volume Group +++++++++++++++++++++++++ + ++--------------------+---------------------------------------------------------------------------------------------------------------------+ +|Interface Definition|Description | ++====================+=====================================================================================================================+ +|URI |/onap/so/infra/serviceInstantiation/serviceInstances/v6/{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 |/onap/so/infra/serviceInstantiation/serviceInstances/v6/{serviceInstanceId}/vnfs/{vnfInstanceId}/vfModules | ++--------------------+----------------------------------------------------------------------------------------+ +|Operation Type |POST | ++--------------------+----------------------------------------------------------------------------------------+ +|Content-Type |application/json | ++--------------------+----------------------------------------------------------------------------------------+ + +Request Body: + ++----------------+---------+-----------+--------------------------+-------------------------------------------+ +|Attribute |Qualifier|Cardinality|Content |Description | ++================+=========+===========+==========================+===========================================+ +|requestDetails |M |1 |requestDetails Object |Content of requestDetails object. | ++----------------+---------+-----------+--------------------------+-------------------------------------------+ + +RequestDetails Object + ++---------------------+-------------------------+-------------------------------------------------+ +|Attribute |Content |Description | ++=====================+=========================+=================================================+ +|modelInfo |modelInfo Object |Content of modelInfo object. | ++---------------------+-------------------------+-------------------------------------------------+ +|cloudConfiguration |cloudConfiguration Object|Content of cloudConfiguration object. | ++---------------------+-------------------------+-------------------------------------------------+ +|requestInfo |requestInfo Object |Content of requestInfo object. | ++---------------------+-------------------------+-------------------------------------------------+ +|relatedInstanceList |List |Content of relatedInstanceList. | ++---------------------+-------------------------+-------------------------------------------------+ + +ModelInfo Object + ++-------------------------+------------------+-------------------------------------------------+ +|Attribute |Content |Description | ++=========================+==================+=================================================+ +|ModelType |String |Type of model | ++-------------------------+------------------+-------------------------------------------------+ +|ModelInvariantId |String |The Model Invariant Id. | ++-------------------------+------------------+-------------------------------------------------+ +|ModelNameVersionId |String |The modelname Version Id | ++-------------------------+------------------+-------------------------------------------------+ +|ModelName |String |Name of the Model | ++-------------------------+------------------+-------------------------------------------------+ +|ModelVersion |String |Version of the model | ++-------------------------+------------------+-------------------------------------------------+ +|ModelCustomization Name |String |The Model Customization name | ++-------------------------+------------------+-------------------------------------------------+ + +CloudConfiguration Object + ++-------------------------+------------------+-------------------------------------------------+ +|Attribute |Content |Description | ++=========================+==================+=================================================+ +|lcpCloudRegionId |String |CloudRegion Id (in A&AI) | ++-------------------------+------------------+-------------------------------------------------+ +|tenantId |String |Name of the Subscriber | ++-------------------------+------------------+-------------------------------------------------+ + +RequestInfo Object + ++-------------------------+------------------+-------------------------------------------------+ +|Attribute |Content |Description | ++=========================+==================+=================================================+ +|InstanceName |String |The instance Name | ++-------------------------+------------------+-------------------------------------------------+ +|Source |String |source of the request | ++-------------------------+------------------+-------------------------------------------------+ +|SuppressRollback |Boolean |SuppressRollback | ++-------------------------+------------------+-------------------------------------------------+ + +relatedInstance List + ++-------------------------+------------------+-------------------------------------------------+ +|Attribute |Content |Description | ++=========================+==================+=================================================+ +|relatedInstance |Object |relatedInstance Object | ++-------------------------+------------------+-------------------------------------------------+ + +relatedInstance List + ++-------------------------+------------------+-------------------------------------------------+ +|Attribute |Content |Description | ++=========================+==================+=================================================+ +|instanceId |String |instanceId | ++-------------------------+------------------+-------------------------------------------------+ +|modelInfo |Object |Content of modelInfo object. | ++-------------------------+------------------+-------------------------------------------------+ +|instanceName |String |Name of the instance | ++-------------------------+------------------+-------------------------------------------------+ + +Delete VF Module +++++++++++++++++++++++++ + ++--------------------+--------------------------------------------------------------------------------------------------------------+ +|Interface Definition|Description | ++====================+==============================================================================================================+ +|URI |/onap/so/infra/serviceInstantiation/serviceInstances/v6/{serviceInstanceId}/vnfs/{vnfInstanceId}/vfModules/{vfmoduleinstance-id} | ++--------------------+--------------------------------------------------------------------------------------------------------------+ +|Operation Type |DELETE | ++--------------------+--------------------------------------------------------------------------------------------------------------+ +|Content-Type |application/json | ++--------------------+--------------------------------------------------------------------------------------------------------------+ + +Request Body: + ++----------------+---------+-----------+--------------------------+-------------------------------------------+ +|Attribute |Qualifier|Cardinality|Content |Description | ++================+=========+===========+==========================+===========================================+ +|requestDetails |M |1 |requestDetails Object |Content of requestDetails object. | ++----------------+---------+-----------+--------------------------+-------------------------------------------+ + +RequestDetails Object + ++---------------------+-------------------------+-------------------------------------------------+ +|Attribute |Content |Description | ++=====================+=========================+=================================================+ +|modelInfo |modelInfo Object |Content of modelInfo object. | ++---------------------+-------------------------+-------------------------------------------------+ +|cloudConfiguration |cloudConfiguration Object|Content of cloudConfiguration object. | ++---------------------+-------------------------+-------------------------------------------------+ +|requestInfo |requestInfo Object |Content of requestInfo object. | ++---------------------+-------------------------+-------------------------------------------------+ + +ModelInfo Object + ++-------------------------+------------------+-------------------------------------------------+ +|Attribute |Content |Description | ++=========================+==================+=================================================+ +|ModelType |String |Type of model | ++-------------------------+------------------+-------------------------------------------------+ +|ModelInvariantId |String |The Model Invariant Id. | ++-------------------------+------------------+-------------------------------------------------+ +|ModelNameVersionId |String |The modelname Version Id | ++-------------------------+------------------+-------------------------------------------------+ +|ModelName |String |Name of the Model | ++-------------------------+------------------+-------------------------------------------------+ +|ModelVersion |String |Version of the model | ++-------------------------+------------------+-------------------------------------------------+ +|ModelCustomization Name |String |The Model Customization name | ++-------------------------+------------------+-------------------------------------------------+ + +CloudConfiguration Object + ++-------------------------+------------------+-------------------------------------------------+ +|Attribute |Content |Description | ++=========================+==================+=================================================+ +|lcpCloudRegionId |String |CloudRegion Id (in A&AI) | ++-------------------------+------------------+-------------------------------------------------+ +|tenantId |String |Name of the Subscriber | ++-------------------------+------------------+-------------------------------------------------+ + +RequestInfo Object + ++-------------------------+------------------+-------------------------------------------------+ +|Attribute |Content |Description | ++=========================+==================+=================================================+ +|Source |String |source of the request | ++-------------------------+------------------+-------------------------------------------------+ + +Create VNF ++++++++++++++++ + ++--------------------+--------------------------------------------------------------+ +|Interface Definition|Description | ++====================+==============================================================+ +|URI |/onap/so/infra/serviceInstantiation/serviceInstances/v6/{serviceInstanceId}/vnfs | ++--------------------+--------------------------------------------------------------+ +|Operation Type |POST | ++--------------------+--------------------------------------------------------------+ +|Content-Type |application/json | ++--------------------+--------------------------------------------------------------+ + +Request Body: + ++----------------+---------+-----------+--------------------------+-------------------------------------------+ +|Attribute |Qualifier|Cardinality|Content |Description | ++================+=========+===========+==========================+===========================================+ +|requestDetails |M |1 |requestDetails Object |Content of requestDetails object. | ++----------------+---------+-----------+--------------------------+-------------------------------------------+ + +RequestDetails Object + ++-------------------+--------------------------+-------------------------------------------------+ +|Attribute |Content |Description | ++===================+==========================+=================================================+ +|modelInfo |modelInfo Object |Content of modelInfo object. | ++-------------------+--------------------------+-------------------------------------------------+ +|subscriberInfo |subscriberInfo Object |Content of subscriberInfo object. | ++-------------------+--------------------------+-------------------------------------------------+ +|requestInfo |requestInfo Object |Content of requestInfo object. | ++-------------------+--------------------------+-------------------------------------------------+ +|requestParameters |requestParameters Object |Content of requestParameters object. | ++-------------------+--------------------------+-------------------------------------------------+ +|relatedInstanceList|relatedInstanceList Object|Content of relatedInstanceList object. | ++-------------------+--------------------------+-------------------------------------------------+ +|cloudConfiguration |cloudConfiguration Object |Content of cloudConfiguration object. | ++-------------------+--------------------------+-------------------------------------------------+ +|project |project Object |Content of project object. | ++-------------------+--------------------------+-------------------------------------------------+ +|owningEntity |owningEntity Object |Content of owningEntity object. | ++-------------------+--------------------------+-------------------------------------------------+ +|platform |platform Object |Content of platform object. | ++-------------------+--------------------------+-------------------------------------------------+ +|lineOfBusiness |lineOfBusiness Object |Content of lineOfBusiness object. | ++-------------------+--------------------------+-------------------------------------------------+ + +ModelInfo Object + ++-------------------------+------------------+-------------------------------------------------+ +|Attribute |Content |Description | ++=========================+==================+=================================================+ +|ModelType |String |Type of model | ++-------------------------+------------------+-------------------------------------------------+ +|ModelInvariantId |String |The Model Invariant Id. | ++-------------------------+------------------+-------------------------------------------------+ +|ModelNameVersionId |String |The modelname Version Id | ++-------------------------+------------------+-------------------------------------------------+ +|ModelName |String |Name of the Model | ++-------------------------+------------------+-------------------------------------------------+ +|ModelVersion |String |Version of the model | ++-------------------------+------------------+-------------------------------------------------+ +|ModelCustomization Name |String |The Model Customization name | ++-------------------------+------------------+-------------------------------------------------+ +|modelCustomizationUuid |String |The Model Customization UUid | ++-------------------------+------------------+-------------------------------------------------+ +|modelVersionId |String |The Model version id | ++-------------------------+------------------+-------------------------------------------------+ +|modelUuid |String |The Model UUid | ++-------------------------+------------------+-------------------------------------------------+ +|modelInvariantUuid |String |The Model Invariant UUid | ++-------------------------+------------------+-------------------------------------------------+ +|modelInstanceName |String |The Model Instance name | ++-------------------------+------------------+-------------------------------------------------+ + +CloudConfiguration Object + ++-------------------------+------------------+-------------------------------------------------+ +|Attribute |Content |Description | ++=========================+==================+=================================================+ +|lcpCloudRegionId |String |CloudRegion Id (in A&AI) | ++-------------------------+------------------+-------------------------------------------------+ +|tenantId |String |Name of the Subscriber | ++-------------------------+------------------+-------------------------------------------------+ + +RequestInfo Object + ++-------------------------+------------------+-------------------------------------------------+ +|Attribute |Content |Description | ++=========================+==================+=================================================+ +|Source |String |source of the request | ++-------------------------+------------------+-------------------------------------------------+ +|billingAccountNumber |String |billingAccountNumber of the request | ++-------------------------+------------------+-------------------------------------------------+ +|callbackUrl |String |callbackUrl of the request | ++-------------------------+------------------+-------------------------------------------------+ +|correlator |String |correlator of the request | ++-------------------------+------------------+-------------------------------------------------+ +|orderNumber |String |orderNumber of the request | ++-------------------------+------------------+-------------------------------------------------+ +|productFamilyId |String |productFamilyId of the request | ++-------------------------+------------------+-------------------------------------------------+ +|orderVersion |String |orderVersion of the request | ++-------------------------+------------------+-------------------------------------------------+ +|instanceName |String |instanceName of the request | ++-------------------------+------------------+-------------------------------------------------+ +|suppressRollback |String |suppressRollback of the request | ++-------------------------+------------------+-------------------------------------------------+ +|requestorId |String |requestorId of the request | ++-------------------------+------------------+-------------------------------------------------+ + +relatedInstance List + ++-------------------------+------------------+-------------------------------------------------+ +|Attribute |Content |Description | ++=========================+==================+=================================================+ +|relatedInstance |Object |relatedInstance Object | ++-------------------------+------------------+-------------------------------------------------+ + +relatedInstance List + ++-------------------------+------------------+-------------------------------------------------+ +|Attribute |Content |Description | ++=========================+==================+=================================================+ +|instanceId |String |instanceId | ++-------------------------+------------------+-------------------------------------------------+ +|modelInfo |Object |Content of modelInfo object. | ++-------------------------+------------------+-------------------------------------------------+ + +RequestParameters Object + ++-------------------------+------------------+-------------------------------------------------+ +|Attribute |Content |Description | ++=========================+==================+=================================================+ +|UserParams |Array |The product family Id. | ++-------------------------+------------------+-------------------------------------------------+ + +UserParams Object + ++-------------------------+------------------+-------------------------------------------------+ +|Attribute |Content |Description | ++=========================+==================+=================================================+ +|name |String |Tag name of attribute | ++-------------------------+------------------+-------------------------------------------------+ +|value |String |Value of the tag | ++-------------------------+------------------+-------------------------------------------------+ + +Delete VNF ++++++++++++++++ + ++--------------------+------------------------------------------------------------------------------+ +|Interface Definition|Description | ++====================+==============================================================================+ +|URI |/onap/so/infra/serviceInstantiation/serviceInstances/v6/{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 |/onap/so/infra/serviceInstantiation/orchestrationRequests/v6/{request-id} | ++--------------------+--------------------------------------------------------------+ +|Operation Type |GET | ++--------------------+--------------------------------------------------------------+ +|Content-Type |application/json | ++--------------------+--------------------------------------------------------------+ + +Response Body: + ++----------------+---------+-----------+--------------------------+-------------------------------------------+ +|Attribute |Qualifier|Cardinality|Content |Description | ++================+=========+===========+==========================+===========================================+ +|request |M |1 |request Object |Content of request object. | ++----------------+---------+-----------+--------------------------+-------------------------------------------+ + +Request Object + ++-------------------+---------+-----------+--------------------------+-------------------------------------------+ +|Attribute |Qualifier|Cardinality|Content |Description | ++===================+=========+===========+==========================+===========================================+ +|requestId |M |1 |String |Request Id | ++-------------------+---------+-----------+--------------------------+-------------------------------------------+ +|startTime |M |1 |request Object |Start time. | ++-------------------+---------+-----------+--------------------------+-------------------------------------------+ +|requestScope |M |1 |request Object |Scope of the request. | ++-------------------+---------+-----------+--------------------------+-------------------------------------------+ +|requestType |M |1 |request Object |Type of the request. | ++-------------------+---------+-----------+--------------------------+-------------------------------------------+ +|requestDetails |M |1 |requestDetails Object |Type of the request. | ++-------------------+---------+-----------+--------------------------+-------------------------------------------+ +|requestStatus |M |1 |requestStatus Object |Type of the request. | ++-------------------+---------+-----------+--------------------------+-------------------------------------------+ + +RequestDetails Object + ++-------------------+--------------------------+-------------------------------------------------+ +|Attribute |Content |Description | ++===================+==========================+=================================================+ +|modelInfo |modelInfo Object |Content of modelInfo object. | ++-------------------+--------------------------+-------------------------------------------------+ +|subscriberInfo |subscriberInfo Object |Content of subscriberInfo object. | ++-------------------+--------------------------+-------------------------------------------------+ +|requestInfo |requestInfo Object |Content of requestInfo object. | ++-------------------+--------------------------+-------------------------------------------------+ +|requestParameters |requestParameters Object |Content of requestParameters object. | ++-------------------+--------------------------+-------------------------------------------------+ +|relatedInstanceList|relatedInstanceList Object|Content of relatedInstanceList object. | ++-------------------+--------------------------+-------------------------------------------------+ +|cloudConfiguration |cloudConfiguration Object |Content of cloudConfiguration object. | ++-------------------+--------------------------+-------------------------------------------------+ +|project |project Object |Content of project object. | ++-------------------+--------------------------+-------------------------------------------------+ +|owningEntity |owningEntity Object |Content of owningEntity object. | ++-------------------+--------------------------+-------------------------------------------------+ +|platform |platform Object |Content of platform object. | ++-------------------+--------------------------+-------------------------------------------------+ +|lineOfBusiness |lineOfBusiness Object |Content of lineOfBusiness object. | ++-------------------+--------------------------+-------------------------------------------------+ + +ModelInfo Object + ++-------------------------+------------------+-------------------------------------------------+ +|Attribute |Content |Description | ++=========================+==================+=================================================+ +|ModelType |String |Type of model | ++-------------------------+------------------+-------------------------------------------------+ +|ModelInvariantId |String |The Model Invariant Id. | ++-------------------------+------------------+-------------------------------------------------+ +|ModelNameVersionId |String |The modelname Version Id | ++-------------------------+------------------+-------------------------------------------------+ +|ModelName |String |Name of the Model | ++-------------------------+------------------+-------------------------------------------------+ +|ModelVersion |String |Version of the model | ++-------------------------+------------------+-------------------------------------------------+ +|ModelCustomization Name |String |The Model Customization name | ++-------------------------+------------------+-------------------------------------------------+ +|modelCustomizationUuid |String |The Model Customization UUid | ++-------------------------+------------------+-------------------------------------------------+ +|modelVersionId |String |The Model version id | ++-------------------------+------------------+-------------------------------------------------+ +|modelUuid |String |The Model UUid | ++-------------------------+------------------+-------------------------------------------------+ +|modelInvariantUuid |String |The Model Invariant UUid | ++-------------------------+------------------+-------------------------------------------------+ +|modelInstanceName |String |The Model Instance name | ++-------------------------+------------------+-------------------------------------------------+ + +SubscriberInfo Object + ++-------------------------+------------------+-------------------------------------------------+ +|Attribute |Content |Description | ++=========================+==================+=================================================+ +|GlobalSubscriberId |String |Global customer Id (in A&AI) | ++-------------------------+------------------+-------------------------------------------------+ +|SubscriberName |String |Name of the Subscriber | ++-------------------------+------------------+-------------------------------------------------+ + +RequestInfo Object + ++-------------------------+------------------+-------------------------------------------------+ +|Attribute |Content |Description | ++=========================+==================+=================================================+ +|Source |String |source of the request | ++-------------------------+------------------+-------------------------------------------------+ +|billingAccountNumber |String |billingAccountNumber of the request | ++-------------------------+------------------+-------------------------------------------------+ +|callbackUrl |String |callbackUrl of the request | ++-------------------------+------------------+-------------------------------------------------+ +|correlator |String |correlator of the request | ++-------------------------+------------------+-------------------------------------------------+ +|orderNumber |String |orderNumber of the request | ++-------------------------+------------------+-------------------------------------------------+ +|productFamilyId |String |productFamilyId of the request | ++-------------------------+------------------+-------------------------------------------------+ +|orderVersion |String |orderVersion of the request | ++-------------------------+------------------+-------------------------------------------------+ +|instanceName |String |instanceName of the request | ++-------------------------+------------------+-------------------------------------------------+ +|suppressRollback |String |suppressRollback of the request | ++-------------------------+------------------+-------------------------------------------------+ +|requestorId |String |requestorId of the request | ++-------------------------+------------------+-------------------------------------------------+ + +RequestParameters Object + ++-------------------------+------------------+-------------------------------------------------+ +|Attribute |Content |Description | ++=========================+==================+=================================================+ +|SubscriptionServiceType |String |The service type of the Subscription | ++-------------------------+------------------+-------------------------------------------------+ + +RequestStatus Object + ++-------------------------+------------------+-------------------------------------------------+ +|Attribute |Content |Description | ++=========================+==================+=================================================+ +|finishTime |String |Time | ++-------------------------+------------------+-------------------------------------------------+ +|requestState |String |state of the request | ++-------------------------+------------------+-------------------------------------------------+ +|statusMessage |String |statusMessage | ++-------------------------+------------------+-------------------------------------------------+ +|percentProgress |String |percentage of progress | ++-------------------------+------------------+-------------------------------------------------+ + +GET Orchestration Requests +++++++++++++++++++++++++++ + ++--------------------+--------------------------------------------------------------+ +|Interface Definition|Description | ++====================+==============================================================+ +|URI |/onap/so/infra/serviceInstantiation/orchestrationRequests/v6 | ++--------------------+--------------------------------------------------------------+ +|Operation Type |GET | ++--------------------+--------------------------------------------------------------+ +|Content-Type |application/json | ++--------------------+--------------------------------------------------------------+ + +Response Body: + ++----------------+---------+-----------+--------------------------+-------------------------------------------+ +|Attribute |Qualifier|Cardinality|Content |Description | ++================+=========+===========+==========================+===========================================+ +|requestList |M |1 |Array |Content of request List. | ++----------------+---------+-----------+--------------------------+-------------------------------------------+ + +RequestList : + ++----------------+---------+-----------+--------------------------+-------------------------------------------+ +|Attribute |Qualifier|Cardinality|Content |Description | ++================+=========+===========+==========================+===========================================+ +|request |M |1 |request Object |Content of request object. | ++----------------+---------+-----------+--------------------------+-------------------------------------------+ + +Request Object + ++-------------------+---------+-----------+--------------------------+-------------------------------------------+ +|Attribute |Qualifier|Cardinality|Content |Description | ++===================+=========+===========+==========================+===========================================+ +|requestId |M |1 |String |Request Id. | ++-------------------+---------+-----------+--------------------------+-------------------------------------------+ +|startTime |M |1 |request Object |Start time. | ++-------------------+---------+-----------+--------------------------+-------------------------------------------+ +|requestScope |M |1 |request Object |Scope of the request. | ++-------------------+---------+-----------+--------------------------+-------------------------------------------+ +|requestType |M |1 |request Object |Type of the request. | ++-------------------+---------+-----------+--------------------------+-------------------------------------------+ +|requestDetails |M |1 |requestDetails Object |Type of the request. | ++-------------------+---------+-----------+--------------------------+-------------------------------------------+ +|requestStatus |M |1 |requestStatus Object |Type of the request. | ++-------------------+---------+-----------+--------------------------+-------------------------------------------+ + +RequestDetails Object + ++-------------------+--------------------------+-------------------------------------------------+ +|Attribute |Content |Description | ++===================+==========================+=================================================+ +|modelInfo |modelInfo Object |Content of modelInfo object. | ++-------------------+--------------------------+-------------------------------------------------+ +|subscriberInfo |subscriberInfo Object |Content of subscriberInfo object. | ++-------------------+--------------------------+-------------------------------------------------+ +|requestInfo |requestInfo Object |Content of requestInfo object. | ++-------------------+--------------------------+-------------------------------------------------+ +|requestParameters |requestParameters Object |Content of requestParameters object. | ++-------------------+--------------------------+-------------------------------------------------+ +|relatedInstanceList|relatedInstanceList Object|Content of relatedInstanceList object. | ++-------------------+--------------------------+-------------------------------------------------+ +|cloudConfiguration |cloudConfiguration Object |Content of cloudConfiguration object. | ++-------------------+--------------------------+-------------------------------------------------+ +|project |project Object |Content of project object. | ++-------------------+--------------------------+-------------------------------------------------+ +|owningEntity |owningEntity Object |Content of owningEntity object. | ++-------------------+--------------------------+-------------------------------------------------+ +|platform |platform Object |Content of platform object. | ++-------------------+--------------------------+-------------------------------------------------+ +|lineOfBusiness |lineOfBusiness Object |Content of lineOfBusiness object. | ++-------------------+--------------------------+-------------------------------------------------+ + +ModelInfo Object + ++-------------------------+------------------+-------------------------------------------------+ +|Attribute |Content |Description | ++=========================+==================+=================================================+ +|ModelType |String |Type of model | ++-------------------------+------------------+-------------------------------------------------+ +|ModelInvariantId |String |The Model Invariant Id. | ++-------------------------+------------------+-------------------------------------------------+ +|ModelNameVersionId |String |The modelname Version Id | ++-------------------------+------------------+-------------------------------------------------+ +|ModelName |String |Name of the Model | ++-------------------------+------------------+-------------------------------------------------+ +|ModelVersion |String |Version of the model | ++-------------------------+------------------+-------------------------------------------------+ +|ModelCustomization Name |String |The Model Customization name | ++-------------------------+------------------+-------------------------------------------------+ +|modelCustomizationUuid |String |The Model Customization UUid | ++-------------------------+------------------+-------------------------------------------------+ +|modelVersionId |String |The Model version id | ++-------------------------+------------------+-------------------------------------------------+ +|modelUuid |String |The Model UUid | ++-------------------------+------------------+-------------------------------------------------+ +|modelInvariantUuid |String |The Model Invariant UUid | ++-------------------------+------------------+-------------------------------------------------+ +|modelInstanceName |String |The Model Instance name | ++-------------------------+------------------+-------------------------------------------------+ + +SubscriberInfo Object + ++-------------------------+------------------+-------------------------------------------------+ +|Attribute |Content |Description | ++=========================+==================+=================================================+ +|GlobalSubscriberId |String |Global customer Id (in A&AI) | ++-------------------------+------------------+-------------------------------------------------+ +|SubscriberName |String |Name of the Subscriber | ++-------------------------+------------------+-------------------------------------------------+ + +RequestInfo Object + ++-------------------------+------------------+-------------------------------------------------+ +|Attribute |Content |Description | ++=========================+==================+=================================================+ +|Source |String |source of the request | ++-------------------------+------------------+-------------------------------------------------+ +|billingAccountNumber |String |billingAccountNumber of the request | ++-------------------------+------------------+-------------------------------------------------+ +|callbackUrl |String |callbackUrl of the request | ++-------------------------+------------------+-------------------------------------------------+ +|correlator |String |correlator of the request | ++-------------------------+------------------+-------------------------------------------------+ +|orderNumber |String |orderNumber of the request | ++-------------------------+------------------+-------------------------------------------------+ +|productFamilyId |String |productFamilyId of the request | ++-------------------------+------------------+-------------------------------------------------+ +|orderVersion |String |orderVersion of the request | ++-------------------------+------------------+-------------------------------------------------+ +|instanceName |String |instanceName of the request | ++-------------------------+------------------+-------------------------------------------------+ +|suppressRollback |String |suppressRollback of the request | ++-------------------------+------------------+-------------------------------------------------+ +|requestorId |String |requestorId of the request | ++-------------------------+------------------+-------------------------------------------------+ + +RequestParameters Object + ++-------------------------+------------------+-------------------------------------------------+ +|Attribute |Content |Description | ++=========================+==================+=================================================+ +|SubscriptionServiceType |String |The service type of the Subscription | ++-------------------------+------------------+-------------------------------------------------+ + +RequestStatus Object + ++-------------------------+------------------+-------------------------------------------------+ +|Attribute |Content |Description | ++=========================+==================+=================================================+ +|finishTime |String |Time | ++-------------------------+------------------+-------------------------------------------------+ +|requestState |String |state of the request | ++-------------------------+------------------+-------------------------------------------------+ +|statusMessage |String |statusMessage | ++-------------------------+------------------+-------------------------------------------------+ +|percentProgress |String |percentage of progress | ++-------------------------+------------------+-------------------------------------------------+ + +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 |/onap/so/infra/serviceInstantiation/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 | ++------------------------------+-----------------+------------------------------------+ +|serviceUuid |String |Model UUID | ++------------------------------+-----------------+------------------------------------+ +|serviceInvariantUuid |String |Model Invariant UUID | ++------------------------------+-----------------+------------------------------------+ +|gloabalSubscriberId |String |Customer Id | ++------------------------------+-----------------+------------------------------------+ +|serviceType |String |service Type | ++------------------------------+-----------------+------------------------------------+ +|parameters |Object |Parameter Object | ++------------------------------+-----------------+------------------------------------+ + +Parameter Object + ++------------------------------+-----------------+------------------------------------+ +|Attribute |Content |Description | ++==============================+=================+====================================+ +|locationConstraints |List of object |location infor for each vnf | ++------------------------------+-----------------+------------------------------------+ +|resource |List of Resource |resource of service/resource | ++------------------------------+-----------------+------------------------------------+ +|requestInputs |key-value map |input of service/resource ++------------------------------+-----------------+------------------------------------+ + +LocationConstraint Object + ++------------------------------+-----------------+------------------------------------+ +|Attribute |Content |Description | ++==============================+=================+====================================+ +|vnfProfileId |String |Customization id for VNF | ++------------------------------+-----------------+------------------------------------+ +|locationConstraints |Object |DC location info of VNF | ++------------------------------+-----------------+------------------------------------+ + +VnfLocationConstraint Object + ++------------------------------+-----------------+------------------------------------+ +|Attribute |Content |Description | ++==============================+=================+====================================+ +|vimId |String |VIM id from ESR definition | ++------------------------------+-----------------+------------------------------------+ + +Resource Object + ++------------------------------+-----------------+------------------------------------+ +|Attribute |Content |Description | ++==============================+=================+====================================+ +|resourceName |String |The resource name | ++------------------------------+-----------------+------------------------------------+ +|resourceInvariantUuid |String |The resource invariant UUID. | ++------------------------------+-----------------+------------------------------------+ +|resourceUuid |String |The resource UUID. | ++------------------------------+-----------------+------------------------------------+ +|resourceCustomizationUuid |String |The resource customization UUID. | ++------------------------------+-----------------+------------------------------------+ +|parameters |Object |Parameter of 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 |/onap/so/infra/serviceInstantiation/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 |/onap/so/infra/serviceInstantiation/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 | ++-------------------+---------+-----------+-------+-----------------------+ +|subscriber-name |O |1 |String |Subscriber name | ++-------------------+---------+-----------+-------+-----------------------+ +|subscriber-type |O |1 |String |Subscriber 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.37/{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 | ++=========================+==================+==============================================================================+ +|Location |String |The location URL of the server. | ++-------------------------+------------------+------------------------------------------------------------------------------+ +|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. | ++----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+ +|is_default |O |1 |boolean |The network is default or not. | ++----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+ +|availability_zone_hints |O |1 |array |The availability zone candidate for the network. | ++----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+ + +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. | ++-----------------------------+------------------+------------------------------------------------------------------------------+ +|created_at |String |Time at which the resource has been created (in UTC ISO8601 format). | ++-----------------------------+------------------+------------------------------------------------------------------------------+ +|dns_domain |String |A valid DNS domain. | ++-----------------------------+------------------+------------------------------------------------------------------------------+ +|id |String |The ID of the network. | ++-----------------------------+------------------+------------------------------------------------------------------------------+ +|ipv4_address_scope |String |The ID of the IPv4 address scope that the network is associated with. | ++-----------------------------+------------------+------------------------------------------------------------------------------+ +|ipv6_address_scope |String |The ID of the IPv6 address scope that the network is associated with. | ++-----------------------------+------------------+------------------------------------------------------------------------------+ +|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. | ++-----------------------------+------------------+------------------------------------------------------------------------------+ +|updated_at |String |Time at which the resource has been updated (in UTC ISO8601 format). | ++-----------------------------+------------------+------------------------------------------------------------------------------+ +|vlan_transparent |boolean |Indicates the VLAN transparency mode of the network. | ++-----------------------------+------------------+------------------------------------------------------------------------------+ +|description |String |A human-readable description for the resource. | ++-----------------------------+------------------+------------------------------------------------------------------------------+ +|is_default |boolean |The network is default pool or not. | ++-----------------------------+------------------+------------------------------------------------------------------------------+ + +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 |String |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. | ++----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+ +|service_types |O |1 |array |The service types associated with the subnet. | ++----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+ + +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. | ++----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+ +|qos_policy_id |O |1 |string |QoS policy associated with the port. | ++----------------------------+---------+-----------+--------------------------+-------------------------------------------------------------------------------------------------+ +|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. | ++-----------------------------+------------------+------------------------------------------------------------------------------+ +|ip_allocation |string |Indicates when ports use either deferred, immediate or no IP allocation (none)| ++-----------------------------+------------------+------------------------------------------------------------------------------+ +|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. | ++-----------------------------+------------------+------------------------------------------------------------------------------+ +|qos_policy_id |string |The ID of the QoS policy associated with the port. | ++-----------------------------+------------------+------------------------------------------------------------------------------+ +|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. | ++-----------------------------+------------------+------------------------------------------------------------------------------+ +|created_at |string |Time at which the resource has been created (in UTC ISO8601 format). | ++-----------------------------+------------------+------------------------------------------------------------------------------+ +|updated_at |string |Time at which the resource has been updated (in UTC ISO8601 format). | ++-----------------------------+------------------+------------------------------------------------------------------------------+ +|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 | ++------------------+---------------------+ + + +OOF/HAS create update API ++++++++++++++++++++++++++ + ++--------------------+--------------------------+ +|Interface Definition|Description | ++====================+==========================+ +|URI |/api/oof/v1/placement | ++--------------------+--------------------------+ +|Operation Type |POST | ++--------------------+--------------------------+ + + +Request Parameters: + ++-------------------+---------+-----------+-------+-------------------------------------------------------------+ +|Attribute |Required |Cardinality|Content|Description | ++===================+=========+===========+=======+=============================================================+ +|requestInfo |Y |1 |Object |The content of the RequestInfo object. | ++-------------------+---------+-----------+-------+-------------------------------------------------------------+ +|placementInfo |Y |1 |Object |The Content of the PlacementInfo object. | ++-------------------+---------+-----------+-------+-------------------------------------------------------------+ +|licenseInfo |N |1 |Object |The Content of the LicenseInfo object. | ++-------------------+---------+-----------+-------+-------------------------------------------------------------+ +|serviceInfo |Y |1 |Object |The Content of the ServiceInfo object. | ++-------------------+---------+-----------+-------+-------------------------------------------------------------+ + + ++-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ +|Attribute |Required |Cardinality|Content|Description | ++===================+=========+===========+=======+=======================================================================+ +|transactionId |Y |1 |String |A unique ID to track an ONAP transaction. | ++-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ +|requestId |Y |1 |String |A unique ID to track multiple requests. | ++-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ +|callbackUrl |Y |1 |String |The end point of a callback service where recommendations are posted. | ++-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ +|callbackHeader |N |1 |String |The header information a client expecting in a async callback. | ++-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ +|sourceId |Y |1 |String |The unique ID of a client making an optimization call. | ++-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ +|requestType |Y |1 |String |The type of a request | ++-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ +|numSolutions |N |1 |Integer|Expected number of solutions. | ++-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ +|optimizers |Y |1..N |List of Strings|A list of optimization services. | ++-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ +|timeout |N |1 |Integer|A tolerance window (in secs) for expecting solutions. Default is 600 secs.| ++-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ + + +PlacementInfo Object + ++-------------------+---------+-----------+-------+-------------------------------------------------------------+ +|Attribute |Required |Cardinality|Content|Description | ++===================+=========+===========+=======+=============================================================+ +|requestParameters |C |1 |String |A JSON object conaining service and customer-specific data. A client or service designer is required to specify the parameters of interest for a given service and their location in the JSON blob through optimization query policies. This attribute is only required if a request contains service or customer-specific information.| ++-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ +|placementDemands |Y |1..N |List of PlacementDemand Object|The resource information for a placement service.| ++-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ +|subscriberInfo |N |1 |Object |The information of a service subscriber. | ++-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ + +PlacementDemand Object + ++-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ +|Attribute |Required |Cardinality|Content|Description | ++===================+=========+===========+=======+=======================================================================+ +|resourceModuleName |Y |1 |String |A resource name as defined in a service model. | ++-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ +|serviceResourceId |Y |1 |String |A unique resource Id with a local scope between client and OOF. | ++-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ +|tenantId |N |1 |String |A tenant Id as defined in the ordering system. | ++-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ +|resourceModelInfo |Y |1 |Object |Resource model information as defined in SDC. | ++-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ +|existingCandidates |N |1..N |List of Candidates Objects | The existing placement information of a resource. | ++-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ +|excludedCandidates |N |1..N |List of Candidates Objects |Candidates that need to be excluded from solutions.| ++-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ +|requiredCandidates |N |1..N |List of Candidates Objects |Candidates that must be included in solutions. | ++-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ + + +SubscriberInfo Object + ++-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ +|Attribute |Required |Cardinality|Content|Description | ++===================+=========+===========+=======+=======================================================================+ +|globalSubscriberId |Y |1 |String |An ID of a subscriber. | ++-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ +|subscriberName |Y |1.N |String |The name of a subscriber. If the name is not known, the value must be 'unknown'.| ++-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ +|subscriberCommonSiteId |N |1 |String |Id representing a subscriber location. | ++-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ + +ModelMetaData Object + ++-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ +|Attribute |Required |Cardinality|Content|Description | ++===================+=========+===========+=======+=======================================================================+ +|modelInvariantId |Y |1 |String |A model invariant Id as defined in a service model. | ++-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ +|modelVersionId |Y |1 |String |A unique model Id as defined in a service model. | ++-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ +|modelName |N |1 |String |A model name as defined in a service model. | ++-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ +|modelType |N |1 |String |A model type as defined in a service model. | ++-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ +|modelVersion |N |1 |String |A model version as defined in a service model. | ++-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ +|modelCustomizationName |N |1 |String |A model customization name as defined in a service model. | ++-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ + + +Candidates Object + ++-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ +|Attribute |Required |Cardinality|Content|Description | ++===================+=========+===========+=======+=======================================================================+ +|identifierType |Y |1 |String |The type of a candidate. | ++-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ +|identifiers |Y |1..N |List |A list of identifiers. | ++-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ +|cloudOwner |C |1 |String |The name of a cloud owner. Only required if identifierType is cloud_region_id.| ++-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ + + +ServiceInfo Object + ++-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ +|Attribute |Required |Cardinality|Content|Description | ++===================+=========+===========+=======+=======================================================================+ +|serviceInstanceId |Y |1 |String |A service instance id associated with a request. | ++-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ +|modelInfo |Y |1 |ModelMetaData Object |A list of identifiers. | ++-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ +|serviceName |Y |1 |String |The name of a service | ++-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ + +LicenseInfo Object + ++-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ +|Attribute |Required |Cardinality|Content|Description | ++===================+=========+===========+=======+=======================================================================+ +|licenseDemands |Y |1..N |List of LicenseDemands Object |A list of resources for license selection. | ++-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ + +LicenseDemand Object + ++-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ +|Attribute |Required |Cardinality|Content|Description | ++===================+=========+===========+=======+=======================================================================+ +|resourceModuleName |Y |1 |String |A resource name as defined in a service model. | ++-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ +|serviceResourceId |Y |1 |String |A unique resource Id with a local scope between client and OOF. | ++-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ +|resourceModelInfo |Y |1 |ModelMetaData Object |Resource model information as defined in a service model.| ++-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ +|existingLicenses |N |1 |LicenseModel Object |Existing license information assigned to a resource. | ++-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ + +LicenseModel Object + ++-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ +|Attribute |Required |Cardinality|Content|Description | ++===================+=========+===========+=======+=======================================================================+ +|entitlementPoolUUID|Y |1..N |List |Entitlement pool UUIDs associated with a resource. | ++-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ +|licenseKeyGroupUUID|Y |1..N |List |License key groups associated with a resource. | ++-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ + + +Response Body + ++-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ +|Attribute |Required |Cardinality|Content|Description | ++===================+=========+===========+=======+=======================================================================+ +|requestId |Y |1 |String |A unique Id for an ONAP transaction. | ++-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ +|transactionId |Y |1 |String |A unique ID to track multiple requests associated with a transaction. | ++-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ +|statusMessage |N |1 |String |Reasoning if a requestStatus is failed. | ++-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ +|requestStatus |Y |1 |String |The status of a request. | ++-------------------+---------+-----------+-------+-----------------------------------------------------------------------+ \ No newline at end of file diff --git a/docs/api/offered_consumed_apis.rst b/docs/api/offered_consumed_apis.rst index f6b593a84d..7eb4d47d85 100644 --- a/docs/api/offered_consumed_apis.rst +++ b/docs/api/offered_consumed_apis.rst @@ -33,4 +33,8 @@ The list of APIs that SO offerers for monitroing the BPMN flows could be found i ":download:`link `", ":download:`link `" Detailed documentation can be found here: - SO_Interface.rst \ No newline at end of file + +.. toctree:: + :maxdepth: 1 + + apis/SO_Interface.rst \ No newline at end of file -- cgit 1.2.3-korg From 0854ab8b5b108cfce82d7362b616ab50e9621da4 Mon Sep 17 00:00:00 2001 From: seshukm Date: Sun, 6 Jan 2019 11:53:10 +0530 Subject: Fix the dev info Issue-ID: SO-1337 Change-Id: Ic3e7976dcca6457968ddcca2cfbe1ccb3ec1f5c2 Signed-off-by: seshukm --- docs/api/offered_consumed_apis.rst | 7 +++++-- docs/developer_info/developer_information.rst | 11 +++++------ 2 files changed, 10 insertions(+), 8 deletions(-) (limited to 'docs') diff --git a/docs/api/offered_consumed_apis.rst b/docs/api/offered_consumed_apis.rst index 7eb4d47d85..0caef0a426 100644 --- a/docs/api/offered_consumed_apis.rst +++ b/docs/api/offered_consumed_apis.rst @@ -31,10 +31,13 @@ The list of APIs that SO offerers for monitroing the BPMN flows could be found i "swagger json file", "yaml doc" ":download:`link `", ":download:`link `" - + +Further Reading +---------------------------------------- + Detailed documentation can be found here: .. toctree:: :maxdepth: 1 - + apis/SO_Interface.rst \ No newline at end of file diff --git a/docs/developer_info/developer_information.rst b/docs/developer_info/developer_information.rst index 61be8f006f..f6d66b913d 100644 --- a/docs/developer_info/developer_information.rst +++ b/docs/developer_info/developer_information.rst @@ -7,14 +7,13 @@ SO Developer Information .. toctree:: :maxdepth: 1 - -.. developer_info_Project_Structure.rst + Camunda_Modeler.rst -.. developer_info_Main_Process_Flows.rst -.. developer_info_Subprocess_Process_Flows.rst -.. developer_info_Project_Deployment_Strategy.rst Building_SO.rst Working_with_SO_Docker.rst Camunda_Cockpit_Community_Edition.rst Camunda_Cockpit_Enterprise_Edition.rst - \ No newline at end of file +.. developer_info_Project_Structure.rst +.. developer_info_Main_Process_Flows.rst +.. developer_info_Subprocess_Process_Flows.rst +.. developer_info_Project_Deployment_Strategy.rst \ No newline at end of file -- cgit 1.2.3-korg From 06c0583110d04e9dce7b606e7c55b93b643a21d0 Mon Sep 17 00:00:00 2001 From: seshukm Date: Mon, 7 Jan 2019 22:24:42 +0800 Subject: Fix the image path Issue-ID: SO-1337 Change-Id: Ifbc15a413cfc0dea96ef7fb22a500901c575af62 Signed-off-by: seshukm --- docs/api/apis/SO_Interface.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs') diff --git a/docs/api/apis/SO_Interface.rst b/docs/api/apis/SO_Interface.rst index 4f3d9146e4..e43239c294 100644 --- a/docs/api/apis/SO_Interface.rst +++ b/docs/api/apis/SO_Interface.rst @@ -5,7 +5,7 @@ SO Interfaces ================================ -.. image:: ../images/SO_1.png +.. image:: ../../images/SO_1.png SO APIs ---------------- -- cgit 1.2.3-korg From c9e3a4e402001aa04235a78880cbf19d5b54a90b Mon Sep 17 00:00:00 2001 From: seshukm Date: Thu, 10 Jan 2019 06:22:56 +0100 Subject: update the SDC client APIs Issue-ID: SO-1337 Change-Id: I87f799664ea7a3b46a53fab6eec8e0aae07c3596 Signed-off-by: seshukm --- docs/api/apis/SO_Interface.rst | 379 +---------------------------------------- 1 file changed, 4 insertions(+), 375 deletions(-) (limited to 'docs') diff --git a/docs/api/apis/SO_Interface.rst b/docs/api/apis/SO_Interface.rst index 4f3d9146e4..42571f456d 100644 --- a/docs/api/apis/SO_Interface.rst +++ b/docs/api/apis/SO_Interface.rst @@ -1151,8 +1151,8 @@ RequestStatus Object |percentProgress |String |percentage of progress | +-------------------------+------------------+-------------------------------------------------+ -SDC API --------- +SDC Client API +------------------ Get List of Existing Catalog Assets +++++++++++++++++++++++++++++++++++ @@ -1371,380 +1371,9 @@ Response: |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 +E2E Service API ---------------- + Create E2E service instance ++++++++++++++++++++++++++++ -- cgit 1.2.3-korg From fa1911835209fdec114f2b919a9e91d584622bf3 Mon Sep 17 00:00:00 2001 From: seshukm Date: Tue, 15 Jan 2019 17:40:35 +0530 Subject: update release notes for 1.3.6 Issue-ID: SO-1352 Change-Id: Ie5bc189058d5f32406e3a92e0e859826c5060f3b Signed-off-by: seshukm --- docs/release-notes.rst | 49 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 49 insertions(+) (limited to 'docs') diff --git a/docs/release-notes.rst b/docs/release-notes.rst index 1cb4ba1778..763d702aaf 100644 --- a/docs/release-notes.rst +++ b/docs/release-notes.rst @@ -8,6 +8,55 @@ Service Orchestrator Release Notes The SO provides the highest level of service orchestration in the ONAP architecture. +Version: 1.3.6 +-------------- + +:Release Date: 2018-01-10 + +This is the official release package that released for the Casablanca Maintenance. + +Casablanca Release branch + +**New Features** + +This release is supporting the features of Casablanca and their defect fixes. +- `SO-1336 `_ +- `SO-1249 `_ +- `SO-1257 `_ +- `SO-1258 `_ +- `SO-1256 `_ +- `SO-1194 `_ +- `SO-1248 `_ +- `SO-1184 `_ + +**Docker Images** + +Dockers released for SO: + + - onap/so/api-handler-infra,1.3.6 + - onap/so/bpmn-infra,1.3.6 + - onap/so/catalog-db-adapter,1.3.6 + - onap/so/openstack-adapter,1.3.6 + - onap/so/request-db-adapter,1.3.6 + - onap/so/sdc-controller,1.3.6 + - onap/so/sdnc-adapter,1.3.6 + - onap/so/so-monitoring,1.3.6 + - onap/so/vfc-adapter,1.3.6 + +**Known Issues** + + +**Security Notes** + + SO code has been formally scanned during build time using NexusIQ and all Critical vulnerabilities have been addressed, items that remain open have been assessed for risk and determined to be false positive. The SO open Critical security vulnerabilities and their risk assessment have been documented as part of the `project `_. + + Quick Links: + + - `SO project page `_ + - `Passing Badge information for SO `_ + - `Project Vulnerability Review Table for SO `_ + + Version: 1.3.3 -------------- -- cgit 1.2.3-korg