A1 policy management API

A1PolicyManagement

createPolicy

To create A1 policies


/policies

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json,application/problem+json" \
 -H "Content-Type: application/json" \
 "https://a1-pms.com/a1-policy-management/v1/policies" \
 -d '{
  "policyId" : "POLICY-ID",
  "nearRtRicId" : "Near-RT-Ric-ID",
  "transient" : false,
  "policyObject" : "{}",
  "serviceId" : "rApp ID",
  "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 = ; // 

[apiInstance createPolicyWith:policyObjectInformation
              completionHandler: ^(PolicyObjectInformation output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var A1PolicyManagementApi = require('a1_policy_management_api');

// Create an instance of the API class
var api = new A1PolicyManagementApi.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 {
                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:
    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 resource


deletePolicy

Delete a policy

Deleting the policy using policyId.


/policies/{policyId}

Usage and SDK Samples

curl -X DELETE \
 -H "Accept: application/problem+json" \
 "https://a1-pms.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 a policy
[apiInstance deletePolicyWith:policyId
    accept:accept
              completionHandler: ^(NSError* error) {
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var A1PolicyManagementApi = require('a1_policy_management_api');

// Create an instance of the API class
var api = new A1PolicyManagementApi.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 a policy
                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 a policy
    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


getAllPolicies

Query policy identities

Returns a list of A1 policies matching given search criteria. <br>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://a1-pms.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 of a given policy type identity.
        String nearRtRicId = nearRtRicId_example; // String | Select policies of a given Near-RT RIC identity.
        String serviceId = serviceId_example; // String | Select policies owned by a given service.
        String typeName = typeName_example; // String | Select policies of types with the given type name (type identity has the format )
        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.getAllPolicies(policyTypeId, nearRtRicId, serviceId, typeName, accept);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling A1PolicyManagementApi#getAllPolicies");
            e.printStackTrace();
        }
    }
}
import 'package:openapi/api.dart';

final api_instance = DefaultApi();

final String policyTypeId = new String(); // String | Select policies of a given policy type identity.
final String nearRtRicId = new String(); // String | Select policies of a given Near-RT RIC identity.
final String serviceId = new String(); // String | Select policies owned by a given service.
final String typeName = new String(); // String | Select policies of types with the given type name (type identity has the format )
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.getAllPolicies(policyTypeId, nearRtRicId, serviceId, typeName, accept);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->getAllPolicies: $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 of a given policy type identity.
        String nearRtRicId = nearRtRicId_example; // String | Select policies of a given Near-RT RIC identity.
        String serviceId = serviceId_example; // String | Select policies owned by a given service.
        String typeName = typeName_example; // String | Select policies of types with the given type name (type identity has the format )
        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.getAllPolicies(policyTypeId, nearRtRicId, serviceId, typeName, accept);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling A1PolicyManagementApi#getAllPolicies");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
A1PolicyManagementApi *apiInstance = [[A1PolicyManagementApi alloc] init];
String *policyTypeId = policyTypeId_example; // Select policies of a given policy type identity. (optional) (default to null)
String *nearRtRicId = nearRtRicId_example; // Select policies of a given Near-RT RIC identity. (optional) (default to null)
String *serviceId = serviceId_example; // Select policies owned by a given service. (optional) (default to null)
String *typeName = typeName_example; // Select policies of types with the given type name (type identity has the format ) (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 policy identities
[apiInstance getAllPoliciesWith: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 A1PolicyManagementApi = require('a1_policy_management_api');

// Create an instance of the API class
var api = new A1PolicyManagementApi.A1PolicyManagementApi()
var opts = {
  'policyTypeId': policyTypeId_example, // {String} Select policies of a given policy type identity.
  'nearRtRicId': nearRtRicId_example, // {String} Select policies of a given Near-RT RIC identity.
  'serviceId': serviceId_example, // {String} Select policies owned by a given service.
  'typeName': typeName_example, // {String} Select policies of types with the given type name (type identity has the format )
  '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.getAllPolicies(opts, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

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

            // Create an instance of the API class
            var apiInstance = new A1PolicyManagementApi();
            var policyTypeId = policyTypeId_example;  // String | Select policies of a given policy type identity. (optional)  (default to null)
            var nearRtRicId = nearRtRicId_example;  // String | Select policies of a given Near-RT RIC identity. (optional)  (default to null)
            var serviceId = serviceId_example;  // String | Select policies owned by a given service. (optional)  (default to null)
            var typeName = typeName_example;  // String | Select policies of types with the given type name (type identity has the format ) (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 policy identities
                array[PolicyInformation] result = apiInstance.getAllPolicies(policyTypeId, nearRtRicId, serviceId, typeName, accept);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling A1PolicyManagementApi.getAllPolicies: " + 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 of a given policy type identity.
$nearRtRicId = nearRtRicId_example; // String | Select policies of a given Near-RT RIC identity.
$serviceId = serviceId_example; // String | Select policies owned by a given service.
$typeName = typeName_example; // String | Select policies of types with the given type name (type identity has the format )
$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->getAllPolicies($policyTypeId, $nearRtRicId, $serviceId, $typeName, $accept);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling A1PolicyManagementApi->getAllPolicies: ', $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 of a given policy type identity.
my $nearRtRicId = nearRtRicId_example; # String | Select policies of a given Near-RT RIC identity.
my $serviceId = serviceId_example; # String | Select policies owned by a given service.
my $typeName = typeName_example; # String | Select policies of types with the given type name (type identity has the format )
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->getAllPolicies(policyTypeId => $policyTypeId, nearRtRicId => $nearRtRicId, serviceId => $serviceId, typeName => $typeName, accept => $accept);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling A1PolicyManagementApi->getAllPolicies: $@\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 of a given policy type identity. (optional) (default to null)
nearRtRicId = nearRtRicId_example # String | Select policies of a given Near-RT RIC identity. (optional) (default to null)
serviceId = serviceId_example # String | Select policies owned by a given service. (optional) (default to null)
typeName = typeName_example # String | Select policies of types with the given type name (type identity has the format ) (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 policy identities
    api_response = api_instance.get_all_policies(policyTypeId=policyTypeId, nearRtRicId=nearRtRicId, serviceId=serviceId, typeName=typeName, accept=accept)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling A1PolicyManagementApi->getAllPolicies: %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.getAllPolicies(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 of a given policy type identity.
nearRtRicId
String
Select policies of a given Near-RT RIC identity.
serviceId
String
Select policies owned by a given service.
typeName
String
Select policies of types with the given type name (type identity has the format <typename_version>)

Responses


getPolicy

Returns a policy


/policies/{policyId}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json,application/problem+json" \
 "https://a1-pms.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)

[apiInstance getPolicyWith:policyId
    accept:accept
              completionHandler: ^(Object output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var A1PolicyManagementApi = require('a1_policy_management_api');

// Create an instance of the API class
var api = new A1PolicyManagementApi.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 {
                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:
    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


getPolicyTypeDefinition

Returns a policy type definition


/policy-types/{policyTypeId}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json,application/problem+json" \
 "https://a1-pms.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 {
            Object 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 {
            Object 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)

[apiInstance getPolicyTypeDefinitionWith:policyTypeId
    accept:accept
              completionHandler: ^(Object output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var A1PolicyManagementApi = require('a1_policy_management_api');

// Create an instance of the API class
var api = new A1PolicyManagementApi.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 {
                Object 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:
    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

Query policy type identities


/policy-types

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json,application/problem+json" \
 "https://a1-pms.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 with the given type name (type identity has the format )
        String compatibleWithVersion = compatibleWithVersion_example; // String | Select types that are compatible with the given version. This parameter is only applicable in conjunction with type_name. 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 with the given type name (type identity has the format )
final String compatibleWithVersion = new String(); // String | Select types that are compatible with the given version. This parameter is only applicable in conjunction with type_name. 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 with the given type name (type identity has the format )
        String compatibleWithVersion = compatibleWithVersion_example; // String | Select types that are compatible with the given version. This parameter is only applicable in conjunction with type_name. 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 with the given type name (type identity has the format ) (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 type_name. 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)

[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 A1PolicyManagementApi = require('a1_policy_management_api');

// Create an instance of the API class
var api = new A1PolicyManagementApi.A1PolicyManagementApi()
var opts = {
  'nearRtRicId': nearRtRicId_example, // {String} Select types for the given Near-RT RIC identity.
  'typeName': typeName_example, // {String} Select types with the given type name (type identity has the format )
  'compatibleWithVersion': compatibleWithVersion_example, // {String} Select types that are compatible with the given version. This parameter is only applicable in conjunction with type_name. 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 with the given type name (type identity has the format ) (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 type_name. 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 {
                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 with the given type name (type identity has the format )
$compatibleWithVersion = compatibleWithVersion_example; // String | Select types that are compatible with the given version. This parameter is only applicable in conjunction with type_name. 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 with the given type name (type identity has the format )
my $compatibleWithVersion = compatibleWithVersion_example; # String | Select types that are compatible with the given version. This parameter is only applicable in conjunction with type_name. 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 with the given type name (type identity has the format ) (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 type_name. 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:
    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 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 type_name. 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


putPolicy

update a policy


/policies/{policyId}

Usage and SDK Samples

curl -X PUT \
 -H "Accept: application/json,application/problem+json" \
 -H "Content-Type: application/json" \
 "https://a1-pms.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.putPolicy(policyId, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling A1PolicyManagementApi#putPolicy");
            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.putPolicy(policyId, body);
    print(result);
} catch (e) {
    print('Exception when calling DefaultApi->putPolicy: $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.putPolicy(policyId, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling A1PolicyManagementApi#putPolicy");
            e.printStackTrace();
        }
    }
}


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

[apiInstance putPolicyWith:policyId
    body:body
              completionHandler: ^(Object output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var A1PolicyManagementApi = require('a1_policy_management_api');

// Create an instance of the API class
var api = new A1PolicyManagementApi.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.putPolicy(policyId, body, callback);
using System;
using System.Diagnostics;
using Org.OpenAPITools.Api;
using Org.OpenAPITools.Client;
using Org.OpenAPITools.Model;

namespace Example
{
    public class putPolicyExample
    {
        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 {
                Object result = apiInstance.putPolicy(policyId, body);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling A1PolicyManagementApi.putPolicy: " + 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->putPolicy($policyId, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling A1PolicyManagementApi->putPolicy: ', $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->putPolicy(policyId => $policyId, body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling A1PolicyManagementApi->putPolicy: $@\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:
    api_response = api_instance.put_policy(policyId, body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling A1PolicyManagementApi->putPolicy: %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.putPolicy(policyId, body, &context).wait();

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

Scopes

Parameters

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

Responses


Configuration

getConfiguration

Returns the contents of the application configuration


/configuration

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json,application/problem+json" \
 "https://a1-pms.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];

[apiInstance getConfigurationWithCompletionHandler: 
              ^('String' output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var A1PolicyManagementApi = require('a1_policy_management_api');

// Create an instance of the API class
var api = new A1PolicyManagementApi.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 {
                '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:
    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

Replace the current configuration file with the given configuration


/configuration

Usage and SDK Samples

curl -X PUT \
 -H "Accept: */*,application/problem+json" \
 -H "Content-Type: application/json" \
 "https://a1-pms.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; // 

[apiInstance putConfigurationWith:body
              completionHandler: ^(Object output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var A1PolicyManagementApi = require('a1_policy_management_api');

// Create an instance of the API class
var api = new A1PolicyManagementApi.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 {
                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:
    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

Returns status and statistics of this service


/status

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "https://a1-pms.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];

[apiInstance getStatusWithCompletionHandler: 
              ^(StatusInfo output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var A1PolicyManagementApi = require('a1_policy_management_api');

// Create an instance of the API class
var api = new A1PolicyManagementApi.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 {
                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:
    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

Returns info for one Near-RT RIC

Either a Near-RT RIC identity or a Managed Element identity can be specified.<br>The intention with Managed Element identity is the ID used in O1 for accessing the traffical element (such as the ID of CU).


/rics/ric

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json,application/problem+json" \
 "https://a1-pms.com/a1-policy-management/v1/rics/ric?managedElementId=managedElementId_example&ricId=ricId_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 managedElementId = managedElementId_example; // String | The identity of a Managed Element. If given, the Near-RT RIC managing the ME is returned.
        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(managedElementId, 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 managedElementId = new String(); // String | The identity of a Managed Element. If given, the Near-RT RIC managing the ME is returned.
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(managedElementId, 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 managedElementId = managedElementId_example; // String | The identity of a Managed Element. If given, the Near-RT RIC managing the ME is returned.
        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(managedElementId, 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 *managedElementId = managedElementId_example; // The identity of a Managed Element. If given, the Near-RT RIC managing the ME is returned. (optional) (default to null)
String *ricId = ricId_example; // The identity of a Near-RT RIC to get information for. (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)

// Returns info for one Near-RT RIC
[apiInstance getRicWith:managedElementId
    ricId:ricId
    accept:accept
              completionHandler: ^(RicInfo output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var A1PolicyManagementApi = require('a1_policy_management_api');

// Create an instance of the API class
var api = new A1PolicyManagementApi.NearRTRICRepositoryApi()
var opts = {
  'managedElementId': managedElementId_example, // {String} The identity of a Managed Element. If given, the Near-RT RIC managing the ME is returned.
  '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.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getRic(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 managedElementId = managedElementId_example;  // String | The identity of a Managed Element. If given, the Near-RT RIC managing the ME is returned. (optional)  (default to null)
            var ricId = ricId_example;  // String | The identity of a Near-RT RIC to get information for. (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 {
                // Returns info for one Near-RT RIC
                RicInfo result = apiInstance.getRic(managedElementId, 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();
$managedElementId = managedElementId_example; // String | The identity of a Managed Element. If given, the Near-RT RIC managing the ME is returned.
$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($managedElementId, $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 $managedElementId = managedElementId_example; # String | The identity of a Managed Element. If given, the Near-RT RIC managing the ME is returned.
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(managedElementId => $managedElementId, 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()
managedElementId = managedElementId_example # String | The identity of a Managed Element. If given, the Near-RT RIC managing the ME is returned. (optional) (default to null)
ricId = ricId_example # String | The identity of a Near-RT RIC to get information for. (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:
    # Returns info for one Near-RT RIC
    api_response = api_instance.get_ric(managedElementId=managedElementId, ricId=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 managedElementId = managedElementId_example; // String
    let ricId = ricId_example; // String
    let accept = application/json; // String

    let mut context = NearRTRICRepositoryApi::Context::default();
    let result = client.getRic(managedElementId, ricId, 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
managedElementId
String
The identity of a Managed Element. If given, the Near-RT RIC managing the ME is returned.
ricId
String
The identity of a Near-RT RIC to get information for.

Responses


getRics

Query Near-RT RIC information

The call returns all Near-RT RICs that supports a given policy type identity


/rics

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json,application/problem+json" \
 "https://a1-pms.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 a policy type. If given, all Near-RT RICs supporting the 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 a policy type. If given, all Near-RT RICs supporting the 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 a policy type. If given, all Near-RT RICs supporting the 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 a policy type. If given, all Near-RT RICs supporting the 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)

// Query Near-RT RIC information
[apiInstance getRicsWith:policyTypeId
    accept:accept
              completionHandler: ^(RicInfoList output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var A1PolicyManagementApi = require('a1_policy_management_api');

// Create an instance of the API class
var api = new A1PolicyManagementApi.NearRTRICRepositoryApi()
var opts = {
  'policyTypeId': policyTypeId_example, // {String} The identity of a policy type. If given, all Near-RT RICs supporting the 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 a policy type. If given, all Near-RT RICs supporting the 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 {
                // Query Near-RT RIC information
                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 a policy type. If given, all Near-RT RICs supporting the 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 a policy type. If given, all Near-RT RICs supporting the 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 a policy type. If given, all Near-RT RICs supporting the 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:
    # Query Near-RT RIC information
    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 a policy type. If given, all Near-RT RICs supporting the policy type are returned

Responses


ServiceRegistryAndSupervision

deleteService

Unregister a service


/services/{serviceId}

Usage and SDK Samples

curl -X DELETE \
 -H "Accept: */*,application/problem+json" \
 "https://a1-pms.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)

[apiInstance deleteServiceWith:serviceId
    accept:accept
              completionHandler: ^(Object output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var A1PolicyManagementApi = require('a1_policy_management_api');

// Create an instance of the API class
var api = new A1PolicyManagementApi.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 {
                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:
    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

Returns service information

Either information about a registered service with given identity or all registered services are returned.


/services

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json,application/problem+json" \
 "https://a1-pms.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 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 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 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 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)

// Returns service information
[apiInstance getServicesWith:serviceId
    accept:accept
              completionHandler: ^(ServiceStatusList output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var A1PolicyManagementApi = require('a1_policy_management_api');

// Create an instance of the API class
var api = new A1PolicyManagementApi.ServiceRegistryAndSupervisionApi()
var opts = {
  'serviceId': serviceId_example, // {String} The identity of the 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 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 {
                // Returns service information
                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 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 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 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:
    # Returns service information
    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 service

Responses


keepAliveService

Heartbeat indicates that the service is running

A registered service should invoke this operation regularly to indicate that it is still alive. If a registered service fails to invoke this operation before the end of a timeout period the service will be deregistered and all its A1 policies wil be removed. (This timeout can be set or disabled when each service is initially registered)


/services/{serviceId}/keepalive

Usage and SDK Samples

curl -X PUT \
 -H "Accept: */*,application/problem+json" \
 -H "Content-Type: application/json" \
 "https://a1-pms.com/a1-policy-management/v1/services/{serviceId}/keepalive" \
 -d ''
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.
        String body = body_example; // String | 

        try {
            Object result = apiInstance.keepAliveService(serviceId, accept, body);
            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.
final String body = new String(); // String | 

try {
    final result = await api_instance.keepAliveService(serviceId, accept, body);
    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.
        String body = body_example; // String | 

        try {
            Object result = apiInstance.keepAliveService(serviceId, accept, body);
            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)
String *body = body_example; //  (optional)

// Heartbeat indicates that the service is running
[apiInstance keepAliveServiceWith:serviceId
    accept:accept
    body:body
              completionHandler: ^(Object output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var A1PolicyManagementApi = require('a1_policy_management_api');

// Create an instance of the API class
var api = new A1PolicyManagementApi.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.
  'body': body_example // {String} 
};

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)
            var body = body_example;  // String |  (optional) 

            try {
                // Heartbeat indicates that the service is running
                Object result = apiInstance.keepAliveService(serviceId, accept, body);
                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.
$body = body_example; // String | 

try {
    $result = $api_instance->keepAliveService($serviceId, $accept, $body);
    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.
my $body = WWW::OPenAPIClient::Object::String->new(); # String | 

eval {
    my $result = $api_instance->keepAliveService(serviceId => $serviceId, accept => $accept, body => $body);
    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)
body = body_example # String |  (optional)

try:
    # Heartbeat indicates that the service is running
    api_response = api_instance.keep_alive_service(serviceId, accept=accept, body=body)
    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 body = body_example; // String

    let mut context = ServiceRegistryAndSupervisionApi::Context::default();
    let result = client.keepAliveService(serviceId, accept, body, &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.
Body parameters
Name Description
body

Responses


putService

Register a service

Registering a service is needed to:<ul><li>Get callbacks about available NearRT RICs.</li><li>Activate supervision of the service. If a service is inactive, its policies will automatically be deleted.</li></ul>Policies can be created even if the service is not registerred. This is a feature which it is optional to use.


/services

Usage and SDK Samples

curl -X PUT \
 -H "Accept: */*,application/problem+json" \
 -H "Content-Type: application/json" \
 "https://a1-pms.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 a service
[apiInstance putServiceWith:serviceRegistrationInfo
              completionHandler: ^(Object output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var A1PolicyManagementApi = require('a1_policy_management_api');

// Create an instance of the API class
var api = new A1PolicyManagementApi.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 a service
                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 a service
    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