A1 Policy Management Service

A1PolicyManagement

deletePolicy

Delete a policy


/a1-policy/v2/policies/{policy_id}

Usage and SDK Samples

curl -X DELETE \
 -H "Accept: */*" \
 "http://localhost/a1-policy/v2/policies/{policy_id}"
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 | 

        try {
            Object result = apiInstance.deletePolicy(policyId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling A1PolicyManagementApi#deletePolicy");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.A1PolicyManagementApi;

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

        try {
            Object result = apiInstance.deletePolicy(policyId);
            System.out.println(result);
        } 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)

// Delete a policy
[apiInstance deletePolicyWith:policyId
              completionHandler: ^(Object output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var A1PolicyManagementService = require('a1_policy_management_service');

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

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deletePolicy(policyId, 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)

            try {
                // Delete a policy
                Object result = apiInstance.deletePolicy(policyId);
                Debug.WriteLine(result);
            } 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 | 

try {
    $result = $api_instance->deletePolicy($policyId);
    print_r($result);
} 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 | 

eval {
    my $result = $api_instance->deletePolicy(policyId => $policyId);
    print Dumper($result);
};
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)

try:
    # Delete a policy
    api_response = api_instance.delete_policy(policyId)
    pprint(api_response)
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 mut context = A1PolicyManagementApi::Context::default();
    let result = client.deletePolicy(policyId, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
policy_id*
String
Required

Responses


getPolicy

Returns a policy


/a1-policy/v2/policies/{policy_id}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost/a1-policy/v2/policies/{policy_id}"
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 | 

        try {
            policy_info_v2 result = apiInstance.getPolicy(policyId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling A1PolicyManagementApi#getPolicy");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.A1PolicyManagementApi;

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

        try {
            policy_info_v2 result = apiInstance.getPolicy(policyId);
            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)

// Returns a policy
[apiInstance getPolicyWith:policyId
              completionHandler: ^(policy_info_v2 output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var A1PolicyManagementService = require('a1_policy_management_service');

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

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getPolicy(policyId, 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)

            try {
                // Returns a policy
                policy_info_v2 result = apiInstance.getPolicy(policyId);
                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 | 

try {
    $result = $api_instance->getPolicy($policyId);
    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 | 

eval {
    my $result = $api_instance->getPolicy(policyId => $policyId);
    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)

try:
    # Returns a policy
    api_response = api_instance.get_policy(policyId)
    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 mut context = A1PolicyManagementApi::Context::default();
    let result = client.getPolicy(policyId, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
policy_id*
String
Required

Responses


getPolicyIds

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.


/a1-policy/v2/policies

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost/a1-policy/v2/policies?policytype_id=policytypeId_example&ric_id=ricId_example&service_id=serviceId_example&type_name=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 ricId = ricId_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 )

        try {
            policy_id_list_v2 result = apiInstance.getPolicyIds(policytypeId, ricId, serviceId, typeName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling A1PolicyManagementApi#getPolicyIds");
            e.printStackTrace();
        }
    }
}
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 ricId = ricId_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 )

        try {
            policy_id_list_v2 result = apiInstance.getPolicyIds(policytypeId, ricId, serviceId, typeName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling A1PolicyManagementApi#getPolicyIds");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
A1PolicyManagementApi *apiInstance = [[A1PolicyManagementApi alloc] init];
String *policytypeId = policytypeId_example; // Select policies of a given policy type identity. (optional) (default to null)
String *ricId = ricId_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)

// Query policy identities
[apiInstance getPolicyIdsWith:policytypeId
    ricId:ricId
    serviceId:serviceId
    typeName:typeName
              completionHandler: ^(policy_id_list_v2 output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var A1PolicyManagementService = require('a1_policy_management_service');

// Create an instance of the API class
var api = new A1PolicyManagementService.A1PolicyManagementApi()
var opts = {
  'policytypeId': policytypeId_example, // {String} Select policies of a given policy type identity.
  'ricId': ricId_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 )
};

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

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

            // Create an instance of the API class
            var apiInstance = new A1PolicyManagementApi();
            var policytypeId = policytypeId_example;  // String | Select policies of a given policy type identity. (optional)  (default to null)
            var ricId = ricId_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)

            try {
                // Query policy identities
                policy_id_list_v2 result = apiInstance.getPolicyIds(policytypeId, ricId, serviceId, typeName);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling A1PolicyManagementApi.getPolicyIds: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\A1PolicyManagementApi();
$policytypeId = policytypeId_example; // String | Select policies of a given policy type identity.
$ricId = ricId_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 )

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::A1PolicyManagementApi->new();
my $policytypeId = policytypeId_example; # String | Select policies of a given policy type identity.
my $ricId = ricId_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 )

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

# Create an instance of the API class
api_instance = openapi_client.A1PolicyManagementApi()
policytypeId = policytypeId_example # String | Select policies of a given policy type identity. (optional) (default to null)
ricId = ricId_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)

try:
    # Query policy identities
    api_response = api_instance.get_policy_ids(policytypeId=policytypeId, ricId=ricId, serviceId=serviceId, typeName=typeName)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling A1PolicyManagementApi->getPolicyIds: %s\n" % e)
extern crate A1PolicyManagementApi;

pub fn main() {
    let policytypeId = policytypeId_example; // String
    let ricId = ricId_example; // String
    let serviceId = serviceId_example; // String
    let typeName = typeName_example; // String

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

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

Scopes

Parameters

Query parameters
Name Description
policytype_id
String
Select policies of a given policy type identity.
ric_id
String
Select policies of a given Near-RT RIC identity.
service_id
String
Select policies owned by a given service.
type_name
String
Select policies of types with the given type name (type identity has the format <typename_version>)

Responses


getPolicyInstances

Query for A1 policy instances

Returns a list of A1 policies matching given search criteria. <br>If several query parameters are defined, the policies matching all conditions are returned.


/a1-policy/v2/policy-instances

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost/a1-policy/v2/policy-instances?policytype_id=policytypeId_example&ric_id=ricId_example&service_id=serviceId_example&type_name=typeName_example"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.A1PolicyManagementApi;

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

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

        // Create an instance of the API class
        A1PolicyManagementApi apiInstance = new A1PolicyManagementApi();
        String policytypeId = policytypeId_example; // String | Select policies with a given type identity.
        String ricId = ricId_example; // String | Select policies for 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 a given type name (type identity has the format )

        try {
            policy_info_list_v2 result = apiInstance.getPolicyInstances(policytypeId, ricId, serviceId, typeName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling A1PolicyManagementApi#getPolicyInstances");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.A1PolicyManagementApi;

public class A1PolicyManagementApiExample {
    public static void main(String[] args) {
        A1PolicyManagementApi apiInstance = new A1PolicyManagementApi();
        String policytypeId = policytypeId_example; // String | Select policies with a given type identity.
        String ricId = ricId_example; // String | Select policies for 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 a given type name (type identity has the format )

        try {
            policy_info_list_v2 result = apiInstance.getPolicyInstances(policytypeId, ricId, serviceId, typeName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling A1PolicyManagementApi#getPolicyInstances");
            e.printStackTrace();
        }
    }
}


// Create an instance of the API class
A1PolicyManagementApi *apiInstance = [[A1PolicyManagementApi alloc] init];
String *policytypeId = policytypeId_example; // Select policies with a given type identity. (optional) (default to null)
String *ricId = ricId_example; // Select policies for a given Near-RT RIC identity. (optional) (default to null)
String *serviceId = serviceId_example; // Select policies owned by a given service. (optional) (default to null)
String *typeName = typeName_example; // Select policies of a given type name (type identity has the format ) (optional) (default to null)

// Query for A1 policy instances
[apiInstance getPolicyInstancesWith:policytypeId
    ricId:ricId
    serviceId:serviceId
    typeName:typeName
              completionHandler: ^(policy_info_list_v2 output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var A1PolicyManagementService = require('a1_policy_management_service');

// Create an instance of the API class
var api = new A1PolicyManagementService.A1PolicyManagementApi()
var opts = {
  'policytypeId': policytypeId_example, // {String} Select policies with a given type identity.
  'ricId': ricId_example, // {String} Select policies for a given Near-RT RIC identity.
  'serviceId': serviceId_example, // {String} Select policies owned by a given service.
  'typeName': typeName_example // {String} Select policies of a given type name (type identity has the format )
};

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

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

            // Create an instance of the API class
            var apiInstance = new A1PolicyManagementApi();
            var policytypeId = policytypeId_example;  // String | Select policies with a given type identity. (optional)  (default to null)
            var ricId = ricId_example;  // String | Select policies for a given Near-RT RIC identity. (optional)  (default to null)
            var serviceId = serviceId_example;  // String | Select policies owned by a given service. (optional)  (default to null)
            var typeName = typeName_example;  // String | Select policies of a given type name (type identity has the format ) (optional)  (default to null)

            try {
                // Query for A1 policy instances
                policy_info_list_v2 result = apiInstance.getPolicyInstances(policytypeId, ricId, serviceId, typeName);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling A1PolicyManagementApi.getPolicyInstances: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\A1PolicyManagementApi();
$policytypeId = policytypeId_example; // String | Select policies with a given type identity.
$ricId = ricId_example; // String | Select policies for a given Near-RT RIC identity.
$serviceId = serviceId_example; // String | Select policies owned by a given service.
$typeName = typeName_example; // String | Select policies of a given type name (type identity has the format )

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::A1PolicyManagementApi->new();
my $policytypeId = policytypeId_example; # String | Select policies with a given type identity.
my $ricId = ricId_example; # String | Select policies for 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 a given type name (type identity has the format )

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

# Create an instance of the API class
api_instance = openapi_client.A1PolicyManagementApi()
policytypeId = policytypeId_example # String | Select policies with a given type identity. (optional) (default to null)
ricId = ricId_example # String | Select policies for a given Near-RT RIC identity. (optional) (default to null)
serviceId = serviceId_example # String | Select policies owned by a given service. (optional) (default to null)
typeName = typeName_example # String | Select policies of a given type name (type identity has the format ) (optional) (default to null)

try:
    # Query for A1 policy instances
    api_response = api_instance.get_policy_instances(policytypeId=policytypeId, ricId=ricId, serviceId=serviceId, typeName=typeName)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling A1PolicyManagementApi->getPolicyInstances: %s\n" % e)
extern crate A1PolicyManagementApi;

pub fn main() {
    let policytypeId = policytypeId_example; // String
    let ricId = ricId_example; // String
    let serviceId = serviceId_example; // String
    let typeName = typeName_example; // String

    let mut context = A1PolicyManagementApi::Context::default();
    let result = client.getPolicyInstances(policytypeId, ricId, serviceId, typeName, &context).wait();

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

Scopes

Parameters

Query parameters
Name Description
policytype_id
String
Select policies with a given type identity.
ric_id
String
Select policies for a given Near-RT RIC identity.
service_id
String
Select policies owned by a given service.
type_name
String
Select policies of a given type name (type identity has the format <typename_version>)

Responses


getPolicyStatus

Returns a policy status


/a1-policy/v2/policies/{policy_id}/status

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost/a1-policy/v2/policies/{policy_id}/status"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.A1PolicyManagementApi;

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

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

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

        try {
            policy_status_info_v2 result = apiInstance.getPolicyStatus(policyId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling A1PolicyManagementApi#getPolicyStatus");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.A1PolicyManagementApi;

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

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


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

// Returns a policy status
[apiInstance getPolicyStatusWith:policyId
              completionHandler: ^(policy_status_info_v2 output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var A1PolicyManagementService = require('a1_policy_management_service');

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

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

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

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

            try {
                // Returns a policy status
                policy_status_info_v2 result = apiInstance.getPolicyStatus(policyId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling A1PolicyManagementApi.getPolicyStatus: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

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

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

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

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

try:
    # Returns a policy status
    api_response = api_instance.get_policy_status(policyId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling A1PolicyManagementApi->getPolicyStatus: %s\n" % e)
extern crate A1PolicyManagementApi;

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

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

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

Scopes

Parameters

Path parameters
Name Description
policy_id*
String
Required

Responses


getPolicyType

Returns a policy type definition


/a1-policy/v2/policy-types/{policytype_id}

Usage and SDK Samples

curl -X GET \
 -H "Accept: */*" \
 "http://localhost/a1-policy/v2/policy-types/{policytype_id}"
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 | 

        try {
            policytype_v2 result = apiInstance.getPolicyType(policytypeId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling A1PolicyManagementApi#getPolicyType");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.A1PolicyManagementApi;

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

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


// Create an instance of the API class
A1PolicyManagementApi *apiInstance = [[A1PolicyManagementApi alloc] init];
String *policytypeId = policytypeId_example; //  (default to null)

// Returns a policy type definition
[apiInstance getPolicyTypeWith:policytypeId
              completionHandler: ^(policytype_v2 output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var A1PolicyManagementService = require('a1_policy_management_service');

// Create an instance of the API class
var api = new A1PolicyManagementService.A1PolicyManagementApi()
var policytypeId = policytypeId_example; // {String} 

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

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

            // Create an instance of the API class
            var apiInstance = new A1PolicyManagementApi();
            var policytypeId = policytypeId_example;  // String |  (default to null)

            try {
                // Returns a policy type definition
                policytype_v2 result = apiInstance.getPolicyType(policytypeId);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling A1PolicyManagementApi.getPolicyType: " + 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 | 

try {
    $result = $api_instance->getPolicyType($policytypeId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling A1PolicyManagementApi->getPolicyType: ', $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 | 

eval {
    my $result = $api_instance->getPolicyType(policytypeId => $policytypeId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling A1PolicyManagementApi->getPolicyType: $@\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)

try:
    # Returns a policy type definition
    api_response = api_instance.get_policy_type(policytypeId)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling A1PolicyManagementApi->getPolicyType: %s\n" % e)
extern crate A1PolicyManagementApi;

pub fn main() {
    let policytypeId = policytypeId_example; // String

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

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

Scopes

Parameters

Path parameters
Name Description
policytype_id*
String
Required

Responses


getPolicyTypes

Query policy type identities


/a1-policy/v2/policy-types

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost/a1-policy/v2/policy-types?ric_id=ricId_example&type_name=typeName_example&compatible_with_version=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 ricId = ricId_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.

        try {
            policytype_id_list_v2 result = apiInstance.getPolicyTypes(ricId, typeName, compatibleWithVersion);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling A1PolicyManagementApi#getPolicyTypes");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.A1PolicyManagementApi;

public class A1PolicyManagementApiExample {
    public static void main(String[] args) {
        A1PolicyManagementApi apiInstance = new A1PolicyManagementApi();
        String ricId = ricId_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.

        try {
            policytype_id_list_v2 result = apiInstance.getPolicyTypes(ricId, typeName, compatibleWithVersion);
            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 *ricId = ricId_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)

// Query policy type identities
[apiInstance getPolicyTypesWith:ricId
    typeName:typeName
    compatibleWithVersion:compatibleWithVersion
              completionHandler: ^(policytype_id_list_v2 output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var A1PolicyManagementService = require('a1_policy_management_service');

// Create an instance of the API class
var api = new A1PolicyManagementService.A1PolicyManagementApi()
var opts = {
  'ricId': ricId_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.
};

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 ricId = ricId_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)

            try {
                // Query policy type identities
                policytype_id_list_v2 result = apiInstance.getPolicyTypes(ricId, typeName, compatibleWithVersion);
                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();
$ricId = ricId_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.

try {
    $result = $api_instance->getPolicyTypes($ricId, $typeName, $compatibleWithVersion);
    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 $ricId = ricId_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.

eval {
    my $result = $api_instance->getPolicyTypes(ricId => $ricId, typeName => $typeName, compatibleWithVersion => $compatibleWithVersion);
    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()
ricId = ricId_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)

try:
    # Query policy type identities
    api_response = api_instance.get_policy_types(ricId=ricId, typeName=typeName, compatibleWithVersion=compatibleWithVersion)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling A1PolicyManagementApi->getPolicyTypes: %s\n" % e)
extern crate A1PolicyManagementApi;

pub fn main() {
    let ricId = ricId_example; // String
    let typeName = typeName_example; // String
    let compatibleWithVersion = compatibleWithVersion_example; // String

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

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

Scopes

Parameters

Query parameters
Name Description
ric_id
String
Select types for the given Near-RT RIC identity.
type_name
String
Select types with the given type name (type identity has the format <typename_version>)
compatible_with_version
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

Create or update a policy


/a1-policy/v2/policies

Usage and SDK Samples

curl -X PUT \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://localhost/a1-policy/v2/policies" \
 -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();
        PolicyInfoV2 policyInfoV2 = ; // PolicyInfoV2 | 

        try {
            Object result = apiInstance.putPolicy(policyInfoV2);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling A1PolicyManagementApi#putPolicy");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.A1PolicyManagementApi;

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

        try {
            Object result = apiInstance.putPolicy(policyInfoV2);
            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];
PolicyInfoV2 *policyInfoV2 = ; // 

// Create or update a policy
[apiInstance putPolicyWith:policyInfoV2
              completionHandler: ^(Object output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var A1PolicyManagementService = require('a1_policy_management_service');

// Create an instance of the API class
var api = new A1PolicyManagementService.A1PolicyManagementApi()
var policyInfoV2 = ; // {PolicyInfoV2} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.putPolicy(policyInfoV2, 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 policyInfoV2 = new PolicyInfoV2(); // PolicyInfoV2 | 

            try {
                // Create or update a policy
                Object result = apiInstance.putPolicy(policyInfoV2);
                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();
$policyInfoV2 = ; // PolicyInfoV2 | 

try {
    $result = $api_instance->putPolicy($policyInfoV2);
    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 $policyInfoV2 = WWW::OPenAPIClient::Object::PolicyInfoV2->new(); # PolicyInfoV2 | 

eval {
    my $result = $api_instance->putPolicy(policyInfoV2 => $policyInfoV2);
    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()
policyInfoV2 =  # PolicyInfoV2 | 

try:
    # Create or update a policy
    api_response = api_instance.put_policy(policyInfoV2)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling A1PolicyManagementApi->putPolicy: %s\n" % e)
extern crate A1PolicyManagementApi;

pub fn main() {
    let policyInfoV2 = ; // PolicyInfoV2

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

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

Scopes

Parameters

Body parameters
Name Description
policyInfoV2 *

Responses


Actuator

health

Actuator web endpoint 'health'


/actuator/health

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/vnd.spring-boot.actuator.v3+json,application/json,application/vnd.spring-boot.actuator.v2+json" \
 "http://localhost/actuator/health"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ActuatorApi;

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

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

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

        try {
            Object result = apiInstance.health();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ActuatorApi#health");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ActuatorApi;

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

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


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

// Actuator web endpoint 'health'
[apiInstance healthWithCompletionHandler: 
              ^(Object output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var A1PolicyManagementService = require('a1_policy_management_service');

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

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

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

            try {
                // Actuator web endpoint 'health'
                Object result = apiInstance.health();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ActuatorApi.health: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

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

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

eval {
    my $result = $api_instance->health();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ActuatorApi->health: $@\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.ActuatorApi()

try:
    # Actuator web endpoint 'health'
    api_response = api_instance.health()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ActuatorApi->health: %s\n" % e)
extern crate ActuatorApi;

pub fn main() {

    let mut context = ActuatorApi::Context::default();
    let result = client.health(&context).wait();

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

Scopes

Parameters

Responses


healthPath

Actuator web endpoint 'health-path'


/actuator/health/**

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/vnd.spring-boot.actuator.v3+json,application/json,application/vnd.spring-boot.actuator.v2+json" \
 "http://localhost/actuator/health/**"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ActuatorApi;

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

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

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

        try {
            Object result = apiInstance.healthPath();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ActuatorApi#healthPath");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ActuatorApi;

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

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


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

// Actuator web endpoint 'health-path'
[apiInstance healthPathWithCompletionHandler: 
              ^(Object output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var A1PolicyManagementService = require('a1_policy_management_service');

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

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

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

            try {
                // Actuator web endpoint 'health-path'
                Object result = apiInstance.healthPath();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ActuatorApi.healthPath: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

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

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

eval {
    my $result = $api_instance->healthPath();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ActuatorApi->healthPath: $@\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.ActuatorApi()

try:
    # Actuator web endpoint 'health-path'
    api_response = api_instance.health_path()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ActuatorApi->healthPath: %s\n" % e)
extern crate ActuatorApi;

pub fn main() {

    let mut context = ActuatorApi::Context::default();
    let result = client.healthPath(&context).wait();

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

Scopes

Parameters

Responses


heapdump

Actuator web endpoint 'heapdump'


/actuator/heapdump

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/octet-stream" \
 "http://localhost/actuator/heapdump"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ActuatorApi;

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

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

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

        try {
            Object result = apiInstance.heapdump();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ActuatorApi#heapdump");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ActuatorApi;

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

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


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

// Actuator web endpoint 'heapdump'
[apiInstance heapdumpWithCompletionHandler: 
              ^(Object output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var A1PolicyManagementService = require('a1_policy_management_service');

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

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

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

            try {
                // Actuator web endpoint 'heapdump'
                Object result = apiInstance.heapdump();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ActuatorApi.heapdump: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

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

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

eval {
    my $result = $api_instance->heapdump();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ActuatorApi->heapdump: $@\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.ActuatorApi()

try:
    # Actuator web endpoint 'heapdump'
    api_response = api_instance.heapdump()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ActuatorApi->heapdump: %s\n" % e)
extern crate ActuatorApi;

pub fn main() {

    let mut context = ActuatorApi::Context::default();
    let result = client.heapdump(&context).wait();

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

Scopes

Parameters

Responses


info

Actuator web endpoint 'info'


/actuator/info

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/vnd.spring-boot.actuator.v3+json,application/json,application/vnd.spring-boot.actuator.v2+json" \
 "http://localhost/actuator/info"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ActuatorApi;

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

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

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

        try {
            Object result = apiInstance.info();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ActuatorApi#info");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ActuatorApi;

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

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


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

// Actuator web endpoint 'info'
[apiInstance infoWithCompletionHandler: 
              ^(Object output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var A1PolicyManagementService = require('a1_policy_management_service');

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

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

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

            try {
                // Actuator web endpoint 'info'
                Object result = apiInstance.info();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ActuatorApi.info: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

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

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

eval {
    my $result = $api_instance->info();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ActuatorApi->info: $@\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.ActuatorApi()

try:
    # Actuator web endpoint 'info'
    api_response = api_instance.info()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ActuatorApi->info: %s\n" % e)
extern crate ActuatorApi;

pub fn main() {

    let mut context = ActuatorApi::Context::default();
    let result = client.info(&context).wait();

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

Scopes

Parameters

Responses



logfile

Actuator web endpoint 'logfile'


/actuator/logfile

Usage and SDK Samples

curl -X GET \
 -H "Accept: text/plain;charset=UTF-8" \
 "http://localhost/actuator/logfile"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ActuatorApi;

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

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

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

        try {
            Object result = apiInstance.logfile();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ActuatorApi#logfile");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ActuatorApi;

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

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


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

// Actuator web endpoint 'logfile'
[apiInstance logfileWithCompletionHandler: 
              ^(Object output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var A1PolicyManagementService = require('a1_policy_management_service');

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

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

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

            try {
                // Actuator web endpoint 'logfile'
                Object result = apiInstance.logfile();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ActuatorApi.logfile: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

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

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

eval {
    my $result = $api_instance->logfile();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ActuatorApi->logfile: $@\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.ActuatorApi()

try:
    # Actuator web endpoint 'logfile'
    api_response = api_instance.logfile()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ActuatorApi->logfile: %s\n" % e)
extern crate ActuatorApi;

pub fn main() {

    let mut context = ActuatorApi::Context::default();
    let result = client.logfile(&context).wait();

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

Scopes

Parameters

Responses


loggers

Actuator web endpoint 'loggers'


/actuator/loggers

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/vnd.spring-boot.actuator.v3+json,application/json,application/vnd.spring-boot.actuator.v2+json" \
 "http://localhost/actuator/loggers"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ActuatorApi;

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

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

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

        try {
            Object result = apiInstance.loggers();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ActuatorApi#loggers");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ActuatorApi;

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

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


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

// Actuator web endpoint 'loggers'
[apiInstance loggersWithCompletionHandler: 
              ^(Object output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var A1PolicyManagementService = require('a1_policy_management_service');

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

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

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

            try {
                // Actuator web endpoint 'loggers'
                Object result = apiInstance.loggers();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ActuatorApi.loggers: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

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

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

eval {
    my $result = $api_instance->loggers();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ActuatorApi->loggers: $@\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.ActuatorApi()

try:
    # Actuator web endpoint 'loggers'
    api_response = api_instance.loggers()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ActuatorApi->loggers: %s\n" % e)
extern crate ActuatorApi;

pub fn main() {

    let mut context = ActuatorApi::Context::default();
    let result = client.loggers(&context).wait();

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

Scopes

Parameters

Responses


loggersName

Actuator web endpoint 'loggers-name'


/actuator/loggers/{name}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/vnd.spring-boot.actuator.v3+json,application/json,application/vnd.spring-boot.actuator.v2+json" \
 "http://localhost/actuator/loggers/{name}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ActuatorApi;

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

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

        // Create an instance of the API class
        ActuatorApi apiInstance = new ActuatorApi();
        String name = name_example; // String | 

        try {
            Object result = apiInstance.loggersName(name);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ActuatorApi#loggersName");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ActuatorApi;

public class ActuatorApiExample {
    public static void main(String[] args) {
        ActuatorApi apiInstance = new ActuatorApi();
        String name = name_example; // String | 

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


// Create an instance of the API class
ActuatorApi *apiInstance = [[ActuatorApi alloc] init];
String *name = name_example; //  (default to null)

// Actuator web endpoint 'loggers-name'
[apiInstance loggersNameWith:name
              completionHandler: ^(Object output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var A1PolicyManagementService = require('a1_policy_management_service');

// Create an instance of the API class
var api = new A1PolicyManagementService.ActuatorApi()
var name = name_example; // {String} 

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

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

            // Create an instance of the API class
            var apiInstance = new ActuatorApi();
            var name = name_example;  // String |  (default to null)

            try {
                // Actuator web endpoint 'loggers-name'
                Object result = apiInstance.loggersName(name);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ActuatorApi.loggersName: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ActuatorApi();
$name = name_example; // String | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ActuatorApi->new();
my $name = name_example; # String | 

eval {
    my $result = $api_instance->loggersName(name => $name);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ActuatorApi->loggersName: $@\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.ActuatorApi()
name = name_example # String |  (default to null)

try:
    # Actuator web endpoint 'loggers-name'
    api_response = api_instance.loggers_name(name)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ActuatorApi->loggersName: %s\n" % e)
extern crate ActuatorApi;

pub fn main() {
    let name = name_example; // String

    let mut context = ActuatorApi::Context::default();
    let result = client.loggersName(name, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
name*
String
Required

Responses


loggersName2

Actuator web endpoint 'loggers-name'


/actuator/loggers/{name}

Usage and SDK Samples

curl -X POST \
 -H "Accept: */*" \
 -H "Content-Type: application/json" \
 "http://localhost/actuator/loggers/{name}" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ActuatorApi;

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

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

        // Create an instance of the API class
        ActuatorApi apiInstance = new ActuatorApi();
        String name = name_example; // String | 
        String body = body_example; // String | 

        try {
            Object result = apiInstance.loggersName2(name, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ActuatorApi#loggersName2");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ActuatorApi;

public class ActuatorApiExample {
    public static void main(String[] args) {
        ActuatorApi apiInstance = new ActuatorApi();
        String name = name_example; // String | 
        String body = body_example; // String | 

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


// Create an instance of the API class
ActuatorApi *apiInstance = [[ActuatorApi alloc] init];
String *name = name_example; //  (default to null)
String *body = body_example; //  (optional)

// Actuator web endpoint 'loggers-name'
[apiInstance loggersName2With:name
    body:body
              completionHandler: ^(Object output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var A1PolicyManagementService = require('a1_policy_management_service');

// Create an instance of the API class
var api = new A1PolicyManagementService.ActuatorApi()
var name = name_example; // {String} 
var opts = {
  'body': body_example // {String} 
};

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

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

            // Create an instance of the API class
            var apiInstance = new ActuatorApi();
            var name = name_example;  // String |  (default to null)
            var body = body_example;  // String |  (optional) 

            try {
                // Actuator web endpoint 'loggers-name'
                Object result = apiInstance.loggersName2(name, body);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ActuatorApi.loggersName2: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ActuatorApi();
$name = name_example; // String | 
$body = body_example; // String | 

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

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

eval {
    my $result = $api_instance->loggersName2(name => $name, body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ActuatorApi->loggersName2: $@\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.ActuatorApi()
name = name_example # String |  (default to null)
body = body_example # String |  (optional)

try:
    # Actuator web endpoint 'loggers-name'
    api_response = api_instance.loggers_name2(name, body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ActuatorApi->loggersName2: %s\n" % e)
extern crate ActuatorApi;

pub fn main() {
    let name = name_example; // String
    let body = body_example; // String

    let mut context = ActuatorApi::Context::default();
    let result = client.loggersName2(name, body, &context).wait();

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

Scopes

Parameters

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

Responses


metrics

Actuator web endpoint 'metrics'


/actuator/metrics

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/vnd.spring-boot.actuator.v3+json,application/json,application/vnd.spring-boot.actuator.v2+json" \
 "http://localhost/actuator/metrics"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ActuatorApi;

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

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

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

        try {
            Object result = apiInstance.metrics();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ActuatorApi#metrics");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ActuatorApi;

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

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


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

// Actuator web endpoint 'metrics'
[apiInstance metricsWithCompletionHandler: 
              ^(Object output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var A1PolicyManagementService = require('a1_policy_management_service');

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

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

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

            try {
                // Actuator web endpoint 'metrics'
                Object result = apiInstance.metrics();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ActuatorApi.metrics: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

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

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

eval {
    my $result = $api_instance->metrics();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ActuatorApi->metrics: $@\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.ActuatorApi()

try:
    # Actuator web endpoint 'metrics'
    api_response = api_instance.metrics()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ActuatorApi->metrics: %s\n" % e)
extern crate ActuatorApi;

pub fn main() {

    let mut context = ActuatorApi::Context::default();
    let result = client.metrics(&context).wait();

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

Scopes

Parameters

Responses


metricsRequiredMetricName

Actuator web endpoint 'metrics-requiredMetricName'


/actuator/metrics/{requiredMetricName}

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/vnd.spring-boot.actuator.v3+json,application/json,application/vnd.spring-boot.actuator.v2+json" \
 "http://localhost/actuator/metrics/{requiredMetricName}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ActuatorApi;

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

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

        // Create an instance of the API class
        ActuatorApi apiInstance = new ActuatorApi();
        String requiredMetricName = requiredMetricName_example; // String | 

        try {
            Object result = apiInstance.metricsRequiredMetricName(requiredMetricName);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ActuatorApi#metricsRequiredMetricName");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ActuatorApi;

public class ActuatorApiExample {
    public static void main(String[] args) {
        ActuatorApi apiInstance = new ActuatorApi();
        String requiredMetricName = requiredMetricName_example; // String | 

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


// Create an instance of the API class
ActuatorApi *apiInstance = [[ActuatorApi alloc] init];
String *requiredMetricName = requiredMetricName_example; //  (default to null)

// Actuator web endpoint 'metrics-requiredMetricName'
[apiInstance metricsRequiredMetricNameWith:requiredMetricName
              completionHandler: ^(Object output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var A1PolicyManagementService = require('a1_policy_management_service');

// Create an instance of the API class
var api = new A1PolicyManagementService.ActuatorApi()
var requiredMetricName = requiredMetricName_example; // {String} 

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

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

            // Create an instance of the API class
            var apiInstance = new ActuatorApi();
            var requiredMetricName = requiredMetricName_example;  // String |  (default to null)

            try {
                // Actuator web endpoint 'metrics-requiredMetricName'
                Object result = apiInstance.metricsRequiredMetricName(requiredMetricName);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ActuatorApi.metricsRequiredMetricName: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ActuatorApi();
$requiredMetricName = requiredMetricName_example; // String | 

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ActuatorApi->new();
my $requiredMetricName = requiredMetricName_example; # String | 

eval {
    my $result = $api_instance->metricsRequiredMetricName(requiredMetricName => $requiredMetricName);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ActuatorApi->metricsRequiredMetricName: $@\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.ActuatorApi()
requiredMetricName = requiredMetricName_example # String |  (default to null)

try:
    # Actuator web endpoint 'metrics-requiredMetricName'
    api_response = api_instance.metrics_required_metric_name(requiredMetricName)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ActuatorApi->metricsRequiredMetricName: %s\n" % e)
extern crate ActuatorApi;

pub fn main() {
    let requiredMetricName = requiredMetricName_example; // String

    let mut context = ActuatorApi::Context::default();
    let result = client.metricsRequiredMetricName(requiredMetricName, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
requiredMetricName*
String
Required

Responses


shutdown

Actuator web endpoint 'shutdown'


/actuator/shutdown

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/vnd.spring-boot.actuator.v3+json,application/json,application/vnd.spring-boot.actuator.v2+json" \
 "http://localhost/actuator/shutdown"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ActuatorApi;

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

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

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

        try {
            Object result = apiInstance.shutdown();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ActuatorApi#shutdown");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ActuatorApi;

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

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


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

// Actuator web endpoint 'shutdown'
[apiInstance shutdownWithCompletionHandler: 
              ^(Object output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var A1PolicyManagementService = require('a1_policy_management_service');

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

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

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

            try {
                // Actuator web endpoint 'shutdown'
                Object result = apiInstance.shutdown();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ActuatorApi.shutdown: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

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

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

eval {
    my $result = $api_instance->shutdown();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ActuatorApi->shutdown: $@\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.ActuatorApi()

try:
    # Actuator web endpoint 'shutdown'
    api_response = api_instance.shutdown()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ActuatorApi->shutdown: %s\n" % e)
extern crate ActuatorApi;

pub fn main() {

    let mut context = ActuatorApi::Context::default();
    let result = client.shutdown(&context).wait();

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

Scopes

Parameters

Responses


threaddump

Actuator web endpoint 'threaddump'


/actuator/threaddump

Usage and SDK Samples

curl -X GET \
 -H "Accept: text/plain;charset=UTF-8,application/vnd.spring-boot.actuator.v3+json,application/json,application/vnd.spring-boot.actuator.v2+json" \
 "http://localhost/actuator/threaddump"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ActuatorApi;

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

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

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

        try {
            Object result = apiInstance.threaddump();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ActuatorApi#threaddump");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ActuatorApi;

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

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


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

// Actuator web endpoint 'threaddump'
[apiInstance threaddumpWithCompletionHandler: 
              ^(Object output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var A1PolicyManagementService = require('a1_policy_management_service');

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

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

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

            try {
                // Actuator web endpoint 'threaddump'
                Object result = apiInstance.threaddump();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ActuatorApi.threaddump: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

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

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

eval {
    my $result = $api_instance->threaddump();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ActuatorApi->threaddump: $@\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.ActuatorApi()

try:
    # Actuator web endpoint 'threaddump'
    api_response = api_instance.threaddump()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ActuatorApi->threaddump: %s\n" % e)
extern crate ActuatorApi;

pub fn main() {

    let mut context = ActuatorApi::Context::default();
    let result = client.threaddump(&context).wait();

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

Scopes

Parameters

Responses


AuthorizationAPI

performAccessControl

Request for access authorization.

The authorization function decides if access is granted.


/example-authz-check

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://localhost/example-authz-check" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AuthorizationAPIApi;

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

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

        // Create an instance of the API class
        AuthorizationAPIApi apiInstance = new AuthorizationAPIApi();
        PolicyAuthorization policyAuthorization = ; // PolicyAuthorization | 

        try {
            authorization_result result = apiInstance.performAccessControl(policyAuthorization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthorizationAPIApi#performAccessControl");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.AuthorizationAPIApi;

public class AuthorizationAPIApiExample {
    public static void main(String[] args) {
        AuthorizationAPIApi apiInstance = new AuthorizationAPIApi();
        PolicyAuthorization policyAuthorization = ; // PolicyAuthorization | 

        try {
            authorization_result result = apiInstance.performAccessControl(policyAuthorization);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuthorizationAPIApi#performAccessControl");
            e.printStackTrace();
        }
    }
}


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

// Request for access authorization.
[apiInstance performAccessControlWith:policyAuthorization
              completionHandler: ^(authorization_result output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var A1PolicyManagementService = require('a1_policy_management_service');

// Create an instance of the API class
var api = new A1PolicyManagementService.AuthorizationAPIApi()
var policyAuthorization = ; // {PolicyAuthorization} 

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

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

            // Create an instance of the API class
            var apiInstance = new AuthorizationAPIApi();
            var policyAuthorization = new PolicyAuthorization(); // PolicyAuthorization | 

            try {
                // Request for access authorization.
                authorization_result result = apiInstance.performAccessControl(policyAuthorization);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling AuthorizationAPIApi.performAccessControl: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\AuthorizationAPIApi();
$policyAuthorization = ; // PolicyAuthorization | 

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

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

eval {
    my $result = $api_instance->performAccessControl(policyAuthorization => $policyAuthorization);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AuthorizationAPIApi->performAccessControl: $@\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.AuthorizationAPIApi()
policyAuthorization =  # PolicyAuthorization | 

try:
    # Request for access authorization.
    api_response = api_instance.perform_access_control(policyAuthorization)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AuthorizationAPIApi->performAccessControl: %s\n" % e)
extern crate AuthorizationAPIApi;

pub fn main() {
    let policyAuthorization = ; // PolicyAuthorization

    let mut context = AuthorizationAPIApi::Context::default();
    let result = client.performAccessControl(policyAuthorization, &context).wait();

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

Scopes

Parameters

Body parameters
Name Description
policyAuthorization *

Responses


HealthCheck

getStatus

Returns status and statistics of this service


/a1-policy/v2/status

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost/a1-policy/v2/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 {
            status_info_v2 result = apiInstance.getStatus();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling HealthCheckApi#getStatus");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.HealthCheckApi;

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

        try {
            status_info_v2 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];

// Returns status and statistics of this service
[apiInstance getStatusWithCompletionHandler: 
              ^(status_info_v2 output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var A1PolicyManagementService = require('a1_policy_management_service');

// Create an instance of the API class
var api = new A1PolicyManagementService.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 {
                // Returns status and statistics of this service
                status_info_v2 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:
    # Returns status and statistics of this service
    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


getStatusV1

Returns status and statistics of this service


/status

Usage and SDK Samples

curl -X GET \
 -H "Accept: */*" \
 "http://localhost/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 {
            'String' result = apiInstance.getStatusV1();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling HealthCheckApi#getStatusV1");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.HealthCheckApi;

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

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


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

// Returns status and statistics of this service
[apiInstance getStatusV1WithCompletionHandler: 
              ^('String' output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var A1PolicyManagementService = require('a1_policy_management_service');

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

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

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

            try {
                // Returns status and statistics of this service
                'String' result = apiInstance.getStatusV1();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling HealthCheckApi.getStatusV1: " + 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->getStatusV1();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling HealthCheckApi->getStatusV1: ', $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->getStatusV1();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling HealthCheckApi->getStatusV1: $@\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:
    # Returns status and statistics of this service
    api_response = api_instance.get_status_v1()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling HealthCheckApi->getStatusV1: %s\n" % e)
extern crate HealthCheckApi;

pub fn main() {

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

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

Scopes

Parameters

Responses


ManagementOfConfiguration

getConfiguration

Returns the contents of the application configuration file


/a1-policy/v2/configuration

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost/a1-policy/v2/configuration"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ManagementOfConfigurationApi;

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

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

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

        try {
            Object result = apiInstance.getConfiguration();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ManagementOfConfigurationApi#getConfiguration");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ManagementOfConfigurationApi;

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

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


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

// Returns the contents of the application configuration file
[apiInstance getConfigurationWithCompletionHandler: 
              ^(Object output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var A1PolicyManagementService = require('a1_policy_management_service');

// Create an instance of the API class
var api = new A1PolicyManagementService.ManagementOfConfigurationApi()
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 ManagementOfConfigurationApi();

            try {
                // Returns the contents of the application configuration file
                Object result = apiInstance.getConfiguration();
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ManagementOfConfigurationApi.getConfiguration: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

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

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

eval {
    my $result = $api_instance->getConfiguration();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ManagementOfConfigurationApi->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.ManagementOfConfigurationApi()

try:
    # Returns the contents of the application configuration file
    api_response = api_instance.get_configuration()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ManagementOfConfigurationApi->getConfiguration: %s\n" % e)
extern crate ManagementOfConfigurationApi;

pub fn main() {

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

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

Scopes

Parameters

Responses


putConfiguration

Replace the current configuration file with the given configuration


/a1-policy/v2/configuration

Usage and SDK Samples

curl -X PUT \
 -H "Accept: */*" \
 -H "Content-Type: application/json" \
 "http://localhost/a1-policy/v2/configuration" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ManagementOfConfigurationApi;

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

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

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

        try {
            Object result = apiInstance.putConfiguration(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ManagementOfConfigurationApi#putConfiguration");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ManagementOfConfigurationApi;

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

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


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

// Replace the current configuration file with the given configuration
[apiInstance putConfigurationWith:body
              completionHandler: ^(Object output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var A1PolicyManagementService = require('a1_policy_management_service');

// Create an instance of the API class
var api = new A1PolicyManagementService.ManagementOfConfigurationApi()
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 ManagementOfConfigurationApi();
            var body = Object;  // Object | 

            try {
                // Replace the current configuration file with the given configuration
                Object result = apiInstance.putConfiguration(body);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ManagementOfConfigurationApi.putConfiguration: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

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

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

# Create an instance of the API class
my $api_instance = WWW::OPenAPIClient::ManagementOfConfigurationApi->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 ManagementOfConfigurationApi->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.ManagementOfConfigurationApi()
body = Object # Object | 

try:
    # Replace the current configuration file with the given configuration
    api_response = api_instance.put_configuration(body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ManagementOfConfigurationApi->putConfiguration: %s\n" % e)
extern crate ManagementOfConfigurationApi;

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

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

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

Scopes

Parameters

Body parameters
Name Description
body *

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).


/a1-policy/v2/rics/ric

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost/a1-policy/v2/rics/ric?managed_element_id=managedElementId_example&ric_id=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.

        try {
            ric_info_v2 result = apiInstance.getRic(managedElementId, ricId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NearRTRICRepositoryApi#getRic");
            e.printStackTrace();
        }
    }
}
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.

        try {
            ric_info_v2 result = apiInstance.getRic(managedElementId, ricId);
            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)

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

// Create an instance of the API class
var api = new A1PolicyManagementService.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.
};

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)

            try {
                // Returns info for one Near-RT RIC
                ric_info_v2 result = apiInstance.getRic(managedElementId, ricId);
                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.

try {
    $result = $api_instance->getRic($managedElementId, $ricId);
    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.

eval {
    my $result = $api_instance->getRic(managedElementId => $managedElementId, ricId => $ricId);
    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)

try:
    # Returns info for one Near-RT RIC
    api_response = api_instance.get_ric(managedElementId=managedElementId, ricId=ricId)
    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 mut context = NearRTRICRepositoryApi::Context::default();
    let result = client.getRic(managedElementId, ricId, &context).wait();

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

Scopes

Parameters

Query parameters
Name Description
managed_element_id
String
The identity of a Managed Element. If given, the Near-RT RIC managing the ME is returned.
ric_id
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


/a1-policy/v2/rics

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost/a1-policy/v2/rics?policytype_id=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

        try {
            ric_info_list_v2 result = apiInstance.getRics(policytypeId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NearRTRICRepositoryApi#getRics");
            e.printStackTrace();
        }
    }
}
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

        try {
            ric_info_list_v2 result = apiInstance.getRics(policytypeId);
            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)

// Query Near-RT RIC information
[apiInstance getRicsWith:policytypeId
              completionHandler: ^(ric_info_list_v2 output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var A1PolicyManagementService = require('a1_policy_management_service');

// Create an instance of the API class
var api = new A1PolicyManagementService.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
};

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)

            try {
                // Query Near-RT RIC information
                ric_info_list_v2 result = apiInstance.getRics(policytypeId);
                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

try {
    $result = $api_instance->getRics($policytypeId);
    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

eval {
    my $result = $api_instance->getRics(policytypeId => $policytypeId);
    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)

try:
    # Query Near-RT RIC information
    api_response = api_instance.get_rics(policytypeId=policytypeId)
    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 mut context = NearRTRICRepositoryApi::Context::default();
    let result = client.getRics(policytypeId, &context).wait();

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

Scopes

Parameters

Query parameters
Name Description
policytype_id
String
The identity of a policy type. If given, all Near-RT RICs supporting the policy type are returned

Responses


ServiceCallbacks

serviceCallback

Callback for Near-RT RIC status

The URL to this call is registered at Service registration.


/r-app/near-rt-ric-status

Usage and SDK Samples

curl -X POST \
 -H "Accept: application/json" \
 -H "Content-Type: application/json" \
 "http://localhost/r-app/near-rt-ric-status" \
 -d ''
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ServiceCallbacksApi;

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

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

        // Create an instance of the API class
        ServiceCallbacksApi apiInstance = new ServiceCallbacksApi();
        ServiceCallbackInfoV2 serviceCallbackInfoV2 = ; // ServiceCallbackInfoV2 | 

        try {
            Object result = apiInstance.serviceCallback(serviceCallbackInfoV2);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ServiceCallbacksApi#serviceCallback");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ServiceCallbacksApi;

public class ServiceCallbacksApiExample {
    public static void main(String[] args) {
        ServiceCallbacksApi apiInstance = new ServiceCallbacksApi();
        ServiceCallbackInfoV2 serviceCallbackInfoV2 = ; // ServiceCallbackInfoV2 | 

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


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

// Callback for Near-RT RIC status
[apiInstance serviceCallbackWith:serviceCallbackInfoV2
              completionHandler: ^(Object output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var A1PolicyManagementService = require('a1_policy_management_service');

// Create an instance of the API class
var api = new A1PolicyManagementService.ServiceCallbacksApi()
var serviceCallbackInfoV2 = ; // {ServiceCallbackInfoV2} 

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

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

            // Create an instance of the API class
            var apiInstance = new ServiceCallbacksApi();
            var serviceCallbackInfoV2 = new ServiceCallbackInfoV2(); // ServiceCallbackInfoV2 | 

            try {
                // Callback for Near-RT RIC status
                Object result = apiInstance.serviceCallback(serviceCallbackInfoV2);
                Debug.WriteLine(result);
            } catch (Exception e) {
                Debug.Print("Exception when calling ServiceCallbacksApi.serviceCallback: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Create an instance of the API class
$api_instance = new OpenAPITools\Client\Api\ServiceCallbacksApi();
$serviceCallbackInfoV2 = ; // ServiceCallbackInfoV2 | 

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

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

eval {
    my $result = $api_instance->serviceCallback(serviceCallbackInfoV2 => $serviceCallbackInfoV2);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ServiceCallbacksApi->serviceCallback: $@\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.ServiceCallbacksApi()
serviceCallbackInfoV2 =  # ServiceCallbackInfoV2 | 

try:
    # Callback for Near-RT RIC status
    api_response = api_instance.service_callback(serviceCallbackInfoV2)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ServiceCallbacksApi->serviceCallback: %s\n" % e)
extern crate ServiceCallbacksApi;

pub fn main() {
    let serviceCallbackInfoV2 = ; // ServiceCallbackInfoV2

    let mut context = ServiceCallbacksApi::Context::default();
    let result = client.serviceCallback(serviceCallbackInfoV2, &context).wait();

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

Scopes

Parameters

Body parameters
Name Description
serviceCallbackInfoV2 *

Responses


ServiceRegistryAndSupervision

deleteService

Unregister a service


/a1-policy/v2/services/{service_id}

Usage and SDK Samples

curl -X DELETE \
 -H "Accept: */*" \
 "http://localhost/a1-policy/v2/services/{service_id}"
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 | 

        try {
            Object result = apiInstance.deleteService(serviceId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ServiceRegistryAndSupervisionApi#deleteService");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ServiceRegistryAndSupervisionApi;

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

        try {
            Object result = apiInstance.deleteService(serviceId);
            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)

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

// Create an instance of the API class
var api = new A1PolicyManagementService.ServiceRegistryAndSupervisionApi()
var serviceId = serviceId_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteService(serviceId, 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)

            try {
                // Unregister a service
                Object result = apiInstance.deleteService(serviceId);
                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 | 

try {
    $result = $api_instance->deleteService($serviceId);
    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 | 

eval {
    my $result = $api_instance->deleteService(serviceId => $serviceId);
    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)

try:
    # Unregister a service
    api_response = api_instance.delete_service(serviceId)
    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 mut context = ServiceRegistryAndSupervisionApi::Context::default();
    let result = client.deleteService(serviceId, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
service_id*
String
Required

Responses


getServices

Returns service information

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


/a1-policy/v2/services

Usage and SDK Samples

curl -X GET \
 -H "Accept: application/json" \
 "http://localhost/a1-policy/v2/services?service_id=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

        try {
            service_list_v2 result = apiInstance.getServices(serviceId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ServiceRegistryAndSupervisionApi#getServices");
            e.printStackTrace();
        }
    }
}
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

        try {
            service_list_v2 result = apiInstance.getServices(serviceId);
            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)

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

// Create an instance of the API class
var api = new A1PolicyManagementService.ServiceRegistryAndSupervisionApi()
var opts = {
  'serviceId': serviceId_example // {String} The identity of the service
};

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)

            try {
                // Returns service information
                service_list_v2 result = apiInstance.getServices(serviceId);
                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

try {
    $result = $api_instance->getServices($serviceId);
    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

eval {
    my $result = $api_instance->getServices(serviceId => $serviceId);
    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)

try:
    # Returns service information
    api_response = api_instance.get_services(serviceId=serviceId)
    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 mut context = ServiceRegistryAndSupervisionApi::Context::default();
    let result = client.getServices(serviceId, &context).wait();

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

Scopes

Parameters

Query parameters
Name Description
service_id
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)


/a1-policy/v2/services/{service_id}/keepalive

Usage and SDK Samples

curl -X PUT \
 -H "Accept: */*" \
 "http://localhost/a1-policy/v2/services/{service_id}/keepalive"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.ServiceRegistryAndSupervisionApi;

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

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

        // Create an instance of the API class
        ServiceRegistryAndSupervisionApi apiInstance = new ServiceRegistryAndSupervisionApi();
        String serviceId = serviceId_example; // String | 

        try {
            Object result = apiInstance.keepAliveService(serviceId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ServiceRegistryAndSupervisionApi#keepAliveService");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ServiceRegistryAndSupervisionApi;

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

        try {
            Object result = apiInstance.keepAliveService(serviceId);
            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)

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

// Create an instance of the API class
var api = new A1PolicyManagementService.ServiceRegistryAndSupervisionApi()
var serviceId = serviceId_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, 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)

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

try {
    $result = $api_instance->keepAliveService($serviceId);
    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 | 

eval {
    my $result = $api_instance->keepAliveService(serviceId => $serviceId);
    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)

try:
    # Heartbeat indicates that the service is running
    api_response = api_instance.keep_alive_service(serviceId)
    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 mut context = ServiceRegistryAndSupervisionApi::Context::default();
    let result = client.keepAliveService(serviceId, &context).wait();

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

Scopes

Parameters

Path parameters
Name Description
service_id*
String
Required

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.


/a1-policy/v2/services

Usage and SDK Samples

curl -X PUT \
 -H "Accept: */*" \
 -H "Content-Type: application/json" \
 "http://localhost/a1-policy/v2/services" \
 -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();
        ServiceRegistrationInfoV2 serviceRegistrationInfoV2 = ; // ServiceRegistrationInfoV2 | 

        try {
            Object result = apiInstance.putService(serviceRegistrationInfoV2);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ServiceRegistryAndSupervisionApi#putService");
            e.printStackTrace();
        }
    }
}
import org.openapitools.client.api.ServiceRegistryAndSupervisionApi;

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

        try {
            Object result = apiInstance.putService(serviceRegistrationInfoV2);
            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];
ServiceRegistrationInfoV2 *serviceRegistrationInfoV2 = ; // 

// Register a service
[apiInstance putServiceWith:serviceRegistrationInfoV2
              completionHandler: ^(Object output, NSError* error) {
    if (output) {
        NSLog(@"%@", output);
    }
    if (error) {
        NSLog(@"Error: %@", error);
    }
}];
var A1PolicyManagementService = require('a1_policy_management_service');

// Create an instance of the API class
var api = new A1PolicyManagementService.ServiceRegistryAndSupervisionApi()
var serviceRegistrationInfoV2 = ; // {ServiceRegistrationInfoV2} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.putService(serviceRegistrationInfoV2, 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 serviceRegistrationInfoV2 = new ServiceRegistrationInfoV2(); // ServiceRegistrationInfoV2 | 

            try {
                // Register a service
                Object result = apiInstance.putService(serviceRegistrationInfoV2);
                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();
$serviceRegistrationInfoV2 = ; // ServiceRegistrationInfoV2 | 

try {
    $result = $api_instance->putService($serviceRegistrationInfoV2);
    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 $serviceRegistrationInfoV2 = WWW::OPenAPIClient::Object::ServiceRegistrationInfoV2->new(); # ServiceRegistrationInfoV2 | 

eval {
    my $result = $api_instance->putService(serviceRegistrationInfoV2 => $serviceRegistrationInfoV2);
    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()
serviceRegistrationInfoV2 =  # ServiceRegistrationInfoV2 | 

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

pub fn main() {
    let serviceRegistrationInfoV2 = ; // ServiceRegistrationInfoV2

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

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

Scopes

Parameters

Body parameters
Name Description
serviceRegistrationInfoV2 *

Responses