ONAP CCSDK - A1 Policy Management API

A1PolicyManagement

createPolicy

Create an A1 Policy Instance (createPolicy)

Create an A1 Policy Instance


/policies

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json,application/problem+json" \
 -H "Content-Type: application/json" \
 "https://example.com/a1-policy-management/v1/policies" \
 -d '{
  "policyId" : "POLICY-ID1",
  "nearRtRicId" : "Near-RT-Ric-ID1",
  "transient" : false,
  "policyObject" : "{}",
  "serviceId" : "rApp 1",
  "policyTypeId" : "ORAN_QOS_1.0.0 '(typeName_SemVersion)'"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.A1PolicyManagementApi;

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

public class A1PolicyManagementApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        A1PolicyManagementApi apiInstance = new A1PolicyManagementApi();
        PolicyObjectInformation policyObjectInformation = ; // PolicyObjectInformation | 

        try {
            PolicyObjectInformation result = apiInstance.createPolicy(policyObjectInformation);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling A1PolicyManagementApi#createPolicy");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final PolicyObjectInformation policyObjectInformation = new PolicyObjectInformation(); // PolicyObjectInformation | 

try {
    final result = await api_instance.createPolicy(policyObjectInformation);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->createPolicy: $e\n');
}

import org.openapitools.client.api.A1PolicyManagementApi;

public class A1PolicyManagementApiExample {
    public static void main(String[] args) {
        A1PolicyManagementApi apiInstance = new A1PolicyManagementApi();
        PolicyObjectInformation policyObjectInformation = ; // PolicyObjectInformation | 

        try {
            PolicyObjectInformation result = apiInstance.createPolicy(policyObjectInformation);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling A1PolicyManagementApi#createPolicy");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
A1PolicyManagementApi *apiInstance = [[A1PolicyManagementApi alloc] init];
PolicyObjectInformation *policyObjectInformation = ; // 

// Create an A1 Policy Instance (createPolicy)
[apiInstance createPolicyWith:policyObjectInformation
              completionHandler: ^(PolicyObjectInformation output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OnapCcsdkA1PolicyManagementApi = require('onap_ccsdk_a1_policy_management_api');

// Create an instance of the API class
var api = new OnapCcsdkA1PolicyManagementApi.A1PolicyManagementApi()
var policyObjectInformation = ; // {PolicyObjectInformation} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createPolicy(policyObjectInformation, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class createPolicyExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new A1PolicyManagementApi();
            var policyObjectInformation = new PolicyObjectInformation(); // PolicyObjectInformation | 

            try {
                // Create an A1 Policy Instance (createPolicy)
                PolicyObjectInformation result = apiInstance.createPolicy(policyObjectInformation);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling A1PolicyManagementApi.createPolicy: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\A1PolicyManagementApi();
$policyObjectInformation = ; // PolicyObjectInformation | 

try {
    $result = $api_instance->createPolicy($policyObjectInformation);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling A1PolicyManagementApi->createPolicy: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::A1PolicyManagementApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::A1PolicyManagementApi->new();
my $policyObjectInformation = WWW::OPenAPIClient::Object::PolicyObjectInformation->new(); # PolicyObjectInformation | 

eval {
    my $result = $api_instance->createPolicy(policyObjectInformation => $policyObjectInformation);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling A1PolicyManagementApi->createPolicy: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.A1PolicyManagementApi()
policyObjectInformation =  # PolicyObjectInformation | 

try:
    # Create an A1 Policy Instance (createPolicy)
    api_response = api_instance.create_policy(policyObjectInformation)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling A1PolicyManagementApi->createPolicy: %s\n" % e)
extern crate A1PolicyManagementApi;

pub fn main() {
    let policyObjectInformation = ; // PolicyObjectInformation

    let mut context = A1PolicyManagementApi::Context::default();
    let result = client.createPolicy(policyObjectInformation, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
policyObjectInformation *

Responses

Name Type Format Description
Location String Contains the URI of the newly created A1 Policy Instances. This URI includes the A1 Policy Instance ID for the newly created policy instance.
Content-Type String Media Type of the response


deletePolicy

Delete an A1 Policy instance (deletePolicy)

Delete an existing A1 Policy instance using its policy ID.


/policies/{policyId}

Usage and SDK Samples

curl -X DELETE \
 -H "Accept: application/problem+json" \
 "https://example.com/a1-policy-management/v1/policies/{policyId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.A1PolicyManagementApi;

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

public class A1PolicyManagementApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        A1PolicyManagementApi apiInstance = new A1PolicyManagementApi();
        String policyId = policyId_example; // String | 
        String accept = application/json; // String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.

        try {
            apiInstance.deletePolicy(policyId, accept);
        } catch (ApiException e) {
            System.err.println("Exception when calling A1PolicyManagementApi#deletePolicy");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String policyId = new String(); // String | 
final String accept = new String(); // String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.

try {
    final result = await api_instance.deletePolicy(policyId, accept);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->deletePolicy: $e\n');
}

import org.openapitools.client.api.A1PolicyManagementApi;

public class A1PolicyManagementApiExample {
    public static void main(String[] args) {
        A1PolicyManagementApi apiInstance = new A1PolicyManagementApi();
        String policyId = policyId_example; // String | 
        String accept = application/json; // String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.

        try {
            apiInstance.deletePolicy(policyId, accept);
        } catch (ApiException e) {
            System.err.println("Exception when calling A1PolicyManagementApi#deletePolicy");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
A1PolicyManagementApi *apiInstance = [[A1PolicyManagementApi alloc] init];
String *policyId = policyId_example; //  (default to null)
String *accept = application/json; // Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed. (optional) (default to null)

// Delete an A1 Policy instance (deletePolicy)
[apiInstance deletePolicyWith:policyId
    accept:accept
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OnapCcsdkA1PolicyManagementApi = require('onap_ccsdk_a1_policy_management_api');

// Create an instance of the API class
var api = new OnapCcsdkA1PolicyManagementApi.A1PolicyManagementApi()
var policyId = policyId_example; // {String} 
var opts = {
  'accept': application/json // {String} Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deletePolicy(policyId, opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class deletePolicyExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new A1PolicyManagementApi();
            var policyId = policyId_example;  // String |  (default to null)
            var accept = application/json;  // String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed. (optional)  (default to null)

            try {
                // Delete an A1 Policy instance (deletePolicy)
                apiInstance.deletePolicy(policyId, accept);
            } catch (Exception e) {
                Debug.Print("Exception when calling A1PolicyManagementApi.deletePolicy: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\A1PolicyManagementApi();
$policyId = policyId_example; // String | 
$accept = application/json; // String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.

try {
    $api_instance->deletePolicy($policyId, $accept);
} catch (Exception $e) {
    echo 'Exception when calling A1PolicyManagementApi->deletePolicy: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::A1PolicyManagementApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::A1PolicyManagementApi->new();
my $policyId = policyId_example; # String | 
my $accept = application/json; # String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.

eval {
    $api_instance->deletePolicy(policyId => $policyId, accept => $accept);
};
if ($@) {
    warn "Exception when calling A1PolicyManagementApi->deletePolicy: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.A1PolicyManagementApi()
policyId = policyId_example # String |  (default to null)
accept = application/json # String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed. (optional) (default to null)

try:
    # Delete an A1 Policy instance (deletePolicy)
    api_instance.delete_policy(policyId, accept=accept)
except ApiException as e:
    print("Exception when calling A1PolicyManagementApi->deletePolicy: %s\n" % e)
extern crate A1PolicyManagementApi;

pub fn main() {
    let policyId = policyId_example; // String
    let accept = application/json; // String

    let mut context = A1PolicyManagementApi::Context::default();
    let result = client.deletePolicy(policyId, accept, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
policyId*
String
Required
Header parameters
Name Description
Accept
String
Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.

Responses


getPolicy

Get an A1 Policy's policy data (getPolicy)

Get an A1 Policy instance's policy data using its policy ID


/policies/{policyId}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json,application/problem+json" \
 "https://example.com/a1-policy-management/v1/policies/{policyId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.A1PolicyManagementApi;

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

public class A1PolicyManagementApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        A1PolicyManagementApi apiInstance = new A1PolicyManagementApi();
        String policyId = policyId_example; // String | 
        String accept = application/json; // String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.

        try {
            Object result = apiInstance.getPolicy(policyId, accept);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling A1PolicyManagementApi#getPolicy");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String policyId = new String(); // String | 
final String accept = new String(); // String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.

try {
    final result = await api_instance.getPolicy(policyId, accept);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getPolicy: $e\n');
}

import org.openapitools.client.api.A1PolicyManagementApi;

public class A1PolicyManagementApiExample {
    public static void main(String[] args) {
        A1PolicyManagementApi apiInstance = new A1PolicyManagementApi();
        String policyId = policyId_example; // String | 
        String accept = application/json; // String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.

        try {
            Object result = apiInstance.getPolicy(policyId, accept);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling A1PolicyManagementApi#getPolicy");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
A1PolicyManagementApi *apiInstance = [[A1PolicyManagementApi alloc] init];
String *policyId = policyId_example; //  (default to null)
String *accept = application/json; // Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed. (optional) (default to null)

// Get an A1 Policy's policy data (getPolicy)
[apiInstance getPolicyWith:policyId
    accept:accept
              completionHandler: ^(Object output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OnapCcsdkA1PolicyManagementApi = require('onap_ccsdk_a1_policy_management_api');

// Create an instance of the API class
var api = new OnapCcsdkA1PolicyManagementApi.A1PolicyManagementApi()
var policyId = policyId_example; // {String} 
var opts = {
  'accept': application/json // {String} Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.
};

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

namespace Example
{
    public class getPolicyExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new A1PolicyManagementApi();
            var policyId = policyId_example;  // String |  (default to null)
            var accept = application/json;  // String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed. (optional)  (default to null)

            try {
                // Get an A1 Policy's policy data (getPolicy)
                Object result = apiInstance.getPolicy(policyId, accept);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling A1PolicyManagementApi.getPolicy: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\A1PolicyManagementApi();
$policyId = policyId_example; // String | 
$accept = application/json; // String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.

try {
    $result = $api_instance->getPolicy($policyId, $accept);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling A1PolicyManagementApi->getPolicy: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::A1PolicyManagementApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::A1PolicyManagementApi->new();
my $policyId = policyId_example; # String | 
my $accept = application/json; # String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.

eval {
    my $result = $api_instance->getPolicy(policyId => $policyId, accept => $accept);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling A1PolicyManagementApi->getPolicy: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.A1PolicyManagementApi()
policyId = policyId_example # String |  (default to null)
accept = application/json # String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed. (optional) (default to null)

try:
    # Get an A1 Policy's policy data (getPolicy)
    api_response = api_instance.get_policy(policyId, accept=accept)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling A1PolicyManagementApi->getPolicy: %s\n" % e)
extern crate A1PolicyManagementApi;

pub fn main() {
    let policyId = policyId_example; // String
    let accept = application/json; // String

    let mut context = A1PolicyManagementApi::Context::default();
    let result = client.getPolicy(policyId, accept, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
policyId*
String
Required
Header parameters
Name Description
Accept
String
Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.

Responses


getPolicyIds

Query for A1 Policy instances (getPolicyIds)

Returns a collection of A1 Policy Instance IDs for policies that match given search criteria. If several query parameters are defined, the policies matching all conditions are returned.


/policies

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json,application/problem+json" \
 "https://example.com/a1-policy-management/v1/policies?policyTypeId=policyTypeId_example&nearRtRicId=nearRtRicId_example&serviceId=serviceId_example&typeName=typeName_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.A1PolicyManagementApi;

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

public class A1PolicyManagementApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        A1PolicyManagementApi apiInstance = new A1PolicyManagementApi();
        String policyTypeId = policyTypeId_example; // String | Select policies with a given A1 Policy Type ID.
        String nearRtRicId = nearRtRicId_example; // String | Select policies for a given Near-RT RIC identity.
        String serviceId = serviceId_example; // String | Select policies owned by a given service (registered or unregistered).
        String typeName = typeName_example; // String | Select policies of a given A1 Policy Type name (type identity has the format 'typename_version').
        String accept = application/json; // String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.

        try {
            array[PolicyInformation] result = apiInstance.getPolicyIds(policyTypeId, nearRtRicId, serviceId, typeName, accept);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling A1PolicyManagementApi#getPolicyIds");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String policyTypeId = new String(); // String | Select policies with a given A1 Policy Type ID.
final String nearRtRicId = new String(); // String | Select policies for a given Near-RT RIC identity.
final String serviceId = new String(); // String | Select policies owned by a given service (registered or unregistered).
final String typeName = new String(); // String | Select policies of a given A1 Policy Type name (type identity has the format 'typename_version').
final String accept = new String(); // String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.

try {
    final result = await api_instance.getPolicyIds(policyTypeId, nearRtRicId, serviceId, typeName, accept);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getPolicyIds: $e\n');
}

import org.openapitools.client.api.A1PolicyManagementApi;

public class A1PolicyManagementApiExample {
    public static void main(String[] args) {
        A1PolicyManagementApi apiInstance = new A1PolicyManagementApi();
        String policyTypeId = policyTypeId_example; // String | Select policies with a given A1 Policy Type ID.
        String nearRtRicId = nearRtRicId_example; // String | Select policies for a given Near-RT RIC identity.
        String serviceId = serviceId_example; // String | Select policies owned by a given service (registered or unregistered).
        String typeName = typeName_example; // String | Select policies of a given A1 Policy Type name (type identity has the format 'typename_version').
        String accept = application/json; // String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.

        try {
            array[PolicyInformation] result = apiInstance.getPolicyIds(policyTypeId, nearRtRicId, serviceId, typeName, accept);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling A1PolicyManagementApi#getPolicyIds");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
A1PolicyManagementApi *apiInstance = [[A1PolicyManagementApi alloc] init];
String *policyTypeId = policyTypeId_example; // Select policies with a given A1 Policy Type ID. (optional) (default to null)
String *nearRtRicId = nearRtRicId_example; // Select policies for a given Near-RT RIC identity. (optional) (default to null)
String *serviceId = serviceId_example; // Select policies owned by a given service (registered or unregistered). (optional) (default to null)
String *typeName = typeName_example; // Select policies of a given A1 Policy Type name (type identity has the format 'typename_version'). (optional) (default to null)
String *accept = application/json; // Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed. (optional) (default to null)

// Query for A1 Policy instances (getPolicyIds)
[apiInstance getPolicyIdsWith:policyTypeId
    nearRtRicId:nearRtRicId
    serviceId:serviceId
    typeName:typeName
    accept:accept
              completionHandler: ^(array[PolicyInformation] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OnapCcsdkA1PolicyManagementApi = require('onap_ccsdk_a1_policy_management_api');

// Create an instance of the API class
var api = new OnapCcsdkA1PolicyManagementApi.A1PolicyManagementApi()
var opts = {
  'policyTypeId': policyTypeId_example, // {String} Select policies with a given A1 Policy Type ID.
  'nearRtRicId': nearRtRicId_example, // {String} Select policies for a given Near-RT RIC identity.
  'serviceId': serviceId_example, // {String} Select policies owned by a given service (registered or unregistered).
  'typeName': typeName_example, // {String} Select policies of a given A1 Policy Type name (type identity has the format 'typename_version').
  'accept': application/json // {String} Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.
};

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

namespace Example
{
    public class getPolicyIdsExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new A1PolicyManagementApi();
            var policyTypeId = policyTypeId_example;  // String | Select policies with a given A1 Policy Type ID. (optional)  (default to null)
            var nearRtRicId = nearRtRicId_example;  // String | Select policies for a given Near-RT RIC identity. (optional)  (default to null)
            var serviceId = serviceId_example;  // String | Select policies owned by a given service (registered or unregistered). (optional)  (default to null)
            var typeName = typeName_example;  // String | Select policies of a given A1 Policy Type name (type identity has the format 'typename_version'). (optional)  (default to null)
            var accept = application/json;  // String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed. (optional)  (default to null)

            try {
                // Query for A1 Policy instances (getPolicyIds)
                array[PolicyInformation] result = apiInstance.getPolicyIds(policyTypeId, nearRtRicId, serviceId, typeName, accept);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling A1PolicyManagementApi.getPolicyIds: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\A1PolicyManagementApi();
$policyTypeId = policyTypeId_example; // String | Select policies with a given A1 Policy Type ID.
$nearRtRicId = nearRtRicId_example; // String | Select policies for a given Near-RT RIC identity.
$serviceId = serviceId_example; // String | Select policies owned by a given service (registered or unregistered).
$typeName = typeName_example; // String | Select policies of a given A1 Policy Type name (type identity has the format 'typename_version').
$accept = application/json; // String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.

try {
    $result = $api_instance->getPolicyIds($policyTypeId, $nearRtRicId, $serviceId, $typeName, $accept);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling A1PolicyManagementApi->getPolicyIds: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::A1PolicyManagementApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::A1PolicyManagementApi->new();
my $policyTypeId = policyTypeId_example; # String | Select policies with a given A1 Policy Type ID.
my $nearRtRicId = nearRtRicId_example; # String | Select policies for a given Near-RT RIC identity.
my $serviceId = serviceId_example; # String | Select policies owned by a given service (registered or unregistered).
my $typeName = typeName_example; # String | Select policies of a given A1 Policy Type name (type identity has the format 'typename_version').
my $accept = application/json; # String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.

eval {
    my $result = $api_instance->getPolicyIds(policyTypeId => $policyTypeId, nearRtRicId => $nearRtRicId, serviceId => $serviceId, typeName => $typeName, accept => $accept);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling A1PolicyManagementApi->getPolicyIds: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.A1PolicyManagementApi()
policyTypeId = policyTypeId_example # String | Select policies with a given A1 Policy Type ID. (optional) (default to null)
nearRtRicId = nearRtRicId_example # String | Select policies for a given Near-RT RIC identity. (optional) (default to null)
serviceId = serviceId_example # String | Select policies owned by a given service (registered or unregistered). (optional) (default to null)
typeName = typeName_example # String | Select policies of a given A1 Policy Type name (type identity has the format 'typename_version'). (optional) (default to null)
accept = application/json # String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed. (optional) (default to null)

try:
    # Query for A1 Policy instances (getPolicyIds)
    api_response = api_instance.get_policy_ids(policyTypeId=policyTypeId, nearRtRicId=nearRtRicId, serviceId=serviceId, typeName=typeName, accept=accept)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling A1PolicyManagementApi->getPolicyIds: %s\n" % e)
extern crate A1PolicyManagementApi;

pub fn main() {
    let policyTypeId = policyTypeId_example; // String
    let nearRtRicId = nearRtRicId_example; // String
    let serviceId = serviceId_example; // String
    let typeName = typeName_example; // String
    let accept = application/json; // String

    let mut context = A1PolicyManagementApi::Context::default();
    let result = client.getPolicyIds(policyTypeId, nearRtRicId, serviceId, typeName, accept, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Header parameters
Name Description
Accept
String
Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.
Query parameters
Name Description
policyTypeId
String
Select policies with a given A1 Policy Type ID.
nearRtRicId
String
Select policies for a given Near-RT RIC identity.
serviceId
String
Select policies owned by a given service (registered or unregistered).
typeName
String
Select policies of a given A1 Policy Type name (type identity has the format 'typename_version').

Responses


getPolicyStatus

Get an A1 Policy Instance's status (getPolicyStatus)

Retrieve the status information for an A1 Policy Instance using its policy ID.


/policies/{policyId}/status

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json,application/problem+json" \
 "https://example.com/a1-policy-management/v1/policies/{policyId}/status"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.A1PolicyManagementApi;

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

public class A1PolicyManagementApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        A1PolicyManagementApi apiInstance = new A1PolicyManagementApi();
        String policyId = policyId_example; // String | 
        String accept = application/json; // String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.

        try {
            Object result = apiInstance.getPolicyStatus(policyId, accept);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling A1PolicyManagementApi#getPolicyStatus");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String policyId = new String(); // String | 
final String accept = new String(); // String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.

try {
    final result = await api_instance.getPolicyStatus(policyId, accept);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getPolicyStatus: $e\n');
}

import org.openapitools.client.api.A1PolicyManagementApi;

public class A1PolicyManagementApiExample {
    public static void main(String[] args) {
        A1PolicyManagementApi apiInstance = new A1PolicyManagementApi();
        String policyId = policyId_example; // String | 
        String accept = application/json; // String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.

        try {
            Object result = apiInstance.getPolicyStatus(policyId, accept);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling A1PolicyManagementApi#getPolicyStatus");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
A1PolicyManagementApi *apiInstance = [[A1PolicyManagementApi alloc] init];
String *policyId = policyId_example; //  (default to null)
String *accept = application/json; // Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed. (optional) (default to null)

// Get an A1 Policy Instance's status (getPolicyStatus)
[apiInstance getPolicyStatusWith:policyId
    accept:accept
              completionHandler: ^(Object output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OnapCcsdkA1PolicyManagementApi = require('onap_ccsdk_a1_policy_management_api');

// Create an instance of the API class
var api = new OnapCcsdkA1PolicyManagementApi.A1PolicyManagementApi()
var policyId = policyId_example; // {String} 
var opts = {
  'accept': application/json // {String} Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.
};

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

namespace Example
{
    public class getPolicyStatusExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new A1PolicyManagementApi();
            var policyId = policyId_example;  // String |  (default to null)
            var accept = application/json;  // String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed. (optional)  (default to null)

            try {
                // Get an A1 Policy Instance's status (getPolicyStatus)
                Object result = apiInstance.getPolicyStatus(policyId, accept);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling A1PolicyManagementApi.getPolicyStatus: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\A1PolicyManagementApi();
$policyId = policyId_example; // String | 
$accept = application/json; // String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.

try {
    $result = $api_instance->getPolicyStatus($policyId, $accept);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling A1PolicyManagementApi->getPolicyStatus: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::A1PolicyManagementApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::A1PolicyManagementApi->new();
my $policyId = policyId_example; # String | 
my $accept = application/json; # String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.

eval {
    my $result = $api_instance->getPolicyStatus(policyId => $policyId, accept => $accept);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling A1PolicyManagementApi->getPolicyStatus: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.A1PolicyManagementApi()
policyId = policyId_example # String |  (default to null)
accept = application/json # String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed. (optional) (default to null)

try:
    # Get an A1 Policy Instance's status (getPolicyStatus)
    api_response = api_instance.get_policy_status(policyId, accept=accept)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling A1PolicyManagementApi->getPolicyStatus: %s\n" % e)
extern crate A1PolicyManagementApi;

pub fn main() {
    let policyId = policyId_example; // String
    let accept = application/json; // String

    let mut context = A1PolicyManagementApi::Context::default();
    let result = client.getPolicyStatus(policyId, accept, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
policyId*
String
Required
Header parameters
Name Description
Accept
String
Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.

Responses


getPolicyTypeDefinition

Get an A1 Policy Type definition (getPolicyTypeDefinition)

Get an A1 Policy Type definition using its policy type ID


/policy-types/{policyTypeId}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json,application/problem+json" \
 "https://example.com/a1-policy-management/v1/policy-types/{policyTypeId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.A1PolicyManagementApi;

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

public class A1PolicyManagementApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        A1PolicyManagementApi apiInstance = new A1PolicyManagementApi();
        String policyTypeId = policyTypeId_example; // String | 
        String accept = application/json; // String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.

        try {
            PolicyTypeObject result = apiInstance.getPolicyTypeDefinition(policyTypeId, accept);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling A1PolicyManagementApi#getPolicyTypeDefinition");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String policyTypeId = new String(); // String | 
final String accept = new String(); // String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.

try {
    final result = await api_instance.getPolicyTypeDefinition(policyTypeId, accept);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getPolicyTypeDefinition: $e\n');
}

import org.openapitools.client.api.A1PolicyManagementApi;

public class A1PolicyManagementApiExample {
    public static void main(String[] args) {
        A1PolicyManagementApi apiInstance = new A1PolicyManagementApi();
        String policyTypeId = policyTypeId_example; // String | 
        String accept = application/json; // String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.

        try {
            PolicyTypeObject result = apiInstance.getPolicyTypeDefinition(policyTypeId, accept);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling A1PolicyManagementApi#getPolicyTypeDefinition");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
A1PolicyManagementApi *apiInstance = [[A1PolicyManagementApi alloc] init];
String *policyTypeId = policyTypeId_example; //  (default to null)
String *accept = application/json; // Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed. (optional) (default to null)

// Get an A1 Policy Type definition (getPolicyTypeDefinition)
[apiInstance getPolicyTypeDefinitionWith:policyTypeId
    accept:accept
              completionHandler: ^(PolicyTypeObject output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OnapCcsdkA1PolicyManagementApi = require('onap_ccsdk_a1_policy_management_api');

// Create an instance of the API class
var api = new OnapCcsdkA1PolicyManagementApi.A1PolicyManagementApi()
var policyTypeId = policyTypeId_example; // {String} 
var opts = {
  'accept': application/json // {String} Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.
};

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

namespace Example
{
    public class getPolicyTypeDefinitionExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new A1PolicyManagementApi();
            var policyTypeId = policyTypeId_example;  // String |  (default to null)
            var accept = application/json;  // String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed. (optional)  (default to null)

            try {
                // Get an A1 Policy Type definition (getPolicyTypeDefinition)
                PolicyTypeObject result = apiInstance.getPolicyTypeDefinition(policyTypeId, accept);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling A1PolicyManagementApi.getPolicyTypeDefinition: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\A1PolicyManagementApi();
$policyTypeId = policyTypeId_example; // String | 
$accept = application/json; // String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.

try {
    $result = $api_instance->getPolicyTypeDefinition($policyTypeId, $accept);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling A1PolicyManagementApi->getPolicyTypeDefinition: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::A1PolicyManagementApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::A1PolicyManagementApi->new();
my $policyTypeId = policyTypeId_example; # String | 
my $accept = application/json; # String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.

eval {
    my $result = $api_instance->getPolicyTypeDefinition(policyTypeId => $policyTypeId, accept => $accept);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling A1PolicyManagementApi->getPolicyTypeDefinition: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.A1PolicyManagementApi()
policyTypeId = policyTypeId_example # String |  (default to null)
accept = application/json # String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed. (optional) (default to null)

try:
    # Get an A1 Policy Type definition (getPolicyTypeDefinition)
    api_response = api_instance.get_policy_type_definition(policyTypeId, accept=accept)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling A1PolicyManagementApi->getPolicyTypeDefinition: %s\n" % e)
extern crate A1PolicyManagementApi;

pub fn main() {
    let policyTypeId = policyTypeId_example; // String
    let accept = application/json; // String

    let mut context = A1PolicyManagementApi::Context::default();
    let result = client.getPolicyTypeDefinition(policyTypeId, accept, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
policyTypeId*
String
Required
Header parameters
Name Description
Accept
String
Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.

Responses


getPolicyTypes

Get A1 Policy Types (getPolicyTypes)

Query A1 Policy Type identities using query parameters


/policy-types

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json,application/problem+json" \
 "https://example.com/a1-policy-management/v1/policy-types?nearRtRicId=nearRtRicId_example&typeName=typeName_example&compatibleWithVersion=compatibleWithVersion_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.A1PolicyManagementApi;

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

public class A1PolicyManagementApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        A1PolicyManagementApi apiInstance = new A1PolicyManagementApi();
        String nearRtRicId = nearRtRicId_example; // String | Select types for the given Near-RT RIC identity.
        String typeName = typeName_example; // String | Select types compatible with the given type name (type identity has the format 'typename_version')
        String compatibleWithVersion = compatibleWithVersion_example; // String | Select types that are compatible with the given version. This parameter is only applicable in conjunction with typeName. As an example version 1.9.1 is compatible with 1.0.0 but not the other way around. Matching types will be returned sorted in ascending order.

        String accept = application/json; // String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.

        try {
            array[PolicyTypeInformation] result = apiInstance.getPolicyTypes(nearRtRicId, typeName, compatibleWithVersion, accept);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling A1PolicyManagementApi#getPolicyTypes");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String nearRtRicId = new String(); // String | Select types for the given Near-RT RIC identity.
final String typeName = new String(); // String | Select types compatible with the given type name (type identity has the format 'typename_version')
final String compatibleWithVersion = new String(); // String | Select types that are compatible with the given version. This parameter is only applicable in conjunction with typeName. As an example version 1.9.1 is compatible with 1.0.0 but not the other way around. Matching types will be returned sorted in ascending order.

final String accept = new String(); // String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.

try {
    final result = await api_instance.getPolicyTypes(nearRtRicId, typeName, compatibleWithVersion, accept);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getPolicyTypes: $e\n');
}

import org.openapitools.client.api.A1PolicyManagementApi;

public class A1PolicyManagementApiExample {
    public static void main(String[] args) {
        A1PolicyManagementApi apiInstance = new A1PolicyManagementApi();
        String nearRtRicId = nearRtRicId_example; // String | Select types for the given Near-RT RIC identity.
        String typeName = typeName_example; // String | Select types compatible with the given type name (type identity has the format 'typename_version')
        String compatibleWithVersion = compatibleWithVersion_example; // String | Select types that are compatible with the given version. This parameter is only applicable in conjunction with typeName. As an example version 1.9.1 is compatible with 1.0.0 but not the other way around. Matching types will be returned sorted in ascending order.

        String accept = application/json; // String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.

        try {
            array[PolicyTypeInformation] result = apiInstance.getPolicyTypes(nearRtRicId, typeName, compatibleWithVersion, accept);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling A1PolicyManagementApi#getPolicyTypes");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
A1PolicyManagementApi *apiInstance = [[A1PolicyManagementApi alloc] init];
String *nearRtRicId = nearRtRicId_example; // Select types for the given Near-RT RIC identity. (optional) (default to null)
String *typeName = typeName_example; // Select types compatible with the given type name (type identity has the format 'typename_version') (optional) (default to null)
String *compatibleWithVersion = compatibleWithVersion_example; // Select types that are compatible with the given version. This parameter is only applicable in conjunction with typeName. As an example version 1.9.1 is compatible with 1.0.0 but not the other way around. Matching types will be returned sorted in ascending order.
 (optional) (default to null)
String *accept = application/json; // Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed. (optional) (default to null)

// Get A1 Policy Types (getPolicyTypes)
[apiInstance getPolicyTypesWith:nearRtRicId
    typeName:typeName
    compatibleWithVersion:compatibleWithVersion
    accept:accept
              completionHandler: ^(array[PolicyTypeInformation] output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OnapCcsdkA1PolicyManagementApi = require('onap_ccsdk_a1_policy_management_api');

// Create an instance of the API class
var api = new OnapCcsdkA1PolicyManagementApi.A1PolicyManagementApi()
var opts = {
  'nearRtRicId': nearRtRicId_example, // {String} Select types for the given Near-RT RIC identity.
  'typeName': typeName_example, // {String} Select types compatible with the given type name (type identity has the format 'typename_version')
  'compatibleWithVersion': compatibleWithVersion_example, // {String} Select types that are compatible with the given version. This parameter is only applicable in conjunction with typeName. As an example version 1.9.1 is compatible with 1.0.0 but not the other way around. Matching types will be returned sorted in ascending order.

  'accept': application/json // {String} Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.
};

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

namespace Example
{
    public class getPolicyTypesExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new A1PolicyManagementApi();
            var nearRtRicId = nearRtRicId_example;  // String | Select types for the given Near-RT RIC identity. (optional)  (default to null)
            var typeName = typeName_example;  // String | Select types compatible with the given type name (type identity has the format 'typename_version') (optional)  (default to null)
            var compatibleWithVersion = compatibleWithVersion_example;  // String | Select types that are compatible with the given version. This parameter is only applicable in conjunction with typeName. As an example version 1.9.1 is compatible with 1.0.0 but not the other way around. Matching types will be returned sorted in ascending order.
 (optional)  (default to null)
            var accept = application/json;  // String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed. (optional)  (default to null)

            try {
                // Get A1 Policy Types (getPolicyTypes)
                array[PolicyTypeInformation] result = apiInstance.getPolicyTypes(nearRtRicId, typeName, compatibleWithVersion, accept);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling A1PolicyManagementApi.getPolicyTypes: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\A1PolicyManagementApi();
$nearRtRicId = nearRtRicId_example; // String | Select types for the given Near-RT RIC identity.
$typeName = typeName_example; // String | Select types compatible with the given type name (type identity has the format 'typename_version')
$compatibleWithVersion = compatibleWithVersion_example; // String | Select types that are compatible with the given version. This parameter is only applicable in conjunction with typeName. As an example version 1.9.1 is compatible with 1.0.0 but not the other way around. Matching types will be returned sorted in ascending order.

$accept = application/json; // String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.

try {
    $result = $api_instance->getPolicyTypes($nearRtRicId, $typeName, $compatibleWithVersion, $accept);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling A1PolicyManagementApi->getPolicyTypes: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::A1PolicyManagementApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::A1PolicyManagementApi->new();
my $nearRtRicId = nearRtRicId_example; # String | Select types for the given Near-RT RIC identity.
my $typeName = typeName_example; # String | Select types compatible with the given type name (type identity has the format 'typename_version')
my $compatibleWithVersion = compatibleWithVersion_example; # String | Select types that are compatible with the given version. This parameter is only applicable in conjunction with typeName. As an example version 1.9.1 is compatible with 1.0.0 but not the other way around. Matching types will be returned sorted in ascending order.

my $accept = application/json; # String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.

eval {
    my $result = $api_instance->getPolicyTypes(nearRtRicId => $nearRtRicId, typeName => $typeName, compatibleWithVersion => $compatibleWithVersion, accept => $accept);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling A1PolicyManagementApi->getPolicyTypes: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.A1PolicyManagementApi()
nearRtRicId = nearRtRicId_example # String | Select types for the given Near-RT RIC identity. (optional) (default to null)
typeName = typeName_example # String | Select types compatible with the given type name (type identity has the format 'typename_version') (optional) (default to null)
compatibleWithVersion = compatibleWithVersion_example # String | Select types that are compatible with the given version. This parameter is only applicable in conjunction with typeName. As an example version 1.9.1 is compatible with 1.0.0 but not the other way around. Matching types will be returned sorted in ascending order.
 (optional) (default to null)
accept = application/json # String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed. (optional) (default to null)

try:
    # Get A1 Policy Types (getPolicyTypes)
    api_response = api_instance.get_policy_types(nearRtRicId=nearRtRicId, typeName=typeName, compatibleWithVersion=compatibleWithVersion, accept=accept)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling A1PolicyManagementApi->getPolicyTypes: %s\n" % e)
extern crate A1PolicyManagementApi;

pub fn main() {
    let nearRtRicId = nearRtRicId_example; // String
    let typeName = typeName_example; // String
    let compatibleWithVersion = compatibleWithVersion_example; // String
    let accept = application/json; // String

    let mut context = A1PolicyManagementApi::Context::default();
    let result = client.getPolicyTypes(nearRtRicId, typeName, compatibleWithVersion, accept, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Header parameters
Name Description
Accept
String
Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.
Query parameters
Name Description
nearRtRicId
String
Select types for the given Near-RT RIC identity.
typeName
String
Select types compatible with the given type name (type identity has the format 'typename_version')
compatibleWithVersion
String
Select types that are compatible with the given version. This parameter is only applicable in conjunction with typeName. As an example version 1.9.1 is compatible with 1.0.0 but not the other way around. Matching types will be returned sorted in ascending order.

Responses


updatePolicy

Update an A1 Policy's policy data (updatePolicy)

Update an existing A1 Policy instance's policy data using its policy ID.


/policies/{policyId}

Usage and SDK Samples

curl -X PUT \
 -H "Accept: application/json,application/problem+json" \
 -H "Content-Type: application/json" \
 "https://example.com/a1-policy-management/v1/policies/{policyId}" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.A1PolicyManagementApi;

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

public class A1PolicyManagementApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        A1PolicyManagementApi apiInstance = new A1PolicyManagementApi();
        String policyId = policyId_example; // String | 
        Object body = Object; // Object | 

        try {
            Object result = apiInstance.updatePolicy(policyId, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling A1PolicyManagementApi#updatePolicy");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String policyId = new String(); // String | 
final Object body = new Object(); // Object | 

try {
    final result = await api_instance.updatePolicy(policyId, body);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->updatePolicy: $e\n');
}

import org.openapitools.client.api.A1PolicyManagementApi;

public class A1PolicyManagementApiExample {
    public static void main(String[] args) {
        A1PolicyManagementApi apiInstance = new A1PolicyManagementApi();
        String policyId = policyId_example; // String | 
        Object body = Object; // Object | 

        try {
            Object result = apiInstance.updatePolicy(policyId, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling A1PolicyManagementApi#updatePolicy");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
A1PolicyManagementApi *apiInstance = [[A1PolicyManagementApi alloc] init];
String *policyId = policyId_example; //  (default to null)
Object *body = Object; // 

// Update an A1 Policy's policy data (updatePolicy)
[apiInstance updatePolicyWith:policyId
    body:body
              completionHandler: ^(Object output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OnapCcsdkA1PolicyManagementApi = require('onap_ccsdk_a1_policy_management_api');

// Create an instance of the API class
var api = new OnapCcsdkA1PolicyManagementApi.A1PolicyManagementApi()
var policyId = policyId_example; // {String} 
var body = Object; // {Object} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updatePolicy(policyId, body, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class updatePolicyExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new A1PolicyManagementApi();
            var policyId = policyId_example;  // String |  (default to null)
            var body = Object;  // Object | 

            try {
                // Update an A1 Policy's policy data (updatePolicy)
                Object result = apiInstance.updatePolicy(policyId, body);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling A1PolicyManagementApi.updatePolicy: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\A1PolicyManagementApi();
$policyId = policyId_example; // String | 
$body = Object; // Object | 

try {
    $result = $api_instance->updatePolicy($policyId, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling A1PolicyManagementApi->updatePolicy: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::A1PolicyManagementApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::A1PolicyManagementApi->new();
my $policyId = policyId_example; # String | 
my $body = WWW::OPenAPIClient::Object::Object->new(); # Object | 

eval {
    my $result = $api_instance->updatePolicy(policyId => $policyId, body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling A1PolicyManagementApi->updatePolicy: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.A1PolicyManagementApi()
policyId = policyId_example # String |  (default to null)
body = Object # Object | 

try:
    # Update an A1 Policy's policy data (updatePolicy)
    api_response = api_instance.update_policy(policyId, body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling A1PolicyManagementApi->updatePolicy: %s\n" % e)
extern crate A1PolicyManagementApi;

pub fn main() {
    let policyId = policyId_example; // String
    let body = Object; // Object

    let mut context = A1PolicyManagementApi::Context::default();
    let result = client.updatePolicy(policyId, body, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
policyId*
String
Required
Body parameters
Name Description
body *

Responses


Configuration

getConfiguration

Get the Application Configuration (getConfiguration)

Returns the entire contents of the Application Configuration.


/configuration

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json,application/problem+json" \
 "https://example.com/a1-policy-management/v1/configuration"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ConfigurationApi;

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

public class ConfigurationApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ConfigurationApi apiInstance = new ConfigurationApi();

        try {
            'String' result = apiInstance.getConfiguration();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConfigurationApi#getConfiguration");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();


try {
    final result = await api_instance.getConfiguration();
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getConfiguration: $e\n');
}

import org.openapitools.client.api.ConfigurationApi;

public class ConfigurationApiExample {
    public static void main(String[] args) {
        ConfigurationApi apiInstance = new ConfigurationApi();

        try {
            'String' result = apiInstance.getConfiguration();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConfigurationApi#getConfiguration");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ConfigurationApi *apiInstance = [[ConfigurationApi alloc] init];

// Get the Application Configuration (getConfiguration)
[apiInstance getConfigurationWithCompletionHandler: 
              ^('String' output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OnapCcsdkA1PolicyManagementApi = require('onap_ccsdk_a1_policy_management_api');

// Create an instance of the API class
var api = new OnapCcsdkA1PolicyManagementApi.ConfigurationApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getConfiguration(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getConfigurationExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new ConfigurationApi();

            try {
                // Get the Application Configuration (getConfiguration)
                'String' result = apiInstance.getConfiguration();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ConfigurationApi.getConfiguration: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ConfigurationApi();

try {
    $result = $api_instance->getConfiguration();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConfigurationApi->getConfiguration: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ConfigurationApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ConfigurationApi->new();

eval {
    my $result = $api_instance->getConfiguration();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ConfigurationApi->getConfiguration: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.ConfigurationApi()

try:
    # Get the Application Configuration (getConfiguration)
    api_response = api_instance.get_configuration()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConfigurationApi->getConfiguration: %s\n" % e)
extern crate ConfigurationApi;

pub fn main() {

    let mut context = ConfigurationApi::Context::default();
    let result = client.getConfiguration(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


putConfiguration

Set/Replace the Application Configuration (putConfiguration)

Replace the current Application Configuration with a new configuration. The new configuration, if accepted, will take effect after a short delay. The new configuration must comply with the Application Configuration schema, which can be found from the the Application Documentation (Developer Guide)


/configuration

Usage and SDK Samples

curl -X PUT \
 -H "Accept: application/json,application/problem+json" \
 -H "Content-Type: application/json" \
 "https://example.com/a1-policy-management/v1/configuration" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ConfigurationApi;

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

public class ConfigurationApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ConfigurationApi apiInstance = new ConfigurationApi();
        Object body = Object; // Object | 

        try {
            Object result = apiInstance.putConfiguration(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConfigurationApi#putConfiguration");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final Object body = new Object(); // Object | 

try {
    final result = await api_instance.putConfiguration(body);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->putConfiguration: $e\n');
}

import org.openapitools.client.api.ConfigurationApi;

public class ConfigurationApiExample {
    public static void main(String[] args) {
        ConfigurationApi apiInstance = new ConfigurationApi();
        Object body = Object; // Object | 

        try {
            Object result = apiInstance.putConfiguration(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConfigurationApi#putConfiguration");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ConfigurationApi *apiInstance = [[ConfigurationApi alloc] init];
Object *body = Object; // 

// Set/Replace the Application Configuration (putConfiguration)
[apiInstance putConfigurationWith:body
              completionHandler: ^(Object output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OnapCcsdkA1PolicyManagementApi = require('onap_ccsdk_a1_policy_management_api');

// Create an instance of the API class
var api = new OnapCcsdkA1PolicyManagementApi.ConfigurationApi()
var body = Object; // {Object} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.putConfiguration(body, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class putConfigurationExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new ConfigurationApi();
            var body = Object;  // Object | 

            try {
                // Set/Replace the Application Configuration (putConfiguration)
                Object result = apiInstance.putConfiguration(body);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ConfigurationApi.putConfiguration: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ConfigurationApi();
$body = Object; // Object | 

try {
    $result = $api_instance->putConfiguration($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConfigurationApi->putConfiguration: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ConfigurationApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ConfigurationApi->new();
my $body = WWW::OPenAPIClient::Object::Object->new(); # Object | 

eval {
    my $result = $api_instance->putConfiguration(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ConfigurationApi->putConfiguration: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.ConfigurationApi()
body = Object # Object | 

try:
    # Set/Replace the Application Configuration (putConfiguration)
    api_response = api_instance.put_configuration(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ConfigurationApi->putConfiguration: %s\n" % e)
extern crate ConfigurationApi;

pub fn main() {
    let body = Object; // Object

    let mut context = ConfigurationApi::Context::default();
    let result = client.putConfiguration(body, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
body *

Responses


HealthCheck

getStatus

Get Status (getStatus)

Returns status and statistics of this service


/status

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json,application/problem+json" \
 "https://example.com/a1-policy-management/v1/status"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.HealthCheckApi;

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

public class HealthCheckApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        HealthCheckApi apiInstance = new HealthCheckApi();

        try {
            StatusInfo result = apiInstance.getStatus();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling HealthCheckApi#getStatus");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();


try {
    final result = await api_instance.getStatus();
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getStatus: $e\n');
}

import org.openapitools.client.api.HealthCheckApi;

public class HealthCheckApiExample {
    public static void main(String[] args) {
        HealthCheckApi apiInstance = new HealthCheckApi();

        try {
            StatusInfo result = apiInstance.getStatus();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling HealthCheckApi#getStatus");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
HealthCheckApi *apiInstance = [[HealthCheckApi alloc] init];

// Get Status (getStatus)
[apiInstance getStatusWithCompletionHandler: 
              ^(StatusInfo output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OnapCcsdkA1PolicyManagementApi = require('onap_ccsdk_a1_policy_management_api');

// Create an instance of the API class
var api = new OnapCcsdkA1PolicyManagementApi.HealthCheckApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getStatus(callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class getStatusExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new HealthCheckApi();

            try {
                // Get Status (getStatus)
                StatusInfo result = apiInstance.getStatus();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling HealthCheckApi.getStatus: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\HealthCheckApi();

try {
    $result = $api_instance->getStatus();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling HealthCheckApi->getStatus: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::HealthCheckApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::HealthCheckApi->new();

eval {
    my $result = $api_instance->getStatus();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling HealthCheckApi->getStatus: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.HealthCheckApi()

try:
    # Get Status (getStatus)
    api_response = api_instance.get_status()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling HealthCheckApi->getStatus: %s\n" % e)
extern crate HealthCheckApi;

pub fn main() {

    let mut context = HealthCheckApi::Context::default();
    let result = client.getStatus(&context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Responses


NearRTRICRepository

getRic

Get a Near-RT RIC (getRic)

Get information about a Near-RT RIC


/rics/{ricId}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json,application/problem+json" \
 "https://example.com/a1-policy-management/v1/rics/{ricId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.NearRTRICRepositoryApi;

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

public class NearRTRICRepositoryApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        NearRTRICRepositoryApi apiInstance = new NearRTRICRepositoryApi();
        String ricId = ricId_example; // String | The identity of a Near-RT RIC to get information for.
        String accept = application/json; // String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.

        try {
            RicInfo result = apiInstance.getRic(ricId, accept);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NearRTRICRepositoryApi#getRic");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String ricId = new String(); // String | The identity of a Near-RT RIC to get information for.
final String accept = new String(); // String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.

try {
    final result = await api_instance.getRic(ricId, accept);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getRic: $e\n');
}

import org.openapitools.client.api.NearRTRICRepositoryApi;

public class NearRTRICRepositoryApiExample {
    public static void main(String[] args) {
        NearRTRICRepositoryApi apiInstance = new NearRTRICRepositoryApi();
        String ricId = ricId_example; // String | The identity of a Near-RT RIC to get information for.
        String accept = application/json; // String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.

        try {
            RicInfo result = apiInstance.getRic(ricId, accept);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NearRTRICRepositoryApi#getRic");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
NearRTRICRepositoryApi *apiInstance = [[NearRTRICRepositoryApi alloc] init];
String *ricId = ricId_example; // The identity of a Near-RT RIC to get information for. (default to null)
String *accept = application/json; // Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed. (optional) (default to null)

// Get a Near-RT RIC (getRic)
[apiInstance getRicWith:ricId
    accept:accept
              completionHandler: ^(RicInfo output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OnapCcsdkA1PolicyManagementApi = require('onap_ccsdk_a1_policy_management_api');

// Create an instance of the API class
var api = new OnapCcsdkA1PolicyManagementApi.NearRTRICRepositoryApi()
var ricId = ricId_example; // {String} The identity of a Near-RT RIC to get information for.
var opts = {
  'accept': application/json // {String} Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.
};

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

namespace Example
{
    public class getRicExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new NearRTRICRepositoryApi();
            var ricId = ricId_example;  // String | The identity of a Near-RT RIC to get information for. (default to null)
            var accept = application/json;  // String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed. (optional)  (default to null)

            try {
                // Get a Near-RT RIC (getRic)
                RicInfo result = apiInstance.getRic(ricId, accept);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling NearRTRICRepositoryApi.getRic: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\NearRTRICRepositoryApi();
$ricId = ricId_example; // String | The identity of a Near-RT RIC to get information for.
$accept = application/json; // String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.

try {
    $result = $api_instance->getRic($ricId, $accept);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling NearRTRICRepositoryApi->getRic: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::NearRTRICRepositoryApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::NearRTRICRepositoryApi->new();
my $ricId = ricId_example; # String | The identity of a Near-RT RIC to get information for.
my $accept = application/json; # String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.

eval {
    my $result = $api_instance->getRic(ricId => $ricId, accept => $accept);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling NearRTRICRepositoryApi->getRic: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.NearRTRICRepositoryApi()
ricId = ricId_example # String | The identity of a Near-RT RIC to get information for. (default to null)
accept = application/json # String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed. (optional) (default to null)

try:
    # Get a Near-RT RIC (getRic)
    api_response = api_instance.get_ric(ricId, accept=accept)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling NearRTRICRepositoryApi->getRic: %s\n" % e)
extern crate NearRTRICRepositoryApi;

pub fn main() {
    let ricId = ricId_example; // String
    let accept = application/json; // String

    let mut context = NearRTRICRepositoryApi::Context::default();
    let result = client.getRic(ricId, accept, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
ricId*
String
The identity of a Near-RT RIC to get information for.
Required
Header parameters
Name Description
Accept
String
Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.

Responses


getRics

Get Near-RT RICs for A1 Policy Type (getRics)

Get all Near-RT RICs that supports a given A1 Policy Type ID


/rics

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json,application/problem+json" \
 "https://example.com/a1-policy-management/v1/rics?policyTypeId=policyTypeId_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.NearRTRICRepositoryApi;

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

public class NearRTRICRepositoryApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        NearRTRICRepositoryApi apiInstance = new NearRTRICRepositoryApi();
        String policyTypeId = policyTypeId_example; // String | The identity of an A1 Policy Type. If given, all Near-RT RICs supporting the A1 Policy Type are returned.

        String accept = application/json; // String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.

        try {
            RicInfoList result = apiInstance.getRics(policyTypeId, accept);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NearRTRICRepositoryApi#getRics");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String policyTypeId = new String(); // String | The identity of an A1 Policy Type. If given, all Near-RT RICs supporting the A1 Policy Type are returned.

final String accept = new String(); // String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.

try {
    final result = await api_instance.getRics(policyTypeId, accept);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getRics: $e\n');
}

import org.openapitools.client.api.NearRTRICRepositoryApi;

public class NearRTRICRepositoryApiExample {
    public static void main(String[] args) {
        NearRTRICRepositoryApi apiInstance = new NearRTRICRepositoryApi();
        String policyTypeId = policyTypeId_example; // String | The identity of an A1 Policy Type. If given, all Near-RT RICs supporting the A1 Policy Type are returned.

        String accept = application/json; // String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.

        try {
            RicInfoList result = apiInstance.getRics(policyTypeId, accept);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NearRTRICRepositoryApi#getRics");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
NearRTRICRepositoryApi *apiInstance = [[NearRTRICRepositoryApi alloc] init];
String *policyTypeId = policyTypeId_example; // The identity of an A1 Policy Type. If given, all Near-RT RICs supporting the A1 Policy Type are returned.
 (optional) (default to null)
String *accept = application/json; // Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed. (optional) (default to null)

// Get Near-RT RICs for A1 Policy Type (getRics)
[apiInstance getRicsWith:policyTypeId
    accept:accept
              completionHandler: ^(RicInfoList output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OnapCcsdkA1PolicyManagementApi = require('onap_ccsdk_a1_policy_management_api');

// Create an instance of the API class
var api = new OnapCcsdkA1PolicyManagementApi.NearRTRICRepositoryApi()
var opts = {
  'policyTypeId': policyTypeId_example, // {String} The identity of an A1 Policy Type. If given, all Near-RT RICs supporting the A1 Policy Type are returned.

  'accept': application/json // {String} Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.
};

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

namespace Example
{
    public class getRicsExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new NearRTRICRepositoryApi();
            var policyTypeId = policyTypeId_example;  // String | The identity of an A1 Policy Type. If given, all Near-RT RICs supporting the A1 Policy Type are returned.
 (optional)  (default to null)
            var accept = application/json;  // String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed. (optional)  (default to null)

            try {
                // Get Near-RT RICs for A1 Policy Type (getRics)
                RicInfoList result = apiInstance.getRics(policyTypeId, accept);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling NearRTRICRepositoryApi.getRics: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\NearRTRICRepositoryApi();
$policyTypeId = policyTypeId_example; // String | The identity of an A1 Policy Type. If given, all Near-RT RICs supporting the A1 Policy Type are returned.

$accept = application/json; // String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.

try {
    $result = $api_instance->getRics($policyTypeId, $accept);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling NearRTRICRepositoryApi->getRics: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::NearRTRICRepositoryApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::NearRTRICRepositoryApi->new();
my $policyTypeId = policyTypeId_example; # String | The identity of an A1 Policy Type. If given, all Near-RT RICs supporting the A1 Policy Type are returned.

my $accept = application/json; # String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.

eval {
    my $result = $api_instance->getRics(policyTypeId => $policyTypeId, accept => $accept);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling NearRTRICRepositoryApi->getRics: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.NearRTRICRepositoryApi()
policyTypeId = policyTypeId_example # String | The identity of an A1 Policy Type. If given, all Near-RT RICs supporting the A1 Policy Type are returned.
 (optional) (default to null)
accept = application/json # String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed. (optional) (default to null)

try:
    # Get Near-RT RICs for A1 Policy Type (getRics)
    api_response = api_instance.get_rics(policyTypeId=policyTypeId, accept=accept)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling NearRTRICRepositoryApi->getRics: %s\n" % e)
extern crate NearRTRICRepositoryApi;

pub fn main() {
    let policyTypeId = policyTypeId_example; // String
    let accept = application/json; // String

    let mut context = NearRTRICRepositoryApi::Context::default();
    let result = client.getRics(policyTypeId, accept, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Header parameters
Name Description
Accept
String
Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.
Query parameters
Name Description
policyTypeId
String
The identity of an A1 Policy Type. If given, all Near-RT RICs supporting the A1 Policy Type are returned.

Responses


ServiceRegistryAndSupervision

deleteService

Unregister a Service (deleteService)

Unregister a registered Service using its service ID. Only registered services can be unregistered. All A1 Policy Instances for the previously registered service will be removed.


/services/{serviceId}

Usage and SDK Samples

curl -X DELETE \
 -H "Accept: application/json,application/problem+json" \
 "https://example.com/a1-policy-management/v1/services/{serviceId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ServiceRegistryAndSupervisionApi;

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

public class ServiceRegistryAndSupervisionApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ServiceRegistryAndSupervisionApi apiInstance = new ServiceRegistryAndSupervisionApi();
        String serviceId = serviceId_example; // String | 
        String accept = application/json; // String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.

        try {
            Object result = apiInstance.deleteService(serviceId, accept);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ServiceRegistryAndSupervisionApi#deleteService");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String serviceId = new String(); // String | 
final String accept = new String(); // String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.

try {
    final result = await api_instance.deleteService(serviceId, accept);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->deleteService: $e\n');
}

import org.openapitools.client.api.ServiceRegistryAndSupervisionApi;

public class ServiceRegistryAndSupervisionApiExample {
    public static void main(String[] args) {
        ServiceRegistryAndSupervisionApi apiInstance = new ServiceRegistryAndSupervisionApi();
        String serviceId = serviceId_example; // String | 
        String accept = application/json; // String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.

        try {
            Object result = apiInstance.deleteService(serviceId, accept);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ServiceRegistryAndSupervisionApi#deleteService");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ServiceRegistryAndSupervisionApi *apiInstance = [[ServiceRegistryAndSupervisionApi alloc] init];
String *serviceId = serviceId_example; //  (default to null)
String *accept = application/json; // Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed. (optional) (default to null)

// Unregister a Service (deleteService)
[apiInstance deleteServiceWith:serviceId
    accept:accept
              completionHandler: ^(Object output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OnapCcsdkA1PolicyManagementApi = require('onap_ccsdk_a1_policy_management_api');

// Create an instance of the API class
var api = new OnapCcsdkA1PolicyManagementApi.ServiceRegistryAndSupervisionApi()
var serviceId = serviceId_example; // {String} 
var opts = {
  'accept': application/json // {String} Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.
};

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

namespace Example
{
    public class deleteServiceExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new ServiceRegistryAndSupervisionApi();
            var serviceId = serviceId_example;  // String |  (default to null)
            var accept = application/json;  // String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed. (optional)  (default to null)

            try {
                // Unregister a Service (deleteService)
                Object result = apiInstance.deleteService(serviceId, accept);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ServiceRegistryAndSupervisionApi.deleteService: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ServiceRegistryAndSupervisionApi();
$serviceId = serviceId_example; // String | 
$accept = application/json; // String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.

try {
    $result = $api_instance->deleteService($serviceId, $accept);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ServiceRegistryAndSupervisionApi->deleteService: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ServiceRegistryAndSupervisionApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ServiceRegistryAndSupervisionApi->new();
my $serviceId = serviceId_example; # String | 
my $accept = application/json; # String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.

eval {
    my $result = $api_instance->deleteService(serviceId => $serviceId, accept => $accept);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ServiceRegistryAndSupervisionApi->deleteService: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.ServiceRegistryAndSupervisionApi()
serviceId = serviceId_example # String |  (default to null)
accept = application/json # String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed. (optional) (default to null)

try:
    # Unregister a Service (deleteService)
    api_response = api_instance.delete_service(serviceId, accept=accept)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ServiceRegistryAndSupervisionApi->deleteService: %s\n" % e)
extern crate ServiceRegistryAndSupervisionApi;

pub fn main() {
    let serviceId = serviceId_example; // String
    let accept = application/json; // String

    let mut context = ServiceRegistryAndSupervisionApi::Context::default();
    let result = client.deleteService(serviceId, accept, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
serviceId*
String
Required
Header parameters
Name Description
Accept
String
Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.

Responses


getServices

Get Services (getServices)

Get information about all registered services, or a single registered service. If the service ID of a registered service is included in the query, information about that service is returned. Otherwise Information about all registered is returned. This operation does not retrieve information about unregistered services.


/services

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json,application/problem+json" \
 "https://example.com/a1-policy-management/v1/services?serviceId=serviceId_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ServiceRegistryAndSupervisionApi;

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

public class ServiceRegistryAndSupervisionApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ServiceRegistryAndSupervisionApi apiInstance = new ServiceRegistryAndSupervisionApi();
        String serviceId = serviceId_example; // String | The identity of the registered service
        String accept = application/json; // String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.

        try {
            ServiceStatusList result = apiInstance.getServices(serviceId, accept);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ServiceRegistryAndSupervisionApi#getServices");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String serviceId = new String(); // String | The identity of the registered service
final String accept = new String(); // String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.

try {
    final result = await api_instance.getServices(serviceId, accept);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getServices: $e\n');
}

import org.openapitools.client.api.ServiceRegistryAndSupervisionApi;

public class ServiceRegistryAndSupervisionApiExample {
    public static void main(String[] args) {
        ServiceRegistryAndSupervisionApi apiInstance = new ServiceRegistryAndSupervisionApi();
        String serviceId = serviceId_example; // String | The identity of the registered service
        String accept = application/json; // String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.

        try {
            ServiceStatusList result = apiInstance.getServices(serviceId, accept);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ServiceRegistryAndSupervisionApi#getServices");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ServiceRegistryAndSupervisionApi *apiInstance = [[ServiceRegistryAndSupervisionApi alloc] init];
String *serviceId = serviceId_example; // The identity of the registered service (optional) (default to null)
String *accept = application/json; // Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed. (optional) (default to null)

// Get Services (getServices)
[apiInstance getServicesWith:serviceId
    accept:accept
              completionHandler: ^(ServiceStatusList output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OnapCcsdkA1PolicyManagementApi = require('onap_ccsdk_a1_policy_management_api');

// Create an instance of the API class
var api = new OnapCcsdkA1PolicyManagementApi.ServiceRegistryAndSupervisionApi()
var opts = {
  'serviceId': serviceId_example, // {String} The identity of the registered service
  'accept': application/json // {String} Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.
};

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

namespace Example
{
    public class getServicesExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new ServiceRegistryAndSupervisionApi();
            var serviceId = serviceId_example;  // String | The identity of the registered service (optional)  (default to null)
            var accept = application/json;  // String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed. (optional)  (default to null)

            try {
                // Get Services (getServices)
                ServiceStatusList result = apiInstance.getServices(serviceId, accept);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ServiceRegistryAndSupervisionApi.getServices: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ServiceRegistryAndSupervisionApi();
$serviceId = serviceId_example; // String | The identity of the registered service
$accept = application/json; // String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.

try {
    $result = $api_instance->getServices($serviceId, $accept);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ServiceRegistryAndSupervisionApi->getServices: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ServiceRegistryAndSupervisionApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ServiceRegistryAndSupervisionApi->new();
my $serviceId = serviceId_example; # String | The identity of the registered service
my $accept = application/json; # String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.

eval {
    my $result = $api_instance->getServices(serviceId => $serviceId, accept => $accept);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ServiceRegistryAndSupervisionApi->getServices: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.ServiceRegistryAndSupervisionApi()
serviceId = serviceId_example # String | The identity of the registered service (optional) (default to null)
accept = application/json # String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed. (optional) (default to null)

try:
    # Get Services (getServices)
    api_response = api_instance.get_services(serviceId=serviceId, accept=accept)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ServiceRegistryAndSupervisionApi->getServices: %s\n" % e)
extern crate ServiceRegistryAndSupervisionApi;

pub fn main() {
    let serviceId = serviceId_example; // String
    let accept = application/json; // String

    let mut context = ServiceRegistryAndSupervisionApi::Context::default();
    let result = client.getServices(serviceId, accept, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Header parameters
Name Description
Accept
String
Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.
Query parameters
Name Description
serviceId
String
The identity of the registered service

Responses


keepAliveService

Heartbeat message from a service (keepAliveService)

A registered service should invoke this operation regularly to indicate that it is still alive. If a registered service fails to invoke some operation, or this operation, before the end of a timeout period the service will be deregistered and all its A1 policies wil be removed and the service is deleted. This operation is only intended for registered services. (This timeout can be set or disabled when each service is initially registered). Unregistered services do not need to invoke this operation, since the optional keep-alive monitoring feature can only be enabled for registered services.


/services/{serviceId}/keepalive

Usage and SDK Samples

curl -X PUT \
 -H "Accept: application/json,application/problem+json" \
 "https://example.com/a1-policy-management/v1/services/{serviceId}/keepalive"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ServiceRegistryAndSupervisionApi;

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

public class ServiceRegistryAndSupervisionApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ServiceRegistryAndSupervisionApi apiInstance = new ServiceRegistryAndSupervisionApi();
        String serviceId = serviceId_example; // String | 
        String accept = application/json; // String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.

        try {
            Object result = apiInstance.keepAliveService(serviceId, accept);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ServiceRegistryAndSupervisionApi#keepAliveService");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String serviceId = new String(); // String | 
final String accept = new String(); // String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.

try {
    final result = await api_instance.keepAliveService(serviceId, accept);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->keepAliveService: $e\n');
}

import org.openapitools.client.api.ServiceRegistryAndSupervisionApi;

public class ServiceRegistryAndSupervisionApiExample {
    public static void main(String[] args) {
        ServiceRegistryAndSupervisionApi apiInstance = new ServiceRegistryAndSupervisionApi();
        String serviceId = serviceId_example; // String | 
        String accept = application/json; // String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.

        try {
            Object result = apiInstance.keepAliveService(serviceId, accept);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ServiceRegistryAndSupervisionApi#keepAliveService");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ServiceRegistryAndSupervisionApi *apiInstance = [[ServiceRegistryAndSupervisionApi alloc] init];
String *serviceId = serviceId_example; //  (default to null)
String *accept = application/json; // Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed. (optional) (default to null)

// Heartbeat message from a service (keepAliveService)
[apiInstance keepAliveServiceWith:serviceId
    accept:accept
              completionHandler: ^(Object output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OnapCcsdkA1PolicyManagementApi = require('onap_ccsdk_a1_policy_management_api');

// Create an instance of the API class
var api = new OnapCcsdkA1PolicyManagementApi.ServiceRegistryAndSupervisionApi()
var serviceId = serviceId_example; // {String} 
var opts = {
  'accept': application/json // {String} Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.
};

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

namespace Example
{
    public class keepAliveServiceExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new ServiceRegistryAndSupervisionApi();
            var serviceId = serviceId_example;  // String |  (default to null)
            var accept = application/json;  // String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed. (optional)  (default to null)

            try {
                // Heartbeat message from a service (keepAliveService)
                Object result = apiInstance.keepAliveService(serviceId, accept);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ServiceRegistryAndSupervisionApi.keepAliveService: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ServiceRegistryAndSupervisionApi();
$serviceId = serviceId_example; // String | 
$accept = application/json; // String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.

try {
    $result = $api_instance->keepAliveService($serviceId, $accept);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ServiceRegistryAndSupervisionApi->keepAliveService: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ServiceRegistryAndSupervisionApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ServiceRegistryAndSupervisionApi->new();
my $serviceId = serviceId_example; # String | 
my $accept = application/json; # String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.

eval {
    my $result = $api_instance->keepAliveService(serviceId => $serviceId, accept => $accept);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ServiceRegistryAndSupervisionApi->keepAliveService: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.ServiceRegistryAndSupervisionApi()
serviceId = serviceId_example # String |  (default to null)
accept = application/json # String | Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed. (optional) (default to null)

try:
    # Heartbeat message from a service (keepAliveService)
    api_response = api_instance.keep_alive_service(serviceId, accept=accept)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ServiceRegistryAndSupervisionApi->keepAliveService: %s\n" % e)
extern crate ServiceRegistryAndSupervisionApi;

pub fn main() {
    let serviceId = serviceId_example; // String
    let accept = application/json; // String

    let mut context = ServiceRegistryAndSupervisionApi::Context::default();
    let result = client.keepAliveService(serviceId, accept, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Path parameters
Name Description
serviceId*
String
Required
Header parameters
Name Description
Accept
String
Specifies the content type that the client expects to receive in response to the request. Only application/json is allowed.

Responses


putService

Register or update a Service (putService)

Register a single service, or update a previous registration. Service registration is required to get callbacks about available NearRT RICs and to enable supervision of the service's active status. If a registered service becomes inactive, its policies can be automatically deleted. A1 Policy instances can also be created for unregistered services. If an unregistered service is later registered, the service's policies are retained when the service becomes registered. This feature is optional to use.


/services

Usage and SDK Samples

curl -X PUT \
 -H "Accept: application/json,application/problem+json" \
 -H "Content-Type: application/json" \
 "https://example.com/a1-policy-management/v1/services" \
 -d '{
  "keepAliveIntervalSeconds" : 0,
  "callbackUrl" : "callbackUrl",
  "serviceId" : "serviceId"
}'
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ServiceRegistryAndSupervisionApi;

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

public class ServiceRegistryAndSupervisionApiExample {
    public static void main(String[] args) {

        // Create an instance of the API class
        ServiceRegistryAndSupervisionApi apiInstance = new ServiceRegistryAndSupervisionApi();
        ServiceRegistrationInfo serviceRegistrationInfo = ; // ServiceRegistrationInfo | 

        try {
            Object result = apiInstance.putService(serviceRegistrationInfo);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ServiceRegistryAndSupervisionApi#putService");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final ServiceRegistrationInfo serviceRegistrationInfo = new ServiceRegistrationInfo(); // ServiceRegistrationInfo | 

try {
    final result = await api_instance.putService(serviceRegistrationInfo);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->putService: $e\n');
}

import org.openapitools.client.api.ServiceRegistryAndSupervisionApi;

public class ServiceRegistryAndSupervisionApiExample {
    public static void main(String[] args) {
        ServiceRegistryAndSupervisionApi apiInstance = new ServiceRegistryAndSupervisionApi();
        ServiceRegistrationInfo serviceRegistrationInfo = ; // ServiceRegistrationInfo | 

        try {
            Object result = apiInstance.putService(serviceRegistrationInfo);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ServiceRegistryAndSupervisionApi#putService");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
ServiceRegistryAndSupervisionApi *apiInstance = [[ServiceRegistryAndSupervisionApi alloc] init];
ServiceRegistrationInfo *serviceRegistrationInfo = ; // 

// Register or update a Service (putService)
[apiInstance putServiceWith:serviceRegistrationInfo
              completionHandler: ^(Object output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var OnapCcsdkA1PolicyManagementApi = require('onap_ccsdk_a1_policy_management_api');

// Create an instance of the API class
var api = new OnapCcsdkA1PolicyManagementApi.ServiceRegistryAndSupervisionApi()
var serviceRegistrationInfo = ; // {ServiceRegistrationInfo} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.putService(serviceRegistrationInfo, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class putServiceExample
    {
        public void main()
        {

            // Create an instance of the API class
            var apiInstance = new ServiceRegistryAndSupervisionApi();
            var serviceRegistrationInfo = new ServiceRegistrationInfo(); // ServiceRegistrationInfo | 

            try {
                // Register or update a Service (putService)
                Object result = apiInstance.putService(serviceRegistrationInfo);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ServiceRegistryAndSupervisionApi.putService: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ServiceRegistryAndSupervisionApi();
$serviceRegistrationInfo = ; // ServiceRegistrationInfo | 

try {
    $result = $api_instance->putService($serviceRegistrationInfo);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ServiceRegistryAndSupervisionApi->putService: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::OPenAPIClient::Configuration;
use WWW::OPenAPIClient::ServiceRegistryAndSupervisionApi;

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ServiceRegistryAndSupervisionApi->new();
my $serviceRegistrationInfo = WWW::OPenAPIClient::Object::ServiceRegistrationInfo->new(); # ServiceRegistrationInfo | 

eval {
    my $result = $api_instance->putService(serviceRegistrationInfo => $serviceRegistrationInfo);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ServiceRegistryAndSupervisionApi->putService: $@\n";
}
from __future__ import print_statement
import time
import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Create an instance of the API class
api_instance = openapi_client.ServiceRegistryAndSupervisionApi()
serviceRegistrationInfo =  # ServiceRegistrationInfo | 

try:
    # Register or update a Service (putService)
    api_response = api_instance.put_service(serviceRegistrationInfo)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ServiceRegistryAndSupervisionApi->putService: %s\n" % e)
extern crate ServiceRegistryAndSupervisionApi;

pub fn main() {
    let serviceRegistrationInfo = ; // ServiceRegistrationInfo

    let mut context = ServiceRegistryAndSupervisionApi::Context::default();
    let result = client.putService(serviceRegistrationInfo, &context).wait();

    println!("{:?}", result);
}

Scopes

Parameters

Body parameters
Name Description
serviceRegistrationInfo *

Responses