SOL003 - VNF Lifecycle Management interface

Sol003VnfLcm

subscriptionsGet

Query Subscription Information The GET method queries the list of active subscriptions of the functional block that invokes the method. It can be used e.g. for resynchronization after error situations.


/subscriptions

Usage and SDK Samples

curl -X GET "https://localhost/vnflcm/v1/subscriptions"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.Sol003VnfLcmApi;

import java.io.File;
import java.util.*;

public class Sol003VnfLcmApiExample {

    public static void main(String[] args) {
        
        Sol003VnfLcmApi apiInstance = new Sol003VnfLcmApi();
        String accept = accept_example; // String | Content-Types that are acceptable for the response. Reference: IETF RFC 7231

        String authorization = authorization_example; // String | The authorization token for the request. Reference: IETF RFC 7235

        try {
            inline_response_200_1 result = apiInstance.subscriptionsGet(accept, authorization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling Sol003VnfLcmApi#subscriptionsGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.Sol003VnfLcmApi;

public class Sol003VnfLcmApiExample {

    public static void main(String[] args) {
        Sol003VnfLcmApi apiInstance = new Sol003VnfLcmApi();
        String accept = accept_example; // String | Content-Types that are acceptable for the response. Reference: IETF RFC 7231

        String authorization = authorization_example; // String | The authorization token for the request. Reference: IETF RFC 7235

        try {
            inline_response_200_1 result = apiInstance.subscriptionsGet(accept, authorization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling Sol003VnfLcmApi#subscriptionsGet");
            e.printStackTrace();
        }
    }
}
String *accept = accept_example; // Content-Types that are acceptable for the response. Reference: IETF RFC 7231

String *authorization = authorization_example; // The authorization token for the request. Reference: IETF RFC 7235
 (optional)

Sol003VnfLcmApi *apiInstance = [[Sol003VnfLcmApi alloc] init];

[apiInstance subscriptionsGetWith:accept
    authorization:authorization
              completionHandler: ^(inline_response_200_1 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Sol003VnfLifecycleManagementInterface = require('sol003___vnf_lifecycle_management_interface');

var api = new Sol003VnfLifecycleManagementInterface.Sol003VnfLcmApi()

var accept = accept_example; // {String} Content-Types that are acceptable for the response. Reference: IETF RFC 7231


var opts = { 
  'authorization': authorization_example // {String} The authorization token for the request. Reference: IETF RFC 7235

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.subscriptionsGet(accept, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class subscriptionsGetExample
    {
        public void main()
        {
            
            var apiInstance = new Sol003VnfLcmApi();
            var accept = accept_example;  // String | Content-Types that are acceptable for the response. Reference: IETF RFC 7231

            var authorization = authorization_example;  // String | The authorization token for the request. Reference: IETF RFC 7235
 (optional) 

            try
            {
                inline_response_200_1 result = apiInstance.subscriptionsGet(accept, authorization);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling Sol003VnfLcmApi.subscriptionsGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\Sol003VnfLcmApi();
$accept = accept_example; // String | Content-Types that are acceptable for the response. Reference: IETF RFC 7231

$authorization = authorization_example; // String | The authorization token for the request. Reference: IETF RFC 7235


try {
    $result = $api_instance->subscriptionsGet($accept, $authorization);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling Sol003VnfLcmApi->subscriptionsGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::Sol003VnfLcmApi;

my $api_instance = WWW::SwaggerClient::Sol003VnfLcmApi->new();
my $accept = accept_example; # String | Content-Types that are acceptable for the response. Reference: IETF RFC 7231

my $authorization = authorization_example; # String | The authorization token for the request. Reference: IETF RFC 7235


eval { 
    my $result = $api_instance->subscriptionsGet(accept => $accept, authorization => $authorization);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling Sol003VnfLcmApi->subscriptionsGet: $@\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.Sol003VnfLcmApi()
accept = accept_example # String | Content-Types that are acceptable for the response. Reference: IETF RFC 7231

authorization = authorization_example # String | The authorization token for the request. Reference: IETF RFC 7235
 (optional)

try: 
    api_response = api_instance.subscriptions_get(accept, authorization=authorization)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling Sol003VnfLcmApi->subscriptionsGet: %s\n" % e)

Parameters

Header parameters
Name Description
Accept*
String
Content-Types that are acceptable for the response. Reference: IETF RFC 7231
Required
Authorization
String
The authorization token for the request. Reference: IETF RFC 7235

Responses

Status: 200 - OK The list of subscriptions was queried successfully. The response body shall contain the representations of all active subscriptions of the functional block that invokes the method.

Name Type Format Description
Content-Type String The MIME type of the body of the response.
WWW-Authenticate String Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.

Status: 400 - Bad Request Invalid attribute-based filtering parameters. The response body shall contain a ProblemDetails structure, in which the "detail" attribute should convey more information about the error.

Name Type Format Description
Content-Type String The MIME type of the body of the response.
WWW-Authenticate String Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.

Status: 401 - Unauthorized If the request contains no access token even though one is required, or if the request contains an authorization token that is invalid (e.g. expired or revoked), the API producer should respond with this response. The details of the error shall be returned in the WWW-Authenticate HTTP header, as defined in IETF RFC 6750 and IETF RFC 7235. The ProblemDetails structure may be provided.

Name Type Format Description
Content-Type String The MIME type of the body of the response.
WWW-Authenticate String Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.

Status: 403 - Forbidden If the API consumer is not allowed to perform a particular request to a particular resource, the API producer shall respond with this response code. The "ProblemDetails" structure shall be provided. It should include in the "detail" attribute information about the source of the problem, and may indicate how to solve it.

Name Type Format Description
Content-Type String The MIME type of the body of the response.

Status: 404 - Not Found If the API producer did not find a current representation for the resource addressed by the URI passed in the request, or is not willing to disclose that one exists, it shall respond with this response code. Specifically in case of this task resource, the reason can also be that the task is not supported for the VNF LCM operation occurrence represented by the parent resource, and that the task resource consequently does not exist. The "ProblemDetails" structure may be provided, including in the "detail" attribute information about the sourceof the problem, e.g. a wrong resource URI variable.

Name Type Format Description
Content-Type String The MIME type of the body of the response.

Status: 405 - Not Found If the API producer did not find a current representation for the resource addressed by the URI passed in the request, or is not willing to disclose that one exists, it shall respond with this response code. The "ProblemDetails" structure may be provided, including in the "detail" attribute information about the source of the problem, e.g. a wrong resource URI variable.

Name Type Format Description
Content-Type String The MIME type of the body of the response.

Status: 406 - Not Acceptable If the "Accept" HTTP header does not contain at least one name of a content type that is acceptable to the API producer, the API producer shall respond with this response code. The "ProblemDetails" structure may be omitted in that case.

Name Type Format Description
Content-Type String The MIME type of the body of the response.

Status: 500 - Internal Server Error If there is an application error not related to the client's input that cannot be easily mapped to any other HTTP response code ("catch all error"), the API producer shall respond withthis response code. The "ProblemDetails" structure shall be provided, and shall include in the "detail" attribute more information about the source of the problem.

Name Type Format Description
Content-Type String The MIME type of the body of the response.

Status: 503 - Service Unavailable If the API producer encounters an internal overload situation of itself or of a system it relies on, it should respond with this response code, following the provisions in IETF RFC 7231 [13] for the use of the "Retry-After" HTTP header and for the alternative to refuse the connection. The "ProblemDetails" structure may be omitted.

Name Type Format Description
Content-Type String The MIME type of the body of the response.

subscriptionsPost

Subscribe The POST method creates a new subscription. Creation of two subscription resources with the same callbackURI and the same filter can result in performance degradation and will provide duplicates of notifications to the NFVO, and might make sense only in very rare use cases. Consequently, the VNFM may either allow creating a subscription resource if another subscription resource with the same filter and callbackUri already exists (in which case it shall return the “201 Created” response code), or may decide to not create a duplicate subscription resource (in which case it shall return a “303 See Other” response code referencing the existing subscription resource with the same filter and callbackUri).


/subscriptions

Usage and SDK Samples

curl -X POST "https://localhost/vnflcm/v1/subscriptions"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.Sol003VnfLcmApi;

import java.io.File;
import java.util.*;

public class Sol003VnfLcmApiExample {

    public static void main(String[] args) {
        
        Sol003VnfLcmApi apiInstance = new Sol003VnfLcmApi();
        LccnSubscriptionRequest lccnSubscriptionRequest = ; // LccnSubscriptionRequest | Details of the subscription to be created.

        String accept = accept_example; // String | Content-Types that are acceptable for the response. Reference: IETF RFC 7231

        String contentType = contentType_example; // String | The MIME type of the body of the request. Reference: IETF RFC 7231

        String authorization = authorization_example; // String | The authorization token for the request. Reference: IETF RFC 7235

        try {
            inline_response_200_1 result = apiInstance.subscriptionsPost(lccnSubscriptionRequest, accept, contentType, authorization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling Sol003VnfLcmApi#subscriptionsPost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.Sol003VnfLcmApi;

public class Sol003VnfLcmApiExample {

    public static void main(String[] args) {
        Sol003VnfLcmApi apiInstance = new Sol003VnfLcmApi();
        LccnSubscriptionRequest lccnSubscriptionRequest = ; // LccnSubscriptionRequest | Details of the subscription to be created.

        String accept = accept_example; // String | Content-Types that are acceptable for the response. Reference: IETF RFC 7231

        String contentType = contentType_example; // String | The MIME type of the body of the request. Reference: IETF RFC 7231

        String authorization = authorization_example; // String | The authorization token for the request. Reference: IETF RFC 7235

        try {
            inline_response_200_1 result = apiInstance.subscriptionsPost(lccnSubscriptionRequest, accept, contentType, authorization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling Sol003VnfLcmApi#subscriptionsPost");
            e.printStackTrace();
        }
    }
}
LccnSubscriptionRequest *lccnSubscriptionRequest = ; // Details of the subscription to be created.

String *accept = accept_example; // Content-Types that are acceptable for the response. Reference: IETF RFC 7231

String *contentType = contentType_example; // The MIME type of the body of the request. Reference: IETF RFC 7231

String *authorization = authorization_example; // The authorization token for the request. Reference: IETF RFC 7235
 (optional)

Sol003VnfLcmApi *apiInstance = [[Sol003VnfLcmApi alloc] init];

[apiInstance subscriptionsPostWith:lccnSubscriptionRequest
    accept:accept
    contentType:contentType
    authorization:authorization
              completionHandler: ^(inline_response_200_1 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Sol003VnfLifecycleManagementInterface = require('sol003___vnf_lifecycle_management_interface');

var api = new Sol003VnfLifecycleManagementInterface.Sol003VnfLcmApi()

var lccnSubscriptionRequest = ; // {LccnSubscriptionRequest} Details of the subscription to be created.


var accept = accept_example; // {String} Content-Types that are acceptable for the response. Reference: IETF RFC 7231


var contentType = contentType_example; // {String} The MIME type of the body of the request. Reference: IETF RFC 7231


var opts = { 
  'authorization': authorization_example // {String} The authorization token for the request. Reference: IETF RFC 7235

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.subscriptionsPost(lccnSubscriptionRequest, accept, contentType, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class subscriptionsPostExample
    {
        public void main()
        {
            
            var apiInstance = new Sol003VnfLcmApi();
            var lccnSubscriptionRequest = new LccnSubscriptionRequest(); // LccnSubscriptionRequest | Details of the subscription to be created.

            var accept = accept_example;  // String | Content-Types that are acceptable for the response. Reference: IETF RFC 7231

            var contentType = contentType_example;  // String | The MIME type of the body of the request. Reference: IETF RFC 7231

            var authorization = authorization_example;  // String | The authorization token for the request. Reference: IETF RFC 7235
 (optional) 

            try
            {
                inline_response_200_1 result = apiInstance.subscriptionsPost(lccnSubscriptionRequest, accept, contentType, authorization);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling Sol003VnfLcmApi.subscriptionsPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\Sol003VnfLcmApi();
$lccnSubscriptionRequest = ; // LccnSubscriptionRequest | Details of the subscription to be created.

$accept = accept_example; // String | Content-Types that are acceptable for the response. Reference: IETF RFC 7231

$contentType = contentType_example; // String | The MIME type of the body of the request. Reference: IETF RFC 7231

$authorization = authorization_example; // String | The authorization token for the request. Reference: IETF RFC 7235


try {
    $result = $api_instance->subscriptionsPost($lccnSubscriptionRequest, $accept, $contentType, $authorization);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling Sol003VnfLcmApi->subscriptionsPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::Sol003VnfLcmApi;

my $api_instance = WWW::SwaggerClient::Sol003VnfLcmApi->new();
my $lccnSubscriptionRequest = WWW::SwaggerClient::Object::LccnSubscriptionRequest->new(); # LccnSubscriptionRequest | Details of the subscription to be created.

my $accept = accept_example; # String | Content-Types that are acceptable for the response. Reference: IETF RFC 7231

my $contentType = contentType_example; # String | The MIME type of the body of the request. Reference: IETF RFC 7231

my $authorization = authorization_example; # String | The authorization token for the request. Reference: IETF RFC 7235


eval { 
    my $result = $api_instance->subscriptionsPost(lccnSubscriptionRequest => $lccnSubscriptionRequest, accept => $accept, contentType => $contentType, authorization => $authorization);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling Sol003VnfLcmApi->subscriptionsPost: $@\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.Sol003VnfLcmApi()
lccnSubscriptionRequest =  # LccnSubscriptionRequest | Details of the subscription to be created.

accept = accept_example # String | Content-Types that are acceptable for the response. Reference: IETF RFC 7231

contentType = contentType_example # String | The MIME type of the body of the request. Reference: IETF RFC 7231

authorization = authorization_example # String | The authorization token for the request. Reference: IETF RFC 7235
 (optional)

try: 
    api_response = api_instance.subscriptions_post(lccnSubscriptionRequest, accept, contentType, authorization=authorization)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling Sol003VnfLcmApi->subscriptionsPost: %s\n" % e)

Parameters

Header parameters
Name Description
Accept*
String
Content-Types that are acceptable for the response. Reference: IETF RFC 7231
Required
Authorization
String
The authorization token for the request. Reference: IETF RFC 7235
Content-Type*
String
The MIME type of the body of the request. Reference: IETF RFC 7231
Required
Body parameters
Name Description
lccnSubscriptionRequest *

Responses

Status: 201 - Created The subscription was created successfully. The response body shall contain a representation of the created subscription resource. The HTTP response shall include a "Location" HTTP header that points to the created subscription resource.

Name Type Format Description
Content-Type String The MIME type of the body of the response.
Location String url The resource URI of the created VNF instance
WWW-Authenticate String Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.

Status: 303 - See Other A subscription with the same callbackURI and the same filter already exists and the policy of the VNFM is to not create redundant subscriptions. The HTTP response shall include a "Location" HTTP header that contains the resource URI of the existing subscription resource. The response body shall be empty.

Name Type Format Description
Location String url The resource URI of the created VNF instance
WWW-Authenticate String Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.

Status: 400 - Bad Request If the request is malformed or syntactically incorrect (e.g. if the request URI contains incorrect query parameters or a syntactically incorrect payload body), the API producer shall respond with this response code. The "ProblemDetails" structure shall be provided, and should include in the "detail" attribute more information about the source of the problem. --- If the request contains a malformed access token, the API producer should respond with this response. The details of the error shall be returned in the WWW-Authenticate HTTP header, as defined in IETF RFC 6750 and IETF RFC 7235. The ProblemDetails structure may be provided. --- If there is an application error related to the client's input that cannot be easily mapped to any other HTTP response code ("catch all error"), the API producer shall respond with this response code.The "ProblemDetails" structure shall be provided, and shall include in the "detail" attribute more information about the source of the problem.

Name Type Format Description
Content-Type String The MIME type of the body of the response.
WWW-Authenticate String Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.

Status: 401 - Unauthorized If the request contains no access token even though one is required, or if the request contains an authorization token that is invalid (e.g. expired or revoked), the API producer should respond with this response. The details of the error shall be returned in the WWW-Authenticate HTTP header, as defined in IETF RFC 6750 and IETF RFC 7235. The ProblemDetails structure may be provided.

Name Type Format Description
Content-Type String The MIME type of the body of the response.
WWW-Authenticate String Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.

Status: 403 - Forbidden If the API consumer is not allowed to perform a particular request to a particular resource, the API producer shall respond with this response code. The "ProblemDetails" structure shall be provided. It should include in the "detail" attribute information about the source of the problem, and may indicate how to solve it.

Name Type Format Description
Content-Type String The MIME type of the body of the response.

Status: 404 - Not Found If the API producer did not find a current representation for the resource addressed by the URI passed in the request, or is not willing to disclose that one exists, it shall respond with this response code. Specifically in case of this task resource, the reason can also be that the task is not supported for the VNF LCM operation occurrence represented by the parent resource, and that the task resource consequently does not exist. The "ProblemDetails" structure may be provided, including in the "detail" attribute information about the sourceof the problem, e.g. a wrong resource URI variable.

Name Type Format Description
Content-Type String The MIME type of the body of the response.

Status: 405 - Not Found If the API producer did not find a current representation for the resource addressed by the URI passed in the request, or is not willing to disclose that one exists, it shall respond with this response code. The "ProblemDetails" structure may be provided, including in the "detail" attribute information about the source of the problem, e.g. a wrong resource URI variable.

Name Type Format Description
Content-Type String The MIME type of the body of the response.

Status: 406 - Not Acceptable If the "Accept" HTTP header does not contain at least one name of a content type that is acceptable to the API producer, the API producer shall respond with this response code. The "ProblemDetails" structure may be omitted in that case.

Name Type Format Description
Content-Type String The MIME type of the body of the response.

Status: 500 - Internal Server Error If there is an application error not related to the client's input that cannot be easily mapped to any other HTTP response code ("catch all error"), the API producer shall respond withthis response code. The "ProblemDetails" structure shall be provided, and shall include in the "detail" attribute more information about the source of the problem.

Name Type Format Description
Content-Type String The MIME type of the body of the response.

Status: 503 - Service Unavailable If the API producer encounters an internal overload situation of itself or of a system it relies on, it should respond with this response code, following the provisions in IETF RFC 7231 [13] for the use of the "Retry-After" HTTP header and for the alternative to refuse the connection. The "ProblemDetails" structure may be omitted.

Name Type Format Description
Content-Type String The MIME type of the body of the response.

subscriptionsSubscriptionIdDelete

Terminate Subscription The DELETE method terminates an individual subscription.


/subscriptions/{subscriptionId}

Usage and SDK Samples

curl -X DELETE "https://localhost/vnflcm/v1/subscriptions/{subscriptionId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.Sol003VnfLcmApi;

import java.io.File;
import java.util.*;

public class Sol003VnfLcmApiExample {

    public static void main(String[] args) {
        
        Sol003VnfLcmApi apiInstance = new Sol003VnfLcmApi();
        String subscriptionId = subscriptionId_example; // String | Identifier of this subscription. This identifier can be retrieved from the resource referenced by the "Location" HTTP header in the response to a POST request creating a new subscription resource. It can also be retrieved from the "id" attribute in the payload body of that response.

        String authorization = authorization_example; // String | The authorization token for the request. Reference: IETF RFC 7235

        try {
            apiInstance.subscriptionsSubscriptionIdDelete(subscriptionId, authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling Sol003VnfLcmApi#subscriptionsSubscriptionIdDelete");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.Sol003VnfLcmApi;

public class Sol003VnfLcmApiExample {

    public static void main(String[] args) {
        Sol003VnfLcmApi apiInstance = new Sol003VnfLcmApi();
        String subscriptionId = subscriptionId_example; // String | Identifier of this subscription. This identifier can be retrieved from the resource referenced by the "Location" HTTP header in the response to a POST request creating a new subscription resource. It can also be retrieved from the "id" attribute in the payload body of that response.

        String authorization = authorization_example; // String | The authorization token for the request. Reference: IETF RFC 7235

        try {
            apiInstance.subscriptionsSubscriptionIdDelete(subscriptionId, authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling Sol003VnfLcmApi#subscriptionsSubscriptionIdDelete");
            e.printStackTrace();
        }
    }
}
String *subscriptionId = subscriptionId_example; // Identifier of this subscription. This identifier can be retrieved from the resource referenced by the "Location" HTTP header in the response to a POST request creating a new subscription resource. It can also be retrieved from the "id" attribute in the payload body of that response.

String *authorization = authorization_example; // The authorization token for the request. Reference: IETF RFC 7235
 (optional)

Sol003VnfLcmApi *apiInstance = [[Sol003VnfLcmApi alloc] init];

[apiInstance subscriptionsSubscriptionIdDeleteWith:subscriptionId
    authorization:authorization
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Sol003VnfLifecycleManagementInterface = require('sol003___vnf_lifecycle_management_interface');

var api = new Sol003VnfLifecycleManagementInterface.Sol003VnfLcmApi()

var subscriptionId = subscriptionId_example; // {String} Identifier of this subscription. This identifier can be retrieved from the resource referenced by the "Location" HTTP header in the response to a POST request creating a new subscription resource. It can also be retrieved from the "id" attribute in the payload body of that response.


var opts = { 
  'authorization': authorization_example // {String} The authorization token for the request. Reference: IETF RFC 7235

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.subscriptionsSubscriptionIdDelete(subscriptionId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class subscriptionsSubscriptionIdDeleteExample
    {
        public void main()
        {
            
            var apiInstance = new Sol003VnfLcmApi();
            var subscriptionId = subscriptionId_example;  // String | Identifier of this subscription. This identifier can be retrieved from the resource referenced by the "Location" HTTP header in the response to a POST request creating a new subscription resource. It can also be retrieved from the "id" attribute in the payload body of that response.

            var authorization = authorization_example;  // String | The authorization token for the request. Reference: IETF RFC 7235
 (optional) 

            try
            {
                apiInstance.subscriptionsSubscriptionIdDelete(subscriptionId, authorization);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling Sol003VnfLcmApi.subscriptionsSubscriptionIdDelete: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\Sol003VnfLcmApi();
$subscriptionId = subscriptionId_example; // String | Identifier of this subscription. This identifier can be retrieved from the resource referenced by the "Location" HTTP header in the response to a POST request creating a new subscription resource. It can also be retrieved from the "id" attribute in the payload body of that response.

$authorization = authorization_example; // String | The authorization token for the request. Reference: IETF RFC 7235


try {
    $api_instance->subscriptionsSubscriptionIdDelete($subscriptionId, $authorization);
} catch (Exception $e) {
    echo 'Exception when calling Sol003VnfLcmApi->subscriptionsSubscriptionIdDelete: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::Sol003VnfLcmApi;

my $api_instance = WWW::SwaggerClient::Sol003VnfLcmApi->new();
my $subscriptionId = subscriptionId_example; # String | Identifier of this subscription. This identifier can be retrieved from the resource referenced by the "Location" HTTP header in the response to a POST request creating a new subscription resource. It can also be retrieved from the "id" attribute in the payload body of that response.

my $authorization = authorization_example; # String | The authorization token for the request. Reference: IETF RFC 7235


eval { 
    $api_instance->subscriptionsSubscriptionIdDelete(subscriptionId => $subscriptionId, authorization => $authorization);
};
if ($@) {
    warn "Exception when calling Sol003VnfLcmApi->subscriptionsSubscriptionIdDelete: $@\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.Sol003VnfLcmApi()
subscriptionId = subscriptionId_example # String | Identifier of this subscription. This identifier can be retrieved from the resource referenced by the "Location" HTTP header in the response to a POST request creating a new subscription resource. It can also be retrieved from the "id" attribute in the payload body of that response.

authorization = authorization_example # String | The authorization token for the request. Reference: IETF RFC 7235
 (optional)

try: 
    api_instance.subscriptions_subscription_id_delete(subscriptionId, authorization=authorization)
except ApiException as e:
    print("Exception when calling Sol003VnfLcmApi->subscriptionsSubscriptionIdDelete: %s\n" % e)

Parameters

Path parameters
Name Description
subscriptionId*
String
Identifier of this subscription. This identifier can be retrieved from the resource referenced by the "Location" HTTP header in the response to a POST request creating a new subscription resource. It can also be retrieved from the "id" attribute in the payload body of that response.
Required
Header parameters
Name Description
Authorization
String
The authorization token for the request. Reference: IETF RFC 7235

Responses

Status: 204 - No Content The subscription resource was deleted successfully. The response body shall be empty.

Name Type Format Description
WWW-Authenticate String Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.

Status: 400 - Bad Request If the request is malformed or syntactically incorrect (e.g. if the request URI contains incorrect query parameters or a syntactically incorrect payload body), the API producer shall respond with this response code. The "ProblemDetails" structure shall be provided, and should include in the "detail" attribute more information about the source of the problem. --- If the request contains a malformed access token, the API producer should respond with this response. The details of the error shall be returned in the WWW-Authenticate HTTP header, as defined in IETF RFC 6750 and IETF RFC 7235. The ProblemDetails structure may be provided. --- If there is an application error related to the client's input that cannot be easily mapped to any other HTTP response code ("catch all error"), the API producer shall respond with this response code.The "ProblemDetails" structure shall be provided, and shall include in the "detail" attribute more information about the source of the problem.

Name Type Format Description
Content-Type String The MIME type of the body of the response.
WWW-Authenticate String Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.

Status: 401 - Unauthorized If the request contains no access token even though one is required, or if the request contains an authorization token that is invalid (e.g. expired or revoked), the API producer should respond with this response. The details of the error shall be returned in the WWW-Authenticate HTTP header, as defined in IETF RFC 6750 and IETF RFC 7235. The ProblemDetails structure may be provided.

Name Type Format Description
Content-Type String The MIME type of the body of the response.
WWW-Authenticate String Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.

Status: 403 - Forbidden If the API consumer is not allowed to perform a particular request to a particular resource, the API producer shall respond with this response code. The "ProblemDetails" structure shall be provided. It should include in the "detail" attribute information about the source of the problem, and may indicate how to solve it.

Name Type Format Description
Content-Type String The MIME type of the body of the response.

Status: 404 - Not Found If the API producer did not find a current representation for the resource addressed by the URI passed in the request, or is not willing to disclose that one exists, it shall respond with this response code. Specifically in case of this task resource, the reason can also be that the task is not supported for the VNF LCM operation occurrence represented by the parent resource, and that the task resource consequently does not exist. The "ProblemDetails" structure may be provided, including in the "detail" attribute information about the sourceof the problem, e.g. a wrong resource URI variable.

Name Type Format Description
Content-Type String The MIME type of the body of the response.

Status: 405 - Not Found If the API producer did not find a current representation for the resource addressed by the URI passed in the request, or is not willing to disclose that one exists, it shall respond with this response code. The "ProblemDetails" structure may be provided, including in the "detail" attribute information about the source of the problem, e.g. a wrong resource URI variable.

Name Type Format Description
Content-Type String The MIME type of the body of the response.

Status: 406 - Not Acceptable If the "Accept" HTTP header does not contain at least one name of a content type that is acceptable to the API producer, the API producer shall respond with this response code. The "ProblemDetails" structure may be omitted in that case.

Name Type Format Description
Content-Type String The MIME type of the body of the response.

Status: 500 - Internal Server Error If there is an application error not related to the client's input that cannot be easily mapped to any other HTTP response code ("catch all error"), the API producer shall respond withthis response code. The "ProblemDetails" structure shall be provided, and shall include in the "detail" attribute more information about the source of the problem.

Name Type Format Description
Content-Type String The MIME type of the body of the response.

Status: 503 - Service Unavailable If the API producer encounters an internal overload situation of itself or of a system it relies on, it should respond with this response code, following the provisions in IETF RFC 7231 [13] for the use of the "Retry-After" HTTP header and for the alternative to refuse the connection. The "ProblemDetails" structure may be omitted.

Name Type Format Description
Content-Type String The MIME type of the body of the response.

subscriptionsSubscriptionIdGet

Query Subscription Information The GET method retrieves information about a subscription by reading an individual subscription resource.


/subscriptions/{subscriptionId}

Usage and SDK Samples

curl -X GET "https://localhost/vnflcm/v1/subscriptions/{subscriptionId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.Sol003VnfLcmApi;

import java.io.File;
import java.util.*;

public class Sol003VnfLcmApiExample {

    public static void main(String[] args) {
        
        Sol003VnfLcmApi apiInstance = new Sol003VnfLcmApi();
        String subscriptionId = subscriptionId_example; // String | Identifier of this subscription. This identifier can be retrieved from the resource referenced by the "Location" HTTP header in the response to a POST request creating a new subscription resource. It can also be retrieved from the "id" attribute in the payload body of that response.

        String accept = accept_example; // String | Content-Types that are acceptable for the response. Reference: IETF RFC 7231

        String authorization = authorization_example; // String | The authorization token for the request. Reference: IETF RFC 7235

        try {
            inline_response_200_1 result = apiInstance.subscriptionsSubscriptionIdGet(subscriptionId, accept, authorization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling Sol003VnfLcmApi#subscriptionsSubscriptionIdGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.Sol003VnfLcmApi;

public class Sol003VnfLcmApiExample {

    public static void main(String[] args) {
        Sol003VnfLcmApi apiInstance = new Sol003VnfLcmApi();
        String subscriptionId = subscriptionId_example; // String | Identifier of this subscription. This identifier can be retrieved from the resource referenced by the "Location" HTTP header in the response to a POST request creating a new subscription resource. It can also be retrieved from the "id" attribute in the payload body of that response.

        String accept = accept_example; // String | Content-Types that are acceptable for the response. Reference: IETF RFC 7231

        String authorization = authorization_example; // String | The authorization token for the request. Reference: IETF RFC 7235

        try {
            inline_response_200_1 result = apiInstance.subscriptionsSubscriptionIdGet(subscriptionId, accept, authorization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling Sol003VnfLcmApi#subscriptionsSubscriptionIdGet");
            e.printStackTrace();
        }
    }
}
String *subscriptionId = subscriptionId_example; // Identifier of this subscription. This identifier can be retrieved from the resource referenced by the "Location" HTTP header in the response to a POST request creating a new subscription resource. It can also be retrieved from the "id" attribute in the payload body of that response.

String *accept = accept_example; // Content-Types that are acceptable for the response. Reference: IETF RFC 7231

String *authorization = authorization_example; // The authorization token for the request. Reference: IETF RFC 7235
 (optional)

Sol003VnfLcmApi *apiInstance = [[Sol003VnfLcmApi alloc] init];

[apiInstance subscriptionsSubscriptionIdGetWith:subscriptionId
    accept:accept
    authorization:authorization
              completionHandler: ^(inline_response_200_1 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Sol003VnfLifecycleManagementInterface = require('sol003___vnf_lifecycle_management_interface');

var api = new Sol003VnfLifecycleManagementInterface.Sol003VnfLcmApi()

var subscriptionId = subscriptionId_example; // {String} Identifier of this subscription. This identifier can be retrieved from the resource referenced by the "Location" HTTP header in the response to a POST request creating a new subscription resource. It can also be retrieved from the "id" attribute in the payload body of that response.


var accept = accept_example; // {String} Content-Types that are acceptable for the response. Reference: IETF RFC 7231


var opts = { 
  'authorization': authorization_example // {String} The authorization token for the request. Reference: IETF RFC 7235

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.subscriptionsSubscriptionIdGet(subscriptionIdaccept, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class subscriptionsSubscriptionIdGetExample
    {
        public void main()
        {
            
            var apiInstance = new Sol003VnfLcmApi();
            var subscriptionId = subscriptionId_example;  // String | Identifier of this subscription. This identifier can be retrieved from the resource referenced by the "Location" HTTP header in the response to a POST request creating a new subscription resource. It can also be retrieved from the "id" attribute in the payload body of that response.

            var accept = accept_example;  // String | Content-Types that are acceptable for the response. Reference: IETF RFC 7231

            var authorization = authorization_example;  // String | The authorization token for the request. Reference: IETF RFC 7235
 (optional) 

            try
            {
                inline_response_200_1 result = apiInstance.subscriptionsSubscriptionIdGet(subscriptionId, accept, authorization);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling Sol003VnfLcmApi.subscriptionsSubscriptionIdGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\Sol003VnfLcmApi();
$subscriptionId = subscriptionId_example; // String | Identifier of this subscription. This identifier can be retrieved from the resource referenced by the "Location" HTTP header in the response to a POST request creating a new subscription resource. It can also be retrieved from the "id" attribute in the payload body of that response.

$accept = accept_example; // String | Content-Types that are acceptable for the response. Reference: IETF RFC 7231

$authorization = authorization_example; // String | The authorization token for the request. Reference: IETF RFC 7235


try {
    $result = $api_instance->subscriptionsSubscriptionIdGet($subscriptionId, $accept, $authorization);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling Sol003VnfLcmApi->subscriptionsSubscriptionIdGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::Sol003VnfLcmApi;

my $api_instance = WWW::SwaggerClient::Sol003VnfLcmApi->new();
my $subscriptionId = subscriptionId_example; # String | Identifier of this subscription. This identifier can be retrieved from the resource referenced by the "Location" HTTP header in the response to a POST request creating a new subscription resource. It can also be retrieved from the "id" attribute in the payload body of that response.

my $accept = accept_example; # String | Content-Types that are acceptable for the response. Reference: IETF RFC 7231

my $authorization = authorization_example; # String | The authorization token for the request. Reference: IETF RFC 7235


eval { 
    my $result = $api_instance->subscriptionsSubscriptionIdGet(subscriptionId => $subscriptionId, accept => $accept, authorization => $authorization);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling Sol003VnfLcmApi->subscriptionsSubscriptionIdGet: $@\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.Sol003VnfLcmApi()
subscriptionId = subscriptionId_example # String | Identifier of this subscription. This identifier can be retrieved from the resource referenced by the "Location" HTTP header in the response to a POST request creating a new subscription resource. It can also be retrieved from the "id" attribute in the payload body of that response.

accept = accept_example # String | Content-Types that are acceptable for the response. Reference: IETF RFC 7231

authorization = authorization_example # String | The authorization token for the request. Reference: IETF RFC 7235
 (optional)

try: 
    api_response = api_instance.subscriptions_subscription_id_get(subscriptionId, accept, authorization=authorization)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling Sol003VnfLcmApi->subscriptionsSubscriptionIdGet: %s\n" % e)

Parameters

Path parameters
Name Description
subscriptionId*
String
Identifier of this subscription. This identifier can be retrieved from the resource referenced by the "Location" HTTP header in the response to a POST request creating a new subscription resource. It can also be retrieved from the "id" attribute in the payload body of that response.
Required
Header parameters
Name Description
Accept*
String
Content-Types that are acceptable for the response. Reference: IETF RFC 7231
Required
Authorization
String
The authorization token for the request. Reference: IETF RFC 7235

Responses

Status: 200 - OK The operation has completed successfully. The response body shall contain a representation of the subscription resource.

Name Type Format Description
Content-Type String The MIME type of the body of the response.
WWW-Authenticate String Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.

Status: 400 - Bad Request If the request is malformed or syntactically incorrect (e.g. if the request URI contains incorrect query parameters or a syntactically incorrect payload body), the API producer shall respond with this response code. The "ProblemDetails" structure shall be provided, and should include in the "detail" attribute more information about the source of the problem. --- If the request contains a malformed access token, the API producer should respond with this response. The details of the error shall be returned in the WWW-Authenticate HTTP header, as defined in IETF RFC 6750 and IETF RFC 7235. The ProblemDetails structure may be provided. --- If there is an application error related to the client's input that cannot be easily mapped to any other HTTP response code ("catch all error"), the API producer shall respond with this response code.The "ProblemDetails" structure shall be provided, and shall include in the "detail" attribute more information about the source of the problem.

Name Type Format Description
Content-Type String The MIME type of the body of the response.
WWW-Authenticate String Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.

Status: 401 - Unauthorized If the request contains no access token even though one is required, or if the request contains an authorization token that is invalid (e.g. expired or revoked), the API producer should respond with this response. The details of the error shall be returned in the WWW-Authenticate HTTP header, as defined in IETF RFC 6750 and IETF RFC 7235. The ProblemDetails structure may be provided.

Name Type Format Description
Content-Type String The MIME type of the body of the response.
WWW-Authenticate String Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.

Status: 403 - Forbidden If the API consumer is not allowed to perform a particular request to a particular resource, the API producer shall respond with this response code. The "ProblemDetails" structure shall be provided. It should include in the "detail" attribute information about the source of the problem, and may indicate how to solve it.

Name Type Format Description
Content-Type String The MIME type of the body of the response.

Status: 404 - Not Found If the API producer did not find a current representation for the resource addressed by the URI passed in the request, or is not willing to disclose that one exists, it shall respond with this response code. Specifically in case of this task resource, the reason can also be that the task is not supported for the VNF LCM operation occurrence represented by the parent resource, and that the task resource consequently does not exist. The "ProblemDetails" structure may be provided, including in the "detail" attribute information about the sourceof the problem, e.g. a wrong resource URI variable.

Name Type Format Description
Content-Type String The MIME type of the body of the response.

Status: 405 - Not Found If the API producer did not find a current representation for the resource addressed by the URI passed in the request, or is not willing to disclose that one exists, it shall respond with this response code. The "ProblemDetails" structure may be provided, including in the "detail" attribute information about the source of the problem, e.g. a wrong resource URI variable.

Name Type Format Description
Content-Type String The MIME type of the body of the response.

Status: 406 - Not Acceptable If the "Accept" HTTP header does not contain at least one name of a content type that is acceptable to the API producer, the API producer shall respond with this response code. The "ProblemDetails" structure may be omitted in that case.

Name Type Format Description
Content-Type String The MIME type of the body of the response.

Status: 500 - Internal Server Error If there is an application error not related to the client's input that cannot be easily mapped to any other HTTP response code ("catch all error"), the API producer shall respond withthis response code. The "ProblemDetails" structure shall be provided, and shall include in the "detail" attribute more information about the source of the problem.

Name Type Format Description
Content-Type String The MIME type of the body of the response.

Status: 503 - Service Unavailable If the API producer encounters an internal overload situation of itself or of a system it relies on, it should respond with this response code, following the provisions in IETF RFC 7231 [13] for the use of the "Retry-After" HTTP header and for the alternative to refuse the connection. The "ProblemDetails" structure may be omitted.

Name Type Format Description
Content-Type String The MIME type of the body of the response.

vnfInstancesPost

Create VNF Identifier The POST method creates a new VNF instance resource.


/vnf_instances

Usage and SDK Samples

curl -X POST "https://localhost/vnflcm/v1/vnf_instances"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.Sol003VnfLcmApi;

import java.io.File;
import java.util.*;

public class Sol003VnfLcmApiExample {

    public static void main(String[] args) {
        
        Sol003VnfLcmApi apiInstance = new Sol003VnfLcmApi();
        CreateVnfRequest createVnfRequest = ; // CreateVnfRequest | The VNF creation parameters
        String accept = accept_example; // String | Content-Types that are acceptable for the response. Reference: IETF RFC 7231

        String contentType = contentType_example; // String | The MIME type of the body of the request. Reference: IETF RFC 7231

        String authorization = authorization_example; // String | The authorization token for the request. Reference: IETF RFC 7235

        try {
            inline_response_201 result = apiInstance.vnfInstancesPost(createVnfRequest, accept, contentType, authorization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling Sol003VnfLcmApi#vnfInstancesPost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.Sol003VnfLcmApi;

public class Sol003VnfLcmApiExample {

    public static void main(String[] args) {
        Sol003VnfLcmApi apiInstance = new Sol003VnfLcmApi();
        CreateVnfRequest createVnfRequest = ; // CreateVnfRequest | The VNF creation parameters
        String accept = accept_example; // String | Content-Types that are acceptable for the response. Reference: IETF RFC 7231

        String contentType = contentType_example; // String | The MIME type of the body of the request. Reference: IETF RFC 7231

        String authorization = authorization_example; // String | The authorization token for the request. Reference: IETF RFC 7235

        try {
            inline_response_201 result = apiInstance.vnfInstancesPost(createVnfRequest, accept, contentType, authorization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling Sol003VnfLcmApi#vnfInstancesPost");
            e.printStackTrace();
        }
    }
}
CreateVnfRequest *createVnfRequest = ; // The VNF creation parameters
String *accept = accept_example; // Content-Types that are acceptable for the response. Reference: IETF RFC 7231

String *contentType = contentType_example; // The MIME type of the body of the request. Reference: IETF RFC 7231

String *authorization = authorization_example; // The authorization token for the request. Reference: IETF RFC 7235
 (optional)

Sol003VnfLcmApi *apiInstance = [[Sol003VnfLcmApi alloc] init];

[apiInstance vnfInstancesPostWith:createVnfRequest
    accept:accept
    contentType:contentType
    authorization:authorization
              completionHandler: ^(inline_response_201 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Sol003VnfLifecycleManagementInterface = require('sol003___vnf_lifecycle_management_interface');

var api = new Sol003VnfLifecycleManagementInterface.Sol003VnfLcmApi()

var createVnfRequest = ; // {CreateVnfRequest} The VNF creation parameters

var accept = accept_example; // {String} Content-Types that are acceptable for the response. Reference: IETF RFC 7231


var contentType = contentType_example; // {String} The MIME type of the body of the request. Reference: IETF RFC 7231


var opts = { 
  'authorization': authorization_example // {String} The authorization token for the request. Reference: IETF RFC 7235

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.vnfInstancesPost(createVnfRequest, accept, contentType, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class vnfInstancesPostExample
    {
        public void main()
        {
            
            var apiInstance = new Sol003VnfLcmApi();
            var createVnfRequest = new CreateVnfRequest(); // CreateVnfRequest | The VNF creation parameters
            var accept = accept_example;  // String | Content-Types that are acceptable for the response. Reference: IETF RFC 7231

            var contentType = contentType_example;  // String | The MIME type of the body of the request. Reference: IETF RFC 7231

            var authorization = authorization_example;  // String | The authorization token for the request. Reference: IETF RFC 7235
 (optional) 

            try
            {
                inline_response_201 result = apiInstance.vnfInstancesPost(createVnfRequest, accept, contentType, authorization);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling Sol003VnfLcmApi.vnfInstancesPost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\Sol003VnfLcmApi();
$createVnfRequest = ; // CreateVnfRequest | The VNF creation parameters
$accept = accept_example; // String | Content-Types that are acceptable for the response. Reference: IETF RFC 7231

$contentType = contentType_example; // String | The MIME type of the body of the request. Reference: IETF RFC 7231

$authorization = authorization_example; // String | The authorization token for the request. Reference: IETF RFC 7235


try {
    $result = $api_instance->vnfInstancesPost($createVnfRequest, $accept, $contentType, $authorization);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling Sol003VnfLcmApi->vnfInstancesPost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::Sol003VnfLcmApi;

my $api_instance = WWW::SwaggerClient::Sol003VnfLcmApi->new();
my $createVnfRequest = WWW::SwaggerClient::Object::CreateVnfRequest->new(); # CreateVnfRequest | The VNF creation parameters
my $accept = accept_example; # String | Content-Types that are acceptable for the response. Reference: IETF RFC 7231

my $contentType = contentType_example; # String | The MIME type of the body of the request. Reference: IETF RFC 7231

my $authorization = authorization_example; # String | The authorization token for the request. Reference: IETF RFC 7235


eval { 
    my $result = $api_instance->vnfInstancesPost(createVnfRequest => $createVnfRequest, accept => $accept, contentType => $contentType, authorization => $authorization);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling Sol003VnfLcmApi->vnfInstancesPost: $@\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.Sol003VnfLcmApi()
createVnfRequest =  # CreateVnfRequest | The VNF creation parameters
accept = accept_example # String | Content-Types that are acceptable for the response. Reference: IETF RFC 7231

contentType = contentType_example # String | The MIME type of the body of the request. Reference: IETF RFC 7231

authorization = authorization_example # String | The authorization token for the request. Reference: IETF RFC 7235
 (optional)

try: 
    api_response = api_instance.vnf_instances_post(createVnfRequest, accept, contentType, authorization=authorization)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling Sol003VnfLcmApi->vnfInstancesPost: %s\n" % e)

Parameters

Header parameters
Name Description
Accept*
String
Content-Types that are acceptable for the response. Reference: IETF RFC 7231
Required
Authorization
String
The authorization token for the request. Reference: IETF RFC 7235
Content-Type*
String
The MIME type of the body of the request. Reference: IETF RFC 7231
Required
Body parameters
Name Description
createVnfRequest *

Responses

Status: 201 - A VNF Instance identifier was created successfully

Name Type Format Description
Content-Type String The MIME type of the body of the response.
Location String url The resource URI of the created VNF instance
WWW-Authenticate String Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.

Status: 400 - Bad Request If the request is malformed or syntactically incorrect (e.g. if the request URI contains incorrect query parameters or a syntactically incorrect payload body), the API producer shall respond with this response code. The "ProblemDetails" structure shall be provided, and should include in the "detail" attribute more information about the source of the problem. --- If the request contains a malformed access token, the API producer should respond with this response. The details of the error shall be returned in the WWW-Authenticate HTTP header, as defined in IETF RFC 6750 and IETF RFC 7235. The ProblemDetails structure may be provided. --- If there is an application error related to the client's input that cannot be easily mapped to any other HTTP response code ("catch all error"), the API producer shall respond with this response code.The "ProblemDetails" structure shall be provided, and shall include in the "detail" attribute more information about the source of the problem.

Name Type Format Description
Content-Type String The MIME type of the body of the response.
WWW-Authenticate String Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.

Status: 401 - Unauthorized If the request contains no access token even though one is required, or if the request contains an authorization token that is invalid (e.g. expired or revoked), the API producer should respond with this response. The details of the error shall be returned in the WWW-Authenticate HTTP header, as defined in IETF RFC 6750 and IETF RFC 7235. The ProblemDetails structure may be provided.

Name Type Format Description
Content-Type String The MIME type of the body of the response.
WWW-Authenticate String Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.

Status: 403 - Forbidden If the API consumer is not allowed to perform a particular request to a particular resource, the API producer shall respond with this response code. The "ProblemDetails" structure shall be provided. It should include in the "detail" attribute information about the source of the problem, and may indicate how to solve it.

Name Type Format Description
Content-Type String The MIME type of the body of the response.

Status: 404 - Not Found If the API producer did not find a current representation for the resource addressed by the URI passed in the request, or is not willing to disclose that one exists, it shall respond with this response code. The "ProblemDetails" structure may be provided, including in the "detail" attribute information about the source of the problem, e.g. a wrong resource URI variable.

Name Type Format Description
Content-Type String The MIME type of the body of the response.

Status: 405 - Not Found If the API producer did not find a current representation for the resource addressed by the URI passed in the request, or is not willing to disclose that one exists, it shall respond with this response code. The "ProblemDetails" structure may be provided, including in the "detail" attribute information about the source of the problem, e.g. a wrong resource URI variable.

Name Type Format Description
Content-Type String The MIME type of the body of the response.

Status: 406 - Not Acceptable If the "Accept" HTTP header does not contain at least one name of a content type that is acceptable to the API producer, the API producer shall respond with this response code. The "ProblemDetails" structure may be omitted in that case.

Name Type Format Description
Content-Type String The MIME type of the body of the response.

Status: 409 - Conflict Another request is in progress that prohibits the fulfilment of the current request, or the current resource state is inconsistent with the request.

Name Type Format Description
Content-Type String The MIME type of the body of the response.
WWW-Authenticate String Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.

Status: 416 - Requested Range Not Satisfiable This code is returned if the requested byte range in the Range HTTP header is not present in the requested resource.

Name Type Format Description
Content-Type String The MIME type of the body of the response.

Status: 422 - Unprocessable Entity If the payload body of a request contains syntactically correct data (e.g. well-formed JSON) but the data cannot be processed (e.g. because it fails validation against a schema), the API producer shall respond with this response code. The "ProblemDetails" structure shall be provided, and should include in the "detail" attribute more information about the source of the problem. NOTE 2: This error response code is only applicable for methods that have a request body.

Name Type Format Description
Content-Type String The MIME type of the body of the response.

Status: 500 - Internal Server Error If there is an application error not related to the client's input that cannot be easily mapped to any other HTTP response code ("catch all error"), the API producer shall respond withthis response code. The "ProblemDetails" structure shall be provided, and shall include in the "detail" attribute more information about the source of the problem.

Name Type Format Description
Content-Type String The MIME type of the body of the response.

Status: 503 - Service Unavailable If the API producer encounters an internal overload situation of itself or of a system it relies on, it should respond with this response code, following the provisions in IETF RFC 7231 [13] for the use of the "Retry-After" HTTP header and for the alternative to refuse the connection. The "ProblemDetails" structure may be omitted.

Name Type Format Description
Content-Type String The MIME type of the body of the response.

vnfInstancesVnfInstanceIdDelete

Delete VNF Identifier This method deletes an individual VNF instance resource.


/vnf_instances/{vnfInstanceId}

Usage and SDK Samples

curl -X DELETE "https://localhost/vnflcm/v1/vnf_instances/{vnfInstanceId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.Sol003VnfLcmApi;

import java.io.File;
import java.util.*;

public class Sol003VnfLcmApiExample {

    public static void main(String[] args) {
        
        Sol003VnfLcmApi apiInstance = new Sol003VnfLcmApi();
        String vnfInstanceId = vnfInstanceId_example; // String | Identifier of the VNF instance. This identifier can be retrieved from the resource referenced by the "Location" HTTP header in the response to a POST request creating a new VNF instance resource. It can also be retrieved from the "id" attribute in the payload body of that response.

        String authorization = authorization_example; // String | The authorization token for the request. Reference: IETF RFC 7235

        try {
            apiInstance.vnfInstancesVnfInstanceIdDelete(vnfInstanceId, authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling Sol003VnfLcmApi#vnfInstancesVnfInstanceIdDelete");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.Sol003VnfLcmApi;

public class Sol003VnfLcmApiExample {

    public static void main(String[] args) {
        Sol003VnfLcmApi apiInstance = new Sol003VnfLcmApi();
        String vnfInstanceId = vnfInstanceId_example; // String | Identifier of the VNF instance. This identifier can be retrieved from the resource referenced by the "Location" HTTP header in the response to a POST request creating a new VNF instance resource. It can also be retrieved from the "id" attribute in the payload body of that response.

        String authorization = authorization_example; // String | The authorization token for the request. Reference: IETF RFC 7235

        try {
            apiInstance.vnfInstancesVnfInstanceIdDelete(vnfInstanceId, authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling Sol003VnfLcmApi#vnfInstancesVnfInstanceIdDelete");
            e.printStackTrace();
        }
    }
}
String *vnfInstanceId = vnfInstanceId_example; // Identifier of the VNF instance. This identifier can be retrieved from the resource referenced by the "Location" HTTP header in the response to a POST request creating a new VNF instance resource. It can also be retrieved from the "id" attribute in the payload body of that response.

String *authorization = authorization_example; // The authorization token for the request. Reference: IETF RFC 7235
 (optional)

Sol003VnfLcmApi *apiInstance = [[Sol003VnfLcmApi alloc] init];

[apiInstance vnfInstancesVnfInstanceIdDeleteWith:vnfInstanceId
    authorization:authorization
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Sol003VnfLifecycleManagementInterface = require('sol003___vnf_lifecycle_management_interface');

var api = new Sol003VnfLifecycleManagementInterface.Sol003VnfLcmApi()

var vnfInstanceId = vnfInstanceId_example; // {String} Identifier of the VNF instance. This identifier can be retrieved from the resource referenced by the "Location" HTTP header in the response to a POST request creating a new VNF instance resource. It can also be retrieved from the "id" attribute in the payload body of that response.


var opts = { 
  'authorization': authorization_example // {String} The authorization token for the request. Reference: IETF RFC 7235

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.vnfInstancesVnfInstanceIdDelete(vnfInstanceId, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class vnfInstancesVnfInstanceIdDeleteExample
    {
        public void main()
        {
            
            var apiInstance = new Sol003VnfLcmApi();
            var vnfInstanceId = vnfInstanceId_example;  // String | Identifier of the VNF instance. This identifier can be retrieved from the resource referenced by the "Location" HTTP header in the response to a POST request creating a new VNF instance resource. It can also be retrieved from the "id" attribute in the payload body of that response.

            var authorization = authorization_example;  // String | The authorization token for the request. Reference: IETF RFC 7235
 (optional) 

            try
            {
                apiInstance.vnfInstancesVnfInstanceIdDelete(vnfInstanceId, authorization);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling Sol003VnfLcmApi.vnfInstancesVnfInstanceIdDelete: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\Sol003VnfLcmApi();
$vnfInstanceId = vnfInstanceId_example; // String | Identifier of the VNF instance. This identifier can be retrieved from the resource referenced by the "Location" HTTP header in the response to a POST request creating a new VNF instance resource. It can also be retrieved from the "id" attribute in the payload body of that response.

$authorization = authorization_example; // String | The authorization token for the request. Reference: IETF RFC 7235


try {
    $api_instance->vnfInstancesVnfInstanceIdDelete($vnfInstanceId, $authorization);
} catch (Exception $e) {
    echo 'Exception when calling Sol003VnfLcmApi->vnfInstancesVnfInstanceIdDelete: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::Sol003VnfLcmApi;

my $api_instance = WWW::SwaggerClient::Sol003VnfLcmApi->new();
my $vnfInstanceId = vnfInstanceId_example; # String | Identifier of the VNF instance. This identifier can be retrieved from the resource referenced by the "Location" HTTP header in the response to a POST request creating a new VNF instance resource. It can also be retrieved from the "id" attribute in the payload body of that response.

my $authorization = authorization_example; # String | The authorization token for the request. Reference: IETF RFC 7235


eval { 
    $api_instance->vnfInstancesVnfInstanceIdDelete(vnfInstanceId => $vnfInstanceId, authorization => $authorization);
};
if ($@) {
    warn "Exception when calling Sol003VnfLcmApi->vnfInstancesVnfInstanceIdDelete: $@\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.Sol003VnfLcmApi()
vnfInstanceId = vnfInstanceId_example # String | Identifier of the VNF instance. This identifier can be retrieved from the resource referenced by the "Location" HTTP header in the response to a POST request creating a new VNF instance resource. It can also be retrieved from the "id" attribute in the payload body of that response.

authorization = authorization_example # String | The authorization token for the request. Reference: IETF RFC 7235
 (optional)

try: 
    api_instance.vnf_instances_vnf_instance_id_delete(vnfInstanceId, authorization=authorization)
except ApiException as e:
    print("Exception when calling Sol003VnfLcmApi->vnfInstancesVnfInstanceIdDelete: %s\n" % e)

Parameters

Path parameters
Name Description
vnfInstanceId*
String
Identifier of the VNF instance. This identifier can be retrieved from the resource referenced by the "Location" HTTP header in the response to a POST request creating a new VNF instance resource. It can also be retrieved from the "id" attribute in the payload body of that response.
Required
Header parameters
Name Description
Authorization
String
The authorization token for the request. Reference: IETF RFC 7235

Responses

Status: 204 - No Content The VNF instance resource and the associated VNF identifier were deleted successfully. The response body shall be empty.

Name Type Format Description
WWW-Authenticate String Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.

Status: 400 - Bad Request It fhe request is malformed or syntactically incorrect (e.g. if the request URI contains incorrect query parameters or a syntactically incorrect payload body), the API producer shall respond with this response code. The "ProblemDetails" structure shall be provided, and should include in the "detail" attribute more information about the source of the problem. If the request contains a malformed access token, the API producer should respond with this response. The details of the error shall be returned in the WWW-Authenticate HTTP header, as defined in IETF RFC 6750 and IETF RFC 7235. The ProblemDetails structure may be provided. If there is an application error related to the client's input that cannot be easily mapped to any other HTTP response code ("catch all error"), the API producer shall respond with this response code.The "ProblemDetails" structure shall be provided, and shall include in the "detail" attribute more information about the source of the problem.

Name Type Format Description
Content-Type String The MIME type of the body of the response.
WWW-Authenticate String Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.

Status: 401 - Unauthorized If the request contains no access token even though one is required, or if the request contains an authorization token that is invalid (e.g. expired or revoked), the API producer should respond with this response. The details of the error shall be returned in the WWW-Authenticate HTTP header, as defined in IETF RFC 6750 and IETF RFC 7235. The ProblemDetails structure may be provided.

Name Type Format Description
Content-Type String The MIME type of the body of the response.
WWW-Authenticate String Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.

Status: 403 - Forbidden If the API consumer is not allowed to perform a particular request to a particular resource, the API producer shall respond with this response code. The "ProblemDetails" structure shall be provided. It should include in the "detail" attribute information about the source of the problem, and may indicate how to solve it.

Name Type Format Description
Content-Type String The MIME type of the body of the response.

Status: 404 - Not Found If the API producer did not find a current representation for the resource addressed by the URI passed in the request, or is not willing to disclose that one exists, it shall respond with this response code. The "ProblemDetails" structure may be provided, including in the "detail" attribute information about the source of the problem, e.g. a wrong resource URI variable.

Name Type Format Description
Content-Type String The MIME type of the body of the response.

Status: 405 - Not Found If the API producer did not find a current representation for the resource addressed by the URI passed in the request, or is not willing to disclose that one exists, it shall respond with this response code. The "ProblemDetails" structure may be provided, including in the "detail" attribute information about the source of the problem, e.g. a wrong resource URI variable.

Name Type Format Description
Content-Type String The MIME type of the body of the response.

Status: 406 - Not Acceptable If the "Accept" HTTP header does not contain at least one name of a content type that is acceptable to the API producer, the API producer shall respond with this response code. The "ProblemDetails" structure may be omitted in that case.

Name Type Format Description
Content-Type String The MIME type of the body of the response.

Status: 409 - Conflict The operation cannot be executed currently, due to a conflict with the state of the VNF instance resource. Typically, this is due to the fact that the VNF instance resource is in INSTANTIATED state. The response body shall contain a ProblemDetails structure, in which the "detail" attribute should convey more information about the error.

Name Type Format Description
Content-Type String The MIME type of the body of the response.
WWW-Authenticate String Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.

Status: 412 - Precondition Failed A precondition given in an HTTP request header is not fulfilled. Typically, this is due to an ETag mismatch, indicating that the resource was modified by another entity. The response body should contain a ProblemDetails structure, in which the "detail" attribute should convey more information about the error.

Name Type Format Description
Content-Type String The MIME type of the body of the response.

Status: 500 - Internal Server Error If there is an application error not related to the client's input that cannot be easily mapped to any other HTTP response code ("catch all error"), the API producer shall respond withthis response code. The "ProblemDetails" structure shall be provided, and shall include in the "detail" attribute more information about the source of the problem.

Name Type Format Description
Content-Type String The MIME type of the body of the response.

Status: 503 - Service Unavailable If the API producer encounters an internal overload situation of itself or of a system it relies on, it should respond with this response code, following the provisions in IETF RFC 7231 [13] for the use of the "Retry-After" HTTP header and for the alternative to refuse the connection. The "ProblemDetails" structure may be omitted.

Name Type Format Description
Content-Type String The MIME type of the body of the response.

vnfInstancesVnfInstanceIdGet

Query VNF The GET method retrieves information about a VNF instance by reading an individual VNF instance resource.


/vnf_instances/{vnfInstanceId}

Usage and SDK Samples

curl -X GET "https://localhost/vnflcm/v1/vnf_instances/{vnfInstanceId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.Sol003VnfLcmApi;

import java.io.File;
import java.util.*;

public class Sol003VnfLcmApiExample {

    public static void main(String[] args) {
        
        Sol003VnfLcmApi apiInstance = new Sol003VnfLcmApi();
        String vnfInstanceId = vnfInstanceId_example; // String | Identifier of the VNF instance. This identifier can be retrieved from the resource referenced by the "Location" HTTP header in the response to a POST request creating a new VNF instance resource. It can also be retrieved from the "id" attribute in the payload body of that response.

        String accept = accept_example; // String | Content-Types that are acceptable for the response. Reference: IETF RFC 7231

        String contentType = contentType_example; // String | The MIME type of the body of the request. Reference: IETF RFC 7231

        String authorization = authorization_example; // String | The authorization token for the request. Reference: IETF RFC 7235

        try {
            inline_response_201 result = apiInstance.vnfInstancesVnfInstanceIdGet(vnfInstanceId, accept, contentType, authorization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling Sol003VnfLcmApi#vnfInstancesVnfInstanceIdGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.Sol003VnfLcmApi;

public class Sol003VnfLcmApiExample {

    public static void main(String[] args) {
        Sol003VnfLcmApi apiInstance = new Sol003VnfLcmApi();
        String vnfInstanceId = vnfInstanceId_example; // String | Identifier of the VNF instance. This identifier can be retrieved from the resource referenced by the "Location" HTTP header in the response to a POST request creating a new VNF instance resource. It can also be retrieved from the "id" attribute in the payload body of that response.

        String accept = accept_example; // String | Content-Types that are acceptable for the response. Reference: IETF RFC 7231

        String contentType = contentType_example; // String | The MIME type of the body of the request. Reference: IETF RFC 7231

        String authorization = authorization_example; // String | The authorization token for the request. Reference: IETF RFC 7235

        try {
            inline_response_201 result = apiInstance.vnfInstancesVnfInstanceIdGet(vnfInstanceId, accept, contentType, authorization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling Sol003VnfLcmApi#vnfInstancesVnfInstanceIdGet");
            e.printStackTrace();
        }
    }
}
String *vnfInstanceId = vnfInstanceId_example; // Identifier of the VNF instance. This identifier can be retrieved from the resource referenced by the "Location" HTTP header in the response to a POST request creating a new VNF instance resource. It can also be retrieved from the "id" attribute in the payload body of that response.

String *accept = accept_example; // Content-Types that are acceptable for the response. Reference: IETF RFC 7231

String *contentType = contentType_example; // The MIME type of the body of the request. Reference: IETF RFC 7231

String *authorization = authorization_example; // The authorization token for the request. Reference: IETF RFC 7235
 (optional)

Sol003VnfLcmApi *apiInstance = [[Sol003VnfLcmApi alloc] init];

[apiInstance vnfInstancesVnfInstanceIdGetWith:vnfInstanceId
    accept:accept
    contentType:contentType
    authorization:authorization
              completionHandler: ^(inline_response_201 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Sol003VnfLifecycleManagementInterface = require('sol003___vnf_lifecycle_management_interface');

var api = new Sol003VnfLifecycleManagementInterface.Sol003VnfLcmApi()

var vnfInstanceId = vnfInstanceId_example; // {String} Identifier of the VNF instance. This identifier can be retrieved from the resource referenced by the "Location" HTTP header in the response to a POST request creating a new VNF instance resource. It can also be retrieved from the "id" attribute in the payload body of that response.


var accept = accept_example; // {String} Content-Types that are acceptable for the response. Reference: IETF RFC 7231


var contentType = contentType_example; // {String} The MIME type of the body of the request. Reference: IETF RFC 7231


var opts = { 
  'authorization': authorization_example // {String} The authorization token for the request. Reference: IETF RFC 7235

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.vnfInstancesVnfInstanceIdGet(vnfInstanceIdaccept, contentType, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class vnfInstancesVnfInstanceIdGetExample
    {
        public void main()
        {
            
            var apiInstance = new Sol003VnfLcmApi();
            var vnfInstanceId = vnfInstanceId_example;  // String | Identifier of the VNF instance. This identifier can be retrieved from the resource referenced by the "Location" HTTP header in the response to a POST request creating a new VNF instance resource. It can also be retrieved from the "id" attribute in the payload body of that response.

            var accept = accept_example;  // String | Content-Types that are acceptable for the response. Reference: IETF RFC 7231

            var contentType = contentType_example;  // String | The MIME type of the body of the request. Reference: IETF RFC 7231

            var authorization = authorization_example;  // String | The authorization token for the request. Reference: IETF RFC 7235
 (optional) 

            try
            {
                inline_response_201 result = apiInstance.vnfInstancesVnfInstanceIdGet(vnfInstanceId, accept, contentType, authorization);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling Sol003VnfLcmApi.vnfInstancesVnfInstanceIdGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\Sol003VnfLcmApi();
$vnfInstanceId = vnfInstanceId_example; // String | Identifier of the VNF instance. This identifier can be retrieved from the resource referenced by the "Location" HTTP header in the response to a POST request creating a new VNF instance resource. It can also be retrieved from the "id" attribute in the payload body of that response.

$accept = accept_example; // String | Content-Types that are acceptable for the response. Reference: IETF RFC 7231

$contentType = contentType_example; // String | The MIME type of the body of the request. Reference: IETF RFC 7231

$authorization = authorization_example; // String | The authorization token for the request. Reference: IETF RFC 7235


try {
    $result = $api_instance->vnfInstancesVnfInstanceIdGet($vnfInstanceId, $accept, $contentType, $authorization);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling Sol003VnfLcmApi->vnfInstancesVnfInstanceIdGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::Sol003VnfLcmApi;

my $api_instance = WWW::SwaggerClient::Sol003VnfLcmApi->new();
my $vnfInstanceId = vnfInstanceId_example; # String | Identifier of the VNF instance. This identifier can be retrieved from the resource referenced by the "Location" HTTP header in the response to a POST request creating a new VNF instance resource. It can also be retrieved from the "id" attribute in the payload body of that response.

my $accept = accept_example; # String | Content-Types that are acceptable for the response. Reference: IETF RFC 7231

my $contentType = contentType_example; # String | The MIME type of the body of the request. Reference: IETF RFC 7231

my $authorization = authorization_example; # String | The authorization token for the request. Reference: IETF RFC 7235


eval { 
    my $result = $api_instance->vnfInstancesVnfInstanceIdGet(vnfInstanceId => $vnfInstanceId, accept => $accept, contentType => $contentType, authorization => $authorization);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling Sol003VnfLcmApi->vnfInstancesVnfInstanceIdGet: $@\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.Sol003VnfLcmApi()
vnfInstanceId = vnfInstanceId_example # String | Identifier of the VNF instance. This identifier can be retrieved from the resource referenced by the "Location" HTTP header in the response to a POST request creating a new VNF instance resource. It can also be retrieved from the "id" attribute in the payload body of that response.

accept = accept_example # String | Content-Types that are acceptable for the response. Reference: IETF RFC 7231

contentType = contentType_example # String | The MIME type of the body of the request. Reference: IETF RFC 7231

authorization = authorization_example # String | The authorization token for the request. Reference: IETF RFC 7235
 (optional)

try: 
    api_response = api_instance.vnf_instances_vnf_instance_id_get(vnfInstanceId, accept, contentType, authorization=authorization)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling Sol003VnfLcmApi->vnfInstancesVnfInstanceIdGet: %s\n" % e)

Parameters

Path parameters
Name Description
vnfInstanceId*
String
Identifier of the VNF instance. This identifier can be retrieved from the resource referenced by the "Location" HTTP header in the response to a POST request creating a new VNF instance resource. It can also be retrieved from the "id" attribute in the payload body of that response.
Required
Header parameters
Name Description
Accept*
String
Content-Types that are acceptable for the response. Reference: IETF RFC 7231
Required
Authorization
String
The authorization token for the request. Reference: IETF RFC 7235
Content-Type*
String
The MIME type of the body of the request. Reference: IETF RFC 7231
Required

Responses

Status: 200 - OK Information about zero or more VNF instances was queried successfully. The response body shall contain representations of zero or more VNF instances.

Name Type Format Description
Content-Type String The MIME type of the body of the response.
WWW-Authenticate String Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.

Status: 400 - Bad Request If the request is malformed or syntactically incorrect (e.g. if the request URI contains incorrect query parameters or a syntactically incorrect payload body), the API producer shall respond with this response code. The "ProblemDetails" structure shall be provided, and should include in the "detail" attribute more information about the source of the problem. --- If the request contains a malformed access token, the API producer should respond with this response. The details of the error shall be returned in the WWW-Authenticate HTTP header, as defined in IETF RFC 6750 and IETF RFC 7235. The ProblemDetails structure may be provided. --- If there is an application error related to the client's input that cannot be easily mapped to any other HTTP response code ("catch all error"), the API producer shall respond with this response code.The "ProblemDetails" structure shall be provided, and shall include in the "detail" attribute more information about the source of the problem.

Name Type Format Description
Content-Type String The MIME type of the body of the response.
WWW-Authenticate String Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.

Status: 401 - Unauthorized If the request contains no access token even though one is required, or if the request contains an authorization token that is invalid (e.g. expired or revoked), the API producer should respond with this response. The details of the error shall be returned in the WWW-Authenticate HTTP header, as defined in IETF RFC 6750 and IETF RFC 7235. The ProblemDetails structure may be provided.

Name Type Format Description
Content-Type String The MIME type of the body of the response.
WWW-Authenticate String Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.

Status: 403 - Forbidden If the API consumer is not allowed to perform a particular request to a particular resource, the API producer shall respond with this response code. The "ProblemDetails" structure shall be provided. It should include in the "detail" attribute information about the source of the problem, and may indicate how to solve it.

Name Type Format Description
Content-Type String The MIME type of the body of the response.

Status: 404 - Not Found If the API producer did not find a current representation for the resource addressed by the URI passed in the request, or is not willing to disclose that one exists, it shall respond with this response code. The "ProblemDetails" structure may be provided, including in the "detail" attribute information about the source of the problem, e.g. a wrong resource URI variable.

Name Type Format Description
Content-Type String The MIME type of the body of the response.

Status: 405 - Not Found If the API producer did not find a current representation for the resource addressed by the URI passed in the request, or is not willing to disclose that one exists, it shall respond with this response code. The "ProblemDetails" structure may be provided, including in the "detail" attribute information about the source of the problem, e.g. a wrong resource URI variable.

Name Type Format Description
Content-Type String The MIME type of the body of the response.

Status: 406 - Not Acceptable If the "Accept" HTTP header does not contain at least one name of a content type that is acceptable to the API producer, the API producer shall respond with this response code. The "ProblemDetails" structure may be omitted in that case.

Name Type Format Description
Content-Type String The MIME type of the body of the response.

Status: 409 - Conflict Another request is in progress that prohibits the fulfilment of the current request, or the current resource state is inconsistent with the request.

Name Type Format Description
Content-Type String The MIME type of the body of the response.
WWW-Authenticate String Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.

Status: 416 - Requested Range Not Satisfiable This code is returned if the requested byte range in the Range HTTP header is not present in the requested resource.

Name Type Format Description
Content-Type String The MIME type of the body of the response.

Status: 500 - Internal Server Error If there is an application error not related to the client's input that cannot be easily mapped to any other HTTP response code ("catch all error"), the API producer shall respond withthis response code. The "ProblemDetails" structure shall be provided, and shall include in the "detail" attribute more information about the source of the problem.

Name Type Format Description
Content-Type String The MIME type of the body of the response.

Status: 503 - Service Unavailable If the API producer encounters an internal overload situation of itself or of a system it relies on, it should respond with this response code, following the provisions in IETF RFC 7231 [13] for the use of the "Retry-After" HTTP header and for the alternative to refuse the connection. The "ProblemDetails" structure may be omitted.

Name Type Format Description
Content-Type String The MIME type of the body of the response.

vnfInstancesVnfInstanceIdInstantiatePost

Instantiate VNF The POST method instantiates a VNF instance.


/vnf_instances/{vnfInstanceId}/instantiate

Usage and SDK Samples

curl -X POST "https://localhost/vnflcm/v1/vnf_instances/{vnfInstanceId}/instantiate"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.Sol003VnfLcmApi;

import java.io.File;
import java.util.*;

public class Sol003VnfLcmApiExample {

    public static void main(String[] args) {
        
        Sol003VnfLcmApi apiInstance = new Sol003VnfLcmApi();
        String vnfInstanceId = vnfInstanceId_example; // String | Identifier of the VNF instance. This identifier can be retrieved from the resource referenced by the "Location" HTTP header in the response to a POST request creating a new VNF instance resource. It can also be retrieved from the "id" attribute in the payload body of that response.

        InstantiateVnfRequest instantiateVnfRequest = ; // InstantiateVnfRequest | Parameters for the VNF instantiation.
        String accept = accept_example; // String | Content-Types that are acceptable for the response. Reference: IETF RFC 7231

        String contentType = contentType_example; // String | The MIME type of the body of the request. Reference: IETF RFC 7231

        String authorization = authorization_example; // String | The authorization token for the request. Reference: IETF RFC 7235

        try {
            apiInstance.vnfInstancesVnfInstanceIdInstantiatePost(vnfInstanceId, instantiateVnfRequest, accept, contentType, authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling Sol003VnfLcmApi#vnfInstancesVnfInstanceIdInstantiatePost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.Sol003VnfLcmApi;

public class Sol003VnfLcmApiExample {

    public static void main(String[] args) {
        Sol003VnfLcmApi apiInstance = new Sol003VnfLcmApi();
        String vnfInstanceId = vnfInstanceId_example; // String | Identifier of the VNF instance. This identifier can be retrieved from the resource referenced by the "Location" HTTP header in the response to a POST request creating a new VNF instance resource. It can also be retrieved from the "id" attribute in the payload body of that response.

        InstantiateVnfRequest instantiateVnfRequest = ; // InstantiateVnfRequest | Parameters for the VNF instantiation.
        String accept = accept_example; // String | Content-Types that are acceptable for the response. Reference: IETF RFC 7231

        String contentType = contentType_example; // String | The MIME type of the body of the request. Reference: IETF RFC 7231

        String authorization = authorization_example; // String | The authorization token for the request. Reference: IETF RFC 7235

        try {
            apiInstance.vnfInstancesVnfInstanceIdInstantiatePost(vnfInstanceId, instantiateVnfRequest, accept, contentType, authorization);
        } catch (ApiException e) {
            System.err.println("Exception when calling Sol003VnfLcmApi#vnfInstancesVnfInstanceIdInstantiatePost");
            e.printStackTrace();
        }
    }
}
String *vnfInstanceId = vnfInstanceId_example; // Identifier of the VNF instance. This identifier can be retrieved from the resource referenced by the "Location" HTTP header in the response to a POST request creating a new VNF instance resource. It can also be retrieved from the "id" attribute in the payload body of that response.

InstantiateVnfRequest *instantiateVnfRequest = ; // Parameters for the VNF instantiation.
String *accept = accept_example; // Content-Types that are acceptable for the response. Reference: IETF RFC 7231

String *contentType = contentType_example; // The MIME type of the body of the request. Reference: IETF RFC 7231

String *authorization = authorization_example; // The authorization token for the request. Reference: IETF RFC 7235
 (optional)

Sol003VnfLcmApi *apiInstance = [[Sol003VnfLcmApi alloc] init];

[apiInstance vnfInstancesVnfInstanceIdInstantiatePostWith:vnfInstanceId
    instantiateVnfRequest:instantiateVnfRequest
    accept:accept
    contentType:contentType
    authorization:authorization
              completionHandler: ^(NSError* error) {
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Sol003VnfLifecycleManagementInterface = require('sol003___vnf_lifecycle_management_interface');

var api = new Sol003VnfLifecycleManagementInterface.Sol003VnfLcmApi()

var vnfInstanceId = vnfInstanceId_example; // {String} Identifier of the VNF instance. This identifier can be retrieved from the resource referenced by the "Location" HTTP header in the response to a POST request creating a new VNF instance resource. It can also be retrieved from the "id" attribute in the payload body of that response.


var instantiateVnfRequest = ; // {InstantiateVnfRequest} Parameters for the VNF instantiation.

var accept = accept_example; // {String} Content-Types that are acceptable for the response. Reference: IETF RFC 7231


var contentType = contentType_example; // {String} The MIME type of the body of the request. Reference: IETF RFC 7231


var opts = { 
  'authorization': authorization_example // {String} The authorization token for the request. Reference: IETF RFC 7235

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.vnfInstancesVnfInstanceIdInstantiatePost(vnfInstanceId, instantiateVnfRequest, accept, contentType, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class vnfInstancesVnfInstanceIdInstantiatePostExample
    {
        public void main()
        {
            
            var apiInstance = new Sol003VnfLcmApi();
            var vnfInstanceId = vnfInstanceId_example;  // String | Identifier of the VNF instance. This identifier can be retrieved from the resource referenced by the "Location" HTTP header in the response to a POST request creating a new VNF instance resource. It can also be retrieved from the "id" attribute in the payload body of that response.

            var instantiateVnfRequest = new InstantiateVnfRequest(); // InstantiateVnfRequest | Parameters for the VNF instantiation.
            var accept = accept_example;  // String | Content-Types that are acceptable for the response. Reference: IETF RFC 7231

            var contentType = contentType_example;  // String | The MIME type of the body of the request. Reference: IETF RFC 7231

            var authorization = authorization_example;  // String | The authorization token for the request. Reference: IETF RFC 7235
 (optional) 

            try
            {
                apiInstance.vnfInstancesVnfInstanceIdInstantiatePost(vnfInstanceId, instantiateVnfRequest, accept, contentType, authorization);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling Sol003VnfLcmApi.vnfInstancesVnfInstanceIdInstantiatePost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\Sol003VnfLcmApi();
$vnfInstanceId = vnfInstanceId_example; // String | Identifier of the VNF instance. This identifier can be retrieved from the resource referenced by the "Location" HTTP header in the response to a POST request creating a new VNF instance resource. It can also be retrieved from the "id" attribute in the payload body of that response.

$instantiateVnfRequest = ; // InstantiateVnfRequest | Parameters for the VNF instantiation.
$accept = accept_example; // String | Content-Types that are acceptable for the response. Reference: IETF RFC 7231

$contentType = contentType_example; // String | The MIME type of the body of the request. Reference: IETF RFC 7231

$authorization = authorization_example; // String | The authorization token for the request. Reference: IETF RFC 7235


try {
    $api_instance->vnfInstancesVnfInstanceIdInstantiatePost($vnfInstanceId, $instantiateVnfRequest, $accept, $contentType, $authorization);
} catch (Exception $e) {
    echo 'Exception when calling Sol003VnfLcmApi->vnfInstancesVnfInstanceIdInstantiatePost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::Sol003VnfLcmApi;

my $api_instance = WWW::SwaggerClient::Sol003VnfLcmApi->new();
my $vnfInstanceId = vnfInstanceId_example; # String | Identifier of the VNF instance. This identifier can be retrieved from the resource referenced by the "Location" HTTP header in the response to a POST request creating a new VNF instance resource. It can also be retrieved from the "id" attribute in the payload body of that response.

my $instantiateVnfRequest = WWW::SwaggerClient::Object::InstantiateVnfRequest->new(); # InstantiateVnfRequest | Parameters for the VNF instantiation.
my $accept = accept_example; # String | Content-Types that are acceptable for the response. Reference: IETF RFC 7231

my $contentType = contentType_example; # String | The MIME type of the body of the request. Reference: IETF RFC 7231

my $authorization = authorization_example; # String | The authorization token for the request. Reference: IETF RFC 7235


eval { 
    $api_instance->vnfInstancesVnfInstanceIdInstantiatePost(vnfInstanceId => $vnfInstanceId, instantiateVnfRequest => $instantiateVnfRequest, accept => $accept, contentType => $contentType, authorization => $authorization);
};
if ($@) {
    warn "Exception when calling Sol003VnfLcmApi->vnfInstancesVnfInstanceIdInstantiatePost: $@\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.Sol003VnfLcmApi()
vnfInstanceId = vnfInstanceId_example # String | Identifier of the VNF instance. This identifier can be retrieved from the resource referenced by the "Location" HTTP header in the response to a POST request creating a new VNF instance resource. It can also be retrieved from the "id" attribute in the payload body of that response.

instantiateVnfRequest =  # InstantiateVnfRequest | Parameters for the VNF instantiation.
accept = accept_example # String | Content-Types that are acceptable for the response. Reference: IETF RFC 7231

contentType = contentType_example # String | The MIME type of the body of the request. Reference: IETF RFC 7231

authorization = authorization_example # String | The authorization token for the request. Reference: IETF RFC 7235
 (optional)

try: 
    api_instance.vnf_instances_vnf_instance_id_instantiate_post(vnfInstanceId, instantiateVnfRequest, accept, contentType, authorization=authorization)
except ApiException as e:
    print("Exception when calling Sol003VnfLcmApi->vnfInstancesVnfInstanceIdInstantiatePost: %s\n" % e)

Parameters

Path parameters
Name Description
vnfInstanceId*
String
Identifier of the VNF instance. This identifier can be retrieved from the resource referenced by the "Location" HTTP header in the response to a POST request creating a new VNF instance resource. It can also be retrieved from the "id" attribute in the payload body of that response.
Required
Header parameters
Name Description
Accept*
String
Content-Types that are acceptable for the response. Reference: IETF RFC 7231
Required
Authorization
String
The authorization token for the request. Reference: IETF RFC 7235
Content-Type*
String
The MIME type of the body of the request. Reference: IETF RFC 7231
Required
Body parameters
Name Description
instantiateVnfRequest *

Responses

Status: 202 - Accepted The request was accepted for processing, but the processing has not been completed. The response body shall be empty. The HTTP response shall include a "Location" HTTP header that contains the URI of the newly-created "VNF LCM operation occurrence" resource corresponding to the operation.

Name Type Format Description
Location String url The resource URI of the created VNF instance
WWW-Authenticate String Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.

Status: 400 - Bad Request If the request is malformed or syntactically incorrect (e.g. if the request URI contains incorrect query parameters or a syntactically incorrect payload body), the API producer shall respond with this response code. The "ProblemDetails" structure shall be provided, and should include in the "detail" attribute more information about the source of the problem. --- If the request contains a malformed access token, the API producer should respond with this response. The details of the error shall be returned in the WWW-Authenticate HTTP header, as defined in IETF RFC 6750 and IETF RFC 7235. The ProblemDetails structure may be provided. --- If there is an application error related to the client's input that cannot be easily mapped to any other HTTP response code ("catch all error"), the API producer shall respond with this response code.The "ProblemDetails" structure shall be provided, and shall include in the "detail" attribute more information about the source of the problem.

Name Type Format Description
Content-Type String The MIME type of the body of the response.
WWW-Authenticate String Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.

Status: 401 - Unauthorized If the request contains no access token even though one is required, or if the request contains an authorization token that is invalid (e.g. expired or revoked), the API producer should respond with this response. The details of the error shall be returned in the WWW-Authenticate HTTP header, as defined in IETF RFC 6750 and IETF RFC 7235. The ProblemDetails structure may be provided.

Name Type Format Description
Content-Type String The MIME type of the body of the response.
WWW-Authenticate String Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.

Status: 403 - Forbidden If the API consumer is not allowed to perform a particular request to a particular resource, the API producer shall respond with this response code. The "ProblemDetails" structure shall be provided. It should include in the "detail" attribute information about the source of the problem, and may indicate how to solve it.

Name Type Format Description
Content-Type String The MIME type of the body of the response.

Status: 404 - Not Found If the API producer did not find a current representation for the resource addressed by the URI passed in the request, or is not willing to disclose that one exists, it shall respond with this response code. The "ProblemDetails" structure may be provided, including in the "detail" attribute information about the source of the problem, e.g. a wrong resource URI variable.

Name Type Format Description
Content-Type String The MIME type of the body of the response.

Status: 405 - Not Found If the API producer did not find a current representation for the resource addressed by the URI passed in the request, or is not willing to disclose that one exists, it shall respond with this response code. The "ProblemDetails" structure may be provided, including in the "detail" attribute information about the source of the problem, e.g. a wrong resource URI variable.

Name Type Format Description
Content-Type String The MIME type of the body of the response.

Status: 406 - Not Acceptable If the "Accept" HTTP header does not contain at least one name of a content type that is acceptable to the API producer, the API producer shall respond with this response code. The "ProblemDetails" structure may be omitted in that case.

Name Type Format Description
Content-Type String The MIME type of the body of the response.

Status: 409 - Conflict The operation cannot be executed currently, due to a conflict with the state of the VNF instance resource. Typically, this is due to the fact that the VNF instance resource is in INSTANTIATED state. The response body shall contain a ProblemDetails structure, in which the "detail" attribute should convey more information about the error.

Name Type Format Description
Content-Type String The MIME type of the body of the response.
WWW-Authenticate String Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.

Status: 416 - Requested Range Not Satisfiable This code is returned if the requested byte range in the Range HTTP header is not present in the requested resource.

Name Type Format Description
Content-Type String The MIME type of the body of the response.

Status: 500 - Internal Server Error If there is an application error not related to the client's input that cannot be easily mapped to any other HTTP response code ("catch all error"), the API producer shall respond withthis response code. The "ProblemDetails" structure shall be provided, and shall include in the "detail" attribute more information about the source of the problem.

Name Type Format Description
Content-Type String The MIME type of the body of the response.

Status: 503 - Service Unavailable If the API producer encounters an internal overload situation of itself or of a system it relies on, it should respond with this response code, following the provisions in IETF RFC 7231 [13] for the use of the "Retry-After" HTTP header and for the alternative to refuse the connection. The "ProblemDetails" structure may be omitted.

Name Type Format Description
Content-Type String The MIME type of the body of the response.

vnfInstancesVnfInstanceIdTerminatePost

Terminate VNF The POST method terminates a VNF instance.


/vnf_instances/{vnfInstanceId}/terminate

Usage and SDK Samples

curl -X POST "https://localhost/vnflcm/v1/vnf_instances/{vnfInstanceId}/terminate"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.Sol003VnfLcmApi;

import java.io.File;
import java.util.*;

public class Sol003VnfLcmApiExample {

    public static void main(String[] args) {
        
        Sol003VnfLcmApi apiInstance = new Sol003VnfLcmApi();
        String vnfInstanceId = vnfInstanceId_example; // String | The identifier of the VNF instance to be terminated. This identifier can be retrieved from the resource referenced by the "Location" HTTP header in the response to a POST request creating a new VNF instance resource. It can also be retrieved from the "id" attribute in the payload body of that response.

        TerminateVnfRequest terminateVnfRequest = ; // TerminateVnfRequest | Parameters for the VNF termination.
        String accept = accept_example; // String | Content-Types that are acceptable for the response. Reference: IETF RFC 7231

        String contentType = contentType_example; // String | The MIME type of the body of the request. Reference: IETF RFC 7231

        String authorization = authorization_example; // String | The authorization token for the request. Reference: IETF RFC 7235

        try {
            inline_response_201 result = apiInstance.vnfInstancesVnfInstanceIdTerminatePost(vnfInstanceId, terminateVnfRequest, accept, contentType, authorization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling Sol003VnfLcmApi#vnfInstancesVnfInstanceIdTerminatePost");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.Sol003VnfLcmApi;

public class Sol003VnfLcmApiExample {

    public static void main(String[] args) {
        Sol003VnfLcmApi apiInstance = new Sol003VnfLcmApi();
        String vnfInstanceId = vnfInstanceId_example; // String | The identifier of the VNF instance to be terminated. This identifier can be retrieved from the resource referenced by the "Location" HTTP header in the response to a POST request creating a new VNF instance resource. It can also be retrieved from the "id" attribute in the payload body of that response.

        TerminateVnfRequest terminateVnfRequest = ; // TerminateVnfRequest | Parameters for the VNF termination.
        String accept = accept_example; // String | Content-Types that are acceptable for the response. Reference: IETF RFC 7231

        String contentType = contentType_example; // String | The MIME type of the body of the request. Reference: IETF RFC 7231

        String authorization = authorization_example; // String | The authorization token for the request. Reference: IETF RFC 7235

        try {
            inline_response_201 result = apiInstance.vnfInstancesVnfInstanceIdTerminatePost(vnfInstanceId, terminateVnfRequest, accept, contentType, authorization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling Sol003VnfLcmApi#vnfInstancesVnfInstanceIdTerminatePost");
            e.printStackTrace();
        }
    }
}
String *vnfInstanceId = vnfInstanceId_example; // The identifier of the VNF instance to be terminated. This identifier can be retrieved from the resource referenced by the "Location" HTTP header in the response to a POST request creating a new VNF instance resource. It can also be retrieved from the "id" attribute in the payload body of that response.

TerminateVnfRequest *terminateVnfRequest = ; // Parameters for the VNF termination.
String *accept = accept_example; // Content-Types that are acceptable for the response. Reference: IETF RFC 7231

String *contentType = contentType_example; // The MIME type of the body of the request. Reference: IETF RFC 7231

String *authorization = authorization_example; // The authorization token for the request. Reference: IETF RFC 7235
 (optional)

Sol003VnfLcmApi *apiInstance = [[Sol003VnfLcmApi alloc] init];

[apiInstance vnfInstancesVnfInstanceIdTerminatePostWith:vnfInstanceId
    terminateVnfRequest:terminateVnfRequest
    accept:accept
    contentType:contentType
    authorization:authorization
              completionHandler: ^(inline_response_201 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Sol003VnfLifecycleManagementInterface = require('sol003___vnf_lifecycle_management_interface');

var api = new Sol003VnfLifecycleManagementInterface.Sol003VnfLcmApi()

var vnfInstanceId = vnfInstanceId_example; // {String} The identifier of the VNF instance to be terminated. This identifier can be retrieved from the resource referenced by the "Location" HTTP header in the response to a POST request creating a new VNF instance resource. It can also be retrieved from the "id" attribute in the payload body of that response.


var terminateVnfRequest = ; // {TerminateVnfRequest} Parameters for the VNF termination.

var accept = accept_example; // {String} Content-Types that are acceptable for the response. Reference: IETF RFC 7231


var contentType = contentType_example; // {String} The MIME type of the body of the request. Reference: IETF RFC 7231


var opts = { 
  'authorization': authorization_example // {String} The authorization token for the request. Reference: IETF RFC 7235

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.vnfInstancesVnfInstanceIdTerminatePost(vnfInstanceId, terminateVnfRequest, accept, contentType, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class vnfInstancesVnfInstanceIdTerminatePostExample
    {
        public void main()
        {
            
            var apiInstance = new Sol003VnfLcmApi();
            var vnfInstanceId = vnfInstanceId_example;  // String | The identifier of the VNF instance to be terminated. This identifier can be retrieved from the resource referenced by the "Location" HTTP header in the response to a POST request creating a new VNF instance resource. It can also be retrieved from the "id" attribute in the payload body of that response.

            var terminateVnfRequest = new TerminateVnfRequest(); // TerminateVnfRequest | Parameters for the VNF termination.
            var accept = accept_example;  // String | Content-Types that are acceptable for the response. Reference: IETF RFC 7231

            var contentType = contentType_example;  // String | The MIME type of the body of the request. Reference: IETF RFC 7231

            var authorization = authorization_example;  // String | The authorization token for the request. Reference: IETF RFC 7235
 (optional) 

            try
            {
                inline_response_201 result = apiInstance.vnfInstancesVnfInstanceIdTerminatePost(vnfInstanceId, terminateVnfRequest, accept, contentType, authorization);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling Sol003VnfLcmApi.vnfInstancesVnfInstanceIdTerminatePost: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\Sol003VnfLcmApi();
$vnfInstanceId = vnfInstanceId_example; // String | The identifier of the VNF instance to be terminated. This identifier can be retrieved from the resource referenced by the "Location" HTTP header in the response to a POST request creating a new VNF instance resource. It can also be retrieved from the "id" attribute in the payload body of that response.

$terminateVnfRequest = ; // TerminateVnfRequest | Parameters for the VNF termination.
$accept = accept_example; // String | Content-Types that are acceptable for the response. Reference: IETF RFC 7231

$contentType = contentType_example; // String | The MIME type of the body of the request. Reference: IETF RFC 7231

$authorization = authorization_example; // String | The authorization token for the request. Reference: IETF RFC 7235


try {
    $result = $api_instance->vnfInstancesVnfInstanceIdTerminatePost($vnfInstanceId, $terminateVnfRequest, $accept, $contentType, $authorization);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling Sol003VnfLcmApi->vnfInstancesVnfInstanceIdTerminatePost: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::Sol003VnfLcmApi;

my $api_instance = WWW::SwaggerClient::Sol003VnfLcmApi->new();
my $vnfInstanceId = vnfInstanceId_example; # String | The identifier of the VNF instance to be terminated. This identifier can be retrieved from the resource referenced by the "Location" HTTP header in the response to a POST request creating a new VNF instance resource. It can also be retrieved from the "id" attribute in the payload body of that response.

my $terminateVnfRequest = WWW::SwaggerClient::Object::TerminateVnfRequest->new(); # TerminateVnfRequest | Parameters for the VNF termination.
my $accept = accept_example; # String | Content-Types that are acceptable for the response. Reference: IETF RFC 7231

my $contentType = contentType_example; # String | The MIME type of the body of the request. Reference: IETF RFC 7231

my $authorization = authorization_example; # String | The authorization token for the request. Reference: IETF RFC 7235


eval { 
    my $result = $api_instance->vnfInstancesVnfInstanceIdTerminatePost(vnfInstanceId => $vnfInstanceId, terminateVnfRequest => $terminateVnfRequest, accept => $accept, contentType => $contentType, authorization => $authorization);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling Sol003VnfLcmApi->vnfInstancesVnfInstanceIdTerminatePost: $@\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.Sol003VnfLcmApi()
vnfInstanceId = vnfInstanceId_example # String | The identifier of the VNF instance to be terminated. This identifier can be retrieved from the resource referenced by the "Location" HTTP header in the response to a POST request creating a new VNF instance resource. It can also be retrieved from the "id" attribute in the payload body of that response.

terminateVnfRequest =  # TerminateVnfRequest | Parameters for the VNF termination.
accept = accept_example # String | Content-Types that are acceptable for the response. Reference: IETF RFC 7231

contentType = contentType_example # String | The MIME type of the body of the request. Reference: IETF RFC 7231

authorization = authorization_example # String | The authorization token for the request. Reference: IETF RFC 7235
 (optional)

try: 
    api_response = api_instance.vnf_instances_vnf_instance_id_terminate_post(vnfInstanceId, terminateVnfRequest, accept, contentType, authorization=authorization)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling Sol003VnfLcmApi->vnfInstancesVnfInstanceIdTerminatePost: %s\n" % e)

Parameters

Path parameters
Name Description
vnfInstanceId*
String
The identifier of the VNF instance to be terminated. This identifier can be retrieved from the resource referenced by the "Location" HTTP header in the response to a POST request creating a new VNF instance resource. It can also be retrieved from the "id" attribute in the payload body of that response.
Required
Header parameters
Name Description
Accept*
String
Content-Types that are acceptable for the response. Reference: IETF RFC 7231
Required
Authorization
String
The authorization token for the request. Reference: IETF RFC 7235
Content-Type*
String
The MIME type of the body of the request. Reference: IETF RFC 7231
Required
Body parameters
Name Description
terminateVnfRequest *

Responses

Status: 202 - Accepted The request was accepted for processing, but the processing has not been completed. On success, the HTTP response shall include a "Location" HTTP header that contains the URI of the newly-created "VNF LCM operation occurrence" resource corresponding to the operation.

Name Type Format Description
Content-Type String The MIME type of the body of the response.
Location String url The resource URI of the created VNF instance
WWW-Authenticate String Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.

Status: 400 - Bad Request If the request is malformed or syntactically incorrect (e.g. if the request URI contains incorrect query parameters or a syntactically incorrect payload body), the API producer shall respond with this response code. The "ProblemDetails" structure shall be provided, and should include in the "detail" attribute more information about the source of the problem. --- If the request contains a malformed access token, the API producer should respond with this response. The details of the error shall be returned in the WWW-Authenticate HTTP header, as defined in IETF RFC 6750 and IETF RFC 7235. The ProblemDetails structure may be provided. --- If there is an application error related to the client's input that cannot be easily mapped to any other HTTP response code ("catch all error"), the API producer shall respond with this response code.The "ProblemDetails" structure shall be provided, and shall include in the "detail" attribute more information about the source of the problem.

Name Type Format Description
Content-Type String The MIME type of the body of the response.
WWW-Authenticate String Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.

Status: 401 - Unauthorized If the request contains no access token even though one is required, or if the request contains an authorization token that is invalid (e.g. expired or revoked), the API producer should respond with this response. The details of the error shall be returned in the WWW-Authenticate HTTP header, as defined in IETF RFC 6750 and IETF RFC 7235. The ProblemDetails structure may be provided.

Name Type Format Description
Content-Type String The MIME type of the body of the response.
WWW-Authenticate String Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.

Status: 403 - Forbidden If the API consumer is not allowed to perform a particular request to a particular resource, the API producer shall respond with this response code. The "ProblemDetails" structure shall be provided. It should include in the "detail" attribute information about the source of the problem, and may indicate how to solve it.

Name Type Format Description
Content-Type String The MIME type of the body of the response.

Status: 404 - Not Found If the API producer did not find a current representation for the resource addressed by the URI passed in the request, or is not willing to disclose that one exists, it shall respond with this response code. The "ProblemDetails" structure may be provided, including in the "detail" attribute information about the source of the problem, e.g. a wrong resource URI variable.

Name Type Format Description
Content-Type String The MIME type of the body of the response.

Status: 405 - Not Found If the API producer did not find a current representation for the resource addressed by the URI passed in the request, or is not willing to disclose that one exists, it shall respond with this response code. The "ProblemDetails" structure may be provided, including in the "detail" attribute information about the source of the problem, e.g. a wrong resource URI variable.

Name Type Format Description
Content-Type String The MIME type of the body of the response.

Status: 406 - Not Acceptable If the "Accept" HTTP header does not contain at least one name of a content type that is acceptable to the API producer, the API producer shall respond with this response code. The "ProblemDetails" structure may be omitted in that case.

Name Type Format Description
Content-Type String The MIME type of the body of the response.

Status: 409 - Conflict The operation cannot be executed currently, due to a conflict with the state of the VNF instance resource. Typically, this is due to the fact that the VNF instance resource is in NOT-INSTANTIATED state, or that another lifecycle management operation is ongoing. The response body shall contain a ProblemDetails structure, in which the "detail" attribute should convey more information about the error.

Name Type Format Description
Content-Type String The MIME type of the body of the response.
WWW-Authenticate String Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.

Status: 500 - Internal Server Error If there is an application error not related to the client's input that cannot be easily mapped to any other HTTP response code ("catch all error"), the API producer shall respond withthis response code. The "ProblemDetails" structure shall be provided, and shall include in the "detail" attribute more information about the source of the problem.

Name Type Format Description
Content-Type String The MIME type of the body of the response.

Status: 503 - Service Unavailable If the API producer encounters an internal overload situation of itself or of a system it relies on, it should respond with this response code, following the provisions in IETF RFC 7231 [13] for the use of the "Retry-After" HTTP header and for the alternative to refuse the connection. The "ProblemDetails" structure may be omitted.

Name Type Format Description
Content-Type String The MIME type of the body of the response.

vnfLcmOpOccsVnfLcmOpOccIdGet

Get Operation Status The client can use this method to retrieve status information about a VNF lifecycle management operation occurrence by reading an individual "VNF LCM operation occurrence" resource.


/vnf_lcm_op_occs/{vnfLcmOpOccId}

Usage and SDK Samples

curl -X GET "https://localhost/vnflcm/v1/vnf_lcm_op_occs/{vnfLcmOpOccId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.Sol003VnfLcmApi;

import java.io.File;
import java.util.*;

public class Sol003VnfLcmApiExample {

    public static void main(String[] args) {
        
        Sol003VnfLcmApi apiInstance = new Sol003VnfLcmApi();
        String vnfLcmOpOccId = vnfLcmOpOccId_example; // String | Identifier of a VNF lifecycle management operation occurrence. This identifier can be retrieved from the resource referenced by the "Location" HTTP header in the response to a PATCH or POST request triggering a VNF LCM operation. It can also be retrieved from the "vnfLcmOpOccId" attribute in the VnfLcmOperationOccurrenceNotification.

        String accept = accept_example; // String | Content-Types that are acceptable for the response. Reference: IETF RFC 7231

        String authorization = authorization_example; // String | The authorization token for the request. Reference: IETF RFC 7235

        try {
            inline_response_200 result = apiInstance.vnfLcmOpOccsVnfLcmOpOccIdGet(vnfLcmOpOccId, accept, authorization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling Sol003VnfLcmApi#vnfLcmOpOccsVnfLcmOpOccIdGet");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.Sol003VnfLcmApi;

public class Sol003VnfLcmApiExample {

    public static void main(String[] args) {
        Sol003VnfLcmApi apiInstance = new Sol003VnfLcmApi();
        String vnfLcmOpOccId = vnfLcmOpOccId_example; // String | Identifier of a VNF lifecycle management operation occurrence. This identifier can be retrieved from the resource referenced by the "Location" HTTP header in the response to a PATCH or POST request triggering a VNF LCM operation. It can also be retrieved from the "vnfLcmOpOccId" attribute in the VnfLcmOperationOccurrenceNotification.

        String accept = accept_example; // String | Content-Types that are acceptable for the response. Reference: IETF RFC 7231

        String authorization = authorization_example; // String | The authorization token for the request. Reference: IETF RFC 7235

        try {
            inline_response_200 result = apiInstance.vnfLcmOpOccsVnfLcmOpOccIdGet(vnfLcmOpOccId, accept, authorization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling Sol003VnfLcmApi#vnfLcmOpOccsVnfLcmOpOccIdGet");
            e.printStackTrace();
        }
    }
}
String *vnfLcmOpOccId = vnfLcmOpOccId_example; // Identifier of a VNF lifecycle management operation occurrence. This identifier can be retrieved from the resource referenced by the "Location" HTTP header in the response to a PATCH or POST request triggering a VNF LCM operation. It can also be retrieved from the "vnfLcmOpOccId" attribute in the VnfLcmOperationOccurrenceNotification.

String *accept = accept_example; // Content-Types that are acceptable for the response. Reference: IETF RFC 7231

String *authorization = authorization_example; // The authorization token for the request. Reference: IETF RFC 7235
 (optional)

Sol003VnfLcmApi *apiInstance = [[Sol003VnfLcmApi alloc] init];

[apiInstance vnfLcmOpOccsVnfLcmOpOccIdGetWith:vnfLcmOpOccId
    accept:accept
    authorization:authorization
              completionHandler: ^(inline_response_200 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var Sol003VnfLifecycleManagementInterface = require('sol003___vnf_lifecycle_management_interface');

var api = new Sol003VnfLifecycleManagementInterface.Sol003VnfLcmApi()

var vnfLcmOpOccId = vnfLcmOpOccId_example; // {String} Identifier of a VNF lifecycle management operation occurrence. This identifier can be retrieved from the resource referenced by the "Location" HTTP header in the response to a PATCH or POST request triggering a VNF LCM operation. It can also be retrieved from the "vnfLcmOpOccId" attribute in the VnfLcmOperationOccurrenceNotification.


var accept = accept_example; // {String} Content-Types that are acceptable for the response. Reference: IETF RFC 7231


var opts = { 
  'authorization': authorization_example // {String} The authorization token for the request. Reference: IETF RFC 7235

};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.vnfLcmOpOccsVnfLcmOpOccIdGet(vnfLcmOpOccId, accept, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class vnfLcmOpOccsVnfLcmOpOccIdGetExample
    {
        public void main()
        {
            
            var apiInstance = new Sol003VnfLcmApi();
            var vnfLcmOpOccId = vnfLcmOpOccId_example;  // String | Identifier of a VNF lifecycle management operation occurrence. This identifier can be retrieved from the resource referenced by the "Location" HTTP header in the response to a PATCH or POST request triggering a VNF LCM operation. It can also be retrieved from the "vnfLcmOpOccId" attribute in the VnfLcmOperationOccurrenceNotification.

            var accept = accept_example;  // String | Content-Types that are acceptable for the response. Reference: IETF RFC 7231

            var authorization = authorization_example;  // String | The authorization token for the request. Reference: IETF RFC 7235
 (optional) 

            try
            {
                inline_response_200 result = apiInstance.vnfLcmOpOccsVnfLcmOpOccIdGet(vnfLcmOpOccId, accept, authorization);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling Sol003VnfLcmApi.vnfLcmOpOccsVnfLcmOpOccIdGet: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

$api_instance = new Swagger\Client\Api\Sol003VnfLcmApi();
$vnfLcmOpOccId = vnfLcmOpOccId_example; // String | Identifier of a VNF lifecycle management operation occurrence. This identifier can be retrieved from the resource referenced by the "Location" HTTP header in the response to a PATCH or POST request triggering a VNF LCM operation. It can also be retrieved from the "vnfLcmOpOccId" attribute in the VnfLcmOperationOccurrenceNotification.

$accept = accept_example; // String | Content-Types that are acceptable for the response. Reference: IETF RFC 7231

$authorization = authorization_example; // String | The authorization token for the request. Reference: IETF RFC 7235


try {
    $result = $api_instance->vnfLcmOpOccsVnfLcmOpOccIdGet($vnfLcmOpOccId, $accept, $authorization);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling Sol003VnfLcmApi->vnfLcmOpOccsVnfLcmOpOccIdGet: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::Sol003VnfLcmApi;

my $api_instance = WWW::SwaggerClient::Sol003VnfLcmApi->new();
my $vnfLcmOpOccId = vnfLcmOpOccId_example; # String | Identifier of a VNF lifecycle management operation occurrence. This identifier can be retrieved from the resource referenced by the "Location" HTTP header in the response to a PATCH or POST request triggering a VNF LCM operation. It can also be retrieved from the "vnfLcmOpOccId" attribute in the VnfLcmOperationOccurrenceNotification.

my $accept = accept_example; # String | Content-Types that are acceptable for the response. Reference: IETF RFC 7231

my $authorization = authorization_example; # String | The authorization token for the request. Reference: IETF RFC 7235


eval { 
    my $result = $api_instance->vnfLcmOpOccsVnfLcmOpOccIdGet(vnfLcmOpOccId => $vnfLcmOpOccId, accept => $accept, authorization => $authorization);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling Sol003VnfLcmApi->vnfLcmOpOccsVnfLcmOpOccIdGet: $@\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.Sol003VnfLcmApi()
vnfLcmOpOccId = vnfLcmOpOccId_example # String | Identifier of a VNF lifecycle management operation occurrence. This identifier can be retrieved from the resource referenced by the "Location" HTTP header in the response to a PATCH or POST request triggering a VNF LCM operation. It can also be retrieved from the "vnfLcmOpOccId" attribute in the VnfLcmOperationOccurrenceNotification.

accept = accept_example # String | Content-Types that are acceptable for the response. Reference: IETF RFC 7231

authorization = authorization_example # String | The authorization token for the request. Reference: IETF RFC 7235
 (optional)

try: 
    api_response = api_instance.vnf_lcm_op_occs_vnf_lcm_op_occ_id_get(vnfLcmOpOccId, accept, authorization=authorization)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling Sol003VnfLcmApi->vnfLcmOpOccsVnfLcmOpOccIdGet: %s\n" % e)

Parameters

Path parameters
Name Description
vnfLcmOpOccId*
String
Identifier of a VNF lifecycle management operation occurrence. This identifier can be retrieved from the resource referenced by the "Location" HTTP header in the response to a PATCH or POST request triggering a VNF LCM operation. It can also be retrieved from the "vnfLcmOpOccId" attribute in the VnfLcmOperationOccurrenceNotification.
Required
Header parameters
Name Description
Accept*
String
Content-Types that are acceptable for the response. Reference: IETF RFC 7231
Required
Authorization
String
The authorization token for the request. Reference: IETF RFC 7235

Responses

Status: 200 - OK Information about an individual VNF instance was queried successfully. The response body shall contain status information about a VNF lifecycle management operation occurrence.

Name Type Format Description
Content-Type String The MIME type of the body of the response.
WWW-Authenticate String Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.

Status: 400 - Bad Request If the request is malformed or syntactically incorrect (e.g. if the request URI contains incorrect query parameters or a syntactically incorrect payload body), the API producer shall respond with this response code. The "ProblemDetails" structure shall be provided, and should include in the "detail" attribute more information about the source of the problem. --- If the request contains a malformed access token, the API producer should respond with this response. The details of the error shall be returned in the WWW-Authenticate HTTP header, as defined in IETF RFC 6750 and IETF RFC 7235. The ProblemDetails structure may be provided. --- If there is an application error related to the client's input that cannot be easily mapped to any other HTTP response code ("catch all error"), the API producer shall respond with this response code.The "ProblemDetails" structure shall be provided, and shall include in the "detail" attribute more information about the source of the problem.

Name Type Format Description
Content-Type String The MIME type of the body of the response.
WWW-Authenticate String Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.

Status: 401 - Unauthorized If the request contains no access token even though one is required, or if the request contains an authorization token that is invalid (e.g. expired or revoked), the API producer should respond with this response. The details of the error shall be returned in the WWW-Authenticate HTTP header, as defined in IETF RFC 6750 and IETF RFC 7235. The ProblemDetails structure may be provided.

Name Type Format Description
Content-Type String The MIME type of the body of the response.
WWW-Authenticate String Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.

Status: 403 - Forbidden If the API consumer is not allowed to perform a particular request to a particular resource, the API producer shall respond with this response code. The "ProblemDetails" structure shall be provided. It should include in the "detail" attribute information about the source of the problem, and may indicate how to solve it.

Name Type Format Description
Content-Type String The MIME type of the body of the response.

Status: 404 - Not Found If the API producer did not find a current representation for the resource addressed by the URI passed in the request, or is not willing to disclose that one exists, it shall respond with this response code. The "ProblemDetails" structure may be provided, including in the "detail" attribute information about the source of the problem, e.g. a wrong resource URI variable.

Name Type Format Description
Content-Type String The MIME type of the body of the response.

Status: 405 - Not Found If the API producer did not find a current representation for the resource addressed by the URI passed in the request, or is not willing to disclose that one exists, it shall respond with this response code. The "ProblemDetails" structure may be provided, including in the "detail" attribute information about the source of the problem, e.g. a wrong resource URI variable.

Name Type Format Description
Content-Type String The MIME type of the body of the response.

Status: 406 - Not Acceptable If the "Accept" HTTP header does not contain at least one name of a content type that is acceptable to the API producer, the API producer shall respond with this response code. The "ProblemDetails" structure may be omitted in that case.

Name Type Format Description
Content-Type String The MIME type of the body of the response.

Status: 409 - Conflict Another request is in progress that prohibits the fulfilment of the current request, or the current resource state is inconsistent with the request.

Name Type Format Description
Content-Type String The MIME type of the body of the response.
WWW-Authenticate String Challenge if the corresponding HTTP request has not provided authorization, or error details if the corresponding HTTP request has provided an invalid authorization token.

Status: 500 - Internal Server Error If there is an application error not related to the client's input that cannot be easily mapped to any other HTTP response code ("catch all error"), the API producer shall respond withthis response code. The "ProblemDetails" structure shall be provided, and shall include in the "detail" attribute more information about the source of the problem.

Name Type Format Description
Content-Type String The MIME type of the body of the response.

Status: 503 - Service Unavailable If the API producer encounters an internal overload situation of itself or of a system it relies on, it should respond with this response code, following the provisions in IETF RFC 7231 [13] for the use of the "Retry-After" HTTP header and for the alternative to refuse the connection. The "ProblemDetails" structure may be omitted.

Name Type Format Description
Content-Type String The MIME type of the body of the response.